神马文学网Spring MVC step-by-step
来源：百度文库 编辑：神马文学网 时间：2024/04/24 22:13:11
一步一步开发Spring Framework MVC应用程序作者：Thomas Risberg2003年7月（2005年4月修订）翻译 Shining Ray @ Nirvana Studio这是一个关于如何使用Spring Framework从无到有开发一个Web应用的逐步的指南。本文分成几个部分。你可以按顺序阅读或者根据你对他们的熟悉程度，跳过某些章节。
目录第1部分 - 设置基本应用程序和环境第1步 - 开发目录第2步 – INDEX.JSP第3步 – 将应用程序部署到TOMCAT第4步 – 测试应用第5步 – 下载SPRING分发包第6步 – 修改WEB-INF目录中的WEB.XML第7步 - 把JAR文件复制到WEB-INF/LIB第8步 - 创建你的控制器第9步 - 构建应用程序第10步 – 复制并修改LOG4J.PROPERTIES第11步 – 部署应用程序第12步 - 创建一个视图总结第2部分 - 开发和配置应用程序第13步 – 改进INDEX.JSP第14步 – 改进视图和控制器第15步 – 解耦视图和控制器第16步 – 添加一些业务逻辑的类第 17 步 – 修改视图用于现实业务数据并且添加消息绑定的支持第18步 – 添加一些测试数据来自动组装一些业务对象第19步 – 添加消息绑定以及给BUILD.XML添加“CLEAN”目标第3部分 - 为应用程序添加单元测试和表单第20步 – 为SPRINGAPPCONTROLLER添加单元测试第21步 – 为PRODUCTMANAGER添加单元测试和新的功能第22步 – 添加一个表单第4部分 - 实现数据库持久第23步 – 添加ANT任务来创建和载入测试数据第24步 – 为JDBC创建一个数据访问对象（DAO）的实现第25步 – 修改WEB应用来使用数据库持久第26步 – 修复损坏的测试 第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
Example - Spring Application
This is my test.
只是为了Web应用的完整性，我在war目录中的WEB-INF目录中创建了一个web.xml。springapp/war/WEB-INF/web.xml第5步 – 下载Spring分发包 如果你还没有下载Spring Framework的发布文件，那现在就行动吧。我目前使用的是“spring-framework-1.2-with-dependencies.zip”，可以从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
public class SpringappController implements Controller { public ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { return new ModelAndView(""); }}这是非常基本的控制器。我们稍后会对他进行扩充，同时过会儿我们还要扩展一些已经提供的抽象的基本实现。这个控制器处理请求并返回一个ModelAndView。不过我们还没有定义任何视图，所以现在没什么可做的了。第9步 – 构建应用程序运行build.xml中的“build”任务。基本上代码应该顺利通过编译。[trisberg@localhost springapp]$ ant buildBuildfile: build.xmlbuild: [javac] Compiling 1 source file to /Users/trisberg/projects/springapp/war/WEB-INF/classesBUILD SUCCESSFULTotal 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 $JBOSS_HOME/server/default/deploy/log4j.xml!# For all other servers: Comment out the Log4J listener in web.xml to activate Log4J.log4j.rootLogger=INFO, stdout, logfilelog4j.appender.stdout=org.apache.log4j.ConsoleAppenderlog4j.appender.stdout.layout=org.apache.log4j.PatternLayoutlog4j.appender.stdout.layout.ConversionPattern=%d %p [%c] - <%m>%nlog4j.appender.logfile=org.apache.log4j.RollingFileAppenderlog4j.appender.logfile.File=/Users/trisberg/jakarta-tomcat-5.0.28/logs/springapp.loglog4j.appender.logfile.MaxFileSize=512KB# Keep three backup files.log4j.appender.logfile.MaxBackupIndex=3# Pattern to output: date priority [category] - messagelog4j.appender.logfile.layout=org.apache.log4j.PatternLayoutlog4j.appender.logfile.layout.ConversionPattern=%d %p [%c] - %m%n第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 started2005-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 hierarchy2005-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 available2005-04-24 14:58:18,524 INFO [org.springframework.core.CollectionFactory] - Commons Collections 3.x available2005-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 ResourceBundleThemeSource2005-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 provided2005-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 default2005-04-24 14:58:18,700 INFO [org.springframework.web.servlet.DispatcherServlet] - No ViewResolvers found in servlet 'springapp': using default2005-04-24 14:58:18,700 INFO [org.springframework.web.servlet.DispatcherServlet] - FrameworkServlet 'springapp': initialization completed in 439 ms2005-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
Hello - Spring Application
Greetings.
里面没什么奇特的东西，只是为了现在试一下。下面我们要修改SpringappController来引导到这个视图。springapp/src/SpringappController.javaimport org.springframework.web.servlet.mvc.Controller;import org.springframework.web.servlet.ModelAndView;import javax.servlet.ServletException;import javax.servlet.http.HttpServletRequest;import javax.servlet.http.HttpServletResponse;import java.io.IOException;import org.apache.commons.logging.Log;import org.apache.commons.logging.LogFactory; public class SpringappController implements Controller { /** Logger for this class and subclasses */ protected final Log logger = LogFactory.getLog(getClass()); public ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { logger.info("SpringappController - returning hello view"); return new ModelAndView("hello.jsp"); }}当我在修改这个类的同时，我还添加了一个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 ms2005-04-24 15:01:56,217 INFO [org.springframework.web.servlet.DispatcherServlet] - Servlet 'springapp' configured successfully2005-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.xml3. 一个控制器 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<%@ page session="false"%> <%@ taglib prefix="c" uri="http://java.sun.com/jstl/core" %><%@ taglib prefix="fmt" uri="http://java.sun.com/jstl/fmt" %>现在我们可以更改index.jsp来使用，由于我们使用了JSTL，我们可以使用
Hello - Spring Application
Greetings, it is now
第15步 – 解耦视图和控制器 现在控制器是指明了视图的完整路径，这在控制器和视图之间产生了一个多余的依赖关系。理想上来说，我们要使用一个逻辑名称来映射到视图，这可以让我们无需更改控制器就可以切换视图。你可以在一个属性文件中设置这个映射，如果你喜欢使用ResourceBundleViewResolver和SimpleUrlHandlerMapping类的话。如果你的映射需求确实很简单，那么在InternalResourceViewResolver上加上前缀和后缀会很方便。后一种方法就是我现在要实现的。我修改了springapp-servlet.xml并包含了viewResolver条目。我选择使用JstlView，它可以让我们使用JSTL，可以结合消息资源绑定，同时他还可以支持国际化。springapp/war/WEB-INF/springapp-servlet.xml
public class SpringappController implements Controller { /** Logger for this class and subclasses */ protected final Log logger = LogFactory.getLog(getClass()); public ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { String now = (new java.util.Date()).toString(); logger.info("returning hello view with " + now); 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.javapackage bus; import java.io.Serializable; public class Product implements Serializable { private String description; private Double price; public void setDescription(String s) { description = s; } public String getDescription() { return description; } public void setPrice(Double d) { price = d; } public Double getPrice() { return price; }}ProductManager中有一个Product的列表List，同样的，这个类也是实现为一个JavaBean。springapp/src/bus/ProductManager.javapackage bus; import java.io.Serializable;import java.util.List; public class ProductManager implements Serializable { private List products; public void setProducts(List p) { products = p; } public List getProducts() { return products; }}下面，我修改了SpringappController来存放一个指向ProductManager类的引用。正如你所见，它现在在一个单独的web的包中——记得把代码放到这个新位置中。我还要添加让控制器将产品信息传送到视图的代码。getModelAndView现在返回一个Map，同时包含了时间日期和产品管理的引用。springapp/src/web/SpringappController.javapackage web; import org.springframework.web.servlet.mvc.Controller;import org.springframework.web.servlet.ModelAndView; import javax.servlet.ServletException;import javax.servlet.http.HttpServletRequest;import javax.servlet.http.HttpServletResponse; import java.io.IOException; import java.util.Map;import java.util.HashMap; import org.apache.commons.logging.Log;import org.apache.commons.logging.LogFactory; import bus.Product;import bus.ProductManager; public class SpringappController implements Controller { /** Logger for this class and subclasses */ protected final Log logger = LogFactory.getLog(getClass()); private ProductManager prodMan; public ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { String now = (new java.util.Date()).toString(); logger.info("returning hello view with " + now); 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
Products
第3部分 -为应用程序添加单元测试和表单第20步 – 为SpringappController添加单元测试 在我们创建单元测试之前，我们要先准备Ant并让我们的构建脚本可以处理单元测试。Ant有一个内置的JUnit目标，但是我们需要把junit.jar放入Ant的lib目录中。我使用了Spring分发包中自带的spring-framework-1.2/lib/junit/junit.jar。只要把它复制到你的Ant安装目录的lib目录下即可。我还将以下目标添加到我们构建脚本中：
public class ProductManager implements Serializable { private List products; public void setProducts(List p) { products = p; } public List getProducts() { return products; } 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添加一个