Struts2中的ModelDriven机制及其运用

短命女 2022-06-06 02:52 130阅读 0赞

## ModelDriven ##

### *为什么需要ModelDriven* ###

所谓ModelDriven，意思是直接把实体类当成页面数据的收集对象。比如，有实体类User如下：

<table style="color:rgb(69,69,69)"> 
 <tbody> 
 <tr> 
 <td> package&nbsp;cn.com.leadfar.struts2.actions; &nbsp; public&nbsp;class&nbsp;User { &nbsp;&nbsp;&nbsp;&nbsp;private&nbsp;int&nbsp;id; &nbsp;&nbsp;&nbsp;&nbsp;private&nbsp;String&nbsp;username; &nbsp;&nbsp;&nbsp;&nbsp;private&nbsp;String&nbsp;password; &nbsp;&nbsp;&nbsp;&nbsp;private&nbsp;int&nbsp;age; &nbsp;&nbsp;&nbsp;&nbsp;private&nbsp;String&nbsp;address; &nbsp;&nbsp;&nbsp;&nbsp;public&nbsp;String getUsername() { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return&nbsp;username; &nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;public&nbsp;void&nbsp;setUsername(String username) { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;this.username&nbsp;= username; &nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;public&nbsp;String getPassword() { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return&nbsp;password; &nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;public&nbsp;void&nbsp;setPassword(String password) { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;this.password&nbsp;= password; &nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;public&nbsp;int&nbsp;getAge() { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return&nbsp;age; &nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;public&nbsp;void&nbsp;setAge(int&nbsp;age) { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;this.age&nbsp;= age; &nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;public&nbsp;String getAddress() { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return&nbsp;address; &nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;public&nbsp;void&nbsp;setAddress(String address) { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;this.address&nbsp;= address; &nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;public&nbsp;int&nbsp;getId() { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return&nbsp;id; &nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;public&nbsp;void&nbsp;setId(int&nbsp;id) { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;this.id&nbsp;= id; &nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; } &nbsp; </td> 
 </tr> 
 </tbody> 
</table>

假如要写一个Action，用来添加User。

第一种做法是直接在Action中定义所有需要的属性，然后在JSP中直接用属性名称来提交数据：

UserAction:

<table style="color:rgb(69,69,69)"> 
 <tbody> 
 <tr> 
 <td> public&nbsp;class&nbsp;UserAction { &nbsp;&nbsp;&nbsp;&nbsp;private&nbsp;int&nbsp;id; &nbsp;&nbsp;&nbsp;&nbsp;private&nbsp;String&nbsp;username; &nbsp;&nbsp;&nbsp;&nbsp;private&nbsp;String&nbsp;password; &nbsp;&nbsp;&nbsp;&nbsp;private&nbsp;int&nbsp;age; &nbsp;&nbsp;&nbsp;&nbsp;private&nbsp;String&nbsp;address; &nbsp; &nbsp;&nbsp;&nbsp;&nbsp;public&nbsp;String add(){ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;User user =&nbsp;new&nbsp;User(); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;user.setId(id); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;user.setUsername(username); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;user.setPassword(password); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;user.setAge(age); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;user.setAddress(address); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;new&nbsp;UserManager().addUser(user); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return&nbsp;"success"; &nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;public&nbsp;int&nbsp;getId() { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return&nbsp;id; &nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;public&nbsp;void&nbsp;setId(int&nbsp;id) { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;this.id&nbsp;= id; &nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;public&nbsp;String getUsername() { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return&nbsp;username; &nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;public&nbsp;void&nbsp;setUsername(String username) { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;this.username&nbsp;= username; &nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;public&nbsp;String getPassword() { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return&nbsp;password; &nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;public&nbsp;void&nbsp;setPassword(String password) { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;this.password&nbsp;= password; &nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;public&nbsp;int&nbsp;getAge() { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return&nbsp;age; &nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;public&nbsp;void&nbsp;setAge(int&nbsp;age) { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;this.age&nbsp;= age; &nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;public&nbsp;String getAddress() { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return&nbsp;address; &nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;public&nbsp;void&nbsp;setAddress(String address) { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;this.address&nbsp;= address; &nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp; } </td> 
 </tr> 
 </tbody> 
</table>

add\_input.jsp:

上述做法不好之处是：如果实体类的属性非常多，那么Action中也要定义相同的属性。

第二种做法是将User对象定义到UserAction中，然后在JSP中通过user属性来给user赋值：

UserAction:

add\_input.jsp:

这种做法不好的地方是：JSP页面上表单域中的命名变得太长

第三种做法是利用ModelDriven机制，让UserAction实现一个ModelDriven接口，同时实现接口中的方法：getModel()。如下所示：

JSP的代码如下：

可见，第三种做法是比较好的，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的代码：

从ModelDrivenInterceptor中，即可以看到model对象被压入ValueStack中！

其中的refreshModelBeforeResult是为了接下来描述的一个问题而提供的解决方法。

## 理解常见的陷阱及其解决方法 ##

假设我们要更新一个实体对象，那么第一步首先是打开更新界面，请看下述模拟打开更新界面的代码：

上述代码中，new UserManager().findUserById(user.getId());这一行，将从数据库中查询相应的记录，同时转换为User对象返回。而return “update\_input”；将转向更新显示页面。

更新页面如下：

<table style="color:rgb(69,69,69)"> 
 <tbody> 
 <tr> 
 <td> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;form&nbsp;action="test/user.action"&nbsp;method="post"&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;input&nbsp;type="hidden"&nbsp;name="method:update"&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;id:&lt;input&nbsp;type="text"&nbsp;name="id"&nbsp;value="&lt;s:property&nbsp;value="id"/&gt;"&gt;&nbsp;&lt;br/&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;username:&lt;input&nbsp;type="text"&nbsp;name="username"&nbsp;value="&lt;s:property&nbsp;value="username"/&gt;"&gt;&nbsp;&lt;br/&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;password:&lt;input&nbsp;type="text"&nbsp;name="password"&nbsp;value="&lt;s:property&nbsp;value="password"/&gt;"&gt;&nbsp;&lt;br/&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;age:&lt;input&nbsp;type="text"&nbsp;name="age"&nbsp;value="&lt;s:property&nbsp;value="age"/&gt;"&gt;&nbsp;&lt;br/&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;address:&lt;input&nbsp;type="text"&nbsp;name="address"&nbsp;value="&lt;s:property&nbsp;value="address"/&gt;"&gt;&nbsp;&lt;br/&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;input&nbsp;type="submit"&nbsp;name="submit"&nbsp;value="更新用户"&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;/form&gt;&nbsp;&lt;br/&gt; </td> 
 </tr> 
 </tbody> 
</table>

上述代码运行起来之后，你在更新界面上将看不到数据（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！