如何在Spring Boot rest服务方法中设置响应头值？

Question

新手问题......我正在构建我的第一个Spring Boot restful服务.我的restful服务设计需要在响应头中返回一些数据.

如何在控制器类方法中设置响应头值？

Answer 1

我建议你在问这里之前搜索文档:

@RequestMapping("/handle")
public ResponseEntity<String> handle() {
    URI location = ...;
    HttpHeaders responseHeaders = new HttpHeaders();
    responseHeaders.setLocation(location);
    responseHeaders.set("MyResponseHeader", "MyValue");
    return new ResponseEntity<String>("Hello World", responseHeaders, HttpStatus.CREATED);
}

资料来源:https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/http/ResponseEntity.html

Answer 2

与其他答案不同,请勿使用HttpServletResponse.如果可以避免,那么您不想使用低级Servlet API.返回ResponseEntity或HttpEntity.

HttpHeaders headers = new HttpHeaders();
headers.add("1", "uno");

return new ResponseEntity<>(headers, HttpStatus.OK);

Answer 3

设置响应头有多种方法：

1. 正如 @Matias Elorriaga 所提到的，您可以使用它来将标头添加到单个响应中。
2. 或者，要向所有响应添加标头，您还可以添加 java 过滤器。

import java.io.IOException;

import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletResponse;

import org.springframework.stereotype.Component;

@javax.servlet.annotation.WebFilter(urlPatterns = {"/*"})
@Component
public class ResponseHeaderFilter implements javax.servlet.Filter {

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        HttpServletResponse res = (HttpServletResponse) response;
        res.setHeader("My-Custom-Header", "Header-Value-Here");
        chain.doFilter(request, response);
    }

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
    }

    @Override
    public void destroy() {
    }
}

3. 或者，在 Spring 5 中，您还可以让 WebFilter 为所有响应添加标头。

import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import org.springframework.web.server.WebFilter;
import org.springframework.web.server.WebFilterChain;

@Component
public class ResponseHeaderWebFilter implements WebFilter {

    @Override
    public Mono filter(ServerWebExchange exchange, WebFilterChain chain) {
        exchange.getResponse().getHeaders().add("My-Custom-Header", "My-Value-Here");
        return chain.filter(exchange);
    }
}

Answer 4

我一直在寻找答案，而且我不想创建响应实体。我在春季论坛上找到了解决方案，因此请记下作者的功劳。

简而言之，您可以在方法声明中请求响应，因此可以填充它。

一个简单的例子：

@RequestMapping(value="/car/{carId}", method = RequestMethod.Get)
@ResponseBody
public Car getCarById(@PathVariable("carId") String Id, HttpServletResponse response) {

    response.setHeader("X-Special-Header", myCar.getEcoLabel());
    //get the car
    return myCar;
}

希望这对其他人也有帮助。

http://forum.spring.io/forum/spring-projects/web-services/102652-setting-header-values-with-spring-rest-controller