3.8 @CookieValue注解

org.springframework.web.bind.annotation.CookieValue注解用于将请求的Cookie数据映射到请求处理方法的形式参数上。
使用@CookieValue注解可指定如下表所示的属性

属性类型是否必要说明

name String 否指定请求参数绑定的名称

value String 否 name属性的别名

required boolean 否指示参数是否必须绑定

defaultValue String 否如果没有传递参数而使用的默认值

jsessionid

@CookieValue注解示例代码如下:

@RequestMapping(value="/cookieValueTest")
public void cookieValueTest(
    @CookieValue(value="JSESSIONID", defaultValue="") String sessionId)
{
    ...
}

以上配置会自动将Cookie中JSESSIONID的值设置到方法的sessionId形式参数上, defaultValue表示Cookie中没有JSESSIONID时默认设置sessionId为空字符串。

示例:@CookieValue注解的使用

新建一个项目CookieValueTest,加入所需的jar文件,示例代码如下:

CookieValueController.java

package org.fkit.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.CookieValue;
import org.springframework.web.bind.annotation.GetMapping;

@Controller
public class CookieValueController
{
	// 测试@CookieValue注解
	// 该方法映射的请求为 /cookieValueTest
	@GetMapping(value = "/cookieValueTest")
	// 将cookie中的JSESSIONID值赋值给方法的参数sessionId
	public void cookieValueTest(
			@CookieValue(value = "JSESSIONID", defaultValue = "") String sessionId)
	{
		System.out.println("通过@CookieValue获得JSESSIONID： " + sessionId);
	}
}

cookieValueTest方法会自动将Cookie中JSESSIONID的值赋值给sessionId形式参数,如果Cookie中没有JSESSIONID时默认设置sessionId为空字符串。

index.jsp

<%@ page language="java" contentType="text/html; charset=UTF-8"
	pageEncoding="UTF-8"%>
<!DOCTYPE>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>@CookieValue测试</title>
</head>
<body>
	<h2>@CookieValue测试</h2>
	<a href="cookieValueTest">测试@CookieValue注解</a>
	<br>
</body>
</html>

部署CookieValueTest这个Web应用,在浏览器中输入如下URL来测试应用:

1	http://localhost:8080/CookieValueTest/

单击”测试@CookieValue注解”超链接发送请求,将调用cookieValueTest方法,控制台输出结果如下

1	通过@CookieValue获得JSESSIONID： 22334F73E67C6C486559D98FF00539CB

可以看到,请求中JSESSIONID的值被传递到方法的sessionId变量并输出打印在控制台。

原文链接: 3.8 @CookieValue注解