安裝 JSON 插件之後,你會多出一種名為 json 的 ResultType。一旦為某個 Action 指定型別為 json 的 Result,這個 Result 就不需要對應到任何視圖資源——因為插件會負責把 Action 中的狀態資訊序列化成 JSON 格式資料,直接回傳給客戶端頁面的 JavaScript。
換句話說,JSON 插件讓我們能在 JavaScript 中異步呼叫 Action,而 Action 不必再借助視圖資源來呈現狀態,改由插件把狀態資料交還呼叫頁面,AJAX 互動於焉完成。
Struts2 的插件機制設計成可插入式,安裝 JSON 插件與安裝其他插件沒有差別:把插件的 JAR 檔複製到 Web 應用程式的 WEB-INF/lib 目錄即可。
以下是一個簡單的登入檢查 Action,示範兩種把資料回傳給頁面的做法:
import com.googlecode.jsonplugin.annotations.JSON;
import com.opensymphony.xwork2.Action;
public class JSONTestAction {
private String username;
private String passWord;
private boolean success;
private Map map = new HashMap();
public String checkLogin() {
if (this.getPassWord() != "" && this.getUsername() != "") {
// 做法一:把要回傳的資料放進 HashMap,
// 產生 {"map":{"success":true},"username":"ww"}
// map.put("success", true);
// 做法二:直接放到成員變數,
// 產生 {"success":true,"username":"ww"}
success = true;
return Action.SUCCESS;
} else {
return Action.INPUT;
}
}
@JSON(serialize = false)
public String getPassWord() {
return passWord;
}
public void setPassword(String passWord) {
this.passWord = passWord;
}
public String getUsername() {
return username;
}
public void setUsername(String username) {
this.username = username;
}
public boolean isSuccess() {
return success;
}
}
這裡有個實務上很關鍵的細節:@JSON(serialize=false)。Struts2 預設會把 Action 中所有提供了 getter 的屬性都序列化輸出到客戶端,但並非每個屬性都該外流。像是以 Spring 注入的 service 類屬性(例如 recordService)雖然具備 getter 與 setter,卻完全不需要出現在 JSON 裡。在 getter 上記上這個註解,就能把它排除在序列化之外,避免不必要的資料曝光與 payload 膨脹。