Spring 注解面面通 之 @CookieValue

2023-11-11 23:18

本文主要是介绍Spring 注解面面通 之 @CookieValue,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

  @CookieValue用于将请求的Cookie数据映射到控制器处理方法的参数中。

  注解解析

  ① value

    绑定的参数名称,参数值为String类型。

  ② name

    绑定的参数名称,参数值为String类型。namevalue可以同时使用,但两者的值需一致,否则会出现错误。

attribute 'name' and its alias 'value' are present with values of [XXX] and [XXX], but only one is permitted

  ③ required

    Cookie中是否必须包含指定的值,默认值为true.

    requiredtrue时,如果Cookie中缺少指定的值,则会抛出异常.

    requiredfalse时,如果Cookie中缺少指定的值,则会返回null.

  ④ defaultValue

    用作绑定失败时的默认值,若Cookie中缺少指定的值,使用此值作为默认值.

    设置defaultValue时,会将required隐式的设置为false.

  注解示例

  1)Controller,用来演示@CookieValue使用方法。

package com.arhorchin.securitit.webannotations;import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Controller;
import org.springframework.ui.ModelMap;
import org.springframework.web.bind.annotation.CookieValue;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.servlet.ModelAndView;import com.arhorchin.securitit.extend.initializer.CustomerApplicationContextInitializer;/*** @author Securitit.* @note 演示@CookieValue使用方法.*/
@Controller
@RequestMapping("/WebAnnotations")
public class CookieValueController {/*** logger.*/private Logger logger = LoggerFactory.getLogger(CustomerApplicationContextInitializer.class);/*** 跳转页面.*/@RequestMapping(value = "/CookieValue.html",method = RequestMethod.GET)public ModelAndView cookieValueHtml(HttpServletRequest req, HttpServletResponse res, ModelMap modelMap)throws Exception {req.getSession(true);return new ModelAndView("webannotations/CookieValue", modelMap);}/*** 从Cookie中获取JSESSIONID.*/@ResponseBody@RequestMapping(value = "/CookieValue.do",method = RequestMethod.GET)public String CookieValue(@CookieValue(value = "JSESSIONID") String jsessionId) throws Exception {logger.info("Current JSESSIONID is " + jsessionId);return "Current JSESSIONID is " + jsessionId;}/*** 从Cookie中获取DEFSESSIONID,DEFSESSIONID在Cookie中不存在,*  由于required设置为true,此时会抛出异常.*/@ResponseBody@RequestMapping(value = "/CookieValueRequiredTrue.do",method = RequestMethod.GET)public String CookieValueRequiredTrue(@CookieValue(value = "DEFSESSIONID",required = true) String jsessionId) throws Exception {logger.info("Current DEFSESSIONID is " + jsessionId);return "Current DEFSESSIONID is " + jsessionId;}/*** 从Cookie中获取DEFSESSIONID,DEFSESSIONID在Cookie中不存在,*  由于required设置为false,此时返回null.*/@ResponseBody@RequestMapping(value = "/CookieValueRequiredFalse.do",method = RequestMethod.GET)public String CookieValueRequiredFalse(@CookieValue(value = "DEFSESSIONID",required = false) String jsessionId) throws Exception {logger.info("Current DEFSESSIONID is " + jsessionId);return "Current DEFSESSIONID is " + jsessionId;}/*** 从Cookie中获取DEFSESSIONID,DEFSESSIONID在Cookie中不存在,*  由于设置了defaultValue,required隐式的设置为false,则返回默认值.*/@ResponseBody@RequestMapping(value = "/CookieValueDefault.do",method = RequestMethod.GET)public String cookieValueDefaultRequiredTest(@CookieValue(value = "DEFSESSIONID",defaultValue = "Securitit's CookieValue Test.") String jsessionId) throws Exception {logger.info("Current DEFSESSIONID is " + jsessionId);return "Current DEFSESSIONID is " + jsessionId;}}

  2)html,用来演示CookieValueController示例。

<!doctype html>
<html lang="en"><head><meta charset="UTF-8"><meta name="Generator" content="EditPlus®"><meta name="Author" content=""><meta name="Keywords" content=""><meta name="Description" content=""><title>@CookieValue 测试页面</title></head><body><a href="http://localhost:9199/spring-annotations/WebAnnotations/CookieValue.do" target="_blank">点击链接,获取Cookie中的JSESSIONID.</a><br /><br /><a href="http://localhost:9199/spring-annotations/WebAnnotations/CookieValueRequiredTrue.do" target="_blank">点击链接,@CookieValue的required属性为true,抛出异常.</a><br /><br /><a href="http://localhost:9199/spring-annotations/WebAnnotations/CookieValueRequiredFalse.do" target="_blank">点击链接,@CookieValue的required属性为false,返回null.</a><br /><br /><a href="http://localhost:9199/spring-annotations/WebAnnotations/CookieValueDefault.do" target="_blank">点击链接,@CookieValue的defaultValue属性设置默认值,required隐式的设置为false.</a></body>
</html>

  3) 启动服务,访问http://localhost:9199/spring-annotations/WebAnnotations/CookieValue.html页面。

在这里插入图片描述

  分别点击页面中的链接,查看@CookieValue对应的效果。

  ① 点击链接,获取Cookie中的JSESSIONID.

在这里插入图片描述

  ② 点击链接,@CookieValue的required属性为true,抛出异常.

在这里插入图片描述

  ③ 点击链接,@CookieValue的required属性为false,返回null.

在这里插入图片描述

  ④ 点击链接,@CookieValue的defaultValue属性设置默认值,required隐式的设置为false.

在这里插入图片描述

  总结

  @CookieValue注解在实际应用中,作用还是很大的,传统Web开发中,Cookie是不可绕过的一环,掌握如何快速的通过Spring框架取值,可以帮助我们更快更好的完成任务。

  若文中存在错误和不足,欢迎指正!

这篇关于Spring 注解面面通 之 @CookieValue的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/393481

相关文章

Java实现MD5加密的四种方式

《Java实现MD5加密的四种方式》MD5是一种广泛使用的哈希算法,其输出结果是一个128位的二进制数,通常以32位十六进制数的形式表示,MD5的底层实现涉及多个复杂的步骤和算法,本文给大家介绍了Ja... 目录MD5介绍Java 中实现 MD5 加密方式方法一:使用 MessageDigest方法二:使用

Java中的runnable 和 callable 区别解析

《Java中的runnable和callable区别解析》Runnable接口用于定义不需要返回结果的任务,而Callable接口可以返回结果并抛出异常,通常与Future结合使用,Runnab... 目录1. Runnable接口1.1 Runnable的定义1.2 Runnable的特点1.3 使用Ru

Java中Runnable和Callable的区别和联系及使用场景

《Java中Runnable和Callable的区别和联系及使用场景》Java多线程有两个重要的接口,Runnable和Callable,分别提供一个run方法和call方法,二者是有较大差异的,本文... 目录一、Runnable使用场景二、Callable的使用场景三、关于Future和FutureTa

Spring 中 BeanFactoryPostProcessor 的作用和示例源码分析

《Spring中BeanFactoryPostProcessor的作用和示例源码分析》Spring的BeanFactoryPostProcessor是容器初始化的扩展接口,允许在Bean实例化前... 目录一、概览1. 核心定位2. 核心功能详解3. 关键特性二、Spring 内置的 BeanFactory

Spring组件初始化扩展点BeanPostProcessor的作用详解

《Spring组件初始化扩展点BeanPostProcessor的作用详解》本文通过实战案例和常见应用场景详细介绍了BeanPostProcessor的使用,并强调了其在Spring扩展中的重要性,感... 目录一、概述二、BeanPostProcessor的作用三、核心方法解析1、postProcessB

Java导入、导出excel用法步骤保姆级教程(附封装好的工具类)

《Java导入、导出excel用法步骤保姆级教程(附封装好的工具类)》:本文主要介绍Java导入、导出excel的相关资料,讲解了使用Java和ApachePOI库将数据导出为Excel文件,包括... 目录前言一、引入Apache POI依赖二、用法&步骤2.1 创建Excel的元素2.3 样式和字体2.

Java实现将Markdown转换为纯文本

《Java实现将Markdown转换为纯文本》这篇文章主要为大家详细介绍了两种在Java中实现Markdown转纯文本的主流方法,文中的示例代码讲解详细,大家可以根据需求选择适合的方案... 目录方法一:使用正则表达式(轻量级方案)方法二:使用 Flexmark-Java 库(专业方案)1. 添加依赖(Ma

Spring Boot拦截器Interceptor与过滤器Filter详细教程(示例详解)

《SpringBoot拦截器Interceptor与过滤器Filter详细教程(示例详解)》本文详细介绍了SpringBoot中的拦截器(Interceptor)和过滤器(Filter),包括它们的... 目录Spring Boot拦截器(Interceptor)与过滤器(Filter)详细教程1. 概述1

SpringBoot利用dynamic-datasource-spring-boot-starter解决多数据源问题

《SpringBoot利用dynamic-datasource-spring-boot-starter解决多数据源问题》dynamic-datasource-spring-boot-starter是一... 目录概要整体架构构想操作步骤创建数据源切换数据源后续问题小结概要自己闲暇时间想实现一个多租户平台,

Java反转字符串的五种方法总结

《Java反转字符串的五种方法总结》:本文主要介绍五种在Java中反转字符串的方法,包括使用StringBuilder的reverse()方法、字符数组、自定义StringBuilder方法、直接... 目录前言方法一:使用StringBuilder的reverse()方法方法二:使用字符数组方法三:使用自