Appfuse开发实践（四）——创建Webwork 框架的 Actions和JSP

Appfuse开发实践（四）—— 创建Webwork 框架的 Actions和JSP

内容提要

这个部分将会展现给你如何创建Webwork框架的Action和JSP，同样会编写JUnit测试来测试PersonAction对象。这个Action对象回合PersonManager交互。

接下来我们开始在AppFuse的构架下创建一个新的Acetion和JSP。如果还没有安装WebWork模块，先运行ant install-webwork任务。

内容列表

[1] 使用XDoclet创建JSP
[2] 创建PersonActionTest以便测试PersonAction
[3] 创建PersonAction对象
[4] 运行PersonActionTest
[5] 清理JSP文件并进行发布
[6] 创建Canoo WebTests模拟测试浏览器行为

一、使用XDoclet创建JSP

在这一步，我们要创建JSP文件显示Person对象的信息。这个JSP将使用Webwork的JSP Tag来把Person.java中的每个属性填充到表格的行中。我们使用的这个工具是由Erik Hatcher开发的。他由一个类(FormTagsHandler.java) 和一对XDoclet模版(FormKeys.xdt and Form_jsp.xdt组成)。这些文件都在extras/viewgen目录下。

产生一个表单元素和对应的标签属性文件只需经过下面几个基本步骤：

命令行下面切换到"extras/viewgen"目录下
执行ant -Dform.name=Person任务在extras/viewgen/build 目录下产生下面三个文件：

Person.properties (表单元素的标签)
PersonForm.jsp (显示一个Person信息的JSP文件)
PersonList.jsp (显示People列表的JSP文件)

把Person.properties文件中的内容拷贝到web/WEB-INF/classes/ApplicationResources_en.properties文件中。下面是一个具体的Person.properties文件例子：

# -- person form --

person.firstName=First Name

person.id=Id

person.lastName=Last Name

由于我们使用的是中文，需要把对应的信息填入web/WEB-INF/classes/ApplicationResources_cn.properties文件中，还要转化为Unicode编码。

把PersonForm.jsp文件拷贝到web/pages/personForm.jsp目录下。把PersonList.jsp拷贝到web/pages/personList.jsp目录下。注意每个文件名的名字第一个字符是小写字符。

"pages"目录下的文件在发布时将发布到"WEB-INF/pages"目录下。容器提供了WEB_INF目录下的所有文件的安全控制。这意味着来自客户端的请求，而不是由发过来的请求将不被相应。把所有的JSP文件放到WEB-INF目录下可以保证用户只能通过Actions来访问这些页面。这样就把系统安全性要求全部转移到Actions上，那里可以得到更高效的处理并且在基本的表示层外面。

AppFuse架构的web应用程序安全性保证了所有*.html文件得到了保护(除了/signup.html和/passwordHint.html文件)。这就保证了客户端必须通过Action才能访问JSP文件。

说明: 如果自定义了CSS特殊页面，那么需要在文件的最上面加上<body id="pageName"/>。这样就可以被 SiteMesh 识别并且放到最终的页面中去。你也可以使用下面的语句一个一个页面的用CSS来定义页面的格式：

body#pageName element.class {}{ background-color: blue }

在ApplicationResources_en.properties文件中加入对应JSP文件的titles和headings键值。

在自动产生的JSP文件中，有两个键表示title (浏览器的顶端)和header (页面的头上)。我们需要在ApplicationResources_en.properties文件中说明这两个键的值(personDetail.title and personDetail.heading)，具体内容如下所示：

# -- person detail page --

personDetail.title=Person Detail

personDetail.heading=Person Information

在这上面我们要在文件中加入"personForm.*"键，为什么我们要使用personForm和personDetail这样的表示形式?最主要的原因是在页面的标签和文本信息有个明显的区别。另外一个原因是因为*Form.*这种形式可以很好的表示数据库中的字段信息。

最近我有个客户希望所有数据库中的字段都可以查询。这个相当容易实现。我在ApplicationResources.properties 检查所有的包含"Form."的键并且把它放到下拉列表框中。在用户界面上，用户可以输入查询项并且选择想要查询的列。

二、创建PersonActionTest类测试PersonAction类

为PersonAction创建一个JUnit测试类, 首先在test/web/**/action目录下创建PersonActionTest.java文件。

package org.myApp.webapp.action;

import org.springframework.mock.web.MockHttpServletRequest;

import com.opensymphony.webwork.ServletActionContext;

public class PersonActionTest extends BaseActionTestCase {

private PersonAction action;

protected void setUp() throws Exception {

super.setUp();

action = (PersonAction) ctx.getBean("personAction");

}

protected void tearDown() throws Exception {

super.tearDown();

action = null;

}

public void testEdit() throws Exception {

log.debug("testing edit

");

action.setId("1");

assertNull(action.getPerson());

assertEquals(action.edit(), "success");

assertNotNull(action.getPerson());

assertFalse(action.hasActionErrors());

}

public void testSave() throws Exception {

MockHttpServletRequest request = new MockHttpServletRequest();

ServletActionContext.setRequest(request);

action.setId("1");

assertEquals(action.edit(), "success");

assertNotNull(action.getPerson());

// update last name and save

action.getPerson().setLastName("Updated Last Name");

assertEquals(action.save(), "input");

assertEquals(action.getPerson().getLastName(), "Updated Last Name");

assertFalse(action.hasActionErrors());

assertFalse(action.hasFieldErrors());

assertNotNull(request.getSession().getAttribute("messages"));

}

public void testRemove() throws Exception {

MockHttpServletRequest request = new MockHttpServletRequest();

ServletActionContext.setRequest(request);

action.setDelete("");

Person person = new Person();

person.setId(new Long(2));

action.setPerson(person);

assertEquals(action.delete(), "success");

assertNotNull(request.getSession().getAttribute("messages"));

}

由于没有创建PersonAction类这个对象无法通过编译。

4、创建PersonAction类

在src/web/**/action目录下，创建PersonAction.java文件：

package org.myApp.webapp.action;

import java.util.ArrayList;

import java.util.List;

import org.myApp.model.Person;

import org.myApp.service.PersonManager;

public class PersonAction extends BaseAction {

private Person person;

private String id;

private PersonManager personManager;

public void setId(String id) {

this.id = id;

}

public void setPersonManager(PersonManager manager) {

this.personManager = manager;

}

public Person getPerson() {

return person;

}

public void setPerson(Person person) {

this.person = person;

}

public String delete() {

personManager.removePerson(String.valueOf(person.getId()));

List args = new ArrayList();

args.add(person.getFirstName() + ' ' + person.getLastName());

saveMessage(getText("person.deleted", args));

return SUCCESS;

}

public String edit() {

if (id != null) {

person = personManager.getPerson(id);

} else {

person = new Person();

}

return SUCCESS;

}

public String save() throws Exception {

if (cancel != null) {

return "cancel";

}

if (delete != null) {

return delete();

}

boolean isNew = (person.getId() == null);

List args = new ArrayList();

args.add(person.getFirstName() + ' ' + person.getLastName());

personManager.savePerson(person);

String key = (isNew) ? "person.added" : "person.updated";

saveMessage(getText(key, args));

if (!isNew) {

return INPUT;

} else {

return SUCCESS;

}

有一些Key需要加到ApplicationResources_en.properties文件中用来显示给用户看的操作成功的提示信息打开web/WEB-INF/classes目录下的ApplicationResources_en.properties并且加入如下内容：

I usually add these under the # -- success messages -- comment.

person.added=Information for <strong>{0}</strong> has been added successfully.

person.deleted=Information for <strong>{0}</strong> has been deleted successfully.

person.updated=Information for <strong>{0}</strong> has been updated successfully.

当然你可以加入一般的added, deleted和updated提示信息，这取决于你的需要。为每个实体使用独立的信息可以在特别情况下改变它。

你可能注意到了我们以和PersonManager类类似的方式调用了TestPersonManager对象。PersonAction和PersonManagerTest都是PersonManagerImpl的客户,这是个很好的结构。

现在你需要告诉Spring和WebWork这个action的存在。首先在web/WEB-INF/action-servlet.xml文件中加入如下的PersonAction定义信息：

</bean>

然后在web/WEB-INF/classes/xwork.xml中加入引用信息说明：

<result name="success">/WEB-INF/pages/personForm.jsp</result>

</action>

<result name="cancel" type="redirect">mainMenu.html</result>

<result name="input">/WEB-INF/pages/personForm.jsp</result>

<result name="success" type="redirect">mainMenu.html</result>

</action>

在上面的书名中"validationStack" interceptor-ref注释掉了因为你没有为Person对象定义任何的validation规则. 我们会在下一章中加入校验规则并且去掉注释。

四、运行PersonActionTest

如果你看了我们的PersonActionTest, 所有的测试依赖一条id为1的纪录(testRemove依赖一套id为2的纪录)，所以让我们在示例数据文件metadata/sql/sample-data.xml中加入这些纪录（原来已经添加了一条，现添加第二条）。如下所示（顺序并不重要）

<column>first_name</column>

<row>

<value>Raible</value>

</row>

<row>

<value>James</value>

<value>Davidson</value>

</row>

</table>

当我们运行任何测试时，DBUnit都会加载这个文件,因此当你运行Action test时这些纪录肯定是有效的。

确定你在project目录下并且所有文件都正确保存，启动MySql，运行ant test-web -Dtestcase=PersonAction任务

BUILD SUCCESSFUL
Total time: 21 seconds

5、清理JSP以便正常显示Person信息

现在清理自动产生的personForm.jsp文件隐藏"id"属性。把下面的代码从 web/pages/personForm.jsp文件中移除掉：

<ww:textfield label="getText('person.id')" name="'person.id'"

value="person.id" required="true"/>

在<table>标签后加入鲜面的代码：

<ww:hidden name="'person.id'" value="person.id"/>

如果希望提高界面的易用性，你可以把焦点设置在第一个字段的文本框上。这需要加入下面的JavaScript代码：

document.forms["person"].elements["firstName"].focus();

</script>

现在执行ant db-load deploy任务, 启动Tomcat并且在浏览器中（我用firefox）输入http://localhost:8080/myApp/editPerson.html?id=1

抛出异常：

com.opensymphony.xwork.config.ConfigurationException: Error loading configuration file xwork.xml

with nested exception

com.opensymphony.xwork.config.ConfigurationException: Caught exception while loading file xwork.xml

with nested exception

org.xml.sax.SAXParseException: Element type "result" must be followed by either attribute specifications, ">" or "/>".

at com.opensymphony.xwork.config.providers.XmlConfigurationProvider.init(XmlConfigurationProvider.java:126)

at com.opensymphony.xwork.config.impl.DefaultConfiguration.reload(DefaultConfiguration.java:85)

at com.opensymphony.xwork.config.ConfigurationManager.getConfiguration(ConfigurationManager.java:56)

at com.opensymphony.xwork.DefaultActionProxyFactory.setupConfigIfActionIsCommand(DefaultActionProxyFactory.java:58)

at com.opensymphony.xwork.DefaultActionProxyFactory.createActionProxy(DefaultActionProxyFactory.java:43)

at com.opensymphony.webwork.dispatcher.ServletDispatcher.serviceAction(ServletDispatcher.java:292)

at com.opensymphony.webwork.dispatcher.ServletDispatcher.service(ServletDispatcher.java:264)

at javax.servlet.http.HttpServlet.service(HttpServlet.java:802)

at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:237)

at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:157)

at com.opensymphony.module.sitemesh.filter.PageFilter.parsePage(PageFilter.java:118)

at com.opensymphony.module.sitemesh.filter.PageFilter.doFilter(PageFilter.java:52)

at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:186)

at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:157)

at org.displaytag.filter.ResponseOverrideFilter.doFilter(ResponseOverrideFilter.java:86)

at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:186)

at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:157)

at org.springframework.web.filter.CharacterEncodingFilter.doFilterInternal(CharacterEncodingFilter.java:73)

at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:73)

at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:186)

at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:157)

at com.opensymphony.clickstream.ClickstreamFilter.doFilter(ClickstreamFilter.java:42)

at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:186)

at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:157)

at org.appfuse.webapp.filter.ActionFilter.doFilter(ActionFilter.java:116)

at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:186)

at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:157)

at org.springframework.orm.hibernate.support.OpenSessionInViewFilter.doFilterInternal(OpenSessionInViewFilter.java:170)

at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:73)

at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:186)

at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:157)

at org.appfuse.webapp.filter.GZIPFilter.doFilter(GZIPFilter.java:51)

at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:186)

at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:157)

at org.apache.catalina.core.StandardWrapperValve.invoke(StandardWrapperValve.java:214)

at org.apache.catalina.core.StandardValveContext.invokeNext(StandardValveContext.java:104)

at org.apache.catalina.core.StandardPipeline.invoke(StandardPipeline.java:520)

at org.apache.catalina.core.StandardContextValve.invokeInternal(StandardContextValve.java:198)

at org.apache.catalina.core.StandardContextValve.invoke(StandardContextValve.java:152)

at org.apache.catalina.core.StandardValveContext.invokeNext(StandardValveContext.java:104)

at org.apache.catalina.authenticator.AuthenticatorBase.invoke(AuthenticatorBase.java:540)

at org.apache.catalina.core.StandardValveContext.invokeNext(StandardValveContext.java:102)

at org.apache.catalina.core.StandardPipeline.invoke(StandardPipeline.java:520)

at org.apache.catalina.core.StandardHostValve.invoke(StandardHostValve.java:137)

at org.apache.catalina.core.StandardValveContext.invokeNext(StandardValveContext.java:104)

at org.apache.catalina.valves.ErrorReportValve.invoke(ErrorReportValve.java:118)

at org.apache.catalina.core.StandardValveContext.invokeNext(StandardValveContext.java:102)

at org.apache.catalina.core.StandardPipeline.invoke(StandardPipeline.java:520)

at org.apache.catalina.core.StandardEngineValve.invoke(StandardEngineValve.java:109)

at org.apache.catalina.core.StandardValveContext.invokeNext(StandardValveContext.java:104)

at org.apache.catalina.core.StandardPipeline.invoke(StandardPipeline.java:520)

at org.apache.catalina.core.ContainerBase.invoke(ContainerBase.java:929)

at org.apache.coyote.tomcat5.CoyoteAdapter.service(CoyoteAdapter.java:160)

at org.apache.coyote.http11.Http11Processor.process(Http11Processor.java:799)

at org.apache.coyote.http11.Http11Protocol$Http11ConnectionHandler.processConnection(Http11Protocol.java:705)

at org.apache.tomcat.util.net.TcpWorkerThread.runIt(PoolTcpEndpoint.java:577)

at org.apache.tomcat.util.threads.ThreadPool$ControlRunnable.run(ThreadPool.java:683)

at java.lang.Thread.run(Thread.java:534)

with nested exception com.opensymphony.xwork.config.ConfigurationException: Caught exception while loading file xwork.xml

with nested exception

org.xml.sax.SAXParseException: Element type "result" must be followed by either attribute specifications, ">" or "/>".

com.opensymphony.xwork.config.ConfigurationException: Caught exception while loading file xwork.xml

with nested exception

org.xml.sax.SAXParseException: Element type "result" must be followed by either attribute specifications, ">" or "/>".

at com.opensymphony.xwork.config.providers.XmlConfigurationProvider.loadConfigurationFile(XmlConfigurationProvider.java:525)

at com.opensymphony.xwork.config.providers.XmlConfigurationProvider.init(XmlConfigurationProvider.java:123)