在尋找structs標籤push的運用時,發現的一篇好文章。
所謂ModelDriven,意思是直接把實體類當成頁面數據的收集對象。比如,有實體類User如下:
package cn.com.leadfar.struts2.actions;
publicclass User { privateintid; private String username; private String password; privateintage; private String address; public String getUsername() { returnusername; } publicvoid setUsername(String username) { this.username = username; } public String getPassword() { returnpassword; } publicvoid setPassword(String password) { this.password = password; } publicint getAge() { returnage; } publicvoid setAge(int age) { this.age = age; } public String getAddress() { returnaddress; } publicvoid setAddress(String address) { this.address = address; } publicint getId() { returnid; } publicvoid setId(int id) { this.id = id; }
}
|
假如要寫一個Action,用來添加User。
第一種做法是直接在Action中定義所有需要的屬性,然後在JSP中直接用屬性名稱來提交數據:
UserAction:
publicclass UserAction { privateintid; private String username; private String password; privateintage; private String address;
public String add(){
User user = new User(); user.setId(id); user.setUsername(username); user.setPassword(password); user.setAge(age); user.setAddress(address);
new UserManager().addUser(user);
return"success"; }
publicint getId() { returnid; } publicvoid setId(int id) { this.id = id; } public String getUsername() { returnusername; } publicvoid setUsername(String username) { this.username = username; } public String getPassword() { returnpassword; } publicvoid setPassword(String password) { this.password = password; } publicint getAge() { returnage; } publicvoid setAge(int age) { this.age = age; } public String getAddress() { returnaddress; } publicvoid setAddress(String address) { this.address = address; }
} |
add_input.jsp:
<form action="test/user.action" method="post"> <input type="hidden" name="method:add"> username:<input type="text" name="username"><br/> password:<input type="text" name="password"><br/> age:<input type="text" name="age"><br/> address:<input type="text" name="address"><br/> <input type="submit" name="submit" value="添加用戶"> </form><br/> |
上述做法不好之處是:如果實體類的屬性非常多,那麼Action中也要定義相同的屬性。
第二種做法是將User對象定義到UserAction中,然後在JSP中通過user屬性來給user賦值:
UserAction:
publicclass UserAction {
private User user;
public String add(){
new UserManager().addUser(user);
return"success"; }
public User getUser() { returnuser; }
publicvoid setUser(User user) { this.user = user; }
} |
add_input.jsp:
<form action="test/user.action" method="post"> <input type="hidden" name="method:add"> username:<input type="text" name="user.username"><br/> password:<input type="text" name="user.password"><br/> age:<input type="text" name="user.age"><br/> address:<input type="text" name="user.address"><br/> <input type="submit" name="submit" value="添加用戶"> </form><br/> |
這種做法不好的地方是:JSP頁面上表單域中的命名變得太長
第三種做法是利用ModelDriven機制,讓UserAction實現一個ModelDriven接口,同時實現接口中的方法:getModel()。如下所示:
publicclass UserAction implements ModelDriven{
private User user;
@Override public Object getModel() { if(user == null){ user = new User(); } returnuser; }
public String add(){
new UserManager().addUser(user);
return"success"; }
public User getUser() { returnuser; }
publicvoid setUser(User user) { this.user = user; } } |
JSP的代碼如下:
<form action="test/user.action" method="post"> <input type="hidden" name="method:add"> username:<input type="text" name="username"><br/> password:<input type="text" name="password"><br/> age:<input type="text" name="age"><br/> <input type="submit" name="submit" value="添加用戶"> </form><br/> |
可見,第三種做法是比較好的,Action和JSP寫起來都比較簡單。
ModelDriven背後的機制?
ModelDriven背後的機制就是ValueStack。界面通過:username/age/address這樣的名稱,就能夠被直接賦值給user對象,這證明user對象正是ValueStack中的一個root對象!
那麼,爲什麼user對象會在ValueStack中呢?它是什麼時候被壓入ValueStack的呢?答案是:ModelDrivenInterceptor(關於Interceptor的概念,請參考後續章節的說明)。ModelDrivenInterceptor是缺省的攔截器鏈的一部分,當一個請求經過ModelDrivenInterceptor的時候,在這個攔截器中,會判斷當前要調用的Action對象是否實現了ModelDriven接口,如果實現了這個接口,則調用getModel()方法,並把返回值(本例是返回user對象)壓入ValueStack。
請看ModelDrivenInterceptor的代碼:
publicclass ModelDrivenInterceptor extends AbstractInterceptor {
protectedbooleanrefreshModelBeforeResult = false;
publicvoid setRefreshModelBeforeResult(boolean val) { this.refreshModelBeforeResult = val; }
@Override public String intercept(ActionInvocation invocation) throws Exception { Object action = invocation.getAction();
if (action instanceof ModelDriven) { ModelDriven modelDriven = (ModelDriven) action; ValueStack stack = invocation.getStack(); Object model = modelDriven.getModel(); if (model != null) { stack.push(model); } if (refreshModelBeforeResult) { invocation.addPreResultListener(new RefreshModelBeforeResult(modelDriven, model)); } } return invocation.invoke(); } |
從ModelDrivenInterceptor中,即可以看到model對象被壓入ValueStack中!
其中的refreshModelBeforeResult是爲了接下來描述的一個問題而提供的解決方法。
理解常見的陷阱及其解決方法
假設我們要更新一個實體對象,那麼第一步首先是打開更新界面,請看下述模擬打開更新界面的代碼:
publicclass UserAction implements ModelDriven{
private User user;
@Override public Object getModel() { if(user == null){ user = new User(); //user.setUsername("這是原來的User對象"); } returnuser; }
public String updateInput(){
//根據ID,查詢數據庫,得到User對象 user = new UserManager().findUserById(user.getId());
return"update_input"; } |
上述代碼中,new UserManager().findUserById(user.getId());這一行,將從數據庫中查詢相應的記錄,同時轉換爲User對象返回。而return “update_input”;將轉向更新顯示頁面。
更新頁面如下:
<form action="test/user.action" method="post"> <input type="hidden" name="method:update"> id:<input type="text" name="id" value="<s:propertyvalue="id"/>"><br/> username:<input type="text" name="username" value="<s:propertyvalue="username"/>"><br/> password:<input type="text" name="password" value="<s:propertyvalue="password"/>"><br/> age:<input type="text" name="age" value="<s:propertyvalue="age"/>"><br/> address:<input type="text" name="address" value="<s:propertyvalue="address"/>"><br/> <input type="submit" name="submit" value="更新用戶"> </form><br/> |
上述代碼運行起來之後,你在更新界面上將看不到數據(id屬性有值,其它屬性無顯示)。關鍵的原因是在執行到updateInput之前,user對象(在getMode()方法中創建的對象)被壓到ValueStack中,這時候,UserAction和ValueStack都指向同一個user對象;但緊接着,UserAction中的user被一個新的user對象覆蓋,這時候,UserAction和ValueStack不再指向同一個user對象!ValueStack中是舊的user對象,而UserAction中是新的user對象!我們在JSP中,直接通過username/address等直接訪問,當然是要訪問ValueStack中的舊user對象,所以它們的屬性都是空的(id屬性除外)!
理解上述問題很重要,當你理解了問題,那麼問題的解決方法就可以有很多了:
比如,你可以把新對象的屬性拷貝到舊對象上;比如,你可以先把舊對象從ValueStack中移除,然後再把新對象壓入ValueStack等……
在最新的struts2版本中,ModelDrivenInterceptor提供了一個配置參數:refreshModelBeforeResult,只要將它定義爲true,上述問題就被解決了!struts2的解決方案就是:先把舊的model對象從ValueStack中移除,然後再把新的model對象壓入ValueStack!