原文： http://zetcode.com/spring/cookies/

Spring Cookies 教程展示了如何在 Spring 应用中使用 Cookie。 使用@CookieValue注解读取 Cookie。

Spring 是用于创建企业应用的流行 Java 应用框架。

Cookies

Cookie 是服务器发送到用户的 Web 浏览器的一小段数据。 浏览器可以存储它，并将其与下一个请求一起发送回同一服务器。

Cookies 主要用于会话管理，个性化和跟踪。

@CookieValue

@CookieValue是一个注解，指示方法参数应绑定到 HTTP cookie。

HttpCookie

HttpCookie将 HTTP cookie 表示为与"Cookie"请求标头的内容一致的名称/值对。 ResponseCookie子类具有"Set-Cookie"响应标题中预期的其他属性。

Spring Cookie 的例子

以下示例创建一个写入和读取 Cookie 的 Spring Web 应用。

  1. pom.xml
  2. src
  3. ├───main
  4. │   ├───java
  5. │   │   └───com
  6. │   │       └───zetcode
  7. │   │           ├───config
  8. │   │           │       MyWebInitializer.java
  9. │   │           │       WebConfig.java
  10. │   │           └───controller
  11. │   │                   MyController.java
  12. │   └───resources
  13. │           logback.xml
  14. └───test
  15.     └───java

这是 Spring 应用的项目结构。

pom.xml

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3.             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
  5.             http://maven.apache.org/xsd/maven-4.0.0.xsd">
  6.     <modelVersion>4.0.0</modelVersion>
  8.     <groupId>com.zetcode</groupId>
  9.     <artifactId>cookiesex</artifactId>
  10.     <version>1.0-SNAPSHOT</version>
  11.     <packaging>war</packaging>
  13.     <properties>
  14.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  15.         <maven.compiler.source>11</maven.compiler.source>
  16.         <maven.compiler.target>11</maven.compiler.target>
  17.         <spring-version>5.1.3.RELEASE</spring-version>
  18.     </properties>
  20.     <dependencies>
  22.         <dependency>
  23.             <groupId>ch.qos.logback</groupId>
  24.             <artifactId>logback-classic</artifactId>
  25.             <version>1.2.3</version>
  26.         </dependency>
  28.         <dependency>
  29.             <groupId>javax.servlet</groupId>
  30.             <artifactId>javax.servlet-api</artifactId>
  31.             <version>4.0.1</version>
  32.             <scope>provided</scope>
  33.         </dependency>
  35.         <dependency>
  36.             <groupId>org.springframework</groupId>
  37.             <artifactId>spring-webmvc</artifactId>
  38.             <version>5.1.3.RELEASE</version>
  39.         </dependency>
  41.     </dependencies>
  43.     <build>
  44.         <plugins>
  46.             <plugin>
  47.                 <groupId>org.apache.maven.plugins</groupId>
  48.                 <artifactId>maven-war-plugin</artifactId>
  49.                 <version>3.2.2</version>
  50.             </plugin>
  52.             <plugin>
  53.                 <groupId>org.eclipse.jetty</groupId>
  54.                 <artifactId>jetty-maven-plugin</artifactId>
  55.                 <version>9.4.14.v20181114</version>
  56.             </plugin>
  58.         </plugins>
  59.     </build>
  60. </project>

我们声明项目依赖项。

resources/logback.xml

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <configuration>
  3.     <logger name="org.springframework" level="ERROR"/>
  4.     <logger name="com.zetcode" level="INFO"/>
  6.     <appender name="consoleAppender" class="ch.qos.logback.core.ConsoleAppender">
  7.         <encoder>
  8.             <Pattern>%d{HH:mm:ss.SSS} %blue(%-5level) %magenta(%logger{36}) - %msg %n
  9.             </Pattern>
  10.         </encoder>
  11.     </appender>
  13.     <root>
  14.         <level value="INFO" />
  15.         <appender-ref ref="consoleAppender" />
  16.     </root>
  17. </configuration>

logback.xml是 Logback 日志库的配置文件。

com/zetcode/config/MyWebInitializer.java

  1. package com.zetcode.config;
  3. import org.springframework.context.annotation.Configuration;
  4. import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer;
  6. @Configuration
  7. public class MyWebInitializer extends
  8.         AbstractAnnotationConfigDispatcherServletInitializer {
  10.     @Override
  11.     protected Class<?>[] getRootConfigClasses() {
  12.         return null;
  13.     }
  15.     @Override
  16.     protected Class<?>[] getServletConfigClasses() {
  18.         return new Class[]{WebConfig.class};
  19.     }
  21.     @Override
  22.     protected String[] getServletMappings() {
  24.         return new String[]{"/"};
  25.     }
  26. }

DispatcherServlet是 Spring Web 应用的前端控制器，已注册在MyWebInitializer中。

  1. @Override
  2. protected Class<?>[] getServletConfigClasses() {
  4.     return new Class[]{WebConfig.class};
  5. }

getServletConfigClasses()返回 Web 配置类。

com/zetcode/config/WebConfig.java

  1. package com.zetcode.config;
  3. import org.springframework.context.annotation.ComponentScan;
  4. import org.springframework.context.annotation.Configuration;
  5. import org.springframework.web.servlet.config.annotation.EnableWebMvc;
  7. @Configuration
  8. @EnableWebMvc
  9. @ComponentScan(basePackages = {"com.zetcode"})
  10. public class WebConfig {
  12. }

WebConfig通过@EnableWebMvc启用 Spring MVC 注解，并为com.zetcode包配置组件扫描。

com/zetcode/MyController.java

  1. package com.zetcode.controller;
  3. import org.slf4j.Logger;
  4. import org.slf4j.LoggerFactory;
  5. import org.springframework.http.HttpHeaders;
  6. import org.springframework.http.HttpStatus;
  7. import org.springframework.http.ResponseCookie;
  8. import org.springframework.http.ResponseEntity;
  9. import org.springframework.web.bind.annotation.CookieValue;
  10. import org.springframework.web.bind.annotation.GetMapping;
  11. import org.springframework.web.bind.annotation.ResponseStatus;
  12. import org.springframework.web.bind.annotation.RestController;
  14. @RestController
  15. public class MyController {
  17.     private static final Logger logger = LoggerFactory.getLogger(MyController.class);
  19.     @ResponseStatus(value = HttpStatus.OK)
  20.     @GetMapping(value = "/readCookie")
  21.     public void readCookie(@CookieValue(value = "fav-col",
  22.             defaultValue = "unknown") String favColour) {
  24.         logger.info("Favourite colour: {}", favColour);
  25.     }
  27.     @ResponseStatus(value = HttpStatus.OK)
  28.     @GetMapping(value = "/writeCookie")
  29.     public ResponseEntity writeCookie() {
  31.         var favColour = "steelblue";
  32.         var cookie = ResponseCookie.from("fav-col", favColour).build();
  34.         return ResponseEntity.ok()
  35.                 .header(HttpHeaders.SET_COOKIE, cookie.toString())
  36.                 .build();
  37.     }
  38. }

我们有两个 GET 映射。 第一个映射读取一个 cookie，第二个映射写入一个 cookie。

  1. public void readCookie(@CookieValue(value = "fav-col",
  2.         defaultValue = "unknown") String favColour) {

我们使用@CookieValue读取 Cookie 值。 如果未设置 cookie 或过期，则为默认值。

  1. var favColour = "steelblue";
  2. var cookie = ResponseCookie.from("fav-col", favColour).build();
  4. return ResponseEntity.ok()
  5.         .header(HttpHeaders.SET_COOKIE, cookie.toString())
  6.         .build();

我们使用ResponseCookie创建一个 cookie，并将其设置为响应头。

  1. $ mvn jetty:run

我们启动 Jetty 服务器。 现在，首先将浏览器定位到localhost:8080/writeCookie，然后通过导航到localhost:8080/readCookie来读取 cookie。

在本教程中，我们在 Spring 中使用 cookie。 您可能也对相关教程感兴趣： Spring @RequestMapping教程， Spring @RequestHeader教程， Java 教程或列出所有 Spring 教程。