Spring MVC 教程-@CookieValue详解

当我们在接口中想获取cookie值的时候，怎么写代码更简单呢？

此时可以使用SpringMVC中的@CookieValue注解来标注参数，下面来看具体的用法。

1、预备知识

2、@CookieValue

该注释指示应将方法参数绑定到HTTP cookie。
方法参数可以声明为javax.servlet.http.Cookie类型，也可以声明为Cookie值类型（String、int等）。

    @Target(ElementType.PARAMETER)
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    public @interface CookieValue {
    
    	/**
    	 * cookie名称
    	 */
    	@AliasFor("name")
    	String value() default "";
    
    	/**
    	 * 同value属性
    	 */
    	@AliasFor("value")
    	String name() default "";
    
    	/**
    	 * 是否需要cookie。
    	 * 默认值为true，如果请求中缺少cookie，则会引发异常。
    	 * 如果请求中不存在cookie，则希望使用空值，请将此选项切换为false。
    	 * 或者，提供一个默认值defaultValue，它隐式地将此标志设置为false。
    	 */
    	boolean required() default true;
    
    	/**
    	 * 默认值
    	 */
    	String defaultValue() default ValueConstants.DEFAULT_NONE;
    
    }

3、2种用法

用法1：参数类型为非javax.servlet.http.Cookie类型，比如（String、int等类型）
用法2：参数类型为javax.servlet.http.Cookie类型

4、案例代码

    package com.javacode2018.springmvc.chat18.controller;
    
    import org.springframework.web.bind.annotation.CookieValue;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    import javax.servlet.http.Cookie;
    import java.util.LinkedHashMap;
    import java.util.Map;
    
    @RestController
    public class CookieValueController {
    
        @RequestMapping("/cookievalue/test1")
        public Map<String, Object> test1(@CookieValue("name") String name,
                                         @CookieValue("age") int age) {
            Map<String, Object> result = new LinkedHashMap<>();
            result.put("name", name);
            result.put("age", age);
            return result;
        }
    
        /**
         * @param nameCookie
         * @param ageCookie
         * @return
         */
        @RequestMapping("/cookievalue/test2")
        public Map<String, Object> test2(@CookieValue("name") Cookie nameCookie,
                                         @CookieValue("age") Cookie ageCookie) {
            Map<String, Object> result = new LinkedHashMap<>();
            result.put("nameCookie", nameCookie);
            result.put("ageCookie", ageCookie);
            return result;
        }
    
    }

测试用例代码

    ###
    POST http://localhost:8080/chat18/cookievalue/test1
    Cookie: name=java; age=26
    
    
    ###
    POST http://localhost:8080/chat18/cookievalue/test2
    Cookie: name=java; age=26

运行2个用例

用例1输出

    {
      "name": "java",
      "age": 26
    }

用例2输出

    {
      "nameCookie": {
        "name": "name",
        "value": "java",
        "version": 0,
        "comment": null,
        "domain": null,
        "maxAge": -1,
        "path": null,
        "secure": false,
        "httpOnly": false
      },
      "ageCookie": {
        "name": "age",
        "value": "26",
        "version": 0,
        "comment": null,
        "domain": null,
        "maxAge": -1,
        "path": null,
        "secure": false,
        "httpOnly": false
      }
    }

5、@CookieValue原理

@CookieValue标注的参数的值来源于org.springframework.web.servlet.mvc.method.annotation.ServletCookieValueMethodArgumentResolver解析器

6、代码位置及说明

6.1、git地址

    https://gitee.com/javacode2018/springmvc-series

6.2、本文案例代码结构说明

阅读全文