SpringMVC框架@RequestMapping用法，处理器方法参数接收，处理器方法返回值详解

1. @RequestMapping 定义请求规则

1.1 指定模块名称

	通过@RequestMapping 注解可以定义处理器对于请求的映射规则。该注解可以注解在方
法上，也可以注解在类上，但意义是不同的。value 属性值常以“/”开始。
	@RequestMapping 的 value 属性用于定义所匹配请求的 URI。但对于注解在方法上与类
上，其 value 属性所指定的 URI，意义是不同的。
	一个@Controller 所注解的类中，可以定义多个处理器方法。当然，不同的处理器方法
所匹配的 URI 是不同的。这些不同的 URI 被指定在注解于方法之上的@RequestMapping 的
value 属性中。但若这些请求具有相同的 URI 部分，则这些相同的 URI，可以被抽取到注解在
类之上的@RequestMapping 的 value 属性中。此时的这个 URI 表示模块的名称。URI 的请求
是相对于 Web 的根目录。
	换个角度说，要访问处理器的指定方法，必须要在方法指定 URI 之前加上处理器类前定
义的模块名称

1.2 对请求提交方式的定义

	对于@RequestMapping，其有一个属性 method，用于对被注解方法所处理请求的提交
方式进行限制，即只有满足该 method 属性指定的提交方式的请求，才会执行该被注解方法。
	Method 属性的取值为 RequestMethod 枚举常量。常用的为 RequestMethod.GET 与
RequestMethod.POST，分别表示提交方式的匹配规则为 GET 与 POST 提交。

2. 处理器方法的参数

处理器方法可以包含以下四类参数，这些参数会在系统调用时由系统自动赋值，即程序
员可在方法内直接使用。
➢ HttpServletRequest
➢ HttpServletResponse
➢ HttpSession
➢ 请求中所携带的请求参数

2.1 逐个参数接收

只要保证请求参数名与该请求处理方法的参数名相同即可。

2.2 请求参数中乱码问题

对于前面所接收的请求参数，若含有中文，则会出现中文乱码问题。Spring 对于请求参
数中的中文乱码问题，给出了专门的字符集过滤器：spring-web-5.2.5.RELEASE.jar 的
org.springframework.web.filter 包下的 CharacterEncodingFilter 类。

2.2.1 解决方案

在 web.xml 中注册字符集过滤器，即可解决 Spring 的请求参数的中文乱码问题。不过，
最好将该过滤器注册在其它过滤器之前。因为过滤器的执行是按照其注册顺序进行的。

	<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>
<!--            强制request使用encoding的编码-->
            <param-name>foreRequestEncoding</param-name>
            <param-value>true</param-value>
        </init-param>
        <init-param>
<!--            强制response使用encoding的编码-->
            <param-name>foreResponseEncoding</param-name>
            <param-value>true</param-value>
        </init-param>
    </filter>
    <filter-mapping>
        <filter-name>characterEncodingFilter</filter-name>
        <url-pattern>*.do</url-pattern>
    </filter-mapping>

2.3 校正请求参数名@RequestParam

所谓校正请求参数名，是指若请求 URL 所携带的参数名称与处理方法中指定的参数名
不相同时，则需在处理方法参数前，添加一个注解@RequestParam(“请求参数名”)，指定请
求 URL 所携带参数的名称。该注解是对处理器方法参数进行修饰的。value 属性指定请求参
数的名称。
@RequestParam属性
1.value,请求中参数
2.required,boolean类型的，默认是true
	true：表示请求中必须有参数
	false：可以没有此参数

2.4 对象参数接收

将处理器方法的参数定义为一个对象，只要保证请求参数名与这个对象的属性同名即可。

3. 处理器方法的返回值

使用@Controller 注解的处理器的处理器方法，其返回值常用的有四种类型：
➢ 第一种：ModelAndView
➢ 第二种：String
➢ 第三种：无返回值 void
➢ 第四种：返回自定义类型对象
根据不同的情况，使用不同的返回值。

3.1 返回 ModelAndView

	若处理器方法处理完后，需要跳转到其它资源，且又要在跳转的资源间传递数据，此时
处理器方法返回 ModelAndView 比较好。当然，若要返回 ModelAndView，则处理器方法中
需要定义 ModelAndView 对象。
	在使用时，若该处理器方法只是进行跳转而不传递数据，或只是传递数据而并不向任何
资源跳转（如对页面的 Ajax 异步响应），此时若返回 ModelAndView，则将总是有一部分多
余：要么 Model 多余，要么 View 多余。即此时返回 ModelAndView 将不合适。

3.2 返回String

处理器方法返回的字符串可以指定逻辑视图名，通过视图解析器解析可以将其转换为物
理视图地址
	返回内部资源逻辑视图名
	若要跳转的资源为内部资源，则视图解析器可以使用 InternalResourceViewResolver 内部
资源视图解析器。此时处理器方法返回的字符串就是要跳转页面的文件名去掉文件扩展名后
的部分。这个字符串与视图解析器中的 prefix、suffix 相结合，即可形成要访问的 URI。

3.3 返回对象Object

	处理器方法也可以返回 Object 对象。这个 Object 可以是 Integer，String，自定义对象，
Map，List 等。但返回的对象不是作为逻辑视图出现的，而是作为直接在页面显示的数据出
现的。
	返回对象，需要使用@ResponseBody 注解，将转换后的 JSON 数据放入到响应体中。

3.3.1 环境搭建

A , maven pom.xml
由于返回 Object 数据，一般都是将数据转化为了 JSON 对象后传递给浏览器页面的。而
这个由 Object 转换为 JSON，是由 Jackson 工具完成的。所以需要导入 Jackson 的相关 Jar 包。

	<dependency>
      <groupId>com.fasterxml.jackson.core</groupId>
      <artifactId>jackson-core</artifactId>
      <version>2.9.0</version>
    </dependency>
    <dependency>
      <groupId>com.fasterxml.jackson.core</groupId>
      <artifactId>jackson-databind</artifactId>
      <version>2.9.0</version>
    </dependency>

B,声明注解驱动
	将 Object 数据转化为 JSON 数据，需要由消息转换器 HttpMessageConverter 完成。而转
换器的开启，需要由<mvc:annotation-driven/>来完成。
	SpringMVC 使用消息转换器实现请求数据和对象，处理器方法返回对象和响应输出之间
的自动转换
	当 Spring 容器进行初始化过程中，在<mvc:annotation-driven/>处创建注解驱动时，默认
创建了七个 HttpMessageConverter 对象。也就是说，我们注册<mvc:annotation-driven/>，就
是为了让容器为我们创建 HttpMessageConverter 对象。
HttpMessageConverter 接口 : HttpMessageConverter<T>是 Spring3.0 新添加的一个接口，
负责将请求信息转换为一个对象（类型为 T），将对象（类型为 T）输出为响应信息

HttpMessageConverter<T>接口定义的方法：

boolean canRead(Class<?> clazz,MediaType mediaType): 指定转换器可以读取的对象类型，即
转 换 器 是 否 可 将 请 求 信 息 转 换 为 clazz 类 型 的 对 象 ， 同 时 指 定 支 持 MIME 类 型
(text/html,applaiction/json 等)

boolean canWrite(Class<?> clazz,MediaType mediaType):指定转换器是否可将 clazz 类型的对
象写到响应流中，响应流支持的媒体类型在 MediaType 中定义。
LIst<MediaType> getSupportMediaTypes()：该转换器支持的媒体类
型。

T read(Class<? extends T> clazz,HttpInputMessage inputMessage)：将请求信息流转换为 T 类型
的对象。

void write(T t,MediaType contnetType,HttpOutputMessgae outputMessage):将 T 类型的对象写
到响应流中，同时指定相应的媒体类型为 contentType

加入注解驱动<mvc:annotation-driven/>后适配器类的 messageConverters 属性值
ByteArrayHttpMessageConverter 负责读取二进制格式的数据和写出二进制格
式的数据
StringHttpMessageConverter 负责读取字符串格式的数据和写出字符串格
式的数据
ResourceHttpMessageConverter 负责读取资源文件和写出资源文件数据
SourceHttpMessageConverter 能够读 / 写 来 自 HTTP 的 请 求 与 响 应 的
javax.xml.transform.Source ,支持 DOMSource, 
SAXSource, 和 StreamSource 的 XML 格式
AllEncompassingFormHttpMessageConverter
负责处理表单(form)数据
Jaxb2RootElementHttpMessageConverter 使用 JAXB 负责读取和写入 xml 标签格式的数
据
MappingJackson2HttpMessageConverter 负责读取和写入 json 格式的数据。利用
Jackson 的 ObjectMapper 读写 json 数据，操作
Object 类型数据，可读取 application/json，响
应媒体类型为 application/json

大白话：加入< mvc:annotation-driven/>注解之后，会创建HttpMessageConverter的七个实现类，接着选择合适的实现类将请求信息转化为指定的对象，响应的时候会选择合适的实现类，将指定类型的对象写入到响应流中，同时指定相应的媒体类型

3.3.2 返回自定义类型对象

	返回自定义类型对象时，不能以对象的形式直接返回给客户端浏览器，而是将对象转换
为 JSON 格式的数据发送给浏览器的。
	由于转换器底层使用了Jackson转换方式将对象转换为JSON数据，所以需要导入Jackson
的相关 Jar 包。

1.定义数据类

package com.hkd.springmvc.bean;

public class Student {
    private String name;
    private Integer age;

    public Student() {
    }

    public Student(String name, Integer age) {
        this.name = name;
        this.age = age;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    @Override
    public String toString() {
        return "Student{" +
                "name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
}

2.修改处理器类

@RequestMapping(value = "/returnStudent.do")
    @ResponseBody
    public Student ReturnStudent(String name,Integer age){
        Student student = new Student();
        student.setName(name);
        student.setAge(age);
        return student;
    }

3.修改index页面

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>请求页</title>
    <script type="text/javascript" src="js/jquery-1.12.4.js"></script>
    <script type="text/javascript">
        $(function(){
            $("#myButton").click(function (){
                $.ajax({
                    url:"returnStudent.do",
                    data:{
                        name:"张三",
                        age:20
                    },
                    type:"post",
                    dataType:"json",
                    success:function (resp){
                        alert(resp.name + "  " + resp.age)
                    }
                })
            })
        })
    </script>
</head>
<body>
<p>ajax请求</p>
<input id="myButton"  type="button" value="发送ajax请求"/>
</body>
</html>

发送ajax请求结果

3.3.3 返回List集合

1.修改处理器类

@RequestMapping(value = "/returnList.do")
    @ResponseBody
    public List<Student> ReturnList(){
        Student student1 = new Student("tom",11);
        Student student2 = new Student("tim",18);

        List<Student> students = new ArrayList<>();
        students.add(student1);
        students.add(student2);

        return students;
    }

2.修改index.jsp

<%--
  Created by IntelliJ IDEA.
  User: chu'qin
  Date: 2023/8/30
  Time: 17:33
  To change this template use File | Settings | File Templates.
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>请求页</title>
    <script type="text/javascript" src="js/jquery-1.12.4.js"></script>
    <script type="text/javascript">
        $(function(){
            $("#myButton").click(function (){
                $.ajax({
                    // url:"returnStudent.do",
                    url:"returnList.do",
                    success:function (data){
                        // alert(resp.name + "  " + resp.age)
                        $.each(data,function(i,n){
                            alert(n.name + "====" + n.age)
                        })
                    }
                })
            })
        })
    </script>
</head>
<body>
<p>ajax请求</p>
<input id="myButton"  type="button" value="发送ajax请求"/>
</body>
</html>

执行结果略

3.3.4 返回字符串对象

若要返回非中文字符串，将前面返回数值型数据的返回值直接修改为字符串即可。但若
返 回 的 字 符 串 中 带 有 中 文 字 符 ， 则 接 收 方 页 面 将 会 出 现 乱 码 。 此 时 需 要 使 用
@RequestMapping 的 produces 属性指定字符集。
***利用produces属性将返回值类型改为文本类型，不然会出现乱码问题（因为执行过程中不走web.xml文件中的过滤器）
produces，产品，结果，即该属性用于设置输出结果类型。
@responseBody标签作用(如果没有该标签，就是返回String，只能实现跳转功能)
	response.setContentType("application/json;charset=utf-8");
	PrintWriter pw = response.getWriter();
	pw.println(json);

1.修改处理器类

	@RequestMapping(value = "/returnString.do",produces = "text/plain;charset=utf-8")
    @ResponseBody
    public String ReturnString(){
        return "我是传过来的字符串";
    }

2.修改index.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>请求页</title>
    <script type="text/javascript" src="js/jquery-1.12.4.js"></script>
    <script type="text/javascript">
        $(function(){
            $("#myButton").click(function (){
                $.ajax({
                    // url:"returnStudent.do",
                    url:"returnString.do",
                    success:function (data){
                        alert(data)
                        // $.each(data,function(i,n){
                        //     alert(n.name + "====" + n.age)
                        // })
                    }
                })
            })
        })
    </script>
</head>
<body>
<p>ajax请求</p>
<input id="myButton"  type="button" value="发送ajax请求"/>
</body>
</html>

3.执行结果