SpringMVC —— 3、获取请求参数

目录

1、通过ServletAPI获取请求参数（少用）

2、通过控制器方法的形参获取请求参数

3、@RequestParam 注解的使用

4、@RequestHeader 注解

5、@CookieValue 注解

6、通过 Pojo 获取请求参数（解决控制台输出乱码问题）

---

1、通过ServletAPI获取请求参数（少用）

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

① 在 TestController 类中添加方法，以便用地址 http://localhost:8080/SpringMVC_demo2/param 可以打开 test_param.html 页面

    @RequestMapping("/param")
    public String param(){
        return "test_param";
    }

② 新建 ParamController 类

@Controller
public class ParamController {

    // 测试通过ServletAPI获取请求参数
    @RequestMapping("/testServletAPI")
    // 形参位置的request表示当前请求，DispatchServlet会自动将当前请求的request注入到形参中的request中
    public String testServletAPI(HttpServletRequest request){
        // 有多个重名的参数(如多选的复选框)使用 request.getParameterValues()
        String username = request.getParameter("username");
        String password = request.getParameter("password");
        System.out.println("username = " + username + ", password = " + password);
        return "success";
    }

}

③ 新建 test_param.html 页面，用来测试

    
    
    测试通过ServletAPI获取请求参数 

2、通过控制器方法的形参获取请求参数

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

注：

若请求所传输的请求参数中有多个同名的请求参数，此时可以在控制器方法的形参中设置字符串数组或者字符串类型的形参接收此请求参数

        若使用字符串数组类型的形参，此参数的数组中包含了每一个数据

        若使用字符串类型的形参，此参数的值为每个数据中间使用逗号拼接的结果

① 在 ParamController 类中添加方法

    // 测试通过控制器方法的形参获取请求参数
    @RequestMapping("/testParam")
    public String testParam(String username, String password, /*String hobby*/ String[] hobby){
        // String hobby：重名的参数会以 String 的格式输出，不同值之间用 , 间隔(例如 a,b,c)
        // System.out.println("username = " + username + ", password = " + password + ", hobby = " + hobby);
        // String[] hobby：重名的参数会以 String数组 的格式输出，不同值各占一个索引
        System.out.println("username = " + username + ", password = " + password + ", hobby = " + Arrays.toString(hobby));
        return "success";
    }

② 在 test_param.html 中添加测试的超链接及表单

    
    测试通过控制器方法的形参获取请求参数 

    

        用户名： 

        密码： 

        爱好：a
        b
        c 

        
    

3、@RequestParam 注解的使用

@RequestParam是将请求参数和控制器方法的形参创建映射关系

@RequestParam注解一共有三个属性：

        value：指定为形参赋值的请求参数的参数名

        required：设置是否必须传输此请求参数，默认值为true

                若设置为true时，则当前请求必须传输value所指定的请求参数，若没有传输该请求参数，且没有设置defaultValue属性，则页面报错400：                  Required String parameter 'xxx' is not present；若设置为false，则当前请求不是必须传输value所指定的请求参数，若没有传输，则注解                  所标识的形参的值为null

        defaultValue：不管required属性值为true或false，当value所指定的请求参数没有传输或传输的值为""时，则使用默认值为形参赋值

① 在 ParamController 类添加方法

// 测试通过@RequestParam注解获取请求参数
    @RequestMapping("/testRequestParam")
    public String testRequestParam(
            // 若请求参数中的参数名和方法体中的形参名不一致，DispatcherServlet就无法自动赋值，可以使用@RequestParam建立映射关系
            @RequestParam(value = "user_name", required = false, defaultValue = "呵呵") String username,
            String password,
            /*String hobby*/ String[] hobby
    ){
        // String hobby：重名的参数会以 String 的格式输出，不同值之间用 , 间隔(例如 a,b,c)
        // System.out.println("username = " + username + ", password = " + password + ", hobby = " + hobby);
        // String[] hobby：重名的参数会以 String数组 的格式输出，不同值各占一个索引
        System.out.println("username = " + username + ", password = " + password + ", hobby = " + Arrays.toString(hobby));
        return "success";
    }

② 在 test_param.html 页面添加测试的表单，注意 用户名 框的 name 属性值与方法中的形参名不一样

    
    

        用户名： 

        密码： 

        爱好：a
        b
        c 

        
    

4、@RequestHeader 注解

@RequestHeader是将请求头信息和控制器方法的形参创建映射关系，若想通过形参获取请求头信息，必须使用 @RequestHeader 注解，而通过形参获取请求参数可以不用 @RequestParam 注解，只需请求参数名与形参名相等即可

@RequestHeader注解一共有三个属性：value、required、defaultValue，用法同@RequestParam

① 在 ParamController 类中添加方法

    // 测试@RequestHeader注解
    @RequestMapping("/testRequestHeader")
    public String testRequestHeader(
            String username,
            String password,
            /*String hobby*/ String[] hobby,
            @RequestHeader(value = "sayHehe", required = false, defaultValue = "hehe") String sayHehe
    ){
        // String hobby：重名的参数会以 String 的格式输出，不同值之间用 , 间隔(例如 a,b,c)
        // System.out.println("username = " + username + ", password = " + password + ", hobby = " + hobby);
        // String[] hobby：重名的参数会以 String数组 的格式输出，不同值各占一个索引
        System.out.println("username = " + username + ", password = " + password + ", hobby = " + Arrays.toString(hobby));
        System.out.println("sayHehe = " + sayHehe);
        return "success";
    }

② 在 test_param.html 页面添加测试的表单

    
    

        用户名： 

        密码： 

        爱好：a
        b
        c 

        
    

5、@CookieValue 注解

@CookieValue是将cookie数据和控制器方法的形参创建映射关系

@CookieValue注解一共有三个属性：value、required、defaultValue，用法同@RequestParam

① 由于session依赖于cookie,cookie是客户端的会话技术，session是服务器的会话技术。当调用getSession方法时，就会创建键为 JSESSIONID的cookie，所以为了使浏览器有 JSESSIONID 的cookie，先运行以下方法（其实就是 1、通过ServletAPI获取请求参数（少用）中的方法添加 getSession 方法），并打开在 test_param.html 的测试链接。第二次打开后服务器就会有键为 JSESSIONID的cookie

    // 测试通过ServletAPI获取请求参数
    @RequestMapping("/testServletAPI")
    // 形参位置的request表示当前请求，DispatchServlet会自动将当前请求的request注入到形参中的request中
    public String testServletAPI(HttpServletRequest request){
        // 由于session依赖于cookie,cookie是客户端的会话技术，session是服务器的会话技术。当调用getSession方法时，就会创建键为JSESSIONID的cookie
        HttpSession session = request.getSession();
        // 有多个重名的参数(如多选的复选框)使用 request.getParameterValues()
        String username = request.getParameter("username");
        String password = request.getParameter("password");
        System.out.println("username = " + username + ", password = " + password);
        return "success";
    }

② 在 ParamController 类中添加方法

    // 测试@CookieValue注解
    @RequestMapping("/testCookieValue")
    public String testCookieValue(
            String username,
            String password,
            /*String hobby*/ String[] hobby,
            @RequestHeader(value = "sayHehe", required = false, defaultValue = "hehe") String sayHehe,
            @CookieValue("JSESSIONID") String JSESSIONID
    ){
        System.out.println("username = " + username + ", password = " + password + ", hobby = " + Arrays.toString(hobby));
        System.out.println("sayHehe = " + sayHehe);
        System.out.println("JSESSIONID = " + JSESSIONID);
        return "successs";
    }

③ 在 test_param.html 中添加测试链接

    
    测试@CookieValue注解 

6、通过 Pojo 获取请求参数（解决控制台输出乱码问题）

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

① 在 src/main/java 目录下创建一个类 com.zyj.mvc.bean.User ，属性如下，只要添加无参和有参构造器、get和set方法、toString方法即可

    private Integer id;
    private String username;
    private String password;
    private Integer age;
    private String sex;
    private String email;

② 在 ParamController 类中添加方法

    // 测试通过Pojo获取请求参数
    @RequestMapping("/testBean")
    public String testBean(User user){
        System.out.println(user);
        return "success";
    }

③ 在 test_param.html 页面中添加测试的表单

    
    

        用户名：

        密码：

        性别：男女

        年龄：

        邮箱：

        
    

④ 提交后，可以发现在控制台输出乱码

User{id=null, username='admin', password='123456', age=22, sex='??·', email='[email protected]'}

思考：

1、在web阶段是通过 request.setCharacterEncoding() 方法来设置字符集，但是在 SpringMVC 阶段，如果要获取 HttpServletRequest，需要在方法中设置形参，但是在形参中获取的 HttpServletRequest 是在获取请求参数之后，而使用 request.setCharacterEncoding() 需要在获取请求参数之前，所以无法生效。

2、也可以修改表单提交的方式为 get 请求。get 请求的乱码是由 tomcat 造成的，可以在 tomcat 设置使用的字符集解决所有 get 请求的乱码。而 tomcat8 及以上的版本已经对get方式中文乱码进行了处理，tomcat8 以下的版本可以在 conf 目录下的 servlet.xml 中设置，如下图

 3、当为 post 请求时，要在获取请求参数之前设置字符集，可以使用SpringMVC提供的编码过滤器CharacterEncodingFilter，但是必须在web.xml中进行注册 ，解决步骤如下：

① 在 web.xml 中注册过滤器

打开 CharacterEncodingFilter 类的源码，发现里面没有 doFilter 方法，判断可能在其继承的 OncePerRequestFilter 类，打开该类的源码，在其 doFilter 方法中发现它会执行 CharacterEncodingFilter 类的 doFilterInternal 方法，如下图：

 查看 doFilterInternal 方法，发现在 encoding 属性不为 null 时，会对 request 和 response 设置字符集，如下图：

 所以需要在注册 CharacterEncodingFilter 过滤器时对 encoding 进行赋值。而 forceRequestEncoding 和 forceResponseEncoding 初始都为 false，但是由于没有设置 request.setCharacterEncoding()，所以 request.getCharacterEncoding() == null 这个添加为 true，可以进入设置 request 字符集的if语句。若要设置 response 的字符集，需要在注册 CharacterEncodingFilter 过滤器时对 forceResponseEncoding 赋值为 true。

    
    
        
        CharacterEncodingFilter
        
        org.springframework.web.filter.CharacterEncodingFilter
    
    
        
        CharacterEncodingFilter
        
        /*
    

修改完后再次运行，可以看到乱码已成功解决