Spring MVC入门
时间:2010-07-19 来源:ryxxlong
在Web MVC架构中,用户并不直接连接至所需的资源,而必须先连接至前端控制器(Front controller),由前端控制器判断用户的请求要分派(Dispatch)给哪一个控制对象(Controller)来处理请求,借此在到控制用户请求资源的目的.在Spring的Web MVC框架中,担任前端控制器角色的是org.springframework.web.servlet.DispatcherServlet,DispatcherServlet负责将客户的请求分配给控制对象.Spring Web MVC请求处理流程如下图所示:
DispatcherServlet实际上是一个Servlet (它继承了HttpServlet)。与其它Servlet一样, DispatcherServlet定义在web应用的web.xml文件中。 DispatcherServlet处理的请求必须在同一个web.xml文件里使用url-mapping定义映射。 下面的例子演示了如何配置DispatcherServlet。 在下面的例子中,基于 Spring 的 Web 应用程序接收到 http://localhost:8080/hello.do(事实上请求路径是 /hello.do) 的请求后, Spring 将这个请求交给一个名为 helloController 的程序进行处理, helloController 再调用 一个名为 hello.jsp 的 jsp 文件生成 HTML 代码发给用户的浏览器显示. 上面的名称(/hello.do, helloController, hello.jsp) 都是变量, 你可以更改.在 Spring MVC 中, jsp 文件中尽量不要有 Java 代码. jsp 文件只作为渲染(或称为视图 View)模板使用.
好了, 我们开始吧.
第一步:使用Spring Web MVC的第一步,就是在将你下载解压的spring目录下的dist\modules文件夹下的spring-webmvc.jar导入到你的项目lib中,由于我的这个测试项目使用了CharacterEncodingFilter,所以我也得将Spring-web.jar导入到我的项目中.导入后在你的 web项目中的web.xml中定义DispatcherServlet,如下所示:
<?xml version="1.0" encoding="UTF-8"?> <web-app version="2.4" xmlns="http://java.sun.com/xml/ns/j2ee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"> <!-- <listener> <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class> </listener> <context-param> <param-name>contextConfigLocation</param-name> <param-value> /WEB-INF/database.xml, /WEB-INF/applicationContext.xml </param-value> </context-param> --> <filter> <filter-name>encodingFilter</filter-name> <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class> <init-param> <param-name>encoding</param-name> <param-value>UTF-8</param-value> </init-param> </filter> <filter-mapping> <filter-name>encodingFilter</filter-name> <url-pattern>*.do</url-pattern> </filter-mapping> <servlet> <servlet-name>dispatcherServlet</servlet-name> <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> <init-param> <param-name>contextConfigLocation</param-name> <param-value>/WEB-INF/mvc-config.xml</param-value> </init-param> <load-on-startup>1</load-on-startup> </servlet> <servlet-mapping> <servlet-name>dispatcherServlet</servlet-name> <url-pattern>*.do</url-pattern> </servlet-mapping> <welcome-file-list> <welcome-file>index.jsp</welcome-file> <welcome-file>index.html</welcome-file> </welcome-file-list> </web-app>
它配置了以下功能:
1.分解配置文件. context-param 标签指明我们的配置文件还有 /WEB-INF/database.xml 和 /WEB-INF/applicationContext.xml. ContextLoaderListener(listener 标签) 由此得知配置文件是哪些, 它会将它们载入. (在学习Spring MVC这个测试例子时,为了简单你可以省去这一配置项)
2.配置 CharacterEncodingFilter (filter 标签), 否则你会发现中文乱码. 因为我的 jsp 和 html 文件都是 UTF-8 编码的, 所以我在 param-value 标签中设置了 UTF-8.
3.配置 DispatcherServlet (servlet 标签), 它是一个 Java Servlet 程序. 我们将它命名为dispatcherServlet. 然后我们再配置 Servlet 映射(servlet-mapping 标签), 也就是你希望哪些请求被DispatcherServlet处理. 这里, 我们设置后缀名为 do(*.do) 的所有URL请求都被名为dispatcherServlet的 DispatcherServlet的程序处理. 选择 .do 只是一个习惯,但是你不要选择 .html! 虽然《Spring in Action》选择了 .html, 但是那是一种非常糟糕的作法, 特别是你整合 Apache 和 Tomcat 的时候. "contextConfigLocation"初始化参数用来设置Bean(MVC相关的,像View解析器,Controller等等)定义文件的位置与名称,如果不设置"contextConfigLocation"初始参数,则DispathcherServlet默认会使用Servlet的名称为前置,读取"Servlet名称-servlet.xml"作为其Bean定义文件,像上面的配置文件中所示,如果没有"contextConfigLocation"初始参数,则会去读取dispatcher-servlet.xml;但在上面的设置中它真正会去读取mvc-config.xm中的定义.你也可以在init-param中定义多个Bean定义文件的来源,你可以如下配置:
<init-param> <param-name>contextConfigLocation</param-name> <param-value>/WEB-INF/mvc-config.xml,/WEB-INF/other-services.xml</param-value> </init-param>
DispatcherServlet负责分配请求至控制对象(Controller),在Spring Web MVC框架中,控制对象要实现org.springframework.web.servlet.mvc.Controller接口,此接口定义如下:
package org.springframework.web.servlet.mvc; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import org.springframework.web.servlet.ModelAndView; public abstract interface Controller { public abstract ModelAndView handleRequest(HttpServletRequest paramHttpServletRequest, HttpServletResponse paramHttpServletResponse) throws Exception; }
当Controller收到DispatcherServlet分配对象请求时,会执行handleRequest()方法来处理请求,处理完毕后回传一个org.springframework.web.servlet.ModelAndView的实例,ModelAndView包括了要呈现在View层(例如JSP网页)的Model数据,以及其他View层的相关消息.
第二步:创建HelloController类,如下所示:
public class HelloController implements Controller { // private HelloManager helloManager; // // public void setHelloManager(HelloManager helloManager) { // this.helloManager = helloManager; // } public ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) throws Exception { // TODO Auto-generated method stub request.setAttribute("hello_1", "你好啊, Spring!"); request.setAttribute("hello_2", "Hello World!"); return new ModelAndView("hello"); } }
return new ModelAndView("hello"); 告诉 InternalResourceViewResolver jsp 模板的名字叫作 hello. request.setAttribute() 设置的对象我们可以在 jsp 文件中使用.
第三步:由于在"contextConfigLocation"初始参数中我们指定了mvc-config.xml文件,所以我们在 WEB-INF 目录下建立一个名为 mvc-config.xml的文件,将controller要此文件中注册,如下所示:
<?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd"> <bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver"> <property name="prefix" value="/WEB-INF/jsp/" /> <property name="suffix" value=".jsp" /> </bean> <bean id="simpleUrlHandlerMapping" class="org.springframework.web.servlet.handler.SimpleUrlHandlerMapping"> <property name="mappings"> <props> <prop key="/hello.do">helloController</prop> </props> </property> </bean> <bean id="helloController" class="com.reiyen.web.HelloController"> <!-- <property name="helloManager" ref="helloManager" /> --> </bean> </beans>
它配置了以下功能:
1.配置 InternalResourceViewResolver, 它是 jsp 渲染模板的处理器. 如果你告诉 InternalResourceViewResolver 处理一个名为 hello 的模板时, 它会渲染 /WEB-INF/jsp/hello.jsp 文件. 把 jsp 文件放到 /WEB-INF/jsp/ 目录下是被鼓励的, 这样可以防止用户不经过 Controller 直接访问 jsp 文件从而出错(有些顽皮的人很喜欢这样做).
2.配置 SimpleUrlHandlerMapping, 在上面的配置文件中, /hello.do 的请求将被 helloController 处理. "/hello.do"和"helloController" 是变量, 你可以更改. 但是你注意到了吗, hello.do 以 .do 作为后缀名. 如果这里(本文的条件下)你不使用.do 作为后缀名, 就没有程序来处理这个请求了. 因为 DispatcherServlet 将收到的请求转交给 3.SimpleUrlHandlerMapping, DispatcherServlet 收不到的请求, SimpleUrlHandlerMapping 当然也收不到了. 你可以在 props 标签内配置多个 prop 标签.
上面, 我们在 web.xml 文件中告诉 ContextLoaderListener, 我们还有另外两个配置文件 /WEB-INF/database.xml 和 /WEB-INF/applicationContext.xml.这些文件不再一一列举.
第四步:在WEB-INF下,创建一个jsp文件夹,在jsp文件夹下再创建一个hello.jsp文件,如下所示:
<%@ page language="java" import="java.util.*" pageEncoding="utf-8"%> <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> <title>First Spring MVC Page</title> </head> <body> <h2>${hello_1}</h2> <h2>${hello_2}</h2> </body> </html>
第五步:将整个web项目部署在web服务器中,在浏览器中输入 http://localhost:8080/spring/hello.do 就可以访问了.