16. OGNL表示式

16.1 OGNL表示式語言簡介

  OGNL （Object Graph Navigation Language）物件圖導航語言。Struts2框架使用OGNL作為預設的表示式語言。
  OGNL相對其它表示式語言具有下面幾大優勢：

• 支援物件方法呼叫，如xxx.doSomeSpecial()；
• 支援類靜態方法的呼叫和值的訪問，表示式的格式:
    @[類全名（包括包路徑）]@[方法名 | 值名]，例如：
    @[email protected](‘foo %s’, ‘bar’)
    或@[email protected]_NAME；
• 支援賦值操作和表示式串聯；
• 訪問OGNL上下文ActionContext；

• 操作集合物件List,Map。
    Ognl 有一個上下文（Context）概念，在 Struts2 中上下文(Context)的實現為ActionContext，ActionContext物件對應Action，可以理解為action執行相關的物件的容器，包括application，session，parameters，locale，value stack等。ActionContext中：

• ValueStack是OGNL上下文的root元素，貫穿整個 Action 的生命週期(每個Action類的物件例項都擁有一個ValueStack 物件)。 相當於一個數據的中轉站. 在其中儲存當前Action 物件和其他相關物件。

• private Map<String, Object> context;這個才是真正意義上的上下文。其中可以put進資料，jsp中可通過OGNL表示式通過key獲取。
    OGNL Context 實現者為 ActionContext ,它結構示意圖如下 :
  
  
    注：這裡的context map指的是ActionContext的map效果；action為相關的action包名，而不是action物件（程式碼中更清晰）。

16.2 理解Struts2中的 ValueStack和OGNL Context

  ValueStack實際是一個介面,在Struts2中利用OGNL時，實際上使用的是實現了該介面的OgnlValueStack類,這個類是Struts2利用OGNL的基礎。
  ValueStack(值棧): 貫穿整個 Action 的生命週期(每個 Action 類的物件例項都擁有一個ValueStack 物件). 相當於一個數據的中轉站. 在其中儲存當前Action 物件和其他相關物件。
  OgnlValueStack 類包含兩個重要的屬性：

    CompoundRoot root; // CompoundRoot extends ArrayList
    transient Map<String, Object> context;

• 其中root為一個ArrayList模擬的值棧，action等相關物件就是儲存這裡：

    /**
     * 實現ValueStack介面的pop操作
     * @see com.opensymphony.xwork2.util.ValueStack#pop()
     */
    public Object pop() {
        return root.pop();
    }

    /**
     * 實現ValueStack介面的push操作
     * @see com.opensymphony.xwork2.util.ValueStack#push(java.lang.Object)
     */
    public void push(Object o) {
        root.push(o);
    }

  再檢視ActionContext類的原始碼可知：

public class ActionContext implements Serializable {

    static ThreadLocal<ActionContext> actionContext = new ThreadLocal<ActionContext>();

    // 所要執行的action類名
    public static final String ACTION_NAME = "com.opensymphony.xwork2.ActionContext.name";

    // 值棧ValueStack的類名，即上面所說的_root物件
    public static final String VALUE_STACK = ValueStack.VALUE_STACK;
    public static final String SESSION = "com.opensymphony.xwork2.ActionContext.session";
    public static final String APPLICATION = "com.opensymphony.xwork2.ActionContext.application";
    public static final String PARAMETERS = "com.opensymphony.xwork2.ActionContext.parameters";
    public static final String LOCALE = "com.opensymphony.xwork2.ActionContext.locale";
    // context map
    private Map<String, Object> context;
    ...
}

  會發現ActionContext中包含一個context，OgnlValueStack中也包含一個context，這兩個context是否為同一個物件呢？？我們在action的execute方法中進行測試：

    public String execute() {
        ActionContext context = ActionContext.getContext();
        OgnlValueStack ognlValueStack = (OgnlValueStack) context.getValueStack();
        // 獲取OgnlValueStack中的context屬性
        Map<String, Object> ognlValueStack_Context = ognlValueStack.getContext();
        // 獲取ActionContext中的context屬性
        Map<String, Object> actionContext_Context = context.getContextMap();
        // 比較ActionContext中的context屬性和OgnlValueStack中的context屬性是否為同一個物件
        System.out.println(ognlValueStack_Context == actionContext_Context); // true

        return SUCCESS;
    }

  測試結果為true！所以說ActionContext中的context屬性和OgnlValueStack中的context屬性實則為同一個物件！這也就解釋了：通過ActionCOntext.getContext().put();方法放入到context（Map集合）的資料，也即OgnlValueStack中context（Map集合），所以可以通過OGNL表示式可以獲取。
  注:在Ognl上下文物件（ActionContext）中，維持值棧root的包名(com.opensymphony.xwork2.util.ValueStack.ValueStack)，OGNL訪問root中的元素時，是不需要#號的，直接通過元素的名稱來進行訪問；而訪問其他物件時，如application、request、session、parameters、attr等，則需要#號引用。

  當Struts2接受一個請求時，會迅速建立ActionContext，ValueStack，action等。然後把action存放進值棧OgnlValueStack的root物件中，所以在頁面上通過Struts2標籤訪問Action的屬性時，就不需要通過#號來引用。

  由於 ValueStack( 值棧 ) 是 Struts 2 中 OGNL上下文的根物件,如果使用者需要訪問值棧中的物件,在 JSP 頁面可以通過EL表示式訪問 ValueStack（值棧）中物件的屬性:

${foo} // 獲得值棧中某個物件的 foo 屬性

  如果訪問其他 Context 中的物件,由於他們不是根物件,所以在訪問時,需要新增 # 字首。

• application物件:用於訪問ServletContext,例如#application.userName或者#application[‘userName’],相當於呼叫ServletContext的getAttribute(“username”)。
• session物件:用來訪問HttpSession ,例如#session.userName或者#session[‘userName’] ,相當於呼叫session.getAttribute(“userName”)。
• request物件:用來訪問HttpServletRequest屬性(attribute)的Map,例如#request.userName或者#request[‘userName’] ,相當於呼叫request.getAttribute(“userName”)。
• parameters物件:用於訪問HTTP的請求引數,例如#parameters.userName或者#parameters[‘userName’] ,相當於呼叫 request.getParameter(“username”)。
• attr物件:用於按page->request->session->application順序訪問其屬性。

16.3 為何使用EL 表示式能夠訪問valueStack中物件的屬性

  在JSP頁面中通過${foo} 這樣的EL表示式就可以獲取值棧中某個物件的 foo 屬性。原因是Struts2對HttpServletRequest作了進一步的封裝。簡略程式碼如下:

public class StrutsRequestWrapper extends HttpServletRequestWrapper {
    public StrutsRequestWrapper(HttpServletRequest req) {
        super(req);
    }
    public Object getAttribute(String key) {
        ......
        ActionContext ctx = ActionContext.getContext();
        Object attribute = super.getAttribute(key);// 先從 request 範圍獲取屬性值
        // 如果從 request 範圍沒有找到屬性值 , 即從 ValueStack 中查詢物件的屬性值
        if (ctx != null && attribute == null) {
            ......
                    ValueStack stack = ctx.getValueStack();
                        if (stack != null) {
                             attribute = stack.findValue(key);
                        }
            ......
        }
        return attribute;
    }
}

16.4 基本案例測試

  案例需求：輸入介面通過表單輸入資料，並注入到action中，輸出介面通過Ognl表示式獲取輸入的內容中未儲存到action部分和儲存的部分，已經action中只提供get方法的屬性。（即獲取以上討論的三種類型的資料）
  （1）輸入介面input.jsp

<form action="/Ognl/day07/ognlTest.action" method="post">
    username: <input type="text" name="username"/><br>
    phone:   <input type="text" name="phone"/><br>
    <!-- 此屬性並沒有注入到action的屬性中 -->
    other:  <input type="text" name="other"/><br>
    <input type="submit" value="提交">
</form>

  （2）Action類：

package com.markliu.day07;

import org.apache.struts2.ServletActionContext;

import com.opensymphony.xwork2.ActionContext;
import com.opensymphony.xwork2.ActionSupport;

public class OgnlTestAction extends ActionSupport {
    private static final long serialVersionUID = 4491003976083155453L;

    private String username;
    private String phone;
    private String message;

    public String getMessage() {
        return message;
    }

    public String getUsername() {
        return username;
    }
    public void setUsername(String username) {
        this.username = username;
    }
    public String getPhone() {
        return phone;
    }
    public void setPhone(String phone) {
        this.phone = phone;
    }

    public String execute() {
        this.message = "從action獲取message！";
        return SUCCESS;
    }

}

  （3）struts.xml配置：

    <package name="day07" namespace="/day07" extends="struts-default">
            <action name="ognlTest" class="com.markliu.day07.OgnlTestAction" method="execute">
                <result name="success">/pages/day07/ognlGetInfo.jsp</result>
            </action>
    </package>

  （4）ognl獲取資料顯示：

<%@ taglib uri="/struts-tags" prefix="s" %>
 ...
<body>
輸入的值並儲存到action中的屬性：
<s:property value="username"/><br>
${phone }<br>
輸入的值沒有儲存到action中的屬性：${other }<s:property value="other"/><br>
action中只提供get方法的屬性: ${message }
</body>

  （5）執行顯示：

輸入的值並儲存到action中的屬性： wq
18212345678
輸入的值沒有儲存到action中的屬性：
action中只提供get方法的屬性: action獲取message！ 

  由執行結果可知：由於action被儲存到valuestack值棧中，所以使用者輸入的資訊注入到action中的屬性，以及action本身的屬性（提供get方法）都可以通過OGNL表示式的兩種形式獲取：EL表示式或Struts2標籤。

16.5 採用 OGNL 表示式建立 List/Map 集合物件

  如果需要一個集合元素的時候(例如 List 物件或者 Map 物件),可以使用 OGNL 中同集合相關的表示式。
  使用如下程式碼直接生成一個 List 物件:

<s:set name="list" value="{'zhangming','xiaoi','liming'}" />
<!-- s:iterator會將當前迭代的物件放到值棧的棧頂中！因此才會有s:property預設輸出ValueStack棧頂的值 -->
<s:iterator value="#list" id="n">
    <s:property value="n"/><br>
</s:iterator>
<!-- s:property標籤的value屬性可選，如果沒有給定，則預設輸出ValueStack棧頂的值
     因此還可以簡寫成如下形式 -->
<s:iterator value="#list">
    <s:property/><br>
</s:iterator>

  生成一個 Map 物件:

<s:set name="foobar" value="#{'foo1':'bar1', 'foo2':'bar2'}" />
<s:iterator value="#foobar" >
    <!-- Map集合迭代採用了內部的Entry類，且此時迭代的Entry物件放在值棧的棧頂，
    Entry中包含key和value的屬性，因此可以通過OGNL表示式獲取棧頂物件的屬性 -->
    <s:property value="key"/>=<s:property value="value"/><br>
</s:iterator>

  <s:set>標籤用於將某個值放入指定範圍。

- scope：指定變數被放置的範圍,該屬性可以接受application、session、request、page或action。如果沒有設定該屬性,則預設放置在ActionContext(OGNL上下文)中。
- value :賦給變數的值 . 如果沒有設定該屬性 , 則將 ValueStack 棧頂的值賦給變數。
  對於集合型別, OGNL 表示式可以使用 in 和 not in 兩個元素符號。其中, in 表示式用來判斷某個元素是否在指定的集合物件中; not in 判斷某個元素是否不在指定的集合物件中。s:if標籤的test中填入OGNL表示式，如下所示。

<s:if test="'foo' in {'foo','bar'}">
</s:if>
<s:else>
</s:else>

<s:if test="'foo' not in {'foo','bar'}">
</s:if>
<s:else>
</s:else>

16.6 OGNL 表示式的投影功能

  除了 in 和 not in 之外, OGNL 還允許使用某個規則獲得集合物件的子集,常用的有以下 3 個相關操作符:
? :獲得所有符合邏輯的元素。
^ :獲得符合邏輯的第一個元素。
$ :獲得符合邏輯的最後一個元素。
例如程式碼，獲取價格大於35的所有圖書:

<s:iterator value="books.{?#this.price > 35}">
    <s:property value="title" /> - $<s:property value="price" /><br>
</s:iterator>