SpringBoot中如何使用Cookies

简介: 本文介绍了如何在Spring Boot中操作HTTP Cookie。内容包括:使用@CookieValue注解读取Cookie,通过HttpServletResponse设置Cookie,读取所有Cookie,设置Cookie过期时间,理解HTTPS与Cookie安全,使用HttpOnly Cookie防止XSS攻击,以及如何删除Cookie。示例代码展示了各种操作的方法。

、 导读

本文大纲

   读取HTTP Cookie

   设置HTTP Cookie

   读取所有Cookie[]

   为Cookie设置过期时间

   Https与Cookie

   HttpOnly Cookie

   删除Cookie

HTTP Cookie(也称为Web cookie,浏览器cookie)是服务器在用户浏览器中存储的小部分数据。服务器端应用程序在返回浏览器请求响应的时候设置cookie,浏览器存储cookie,并将它们在下一个请求一起发送的时候自动带回服务器端应用程序。

Cookies提供了一种在服务器和浏览器之间交换信息的方法,以管理会话(登录,购物车,游戏得分),记住用户首选项(主题,隐私策略接受)以及跟踪整个站点的用户行为。Cookies在一定程度上解放了服务器端的压力,因为将一部分数据放在浏览器端存储,所以这部分数据不能是涉及应用安全的数据。在本文中,我们将学习如何在Spring Boot应用程序中读取、设置和删除HTTP cookie。

二、读取HTTP Cookie

Spring框架提供@CookieValue注释来获取HTTP cookie的值,此注解可直接用在控制器方法参数中。

   

   @GetMapping("/")

   public String readCookie(@CookieValue(value = "username",  

                                         defaultValue = "Atta") String username) {

       return "Hey! My username is " + username;

   }

   

在上述代码段中,请注意defaultValue = "Atta"。如果没有设置默认值,并且没有找到名称为username的Cookie,Spring将抛出java.lang.IllegalStateException异常。

三、设置HTTP Cookie

要在Spring Boot中设置cookie,我们可以使用HttpServletResponse类的方法addCookie()。您需要做的就是创建一个新的Cookie对象并将其添加到响应中。

   @GetMapping("/change-username")

   public String setCookie(HttpServletResponse response) {

       // 创建一个 cookie对象

       Cookie cookie = new Cookie("username", "Jovan");

   

       //将cookie对象加入response响应

       response.addCookie(cookie);

   

       return "Username is changed!";

   }

四、读取所有Cookie[]

除了使用@CookieValue注解,我们还可以使用HttpServletRequest类作为控制器方法参数来读取所有cookie。此类提供了getCookies()方法,该方法以数组形式返回浏览器发送的所有cookie。

   @GetMapping("/all-cookies")

   public String readAllCookies(HttpServletRequest request) {

   

       Cookie[] cookies = request.getCookies();

       if (cookies != null) {

           return Arrays.stream(cookies)

                   .map(c -> c.getName() + "=" + c.getValue())

                   .collect(Collectors.joining(", "));

       }

   

       return "No cookies";

   }

五、为Cookie设置过期时间

如果没有为cookie指定过期时间,则其生命周期将持续到Session过期为止。这样的cookie称为会话cookie。会话cookie保持活动状态,直到用户关闭其浏览器或清除其cookie。但是您可以覆盖此默认行为,并使用类的setMaxAge()方法设置cookie的过期时间。

   // 创建一个 cookie对象

   Cookie cookie = new Cookie("username", "Jovan");

   cookie.setMaxAge(7 * 24 * 60 * 60); // 7天过期

   

   //将cookie对象加入response响应

   response.addCookie(cookie);

   

现在,usernameCookie不会因为Seesion结束到期,而是会在接下来的7天保持有效。传递给setMaxAge()方法的到期时间以秒为单位。到期日期和时间是相对于设置cookie的客户端而不是服务器而言的。

六、Https与Cookie

我们需要了解一个概念:什么的安全的Cookies?安全的cookie是仅可以通过加密的HTTPS连接发送到服务器的cookie。无法通过未加密的HTTP连接将cookie发送到服务器。也就是说,如果设置了setSecure(true),该Cookie将无法在Http连接中传输,只能是Https连接中传输。

   // 创建一个 cookie对象

   Cookie cookie = new Cookie("username", "Jovan");

   cookie.setSecure(true);  //Https 安全cookie

   

   //将cookie对象加入response响应

   response.addCookie(cookie);

   

七、HttpOnly Cookie

HttpOnly cookie用于防止跨站点脚本(XSS)攻击,也就是说设置了Http Only的Cookie不能通过JavaScript的Document.cookieAPI访问,仅能在服务端由服务器程序访问。

   // 创建一个 cookie对象

   Cookie cookie = new Cookie("username", "Jovan");

   cookie.setHttpOnly(true);  //不能被js访问的Cookie

   

   //将cookie对象加入response响应

   response.addCookie(cookie);

八、删除Cookie

要删除Cookie,需要将Max-Age设置为0,并且将Cookie的值设置为null。不要将Max-Age指令值设置为-1负数。否则,浏览器会将其视为会话cookie。

   // 将Cookie的值设置为null

   Cookie cookie = new Cookie("username", null);

   //将`Max-Age`设置为0

   cookie.setMaxAge(0);

   

   response.addCookie(cookie);


相关文章
|
安全 Java Spring
Spring Boot 过滤器(Filter)详解
本文详解Spring Boot中过滤器的原理与实践,涵盖Filter接口、执行流程、@Component与FilterRegistrationBean两种实现方式、执行顺序控制及典型应用场景如日志记录、权限验证。对比拦截器,突出其在Servlet容器层的通用性与灵活性,助力构建高效稳定的Web应用。
5825 1
springboot静态资源目录访问,及自定义静态资源路径,index页面的访问
本文介绍了Spring Boot中静态资源的访问位置、如何进行静态资源访问测试、自定义静态资源路径和静态资源请求映射,以及如何处理自定义静态资源映射对index页面访问的影响。提供了两种解决方案:取消自定义静态资源映射或编写Controller来截获index.html的请求并重定向。
springboot静态资源目录访问,及自定义静态资源路径,index页面的访问
|
存储 安全 JavaScript
SpringBoot中如何使用Cookies
本文介绍了如何在Spring Boot中操作HTTP Cookie。包括读取Cookie使用`@CookieValue`注解,设置Cookie通过`HttpServletResponse`的`addCookie()`方法,获取所有Cookie用`HttpServletRequest`的`getCookies()`,设置Cookie过期时间用`setMaxAge()`,理解HTTPS与Cookie的安全性,启用HttpOnly Cookie以防止XSS攻击,以及如何删除Cookie。
727 0
ELK 圣经:Elasticsearch、Logstash、Kibana 从入门到精通
ELK是一套强大的日志管理和分析工具,广泛应用于日志监控、故障排查、业务分析等场景。本文档将详细介绍ELK的各个组件及其配置方法,帮助读者从零开始掌握ELK的使用。
|
XML JSON Java
springboot文件上传,单文件上传和多文件上传,以及数据遍历和回显
本文介绍了在Spring Boot中如何实现文件上传,包括单文件和多文件上传的实现,文件上传的表单页面创建,接收上传文件的Controller层代码编写,以及上传成功后如何在页面上遍历并显示上传的文件。同时,还涉及了`MultipartFile`类的使用和`@RequestPart`注解,以及在`application.properties`中配置文件上传的相关参数。
springboot文件上传,单文件上传和多文件上传,以及数据遍历和回显
|
SQL 前端开发 NoSQL
SpringBoot+Vue 实现图片验证码功能需求
这篇文章介绍了如何在SpringBoot+Vue项目中实现图片验证码功能,包括后端生成与校验验证码的方法以及前端展示验证码的实现步骤。
SpringBoot+Vue 实现图片验证码功能需求
|
前端开发 Java 编译器
classpath中存在多个jar存在同限定名的class classloader会如何加载
总之,合理组织类路径和使用现代化的构建工具,可有效避免类加载冲突,保证应用的稳定运行。
621 8
|
前端开发 小程序 Java
【规范】SpringBoot接口返回结果及异常统一处理,这样封装才优雅
本文详细介绍了如何在SpringBoot项目中统一处理接口返回结果及全局异常。首先,通过封装`ResponseResult`类,实现了接口返回结果的规范化,包括状态码、状态信息、返回信息和数据等字段,提供了多种成功和失败的返回方法。其次,利用`@RestControllerAdvice`和`@ExceptionHandler`注解配置全局异常处理,捕获并友好地处理各种异常信息。
8040 1
【规范】SpringBoot接口返回结果及异常统一处理,这样封装才优雅
|
Oracle Java 关系型数据库
@Id、@GeneratedValue的作用,以及@GeneratedValue的使用
@Id、@GeneratedValue的作用,以及@GeneratedValue的使用
|
缓存 Java UED
使用response.setHeader设置响应头
使用response.setHeader设置响应头

热门文章

最新文章