在Spring Boot中设置响应头

原创

mob64ca12e6b22d 2024-08-14 05:09:02 ©著作权

文章标签 响应头 spring java 文章分类 spring boot 后端开发

©著作权归作者所有：来自51CTO博客作者mob64ca12e6b22d的原创作品，请联系作者获取转载授权，否则将追究法律责任

在Spring Boot中设置响应头

在Spring Boot应用程序中，设置HTTP响应头是一个常见的需求，尤其是当我们需要控制缓存、跨域资源共享（CORS）、安全性和内容类型等时。在本篇文章中，我们将介绍如何在Spring Boot中设置响应头，并提供实用的代码示例。

1. 什么是HTTP响应头？

HTTP响应头是服务器返回给客户端（通常是浏览器）的信息，它包含有关服务器和响应本身的重要信息。响应头的作用包括但不限于：

指示数据类型（例如：Content-Type）
缓存控制指令（例如：Cache-Control）
安全控制（例如：X-Content-Type-Options、Strict-Transport-Security）

2. 在Spring Boot中设置响应头的方式

2.1 使用`@ResponseHeader`注解

我们可以使用Spring的@ResponseHeader注解在控制器方法中设置响应头。

import org.springframework.http.HttpHeaders;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HeaderController {

    @GetMapping("/headers")
    public ResponseEntity<String> getHeaders() {
        HttpHeaders headers = new HttpHeaders();
        headers.add("Custom-Header", "Value");

        return ResponseEntity.ok()
                             .headers(headers)
                             .body("Headers set!");
    }
}

在这个例子中，我们定义了一个简单的REST接口，在响应中添加了一个自定义的响应头“Custom-Header”。

2.2 使用`@CrossOrigin`注解

对于处理跨域请求，我们也可以使用@CrossOrigin注解，该注解可以帮助我们设置CORS相关的响应头。

import org.springframework.web.bind.annotation.CrossOrigin;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@CrossOrigin(origins = "
public class MyController {

    @GetMapping("/cors")
    public String handleCORS() {
        return "CORS headers set!";
    }
}

在这个示例中，@CrossOrigin注解使得来自`

2.3 全局设置响应头

如果你想为所有的响应设置一些公共的响应头，可以使用WebMvcConfigurer接口来实现。

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import org.springframework.web.servlet.config.annotation.CorsRegistry;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.http.HttpHeaders;

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void addCorsMappings(CorsRegistry registry) {
        registry.addMapping("/**").allowedOrigins("
    }
}

3. 状态图

在处理请求和设置响应头时，我们可以用状态图来表示这一过程；下图呈现了请求的处理流程：

stateDiagram
    [*] --> RequestReceived
    RequestReceived --> SettingHeaders: Set response headers
    SettingHeaders --> SendingResponse
    SendingResponse --> [*]