Spring MVC(model-view-controller)框架圍繞著DispatcherServlet進行設計,DispatcherServlet就是Spring MVC的前端控制器。瀏覽器端用戶的請求就是通過DispatcherServlet進行了分發到達一個合適Controller來生產所需要的業務數據model,model再通過DispatcherServlet進行傳遞,傳遞給view來完成最終的業務呈現。如下圖:
核心步驟:
1、 DispatcherServlet在web.xml中的部署描述,從而攔截請求到Spring Web MVC。
2、 HandlerMapping的配置,從而將請求映射到處理器。
3、 HandlerAdapter的配置,把處理器包裝為適配器,從而支持多種類型的處理器,即適配器設計模式的應用。
4、 ViewResolver的配置,將把邏輯視圖名解析為具體的View。
5、處理器(頁面控制器)的配置,用于對請求進行處理。
XML 例子:
-
web.xml中添加如下配置,實現前端控制器:
<servlet> <servlet-name>chapter2</servlet-name> <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> <load-on-startup>1</load-on-startup> <!-- <init-param> <param-name>contextConfigLocation</param-name> <param-value>classpath:spring-servlet-config.xml</param-value> </init-param> --> </servlet> <servlet-mapping> <servlet-name>chapter2</servlet-name> <url-pattern>/</url-pattern> </servlet-mapping>
load-on-startup:表示啟動容器時初始化該Servlet。
url-pattern:表示哪些請求交給Spring Web MVC處理, “/” 是用來定義默認servlet映射的。也可以如“*.do”表示攔截所有以do為擴展名的請求。
- 在Spring配置文件中配置HandlerMapping、HandlerAdapter
具體配置在WEB-INF/chapter2-servlet.xml文件中(chapter2為web.xml中的servlet-name):
<!-- HandlerMapping -->
<bean class="org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping"/>
<!-- HandlerAdapter -->
<bean class="org.springframework.web.servlet.mvc.SimpleControllerHandlerAdapter"/>
BeanNameUrlHandlerMapping:表示將請求的URL和Bean名字映射,如URL為 “上下文/hello”,則Spring配置文件必須有一個名字為“/hello”的Bean。
SimpleControllerHandlerAdapter:表示所有實現了org.springframework.web.servlet.mvc.Controller接口的Bean可以作為Spring Web MVC中的處理器。
- 配置ViewResolver
具體配置在WEB-INF/ chapter2-servlet.xml文件中(chapter2為web.xml中的servlet-name):
<!-- ViewResolver -->
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<property name="viewClass" value="org.springframework.web.servlet.view.JstlView"/>
<property name="prefix" value="/WEB-INF/jsp/"/>
<property name="suffix" value=".jsp"/>
</bean>
InternalResourceViewResolver:用于支持Servlet、JSP視圖解析。
viewClass:JstlView表示JSP模板頁面需要使用JSTL標簽庫,classpath中必須包含jstl的相關jar包;
prefix和suffix:查找視圖頁面的前綴和后綴(前綴[邏輯視圖名]后綴),比如傳進來的邏輯視圖名為hello,則該該jsp視圖頁面應該存放在“WEB-INF/jsp/hello.jsp”;
-
最后配置文件如下:
<beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context" xmlns:mvc="http://www.springframework.org/schema/mvc" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd "> <!-- HandlerMapping --> <bean class="org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping"/> <!-- HandlerAdapter --> <bean class="org.springframework.web.servlet.mvc.SimpleControllerHandlerAdapter"/> <!-- ViewResolver --> <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"> <property name="viewClass" value="org.springframework.web.servlet.view.JstlView"/> <property name="prefix" value="/WEB-INF/jsp/"/> <property name="suffix" value=".jsp"/> </bean> <!-- 處理器 --> <bean name="/hello" class="cn.javass.chapter2.web.controller.HelloWorldController“> </beans>
-
Controller:
package cn.javass.chapter2.web.controller; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import org.springframework.web.servlet.ModelAndView; import org.springframework.web.servlet.mvc.Controller; public class HelloWorldController implements Controller { @Override public ModelAndView handleRequest(HttpServletRequest req, HttpServletResponse resp) throws Exception { //1、收集參數、驗證參數 //2、綁定參數到命令對象 //3、將命令對象傳入業務對象進行業務處理 //4、選擇下一個頁面 ModelAndView mv = new ModelAndView(); //添加模型數據 可以是任意的POJO對象 mv.addObject("message", "Hello World!"); //設置邏輯視圖名,視圖解析器會根據該名字解析到具體的視圖頁面 mv.setViewName("hello"); return mv; } }
配置文件中的視圖解析器InternalResourceViewResolver會將其解析為WEB-INF/jsp/hello.jsp
-
/WEB-INF/jsp/hello.jsp視圖頁面:
<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%> <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>Hello World</title> </head> <body> ${message} </body> </html>
運行步驟:
1.首先用戶發送請求 http://localhost:9080/springmvc-chapter2/hello ——>web容器,web容器根據“/hello”路徑映射到DispatcherServlet(url-pattern為/)進行處理。
2.DispatcherServlet——>BeanNameUrlHandlerMapping進行請求到處理的映射,BeanNameUrlHandlerMapping將“/hello”路徑直接映射到名字為“/hello”的Bean進行處理,即HelloWorldController,BeanNameUrlHandlerMapping將其包裝為HandlerExecutionChain(只包括HelloWorldController處理器,沒有攔截器)。
3.DispatcherServlet——> SimpleControllerHandlerAdapter,SimpleControllerHandlerAdapter將HandlerExecutionChain中的處理器(HelloWorldController)適配為SimpleControllerHandlerAdapter。
4.SimpleControllerHandlerAdapter——> HelloWorldController處理器功能處理方法的調用,SimpleControllerHandlerAdapter將會調用處理器的handleRequest方法進行功能處理,該處理方法返回一個ModelAndView給DispatcherServlet。
5.hello(ModelAndView的邏輯視圖名)——>InternalResourceViewResolver, InternalResourceViewResolver使用JstlView,具體視圖頁面在/WEB-INF/jsp/hello.jsp。
6.JstlView(/WEB-INF/jsp/hello.jsp)——>渲染,將在處理器傳入的模型數據(message=HelloWorld!)在視圖中展示出來。
7.返回控制權給DispatcherServlet,由DispatcherServlet返回響應給用戶,到此一個流程結束。
與Sprin集成:
配置是Spring集成Web環境的通用配置;一般用于加載除Web層的Bean(如DAO、Service等),以便于與其他任何Web框架集成。
contextConfigLocation:表示用于加載Bean的配置文件;
contextClass:表示用于加載Bean的ApplicationContext實現類,默認WebApplicationContext。
<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>
classpath:applicationContext
</param-value>
</context-param>
<listener>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
ContextLoaderListener初始化的上下文加載的Bean是對于整個應用程序共享的,不管是使用什么表現層技術,一般如DAO層、Service層Bean。
DispatcherServlet初始化的上下文加載的Bean是只對Spring Web MVC有效的Bean,如Controller、HandlerMapping、HandlerAdapter等等,該初始化上下文應該只加載Web相關組件。
注解 例子:
通過@Controller 和 @RequestMapping注解定義我們的處理器類。通過在一個POJO類上放置@Controller或@RequestMapping,即可把一個POJO類變身為處理器。
@RequestMapping(value = "/hello") 請求URL(/hello) 無需實現/繼承任何接口/類。
-
推薦使用這種方式聲明處理器,它和我們的@Service、@Repository很好的對應了我們常見的三層開發架構的組件。
@Controller public class HelloWorldController { …… }
-
這種方式也是可以工作的,但如果在類上使用@ RequestMapping注解一般是用于窄化功能處理方法的映射的。
@RequestMapping public class HelloWorldController { …… }
-
窄化請求映射。
@Controller @RequestMapping(value="/user") //①處理器的通用映射前綴 public class HelloWorldController { @RequestMapping(value = "/hello2") //②相對于①處的映射進行窄化 public ModelAndView helloWorld() { …… } …… }
URL路徑映射:
@RequestMapping(value={"/test1", "/user/create"}):多個URL路徑可以映射到同一個處理器的功能處理方法。
@RequestMapping(value="/users/{userId}"):{×××}占位符, 請求的URL可以是 “/users/123456”或“/users/abcd”,通過@PathVariable可以提取URI模板模式中的{×××}中的×××變量。
@RequestMapping(value="/users/{userId}/create"):這樣也是可以的,請求的URL可以是“/users/123/create”。
@RequestMapping(value="/users/{userId}/topics/{topicId}"):這樣也是可以的,請求的URL可以是“/users/123/topics/123”。
@RequestMapping(value="/users/"):可以匹配“/users/abc/abc”,但根據最長匹配優先“/users/123”將優先映射“/users/{userId}”。
@RequestMapping(value="/product?"):可匹配“/product1”或“/producta”,但不匹配“/product”或“/productaa”;
@RequestMapping(value="/product"):可匹配“/productabc”或“/product”,但不匹配“/productabc/abc”;
@RequestMapping(value="/product/"):可匹配“/product/abc”,但不匹配“/productabc”;
@RequestMapping(value="/products/**/{productId}"):可匹配“/products/abc/abc/123”或“/products/123”請求參數數據映射:
@RequestMapping(params="create") :表示請求中有“create”參數名,如可匹配的請求URL“http://×××/parameterTest?create”。
@RequestMapping(params="!create"):表示請求中沒有“create”參數名,如可匹配的請求URL“http://×××/parameterTest?abc”。
@RequestMapping(params="submitFlag=create"):表示請求中有“submitFlag=create”請求參數,如請求URL為http://×××/parameterTest?submitFlag=create。
@RequestMapping(params="submitFlag!=create"):表示請求中的參數“submitFlag!=create”,如可匹配的請求URL“http://×××/parameter1?submitFlag=abc”。-
數據綁定:
@RequestParam用于將請求參數區數據映射到功能處理方法的參數上,請求中包含username參數(如/requestparam1?username=zhang),則自動傳入。public String requestparam1(@RequestParam String username) { …… } //即通過@RequestParam("username")明確告訴Spring Web MVC使用username進行入參。 public String requestparam2(@RequestParam("username") String username){ …… } //required:是否必須,默認是true,表示請求中一定要有相應的參數,否則將報404錯誤碼。 public String requestparam4(@RequestParam(value="username",required=false) String username){ …… } //defaultValue:默認值,表示如果請求中沒有同名參數時的默認值。 public String requestparam4(@RequestParam(value="username",required=false, defaultValue="zhang") String username){ …… } public String requestparam5(@RequestParam(value="list") List<String> list){ …… }
@PathVariable用于將請求URL中的模板變量映射到功能處理方法的參數上。
@RequestMapping(value="/users/{userId}/topics/{topicId}")
public String test(@PathVariable(value="userId") int userId, @PathVariable(value="topicId") int topicId){
……
}
@CookieValue用于將請求的Cookie數據映射到功能處理方法的參數上。@CookieValue也擁有和@RequestParam相同的value,required,defaultValue三個參數,含義一樣。
//將自動將JSESSIONID值入參到sessionId參數上,defaultValue表示Cookie中沒有JSESSIONID時默認為空。
public String test(@CookieValue(value="JSESSIONID", defaultValue="") String sessionId){
……
}
//傳入參數類型也可以是javax.servlet.http.Cookie類型。
public String test2(@CookieValue(value="JSESSIONID", defaultValue="") Cookie sessionId){
……
}
@RequestHeader用于將請求的頭信息區數據映射到功能處理方法的參數上。@RequestHeader也擁有和@RequestParam相同的三個參數,含義一樣。
//如上配置將自動將請求頭“User-Agent”值入參到userAgent參數上,并將“Accept”請求頭值入參到accepts參數上。
public String test(@RequestHeader("User-Agent") String userAgent, @RequestHeader(value="Accept") String[] accepts){
……
}
@ModelAttribute放在方法的注解上時,會在每一個@RequestMapping標注的方法前先執行此@ModelAttribute方法,如果有返回值,則自動將該返回值加入到ModelMap中。
暴露表單引用對象為模型(model)數據
返回void:
//訪問控制器方法helloWorld時,會首先調用populateModel方法,將頁面參數abc(/helloWorld.ht?abc=text)放到model的attributeName屬性中,在視圖中可以直接訪問。
//在視圖中可以直接訪問<c:out value="${attributeName}"></c:out>
@Controller
public class HelloModelController {
@ModelAttribute
public void populateModel(@RequestParam String abc, Model model) {
model.addAttribute("attributeName", abc);
}
@RequestMapping(value = "/helloWorld")
public String helloWorld() {
return "helloWorld.jsp";
}
}
返回具體類:
//設置這個注解之后可以直接在前端頁面使用hobbise這個對象(List)集合。
//例如:<c:forEach items="${hb}" var="hobby" varStatus="vs">
@ModelAttribute("hb")
public List<String> hobbiesList(){
List<String> hobbise = new LinkedList<String>();
hobbise.add("basketball");
hobbise.add("football");
hobbise.add("tennis");
return hobbise; //那么這個model屬性的名稱是hb。相當于model.addAttribute("hb", hobbise);
}
@RequestMapping(value = "/helloWorld")
public String helloWorld(@ModelAttribute("hb") List<String> hobbise) {
System.out.println("hobbise : "+hobbise.toString());
return "helloWorld";
}
在這個例子里,@ModelAttribute("hb") List<String> hobbise注釋方法參數,參數hobbise的值來源于hobbiesList()方法中的model的屬性hb。進行模型綁定時首先查找模型數據中是否含有同名對象,如果有直接使用,如果沒有通過反射創建一個。參考
綁定請求參數到命令對象
//如請求參數包含“?username=zhang&password=123&workInfo.city=bj”自動綁定到User類中的username屬性,password屬性,workInfo屬性的city屬性中。
//我們在視圖頁面也可以直接使用user,如:${user},${user.username}
public String test1(@ModelAttribute("user") UserModel user) {
……
}
@SessionAttributes注解就可以使得模型中的數據存儲一份到session域中。默認情況下Spring MVC將模型中的數據存儲到request域中。當一個請求結束后,數據就失效了。如果要跨頁面使用。那么需要使用到session。
@SessionAttributes參數:
1.names:這是一個字符串數組。里面應寫需要存儲到session中數據的名稱。
2.types:根據指定參數的類型,將模型中對應類型的參數存儲到session中。
3.value:其實和names是一樣的。
@RequestMapping("/test")
public String test(Map<String,Object> map){
map.put("names", Arrays.asList("caoyc","zhh","cjx"));
map.put("age", 18);
return "hello";
}
request中names:${requestScope.names}<br/>
request中age:${requestScope.age}<br/>
<hr/>
session中names:${sessionScope.names }<br/>
session中age:${sessionScope.age }<br>
@SessionAttributes(value={"names"},types={Integer.class})
@Controller
public class TestController {
@RequestMapping("/test")
public String testController(Map<String,Object> map){
map.put("names", Arrays.asList("caoyc","zhh","cjx"));
map.put("age", 18);
return "hello";
}
}
如果在另一個Controller重要調用其他Controller中放入session中的值,也許要在Controller上加上相同的SessionAttributes注解,例如:
@Controller
@SessionAttributes("names")
public class AnotherController {
public String lendBooks(@ModelAttribute("names")List names){
System.out.println("names:"+names.toString);
}
}