第2章 处理请求、共享数据、视图

关于 @RequestMapping 注解

1、功能

从注解名称上我们可以看到，@RequestMapping 注解的作用就是将请求和处理请求的控制器方法关联起来，建立映射关系。
SpringMVC 接收到指定的请求，就会来找到在映射关系中对应的控制器方法来处理这个请求。

2、位置

• 标识一个类：设置映射请求的请求路径的初始信息。

• 标识一个方法：设置映射请求请求路径的具体信息。

  @Controller
  @RequestMapping("/test")
  public class RequestMappingController {
    //此时请求映射所映射的请求的请求路径为：/test/testRequestMapping
    @RequestMapping("/testRequestMapping")
    public String testRequestMapping(){
        return "success";
    }
  }

3、value 属性

• value 属性通过请求的请求地址匹配请求映射。
• value 属性是一个字符串类型的数组，表示该请求映射能够匹配多个请求地址所对应的请求。
• value 属性必须设置，至少通过请求地址匹配请求映射。

  <a th:href="@{/testRequestMapping}">测试@RequestMapping的value属性-->/testRequestMapping</a><br>
  <a th:href="@{/test}">测试@RequestMapping的value属性-->/test</a><br>

  @RequestMapping(value = {"/testRequestMapping", "/test"})
  public String testRequestMapping(){
    return "success";
  }
  

4、method 属性

• method 属性通过请求的请求方式（GET、POST、PUT、DELETE等）匹配请求映射。
• method 属性是一个RequestMethod类型的数组，表示该请求映射能够匹配多种请求方式的请求。

• 若当前请求的请求地址满足请求映射的 value 属性，但是请求方式不满足 method 属性，则浏览器报错405，比如：Request method 'POST' not supported。

  <a th:href="@{/test}">测试 @RequestMapping 的 value 属性-->/test</a><br>
  <form th:action="@{/test}" method="post">
    <input type="submit">
  </form>
  

  @RequestMapping(
        value = {"/testRequestMapping", "/test"},
        method = {RequestMethod.GET, RequestMethod.POST}
  )
  public String testRequestMapping(){
  
    return "success";
  }
  

对于处理指定请求方式的控制器方法，SpringMVC中提供了@RequestMapping的派生注解：

• 处理get请求的映射：@GetMapping
• 处理post请求的映射：@PostMapping
• 处理put请求的映射：@PutMapping
• 处理delete请求的映射：@DeleteMapping

【注意】
常用的请求方式有：get，post，put，delete，但是目前浏览器只支持 get 和 post，若在 form 表单提交时，为 method 设置了其他请求方式的字符串（put或delete），则按照默认的请求方式 get 处理，若要发送 put 和 delete 请求，则需要通过 spring 提供的过滤器HiddenHttpMethodFilter，在 RESTful 部分会讲到。

5、params 属性

• params 属性通过请求的请求参数匹配请求映射。
• params 属性是一个字符串类型的数组，可以通过 4 种表达式设置请求参数和请求映射的匹配关系：
  • "param"：要求请求映射所匹配的请求必须携带 param 请求参数。
  • "!param"：要求请求映射所匹配的请求必须不能携带 param 请求参数。
  • "param=value"：要求请求映射所匹配的请求必须携带 param 请求参数且 param=value。
  • "param!=value"：要求请求映射所匹配的请求必须携带 param 请求参数但是 param!=value。

    <a th:href="@{/test(username='admin',password=123456)">测试 @RequestMapping 的 params 属性-->/test</a>
    

    @RequestMapping(
       value = {"/testRequestMapping", "/test"},
       method = {RequestMethod.GET, RequestMethod.POST},
       params = {"username","password!=123456"}
    )
    public String testRequestMapping(){
    return "success";
    }
    

    【注意】
    若当前请求满足 @RequestMapping 注解的 value 和 method 属性，但是不满足 params 属性，此时页面会报错400：Parameter conditions "username, password!=123456" not met for actual request parameters: username={admin}, password={123456}

6、headers 属性

• headers 属性通过请求的请求头信息匹配请求映射。
• headers 属性是一个字符串类型的数组，可以通过四种表达式设置请求头信息和请求映射的匹配关系。
  • "header"：要求请求映射所匹配的请求必须携带 header 请求头信息。
  • "!header"：要求请求映射所匹配的请求必须不能携带 header 请求头信息。
  • "header=value"：要求请求映射所匹配的请求必须携带 header 请求头信息且 header=value。
  • "header!=value"：要求请求映射所匹配的请求必须携带 header 请求头信息且 header!=value。

<a th:href="@{/hello/testHeaders}">测试params和headers属性</a>

@RequestMapping(
    value = "/testHeaders",
    headers = {"Host=localhost:8080"}
)
public String testParams() {

    return "success";
}

【注意】
若当前请求满足@RequestMapping注解的value和method属性，但是不满足headers属性，此时页面显示404错误，即资源未找到。

7、ant 风格的请求路径

？：表示任意的单个字符。
*：表示任意的 0 个或多个字符。
**：表示任意的一层或多层目录。（注意：在使用 ** 时，只能使用 /**/xxx 的方式）

<a th:href="@{/hello/a1a/testAnt}">测试Ant风格的路径</a>

//@RequestMapping("/a?a/testAnt")
//@RequestMapping("/a*a/testAnt")
@RequestMapping("/**/testAnt")
public String testAnt() {
    return "success";
}

8、请求路径中的占位符

原始方式：/deleteUser?id=1
rest方式：/deleteUser/1
SpringMVC路径中的占位符常用于 RESTful 风格中，当请求路径中将某些数据通过路径的方式传输到服务器中，就可以在相应的@RequestMapping 注解的 value 属性中通过占位符{xxx}表示传输的数据，在通过 @PathVariable 注解，将占位符所表示的数据赋值给控制器方法的形参。

<a th:href="@{/testRest/1/admin}">测试路径中的占位符-->/testRest</a>

@RequestMapping("/testRest/{id}/{username}")
public String testRest(
    @PathVariable("id") String id, 
    @PathVariable("username") String username){

    System.out.println("id:"+id+",username:"+username);

    return "success";
}
//控制台输出的内容为-->id:1,username:admin

获取请求参数（两种方式）

方式一：通过 ServletAPI 获取

将 HttpServletRequest 作为控制器方法的形参，此时 HttpServletRequest 类型的参数表示封装了当前请求的请求报文的对象。

<a th:href="@{/testServletAPI(username='admin', password=123456)}">测试使用ServletAPI获取请求参数</a>

@RequestMapping("testServletAPI")
public String testServletAPI(HttpServletRequest request) {
    HttpSession session = request.getSession();
    String username = request.getParameter("username");
    String password = request.getParameter("password");
    System.out.println("username = " + username + ", password = " + password);

    return "success";
}

方式二：通过控制器方法的形参（推荐使用）

在控制器方法的形参位置，设置和请求参数同名的形参，当浏览器发送请求，匹配到请求映射时，在 DispatcherServlet 中就会将请求参数赋值给相应的形参。

<a th:href="@{/testParam(username='admin', password=123456)}">测试使用控制器方法的形参获取请求参数</a>

@RequestMapping("/testParam")
public String testParam(String username, String password){
    System.out.println("username:" + username +",password:" + password);

    return "success";
}

【注意】

• 若请求所传输的请求参数中有多个同名的请求参数，此时可以在控制器方法的形参中设置字符串数组或者字符串类型的形参接收此请求参数。
• 若使用字符串数组类型的形参，此参数的数组中包含了每一个数据。
• 若使用字符串类型的形参，此参数的值为每个数据中间使用逗号拼接的结果。

关于 @RequestParam 注解

@RequestParam 是将请求参数和控制器方法的形参创建映射关系，一共有三个属性：

• value：指定为形参赋值的请求参数的参数名。
• required：设置是否必须传输此请求参数，默认值为true。若设置为true时，则当前请求必须传输value所指定的请求参数，若没有传输该请求参数，且没有设置defaultValue属性，则页面报错400：Required String parameter 'xxx' is not present；若设置为false，则当前请求不是必须传输value所指定的请求参数，若没有传输，则注解所标识的形参的值为null
• defaultValue：不管required属性值为true或false，当value所指定的请求参数没有传输或传输的值为""时，则使用默认值为形参赋值。

关于 @RequestHeader 注解

@RequestHeader是将请求头信息和控制器方法的形参创建映射关系，一共有三个属性（用法同@RequestParam）：

• value
• required
• defaultValue

关于 @CookieValue 注解

@CookieValue是将cookie数据和控制器方法的形参创建映射关系，一共有三个属性（用法同@RequestParam）：

• value
• required
• defaultValue

<a th:href="@{/testParam(username='admin', password=123456)}">测试使用控制器方法的形参获取请求参数</a>
<br>
<form th:action="@{/testParam}" method="get">
    用户名：<input type="text" name="user-name"><br>
    密 码：<input type="password" name="password"><br>
    爱 好：
    <input type="checkbox" name="hobby" value="篮球">篮球
    <input type="checkbox" name="hobby" value="足球">足球
    <input type="checkbox" name="hobby" value="乒乓球">乒乓球<br>
    <input type="submit" value="测试使用控制器方法的形参获取请求参数">
</form>

//注意 @RequestParam 与 @PathVariable 的不同，后者是对应 RESTful 风格的，前者是普通风格。
//value 属性值必须与浏览器发送的请求参数一致。
//required = false 表示可以不用传输，其值为null，required 默认值是 true 也就是必须传输。
//defaultValue 表示默认值，在不传输或者传输的是""的时候采用，如果传输了值以传输的值为准。
//@RequestHeader 用来获取请求头信息。
//@CookieValue 用来获取Cookie信息。
@RequestMapping("/testParam")
public String testParam(
    @RequestParam(value = "user-name", 
                  required = false, 
                  defaultValue = "admin") String username,
    String password, String[] hobby,
    @RequestHeader("Host") String host,
    @CookieValue("JSESSIONID") String JSESSIONID) {

    System.out.println("username = " + username + ", " +
                       "password = " + password + ", hobby = " + 
                       Arrays.toString(hobby));
    System.out.println("Host = " + host);
    System.out.println("JSESSIONID = " + JSESSIONID);

    return "success";
}

通过POJO获取请求参数

可以在控制器方法的形参位置设置一个实体类类型的形参，此时若浏览器传输的请求参数的参数名和实体类中的属性名一致，那么请求参数就会为此属性赋值。

<form th:action="@{/testpojo}" method="post">
    用户名：<input type="text" name="username"><br>
    密码：<input type="password" name="password"><br>
    性别：<input type="radio" name="sex" value="男">男<input type="radio" name="sex" value="女">女<br>
    年龄：<input type="text" name="age"><br>
    邮箱：<input type="text" name="email"><br>
    <input type="submit">
</form>

@RequestMapping("/testpojo")
public String testPOJO(User user){
    System.out.println(user);

    return "success";
}
//最终结果-->User{id=null, username='张三', password='123', age=23, sex='男', email='123@qq.com'}

解决获取请求参数中的乱码问题

解决获取请求参数的乱码问题，可以使用 SpringMVC 提供的编码过滤器 CharacterEncodingFilter，但是必须在 web.xml 中进行注册。
注：SpringMVC中处理编码的过滤器一定要配置到其他过滤器之前，否则无效。

<!--配置springMVC的编码过滤器-->
<filter>
    <filter-name>CharacterEncodingFilter</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>
      <init-param>
          <param-name>forceRequestEncoding</param-name>
          <param-value>true</param-value>
      </init-param>
    <init-param>
        <param-name>forceResponseEncoding</param-name>
        <param-value>true</param-value>
    </init-param>
</filter>
<filter-mapping>
    <filter-name>CharacterEncodingFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

域对象共享数据

向 request 域中共享数据（5种方式）

1、通过 ServletAPI

@RequestMapping("/testServletAPI")
public String testServletAPI(HttpServletRequest request){
    request.setAttribute("testScope", "hello,servletAPI");
    return "success";
}

2、通过 ModelAndView

@RequestMapping("/testModelAndView")
public ModelAndView testModelAndView(){
    /**
     * ModelAndView 有 Model 和 View 的功能
     * Model 主要用于向请求域共享数据
     * View 主要用于设置视图，实现页面跳转
     */
    ModelAndView mav = new ModelAndView();
    mav.addObject("testScope", "hello,ModelAndView");//向请求域共享数据
    mav.setViewName("success");//设置视图，实现页面跳转
    return mav;
}

3、通过 Model

@RequestMapping("/testModel")
public String testModel(Model model){
    model.addAttribute("testScope", "hello, Model");

    return "success";
}

4、通过 map

@RequestMapping("/testMap")
public String testMap(Map<String, Object> map){
    map.put("testScope", "hello, Map");

    return "success";
}

5、通过 ModelMap

@RequestMapping("/testModelMap")
public String testModelMap(ModelMap modelMap){
    modelMap.addAttribute("testScope", "hello, ModelMap");

    return "success";
}

Model、Map、ModelMap 之间的关系？

Model、ModelMap、Map类型的参数其实本质上都是 BindingAwareModelMap 类型的。

public interface Model{}
public class ModelMap extends LinkedHashMap<String, Object> {}
public class ExtendedModelMap extends ModelMap implements Model {}
public class BindingAwareModelMap extends ExtendedModelMap {}

向 Session 域中共享数据

@RequestMapping("/testSession")
public String testSession(HttpSession session){
    session.setAttribute("testSessionScope", "hello,session");

    return "success";
}

向 Application 域共享数据

@RequestMapping("/testApplication")
public String testApplication(HttpSession session){
    ServletContext application = session.getServletContext();
    application.setAttribute("testApplicationScope", "hello,application");

    return "success";
}

SpringMVC 中的视图

SpringMVC 中的视图是 View 接口，视图的作用渲染数据，将模型 Model 中的数据展示给用户。

• SpringMVC视图的种类很多，默认有转发视图 InternalResourceView 和重定向视图 RedirectView。
• 当工程引入 JSTL 的依赖，转发视图会自动转换为 JstlView。
• 若使用的视图技术为 Thymeleaf，在 SpringMVC 的配置文件中配置了 Thymeleaf 的视图解析器，由此视图解析器解析之后所得到的是ThymeleafView。

1、ThymeleafView

当控制器方法中所设置的视图名称没有任何前缀时，此时的视图名称会被 SpringMVC 配置文件中所配置的视图解析器解析，视图名称拼接视图前缀和视图后缀所得到的最终路径，会通过转发的方式实现跳转。

@RequestMapping("/testHello")
public String testHello(){

    return "hello";//转到 WEB-INF/templates/hello.html 页面
}

2、转发视图

SpringMVC 中默认的转发视图是 InternalResourceView

SpringMVC 中创建转发视图的情况：
当控制器方法中所设置的视图名称以"forward:"为前缀时，创建 InternalResourceView 视图，此时的视图名称不会被SpringMVC 配置文件中所配置的视图解析器解析，而是会将前缀"forward:"去掉，剩余部分作为最终路径通过转发的方式实现跳转。

@RequestMapping("/testForward")
public String testForward(){

    return "forward:/testHello";//不会被 ThymeleafView 解析
}

3、重定向视图

SpringMVC 中默认的重定向视图是 RedirectView。

当控制器方法中所设置的视图名称以"redirect:"为前缀时，创建 RedirectView 视图，此时的视图名称不会被SpringMVC配置文件中所配置的视图解析器解析，而是会将前缀"redirect:"去掉，剩余部分作为最终路径通过重定向的方式实现跳转。

@RequestMapping("/testRedirect")
public String testRedirect(){

    return "redirect:/testHello";//不会被 ThymeleafView 解析
}

4、视图控制器view-controller

当控制器方法中，仅仅用来实现页面跳转，即只需要设置视图名称时，可以将处理器方法使用view-controller标签进行表示。

<!--
    path：设置处理的请求地址
    view-name：设置请求地址所对应的视图名称
-->
<mvc:view-controller path="/testView" view-name="success"></mvc:view-controller>

【注意】
当 SpringMVC 中设置任何一个view-controller时，其他控制器中的请求映射将全部失效，此时还需要在 SpringMVC 的核心配置文件中设置开启mvc注解驱动的标签：<mvc:annotation-driven />。