第1部分 -设置基本应用程序和环境
先决条件:
o Java SDK(我目前使用的是1.4.2版)
o Ant (使用1.6.2)
o Apache Tomcat(使用5.0.28版)
你应该已经对使用以上软件相当的自如了。
我不会在这篇文档里面涵盖很多背景信息或者理论——已经有很多书深入地讨论了这些东西。我们会直接投入开发程序的过程中。
第1步 - 开发目录
我们需要一个地方用来放置所有的源代码和其他我们将要创建的文件,所以我新建了一个目录,并命名为“springapp
”。你可以把这个目录放在你的主文件夹或者其它一些地方。我把我的新建在我已经放在主目录中的“projects
”目录下,这时我的目录的完整路径“/User/trisberg/projects/springapp
”。在这个目录中我新建了一个“src”目录来存放所有的Java源代码。然后我创建了另一个目录并命名为“war”。这个目录会存放所有将来进入WAR文件的东西,这个文件我们可以用来部署我们的应用程序。所有除了Java源代码的源文件,像JSP文件和配置文件,也属于这个目录。
第2步 – index.jsp
我将从建立一个叫做“index.jsp
”的文件(放在war目录中)开始。这是我们整个应用的入口点。
springapp/war/index.jsp |
|
只是为了Web应用的完整性,我在war目录中的WEB-INF目录中创建了一个web.xml。
springapp/war/WEB-INF/web.xml |
|
第3步 – 将应用程序部署到Tomcat
下面,我要写一个Ant构建脚本,贯穿这个文档我们都要使用它。一个独立的构建脚本包含了应用服务器特定的任务。同样还有用于控制Tomcat下的任务。
springapp/build.xml |
<!-- We need the servlet API classes: --> <!-- for Tomcat 4.1 use servlet.jar --> <!-- for Tomcat 5.0 use servlet-api.jar --> <!-- for Other app server - check the docs --> <!-- ============================================================== --> <!-- Tomcat tasks - remove these if you don't have Tomcat installed --> <!-- ============================================================== --> <!-- End Tomcat tasks --> |
这个脚本现在包含了所有我们需要的目标,以便使我们开发更加容易。这里我不会详细解释这个脚本,因为大部分内容都是比较标准Ant和Tomcat的东西。你可以直接复制上面的构建文件并且把它放在你的开发目录的根目录中。我们还需要一个build.properties
文件,你需要自定这个文件来配合你的服务器安装。这个文件和build.xml
文件在同一个目录中。
springapp/build.properties |
# Ant properties for building the springapp |
如果你是在一个你不是Tomcat安装的所有者的系统中,那么Tomcat所有者必须给你访问webapps目录的全部权限,或者他可以在webapps目录下面新建一个“springapp”目录,并且给你全部权限来把程序部署到这个新建的目录中。在Linux上我运行chmod a+rwx springapp
来给与所有人对目录的访问权利。
如果你使用一个不用的Web应用服务器,那么你要删除在构建脚本底部的那些特定于Tomcat的任务。你还要依赖你服务器的热部署特定,否则你就需要手工重新启动你的应用服务器。
现在我运行Ant来确保所有的东西都工作正常。你应该把你当前的目录设置到“springapp”目录下。
[trisberg@localhost springapp]$ ant Buildfile: build.xml usage: [echo] springapp build file [echo] ----------------------------------- [echo] Available targets are: [echo] build --> Build the application [echo] deploy --> Deploy application as directory [echo] deploywar --> Deploy application as a WAR file [echo] install --> Install application in Tomcat [echo] reload --> Reload application in Tomcat [echo] start --> Start Tomcat application [echo] stop --> Stop Tomcat application [echo] list --> List Tomcat applications BUILD SUCCESSFUL Total time: 2 seconds |
这里最后的动作是进行实际的部署。只要运行Ant并且指明“deploy”或者“deploywar”作为目标。
[trisberg@localhost springapp]$ ant deploy Buildfile: build.xml build: [mkdir] Created dir: /Users/trisberg/projects/springapp/war/WEB-INF/classes deploy: [copy] Copying 2 files to /Users/trisberg/jakarta-tomcat-5.0.28/webapps/springapp BUILD SUCCESSFUL Total time: 2 seconds |
第4步 – 测试应用
让我们立刻启动Tomcat并且确保我们可以访问这个应用程序。使用我们的构建脚本中的“list
”任务来查看Tomcat是否已经载入了新的应用程序。
[trisberg@localhost springapp]$ ant list Buildfile: build.xml list: [list] OK - Listed applications for virtual host localhost [list] /admin:running:0:/Users/trisberg/jakarta-tomcat-5.0.28/server/webapps/admin [list] /webdav:running:0:/Users/trisberg/jakarta-tomcat-5.0.28/webapps/webdav [list] /servlets-examples:running:0:/Users/trisberg/jakarta-tomcat-5.0.28/webapps/servlets-examples [list] /springapp:running:0:/Users/trisberg/jakarta-tomcat-5.0.28/webapps/springapp [list] /jsp-examples:running:0:/Users/trisberg/jakarta-tomcat-5.0.28/webapps/jsp-examples [list] /balancer:running:0:balancer [list] /tomcat-docs:running:0:/Users/trisberg/jakarta-tomcat-5.0.28/webapps/tomcat-docs [list] /:running:0:/Users/trisberg/jakarta-tomcat-5.0.28/webapps/ROOT [list] /manager:running:0:/Users/trisberg/jakarta-tomcat-5.0.28/server/webapps/manager BUILD SUCCESSFUL Total time: 1 second |
如果他没有被列出,使用“install
”任务来把应用程序安装到Tomcat中。
[trisberg@localhost springapp]$ ant install Buildfile: build.xml install: [install] OK - Installed application at context path /springapp BUILD SUCCESSFUL Total time: 2 seconds |
现在打开一个浏览器并浏览http://localhost:8080/springapp/index.jsp.
第5步 – 下载Spring分发包
如果你还没有下载Spring Framework的发布文件,那现在就行动吧。我目前使用的是“spring-framework-1.2-with-dependencies.zip
”,可以从http://www.springframework.org/download.html 下载到。我把文件解压缩到我的主目录中。我们后面将要用到里面的一些文件。
到此为止必要的环境安装已经完成了,现在我们要开始实际开发我们的Spring Framework MVC应用了。
第6步 – 修改WEB-INF目录中的web.xml
进入“springapp/war/ WEB-INF
”目录。修改我们前面创建的最小“web.xml
”文件。现在我们要修改它来满足我们需求。我们定义一个将来控制我们所有请求转向的DispatcherServlet
,它将根据我们以后某处输入的信息进行工作。同时还有一个标准的用来映射到我们使用的URL模式的servlet-mapping
条目。我决定让所有带“.htm
”扩展名的URL转向到“springapp
” 分配器。
springapp/war/WEB-INF/web.xml |
<servlet> <servlet-name>springapp</servlet-name> <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> <load-on-startup>1</load-on-startup> </servlet> <servlet-mapping> <servlet-name>springapp</servlet-name> <url-pattern>*.htm</url-pattern> </servlet-mapping> <welcome-file-list> <welcome-file> index.jsp </welcome-file> </welcome-file-list> |
下面,在springapp/war/WEB-INF
目录下创建一个叫做“springapp-servlet.xml
”的文件(你可以直接从Spring分发包中复制一个范例文件,位于sample/skeletons/webapp-minimal
目录中)。DispatcherServlet
所使用的定义就要放在这个文件中。文件名是web.xml
中的servlet-name并加上“-servlet”后缀。这是Spring Framework所使用的标准命名约定。现在,添加一个叫做springappController
的bean条目并创建一个SpringappController
类。这里将定义我们的应用程序所使用的控制器。我们还要添加一个URL映射 urlMapping
这样DispatcherServlet
就会知道对于不同的URL应该调用哪个控制器。
springapp/war/WEB-INF/springapp-servlet.xml |
<!-- - Application context definition for "springapp" DispatcherServlet. --> |
第7步 - 把jar文件复制到WEB-INF/lib
首先在“war/WEB-INF
”目录中创建一个“lib”目录。然后,从Spring分发包中,将spring.jar
(spring-framework-1.2/dist/spring.jar
)复制到新建的war/WEB-INF/lib
目录中。同时把commons-logging的jar文件(spring-framework-1.2/lib/jakarta-commons/commons-logging.jar
)也复制到war/WEB-INF/lib
中。同时我们还需要log4j.jar。把log4j-1.2.9.jar(spring-framework-1.2/lib/log4j/log4j-1.2.9.jar)
复制到 war/WEB-INF/lib
目录。这些jar文件以后会被部署到服务器上而且他们在构建过程中也会被用到。
第8步 - 创建你的控制器
创建你的控制器——我把我的控制器命名为SpringappController.java
并把它放在springapp/src
目录下。
springapp/src/SpringappController.java |
|
这是非常基本的控制器。我们稍后会对他进行扩充,同时过会儿我们还要扩展一些已经提供的抽象的基本实现。这个控制器处理请求并返回一个ModelAndView
。不过我们还没有定义任何视图,所以现在没什么可做的了。
第9步 - 构建应用程序
运行build.xml
中的“build
”任务。基本上代码应该顺利通过编译。
[trisberg@localhost springapp]$ ant build Buildfile: build.xml build: [javac] Compiling 1 source file to /Users/trisberg/projects/springapp/war/WEB-INF/classes BUILD SUCCESSFUL Total time: 2 seconds |
第10步 – 复制并修改log4j.properties
Spring Framework使用log4j来进行日志记录,所以我们要为log4j创建一个配置文件。把log4j.properties
文件从Petclinic范例应用程序(spring-framework-1.2/samples/petclinic/war/WEB-INF/log4j.properties
) 中复制到war/WEB-INF/classes
目录中(这个目录应该在前一步中被创建了)。现在取消log4j.rootCategory
属性前的注释并且更改写入的日志文件的名称和位置。我决定把日志写入与其他Tomcat日志一样的目录中。
springapp/war/WEB-INF/classes/log4j.properties |
# For JBoss: Avoid to setup Log4J outside # For all other servers: Comment out the Log4J listener in web.xml to activate Log4J. |
第11步 – 部署应用程序
运行build.xml
中的“deploy
”任务然后再运行“stop
”和“start
”任务。这将强制应用程序重新载入。我们要检查Tomcat日志中的部署错误——可能在上面的XML文件中有输入错误或者也可能缺少class或者jar文件。下面是一个日志的例子(/Users/trisberg/jakarta-tomcat-5.0.28/logs/springapp.log
)。
2005-04-24 14:58:18,112 INFO [org.springframework.web.servlet.DispatcherServlet] - Initializing servlet 'springapp' 2005-04-24 14:58:18,261 INFO [org.springframework.web.servlet.DispatcherServlet] - FrameworkServlet 'springapp': initialization started 2005-04-24 14:58:18,373 INFO [org.springframework.beans.factory.xml.XmlBeanDefinitionReader] - Loading XML bean definitions from ServletContext resource [/WEB-INF/springapp-servlet.xml] 2005-04-24 14:58:18,498 INFO [org.springframework.web.context.support.XmlWebApplicationContext] - Bean factory for application context [WebApplicationContext for namespace 'springapp-servlet']: org.springframework.beans.factory.support.DefaultListableBeanFactory defining beans [springappController,urlMapping]; root of BeanFactory hierarchy 2005-04-24 14:58:18,505 INFO [org.springframework.web.context.support.XmlWebApplicationContext] - 2 beans defined in application context [WebApplicationContext for namespace 'springapp-servlet'] 2005-04-24 14:58:18,523 INFO [org.springframework.core.CollectionFactory] - JDK 1.4+ collections available 2005-04-24 14:58:18,524 INFO [org.springframework.core.CollectionFactory] - Commons Collections 3.x available 2005-04-24 14:58:18,537 INFO [org.springframework.web.context.support.XmlWebApplicationContext] - Unable to locate MessageSource with name 'messageSource': using default [org.springframework.context.support.DelegatingMessageSource@8dacb] 2005-04-24 14:58:18,539 INFO [org.springframework.web.context.support.XmlWebApplicationContext] - Unable to locate ApplicationEventMulticaster with name 'applicationEventMulticaster': using default [org.springframework.context.event.SimpleApplicationEventMulticaster@5674a4] 2005-04-24 14:58:18,549 INFO [org.springframework.ui.context.support.UiApplicationContextUtils] - No ThemeSource found for [WebApplicationContext for namespace 'springapp-servlet']: using ResourceBundleThemeSource 2005-04-24 14:58:18,556 INFO [org.springframework.beans.factory.support.DefaultListableBeanFactory] - Pre-instantiating singletons in factory [org.springframework.beans.factory.support.DefaultListableBeanFactory defining beans [springappController,urlMapping]; root of BeanFactory hierarchy] 2005-04-24 14:58:18,557 INFO [org.springframework.beans.factory.support.DefaultListableBeanFactory] - Creating shared instance of singleton bean 'springappController' 2005-04-24 14:58:18,603 INFO [org.springframework.beans.factory.support.DefaultListableBeanFactory] - Creating shared instance of singleton bean 'urlMapping' 2005-04-24 14:58:18,667 INFO [org.springframework.web.servlet.DispatcherServlet] - Using context class [org.springframework.web.context.support.XmlWebApplicationContext] for servlet 'springapp' 2005-04-24 14:58:18,668 INFO [org.springframework.web.servlet.DispatcherServlet] - Unable to locate MultipartResolver with name 'multipartResolver': no multipart request handling provided 2005-04-24 14:58:18,670 INFO [org.springframework.web.servlet.DispatcherServlet] - Unable to locate LocaleResolver with name 'localeResolver': using default [org.springframework.web.servlet.i18n.AcceptHeaderLocaleResolver@318309] 2005-04-24 14:58:18,675 INFO [org.springframework.web.servlet.DispatcherServlet] - Unable to locate ThemeResolver with name 'themeResolver': using default [org.springframework.web.servlet.theme.FixedThemeResolver@c11e94] 2005-04-24 14:58:18,681 INFO [org.springframework.web.servlet.DispatcherServlet] - No HandlerAdapters found in servlet 'springapp': using default 2005-04-24 14:58:18,700 INFO [org.springframework.web.servlet.DispatcherServlet] - No ViewResolvers found in servlet 'springapp': using default 2005-04-24 14:58:18,700 INFO [org.springframework.web.servlet.DispatcherServlet] - FrameworkServlet 'springapp': initialization completed in 439 ms 2005-04-24 14:58:18,704 INFO [org.springframework.web.servlet.DispatcherServlet] - Servlet 'springapp' configured successfully |
第12步 - 创建一个视图
现在是时候创建我们第一个视图了。我将使用一个JSP页面,并命名为hello.jsp
。然后我把它放在了war目录中。
springapp/war/hello.jsp |
|
里面没什么奇特的东西,只是为了现在试一下。下面我们要修改SpringappController来引导到这个视图。
springapp/src/SpringappController.java |
import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; /** Logger for this class and subclasses */ protected final Log logger = LogFactory.getLog(getClass()); logger.info("SpringappController - returning hello view");
|
当我在修改这个类的同时,我还添加了一个logger
这样我们可以校对我们在这里实际得到的值。更改的内容将以红色标明。这个类返回的模型将最终通过一个ViewResolver
来进行转换。由于我们并没有指定一个特别的,所以我们将使用一个默认的,它仅仅引导到匹配指定的视图的名字的URL。我们稍候将修改它。
现在编译并部署这个应用程序。在通知Tomcat重新启动应用程序之后,所有的东西都应该被重新载入了。
让我们在浏览器中试一下——输入URL http://localhost:8080/springapp/hello.htm,然后我们应该看到以下内容:
我们也可以检查一下日志——我这里仅列出最后的条目,我们可以看到控制器确实被调用了,然后它引导到了hello视图。(/Users/trisberg/jakarta-tomcat-5.0.28/logs/springapp.log
)
2005-04-24 15:01:56,217 INFO [org.springframework.web.servlet.DispatcherServlet] - FrameworkServlet 'springapp': initialization completed in 372 ms 2005-04-24 15:01:56,217 INFO [org.springframework.web.servlet.DispatcherServlet] - Servlet 'springapp' configured successfully 2005-04-24 15:03:57,908 INFO [SpringappController] - SpringappController - returning hello view |
总结
让我们快速回顾一下目前我们已经创建的应用程序的各个部分:
1. 一个基本不做什么事情的介绍页面index.jsp
。它只是用来测试我们的安装。我们以后会修改它,以便提供一个链接指向我们的应用。
2. 一个DispatcherServlet
和一个相应的配置文件springapp-servlet.xml
。
3. 一个控制器 springappController.java
,包含了有限的功能——他仅仅把一个ModelAndView
引导到ViewResolver
。事实上,我们目前还只有一个空的模型,不过我们以后会修正它。
4. 一个视图 hello.jsp
,同样是极其基本的。但是整个安装工作可以运行并且我们现在已经准备好开始添加更多的功能了。
第2部分 -开发和配置应用程序
在第一部分(第1 – 12 步)我们已经配置了开发环境并建立了一个基本的应用程序。
我们已经准备好了:
1. 一个介绍页面index.jsp
.
2. 一个 DispatcherServlet
,以及相应的配置文件
springapp-servlet.xml
3. 一个控制器 springappController.java
.
4. 一个视图 hello.jsp
.
现在我们要改进这些部件来建立一个更好的应用程序。
第13步 – 改进index.jsp
我们将利用JSP标准标签库(JSTL),所以我要先复制我们所需的JSTL文件到我们的WEB-INF/lib
目录中。复制“spring-framework-1.2/lib/j2ee
”中的jstl.jar和“spring-framework-1.2/lib/jakarta-taglibs
”中的standard.jar
到springapp/war/WEB-INF/lib
目录下。我还创建了一个“header”文件,将来会在我写的每一个JSP页面中包含这个文件。这样会令开发更加简单同时我可以确保在所有的JSP文件中都有同样的定义。我将把所有的JSP文件放在WEB-INF
目录下的一个jsp
目录中。这可以确保只有控制器可以访问这些视图——直接在浏览器中输入URL来访问这些页面是不行的。这个策略不一定在所有的应用服务器中都可以行得通,如果你使用的应用服务器恰好不行的话,只要把jsp目录往上移一级。你可以使用springapp/war/jsp
作为目录来替代以后所有的例子代码中的“springapp/war/WEB-INF/jsp
”。
springapp/war/WEB-INF/jsp/include.jsp |
|
现在我们可以更改index.jsp
来使用,由于我们使用了JSTL,我们可以使用<c:redirect>
标签来转向到我们的控制器。
springapp/war/index.jsp |
|
第14步 – 改进视图和控制器
现在我要把hello.jsp
视图移入WEB-INF/jsp
目录。Index.jsp
里面添加的包含文件include.jsp
同样也添加到了hello.jsp
中。我也使用JSTL<c:out>
标签来输出从传给视图的模型里获取的当前的日期和时间。
springapp/war/WEB-INF/jsp/hello.jsp |
|
对于SpringappController.java
,我们还要做一些更改。由于我们把文件移动到了一个新的位置,所以需要把视图变成WEB-INF/jsp/hello.jsp
。同时添加一个包含当前时间和日期的字符串作为模型。
springapp/src/SpringappController.java |
/** Logger for this class and subclasses */ String now = (new java.util.Date()).toString(); logger.info("returning hello view with " + now); return new ModelAndView("WEB-INF/jsp/hello.jsp", "now", now); |
在我们构建并部署了新的代码之后,现在我们准备尝试它了。我们在浏览器中输入http://localhost:8080/springapp,它首先会调用index.jsp
,然后它又会重定向到hello.htm
,这个URL又会调用控制器并把时间和日期发送给视图。
第15步 – 解耦视图和控制器
现在控制器是指明了视图的完整路径,这在控制器和视图之间产生了一个多余的依赖关系。理想上来说,我们要使用一个逻辑名称来映射到视图,这可以让我们无需更改控制器就可以切换视图。你可以在一个属性文件中设置这个映射,如果你喜欢使用ResourceBundleViewResolver
和SimpleUrlHandlerMapping
类的话。如果你的映射需求确实很简单,那么在InternalResourceViewResolver
上加上前缀和后缀会很方便。后一种方法就是我现在要实现的。我修改了springapp-servlet.xml
并包含了viewResolver
条目。我选择使用JstlView
,它可以让我们使用JSTL,可以结合消息资源绑定,同时他还可以支持国际化。
springapp/war/WEB-INF/springapp-servlet.xml |
<!-- - Application context definition for "springapp" DispatcherServlet. --> <bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver"> <property name="viewClass"> <value>org.springframework.web.servlet.view.JstlView</value> </property> <property name="prefix"><value>/WEB-INF/jsp/</value></property> <property name="suffix"><value>.jsp</value></property> </bean> |
所以现在我可以从控制器的视图名称中删除前缀和后缀了。
springapp/src/SpringappController.java |
return new ModelAndView("hello", "now", now); |
编译并部署,应用程序应该仍然可以正常运行。
第16步 – 添加一些业务逻辑的类
目前位置我们的应用还不是很有用。我想添加一些业务逻辑,一个Product
类和一个管理所有产品的类。我把管理类命名为ProductManager
。为了能分离依赖Web的逻辑和业务逻辑,我将在Java源代码重创建两个单独的包——web和bus。如果这个应用程序是为一个真实的公司开发的,我可能会把包命名成像com.mycompany.web
和com.mycompany.bus
之类的名字,不过这只是一个演示而已我就让包的名称简短一些。Product
类是实现为一个JavaBean——它有一个默认的构造器(如果我们没有指明任何构造器,会自动给出),两个实例变量description
和price
的获取器(getter)和设制器(setter)。我还把它设为Serializable
,这对我们的应用不是必需的,不过以后我们很可能要把这个类在不同的应用层中传递的时候,那时就可以直接使用了。
springapp/src/bus/Product.java |
|
ProductManager
中有一个Product
的列表List,同样的,这个类也是实现为一个JavaBean。
springapp/src/bus/ProductManager.java |
|
下面,我修改了SpringappController
来存放一个指向ProductManager
类的引用。正如你所见,它现在在一个单独的web的包中——记得把代码放到这个新位置中。我还要添加让控制器将产品信息传送到视图的代码。getModelAndView
现在返回一个Map
,同时包含了时间日期和产品管理的引用。
springapp/src/web/SpringappController.java |
import java.util.Map; import java.util.HashMap; private ProductManager prodMan; Map myModel = new HashMap(); myModel.put("now", now); myModel.put("products", getProductManager().getProducts()); return new ModelAndView("hello", "model", myModel); public void setProductManager(ProductManager pm) { prodMan = pm; } public ProductManager getProductManager() { return prodMan; } |
第 17 步 – 修改视图用于现实业务数据并且添加消息绑定的支持
我使用了JSTL<c:forEach>
标签来添加了一个现实产品信息的部分。我还用JSTL<fmt:message>
标记替换了标题和欢迎文本,这样可以从给定的“message”源中读取文本并显示——在后面的步骤中我会显示这个方法。
springapp/war/WEB-INF/jsp/hello.jsp |
<h1><fmt:message key="heading"/></h1>
<h3>Products</h3> <c:forEach items="${model.products}" var="prod"> <c:out value="${prod.description}"/> <i>___FCKpd___525lt;c:out value="${prod.price}"/></i><br><br> </c:forEach> |
第18步 – 添加一些测试数据来自动组装一些业务对象
我不会添加任何用于从数据库中载入业务对象的代码。然和,我们可以使用Spring的bean和应用程序上下文的支持来牵线到实例的引用。我只要简单地把握需要的数据作为bean之间的偶合条目写入springapp-servlet.xml
。我还要添加messageSource
条目来引入消息资源绑定(“messages.properties
”),在下一步我将创建它。
springapp/war/WEB-INF/springapp-servlet.xml |
<!-- - Application context definition for "springapp" DispatcherServlet. --> <property name="productManager"> <ref bean="prodMan"/> </property> </bean> <bean id="prodMan" class="bus.ProductManager"> <property name="products"> <list> <ref bean="product1"/> <ref bean="product2"/> <ref bean="product3"/> </list> </property> </bean> <bean id="product1" class="bus.Product"> <property name="description"><value>Lamp</value></property> <property name="price"><value>5.75</value></property> </bean> <bean id="product2" class="bus.Product"> <property name="description"><value>Table</value></property> <property name="price"><value>75.25</value></property> </bean> <bean id="product3" class="bus.Product"> <property name="description"><value>Chair</value></property> <property name="price"><value>22.79</value></property> </bean> <bean id="messageSource" class="org.springframework.context.support.ResourceBundleMessageSource"> <property name="basename"><value>messages</value></property> </bean> |
第19步 – 添加消息绑定以及给build.xml添加“clean”目标
我在war/WEB-INF/classes
目录中创建了一个“messages.properties
”文件。这个属性绑定文件目前有3个条目可以匹配在<fmt:message>
标记中指定的键。
springapp/war/WEB-INF/classes/messages.properties |
|
由于我们移动了一些源代码,所以给构建脚本中添加一个“clean
”和一个“undeploy
”目标。我把以下内容添加到build.xml文件。
<target name="clean" description="Clean output directories"> <delete> <fileset dir="${build.dir}"> <include name="**/*.class"/> </fileset> </delete> </target> <target name="undeploy" description="Un-Deploy application"> <delete> <fileset dir="${deploy.path}/${name}"> <include name="**/*.*"/> </fileset> </delete> </target> |
现在停止Tomcat服务器,运行clean
、undeploy
和deploy
目标。这应该会删除所有的旧文件,重新构建应用并部署它:
第3部分 -为应用程序添加单元测试和表单
第20步 – 为SpringappController
添加单元测试
在我们创建单元测试之前,我们要先准备Ant并让我们的构建脚本可以处理单元测试。Ant有一个内置的JUnit目标,但是我们需要把junit.jar
放入Ant的lib目录中。我使用了Spring分发包中自带的spring-framework-1.2/lib/junit/junit.jar
。只要把它复制到你的Ant安装目录的lib目录下即可。我还将以下目标添加到我们构建脚本中:
<target name="junit" depends="build" description="Run JUnit Tests"> <junit printsummary="on" fork="false" haltonfailure="false" failureproperty="tests.failed" showoutput="true"> <classpath refid="master-classpath"/> <formatter type="brief" usefile="false"/> <batchtest> <fileset dir="${build.dir}"> <include name="**/Test*.*"/> </fileset> </batchtest> </junit> <fail if="tests.failed"> tests.failed=${tests.failed} *********************************************************** *********************************************************** **** One or more tests failed! Check the output ... **** *********************************************************** *********************************************************** </fail> </target> |
现在我在src
目录中添加了一个新的子目录叫做tests
。相信大家也都猜到了,这个目录将包含所有的单元测试。
这些工作结束之后,我们准备开始写我们的第一个单元测试。SpringappController
要依赖于HttpServletRequest
和HttpServletResponse
以及我们的应用程序上下文。由于控制器并没有使用请求和响应,我们直接传送null
。如果不是这样,我们要使用EasyMock创建一些模仿对象mock object,这样就可以在测试用使用了。使用某个类,可以在Web Server环境之外载入应用程序上下文。有好几个类可以使用,针对当前的任务我们将使用FileSystemXmlApplicationContext
。
springapp/src/tests/TestSpringappController.java |
|
唯一的测试就是调用handleRequest
,我们检测从模型中返回的产品。在setUp
方法中,我们载入应用程序上下文,之前我已经复制到了tests
中的WEB-INF
目录中。我创建了一个副本这样这个文件可以在测试中以“messageSource
”所需的bean的最小集来运行。这样,复制springapp/war/WEB-INF/springapp-servlet.xml
到springapp/src/tests/WEB-INF
目录中。你可以删除“messageSource
”、“urlMapping
”和“viewResolver
”bean条目,因为这个测试不需要他们。
springapp/src/tests/WEB-INF/springapp-servlet.xml |
<!-- - Application context definition for "springapp" DispatcherServlet. --> |
当你运行这个测试的时候,你应该看到载入应用程序上下文时有很多日志信息。
第21步 – 为ProductManager添加单元测试和新的功能
接下来我为ProductManager
添加一个测试案例,同时我打算给ProductManager
添加一个用于增加价格的新方法,并添加一个测试。
springapp/src/tests/TestProductManager .java |
|
对于这个测试,没有必要创建一个应用程序上下文。我只在setUp
方法中建立了产品信息并且把他们添加到了产品管理对象中。我还给getProducts
和increasePrice
添加了测试。increasePrice
方法根据传给它的百分比对价格进行增加。我修改了ProductManager
类来实现这个新方法。
springapp/src/bus/ProductManager.java |
import java.util.ListIterator; public void increasePrice(int pct) { ListIterator li = products.listIterator(); while (li.hasNext()) { Product p = (Product) li.next(); double newPrice = p.getPrice().doubleValue() * (100 + pct)/100; p.setPrice(new Double(newPrice)); } } |
下面我构建并运行这些测试。正如你所见,这些测试就像一般的测试一样——业务类不依赖于任何servlet类,所以这些类测试起来很方便。
第22步 – 添加一个表单
为了在Web应用中提供了一个接口,我添加了一个可以让用户输入百分比值的表单。这个表单使用了一个叫做“spring”的标签库,它是由Spring Framework所提供的。我们要从Spring的分发包中把spring-framework-1.2/dist/spring.tld
复制到springapp/war/WEB-INF
目录中。现在我们还要给web.xml
添加一个<taglib>
条目。
springapp/war/WEB-INF/web.xml |
<taglib> <taglib-uri>/spring</taglib-uri> <taglib-location>/WEB-INF/spring.tld</taglib-location> </taglib> |
我们还需要在jsp文件的page
指令中申明这个taglib。我们用普通的方法通过<form>
标签声明一个表单,以及一个<input>
文本域和一个提交按钮。
springapp/war/WEB-INF/jsp/priceincrease.jsp |
|
<spring:bind>
标记是用于将一个<input>
表单元素绑定到一个命令对象PriceIncrease.java
上的。这个命令对象以后会被传送给效验器,同时如果它通过了检验,它会被继续传送给控制器。${status.errorMessage}
和${status.value}
是由框架声明的特殊变量,可以用来显示错误信息和当前域的值。
springapp/src/bus/PriceIncrease.java |
|
这是一个十分简单的JavaBean类,同时这里有一个属性以及他的获取器和设置器。在用户按下了提交按钮之后,Validator
类将获取控制。在表单中输入的值会被框架设置在命令对象上。然后会调用方法validate
,并传入命令对象和一个用来存放错误信息的对象。
springapp/src/bus/PriceIncreaseValidator.java |
|
现在我们要在springapp-servlet.xml
文件中添加一条内容来定义新的表单和控制器。我们定义命令对象和效验器的属性。我们还要指明两个视图,一个用来显示表单,另一个将是在成功的表单处理之后我们将看到的。后一个也叫做成功视图,可以是两种类型之一:它可以是一个普通的视图引用直接引导到我们某个JSP页面。但这种方法的一个缺点是,如果用户刷新页面,那么表单的数据就会被重新提交,然后你可能最后就做了两次priceIncreace
。另一种方法是使用一个重定向,它将给用户浏览器返回一个应答并且指示浏览器重定向到一个新的URL。我们这里使用的这个URL不可以是我们的JSP页面之一,因为他们对于直接访问是不可见的。必须一个从外部可以获取的URL。所以我选择了“hello.htm
”来作为我的重定向URL。这个URL影射到“hello.jsp
”页面,这个应该运行得很令人满意。
springapp/war/WEB-INF/springapp-servlet.xml |
<!-- Controller for the initial "Hello" page --> <!-- Validator and Form Controller for the "Price Increase" page --> <bean id="priceIncreaseValidator" class="bus.PriceIncreaseValidator"/> <bean id="priceIncreaseForm" class="web.PriceIncreaseFormController"> <property name="sessionForm"><value>true</value></property> <property name="commandName"><value>priceIncrease</value></property> <property name="commandClass"><value>bus.PriceIncrease</value></property> <property name="validator"><ref bean="priceIncreaseValidator"/></property> <property name="formView"><value>priceincrease</value></property> <property name="successView"><value>hello.htm</value></property> <property name="productManager"> <ref bean="prodMan"/> </property> </bean> <prop key="/priceincrease.htm">priceIncreaseForm</prop> |
下面,让我们看一下这个表单的控制器。onSubmit
方法获取了控制并且在它调用ProductManager
对象的increasePrice
方法之前进行了一些日志记录。然后它使用successView
的url创建了RedirectView
的一个新的实例,并传递这个实例给ModelAndView
,最后返回这个ModelAndView
的实例。
springapp/src/web/PriceIncreaseFormController.java |
|
我们还要在message.properties
资源文件里面添加一些消息。
springapp/war/WEB-INF/classes/messages.properties |
priceincrease.heading=Price Increase :: SpringApp error.not-specified=Percentage not specified!!! error.too-low=You have to specify a percentage higher than {0}! error.too-high=Don't be greedy - you can't raise prices by more than {0}%! required=Entry required. typeMismatch=Invalid data. typeMismatch.percentage=That is not a number!!! |
最后,我们要从hello.jsp
中提供一个指向priceincrease
页面的链接。
springapp/war/WEB-INF/jsp/hello.jsp |
<br> <a href="<c:url value="priceincrease.htm"/>">Increase Prices</a> <br> |
编译并部署,在重新载入应用之后,我们就可以再测试它了。下面是表单出错时所显示的样子:
第4部分 - 实现数据库持久
在第一部分(第1 – 12步)中,我们配置了开发环境并建立了一个基本的应用程序,并以此开始。第二部分(第13 – 19步)在某些方面改进了应用程序。第三部分(第20 – 22步)为应用程序添加了一些单元测试并且我们还添加一个表单用来进行价格增加。在第四部分中,我们要处理数据库持久的问题了。我们在前几部分中看到了我们如何使用在配置文件中bean定义来载入一些业务对象。很显然在实际生活中是这个实行不同的——一旦我们重启了服务器,我们就又回到了原来的价格。我们需要添加可以实际在数据中持久这些更改的代码。
第23步 – 添加Ant任务来创建和载入测试数据
在我们开始开发持久部分的代码之前,我们应该先创建我们开发和测试所需的数据库表。我们当然还需要一个数据库。我打算使用HSQL,这是一个很优秀的用Java写的开源数据库。这个数据库和Spring一起分发的,所以我们只要把jar文件复制到web应用的库目录中就可以了。复制spring-framework-1.2/lib/hsqldb/hsqldb.jar
到springapp/war/WEB-INF/lib/
中。我想让HSQL以独立的模式运行。这样我们就不用担心每次启动一个单独数据库服务器了。用来连接到HSQL的URL可以控制数据库运行的模式。为了能够运行一些针对数据库的Ant任务,我们还要在build.properties
文件中添加一些数据库的属性。
springapp/build.properties |
db.driver=org.hsqldb.jdbcDriver db.url=jdbc:hsqldb:db/test db.user=sa db.pw= |
下面我要为构建脚本添加我需要的目标。有创建和删除表格以及载入和删除数据库目标。Next I add the targets I need to the build script. There are targets to create and delete tables and to load and delete test data.
<target name="createTables"> <echo message="CREATE TABLES USING: ${db.driver} ${db.url}"/> <sql driver="${db.driver}" url="${db.url}" userid="${db.user}" password="${db.pw}" οnerrοr="continue"> <classpath refid="master-classpath"/> CREATE TABLE products ( id INTEGER NOT NULL PRIMARY KEY, description varchar(255), price decimal(15,2) ); CREATE INDEX products_description ON products(description); </sql> </target> <target name="dropTables"> <echo message="DROP TABLES USING: ${db.driver} ${db.url}"/> <sql driver="${db.driver}" url="${db.url}" userid="${db.user}" password="${db.pw}" οnerrοr="continue"> <classpath refid="master-classpath"/> DROP TABLE products; </sql> </target> <target name="loadData"> <echo message="LOAD DATA USING: ${db.driver} ${db.url}"/> <sql driver="${db.driver}" url="${db.url}" userid="${db.user}" password="${db.pw}" οnerrοr="continue"> <classpath refid="master-classpath"/> INSERT INTO products (id, description, price) values(1, 'Lamp', 5.78); INSERT INTO products (id, description, price) values(2, 'Table', 75.29); INSERT INTO products (id, description, price) values(3, 'Chair', 22.81); COMMIT; SHUTDOWN </sql> </target> <target name="printData"> <echo message="PRINT DATA USING: ${db.driver} ${db.url}"/> <sql driver="${db.driver}" url="${db.url}" userid="${db.user}" password="${db.pw}" οnerrοr="continue" print="true"> <classpath refid="master-classpath"/> SELECT * FROM products; </sql> </target> <target name="clearData"> <echo message="CLEAR DATA USING: ${db.driver} ${db.url}"/> <sql driver="${db.driver}" url="${db.url}" userid="${db.user}" password="${db.pw}" οnerrοr="continue"> <classpath refid="master-classpath"/> DELETE FROM products; </sql> </target> |
现在我将执行其中一些任务来建立测试数据库。这会在springapp目录下创建一个db目录。运行“ant createTables loadData pringData
”——我把我的输出列在下面了。
[trisberg@localhost springapp]$ ant createTables loadData printData Buildfile: build.xml createTables: [echo] CREATE TABLES USING: org.hsqldb.jdbcDriver jdbc:hsqldb:db/test [sql] Executing commands [sql] 2 of 2 SQL statements executed successfully loadData: [echo] LOAD DATA USING: org.hsqldb.jdbcDriver jdbc:hsqldb:db/test [sql] Executing commands [sql] 3 of 3 SQL statements executed successfully printData: [echo] PRINT DATA USING: org.hsqldb.jdbcDriver jdbc:hsqldb:db/test [sql] Executing commands [sql] ID,DESCRIPTION,PRICE [sql] 1,Lamp,5.78 [sql] 2,Table,75.29 [sql] 3,Chair,22.81 [sql] 1 of 1 SQL statements executed successfully BUILD SUCCESSFUL Total time: 2 seconds |
第24步 – 为JDBC创建一个数据访问对象(DAO)的实现
我先新建一个“springapp/src/db
”目录来存放我用来进行数据库访问的类。在这个目录中我创建了一个叫做“ProductManagerDao.java
”的接口。这是定义了DAO实现类需要提供的功能的接口——我们可以有多种实现。
springapp/src/db/ProductManagerDao.java |
|
我们按照它建立一个叫做“ProductManagerDaoJdbc.java
”的类,它是一个上面接口的JDBC的实现。Spring提供了一个JDBC抽象框架,我们可以利用它。直接使用JDBC和使用Spring的JDBC框架之间最大的区别是,你不必关心打开和关闭连接或者是任何语句。Spring的框架会帮你进行处理。另一个好处是你不用捕获任何异常,除非你需要。Spring会把所有SQLException
包装在从DataAccessException
中继承的不检测的异常层次中。如果需要,你也可以捕获这个异常,但由于大多数数据库异常是无法恢复的,所以你可能会就让异常传到更高的层次中去。
springapp/src/db/ProductManagerDaoJdbc.java |
|
让我们回顾一下这个类中的两个DAO方法。首先,getProductList()
创建一个获取所有产品信息的查询对象。执行了查询后,结果会作为Products
的一个列表返回。在类的末尾我们可以看到这个查询类的定义。我把它作为一个内部类实现了。这个查询类扩展了MappingSqlQuery
,这是Spring JDBC框架的一个核心类。这个类的用法是你必须在建立类的时候指定一个SQL查询,然后你也要负责实现mapRow
方法来把每一行的数据映射到代表查询中所取得的实体的类中。好了,这就是你必须要提供的东西。剩下的东西就交给框架去管吧。在ProductQuery
类的构造器中,我传入了数据源。这个数据源将通过一个与我们在第二部分中引入业务对象的方法类似的形式给出,所以我们无须担心如何在DAO类中获取一个数据源。在构造器中我同样定义了我们要用来获取产品的SQL查询。它会创建一个新的Product
对象并根据从数据集的当前行获取的数据组装它。你不许要对数据集调用getNext
方法,这些都由框架来处理。这也是控制反转(IoC)方法的另一个例子。
第二个方法increasePrice
要利用一个SqlUpdate
类。同时把数据源和一个带有占位符的SQL更新语句作为参数传给这个类。SQL语句的语法和JDBC中的预处理语句的语法是一样的。事实上,SqlUpdate
在幕后就会创建这个预处理语句。对于SQL语句中的参数,我们要给他们名称并且申明他们的类型这样框架才能在执行预处理语句之前正确设置这些参数。在声明了所有的参数之后,我们按照一个JDO的形式对语句进行“编译”。这会通知我们已经完成参数声明,然后框架会检查并确保我们对SQL语句中的每个占位符都有一个匹配的声明。下面我们声明一个Object
数组用来存放参数值,并把它们传入预处理语句中。这个数组将被传入SqlUpdate
的update
方法中。update
方法则会返回受影响的行数。
我需要把每一个产品的主键的值存储在Product
类中。当我持久化这个对象的更改到数据库的时候,就会用到这个键。为了存放这个键,我在Product.java
中添加了一个叫做“id”的私有字段,并且加入了设置器和获取器。
springapp/src/bus/Product.java |
private int id; public void setId(int i) { id = i; } public int getId() { return id; } |
现在可以测试整个DAO装置了。事实上,我们也许应该首先写这些测试,但是由于这是一个教程风格的文档,所以我想在测试之前先介绍实际的代码会更有意义。我决定使用一个现场的数据库进行测试,所以我要再build.xml
中给junit
任务添加对clearData
和loadData
的依赖。这将确保我们的测试都会有一个一致的起点。
|
下面,我给单元测试集合添加了一个TestProductManagerDaoJdbc.java
。在启动部分我创建了一个用于测试的数据源。
springapp/src/test/TestProductManagerDaoJdbc.java |
|
一旦我们通过了单元测试,我们就可以继续并修改Web应用来使用这些信的数据库持久能力。
第25步 – 修改Web应用来使用数据库持久
如果我们合理地构建了我们的应用程序,我们应该只需要更改业务类就可以立用数据库持久。视图和控制器类不应该被修改,因为他们应该部不知道任何业务类的实现细节。所以让我们把持久添加到ProductManager
类中就可以了。我添加了一个ProductManagerDao
接口的引用以及这个引用的设置器方法。我们实际上使用哪个实现对于ProductManager
类是不相关的,同时我们将通过配置选项对他进行设置。
springapp/src/bus/ProductManager.java |
import db.ProductManagerDao; private ProductManagerDao pmd; /* public void setProducts(List p) { products = p; } */ products = pmd.getProductList(); /* double newPrice = p.getPrice().doubleValue() * (100 + pct)/100; p.setPrice(new Double(newPrice)); */ pmd.increasePrice(p, pct); |
我们不再依赖我们在内存中种产品列表。每当getProducts
被调用的时候,我们都会去查询一下数据库。increasePrice
方法现在代理调用DAO来增加价格,而新的价格会在下一次我们调用getProducts
方法的时候反映出来。
下面我们要为Web应用修改配置文件——springapp-servlet.xml
。
springapp/war/WEB-INF/springapp-servlet.xml |
<!-- - Application context definition for "springapp" DispatcherServlet. --> <!-- Controller for the initial "Hello" page --> <bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource"> <property name="driverClassName"><value>org.hsqldb.jdbcDriver</value></property> <property name="url"> <value>jdbc:hsqldb:/Users/trisberg/projects/springapp/db/test</value> </property> <property name="username"><value>sa</value></property> <property name="password"><value></value></property> </bean> <bean id="prodManDao" class="db.ProductManagerDaoJdbc"> <property name="dataSource"> <ref bean="dataSource"/> </property> </bean> <property name="productManagerDao"> <ref bean="prodManDao"/> </property> <!-- <property name="products"> <list> <ref bean="product1"/> <ref bean="product2"/> <ref bean="product3"/> </list> </property> --> <!-- <bean id="product1" class="bus.Product"> <property name="description"><value>Lamp</value></property> <property name="price"><value>5.75</value></property> </bean> <bean id="product2" class="bus.Product"> <property name="description"><value>Table</value></property> <property name="price"><value>75.25</value></property> </bean> <bean id="product3" class="bus.Product"> <property name="description"><value>Chair</value></property> <property name="price"><value>22.79</value></property> </bean> --> |
我删除了原来传给ProductManager
的产品的集合。我把它们替换成了一个DataSource
和一个ProductManagerDaoJdbc
实现。指定给datasource
的URL包含了数据库位置的完整路径(/Users/trisberg/projects/springapp/db/test
)。当然你要把它调整为符合你情况的设置。
现在我们可以构建并部署修改过的应用了,运行“ant undeploy deploy
”来清除所有的旧类并把它们替换成新的。然后启动Tomcat并载入应用。你可以看到的区别是小数被限制为2位,这是因为这个列是这样在数据库中被声明的。同时,你应该看到了价格的增加都会保持有效即时在你的应用程序周期结束之后。
第26步 – 修复损坏的测试
我们完全更改了ProductManager
的实现——我们把所有功能推倒ProductManagerDao
实现中,这样原来的测试都失败了。要修复这个问题,我将创建一个ProductManagerDao
的模仿实现。这个实现将基本模拟原来我们在ProductManager
中的功能。
springapp/src/tests/MockProductManagerDaoImpl.java |
|
现在我们要配置“TestSpringappController
”和“TestProductManager
”测试来使用这个模仿实现。对于“TestSpringappController
”我将修改我复制到tests/WEB-INF
目录下的“springapp-servlet.xml
”文件(我知道对这个文件作一个副本是个很好的主意)。主意不要修改war/WEB-INF
中的那个文件——我们需要它保持原样这样我们可以在Tomcat中运行应用程序。我们把产品列表从ProductManager
移到ProductManagerDao
并且给ProductManager
一个指向这个DAO的引用。
springapp/src/tests/WEB-INF/springapp-servlet.xml |
<!-- - Application context definition for "springapp" DispatcherServlet. --> <bean id="prodManDao" class="tests.MockProductManagerDaoImpl"> <property name="products"> <list> <ref bean="product1"/> <ref bean="product2"/> <ref bean="product3"/> </list> </property> </bean> <property name="productManagerDao"> <ref bean="prodManDao"/> </property> <!-- <property name="products"> <list> <ref bean="product1"/> <ref bean="product2"/> <ref bean="product3"/> </list> </property> --> |
对于TestProductManager
测试案例我们将对setUp
方法做一个类似的修改。
springapp/src/tests/TestProductManager .java |
import db.ProductManagerDao; /* pm.setProducts(al); */ MockProductManagerDaoImpl pmdao = new MockProductManagerDaoImpl(); pmdao.setProducts(al); pm.setProductManagerDao(pmdao); pm.getProducts(); |