Spring春风拂面系列---SpringBoot 设置response header的方法总结

主要分为两类，一是单个响应增加响应头，而是对所有响应增加响应头

单个响应

如果我们要在单个请求响应response增加header，可以使用httpServletResponse 或者 ResponseEntity objects.

Using HttpServletResponse
We simply have to add the HttpServletResponse object to our REST endpoint as an argument, then use the addHeader() method:

@GetMapping("/http-servlet-response")
public String usingHttpServletResponse(HttpServletResponse response) {response.addHeader("Baeldung-Example-Header", "Value-HttpServletResponse");return "Response with header using HttpServletResponse";
}

Using ResponseEntity

In this case, let's use the BodyBuilder provided by the ResponseEntity class:

@GetMapping("/response-entity-builder-with-http-headers")
public ResponseEntity<String> usingResponseEntityBuilderAndHttpHeaders() {HttpHeaders responseHeaders = new HttpHeaders();responseHeaders.set("Baeldung-Example-Header", "Value-ResponseEntityBuilderWithHttpHeaders");return ResponseEntity.ok().headers(responseHeaders).body("Response with header using ResponseEntity");
}

所有响应

1. 通过Filter

Now let's imagine we want to set a particular header to many of our endpoints.

Of course, it would be frustrating if we have to replicate the previous code on each mapping methods.

A better approach to accomplish this is by configuring a Filter in our service:

@Component
public class AddResponseHeaderFilter extends OncePerRequestFilter {@Overrideprotected void doFilterInternal(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse,FilterChain filterChain) throws ServletException, IOException {httpServletResponse.addHeader("X-Frame-Options", "DENY");httpServletResponse.addHeader("Cache-Control", "no-cache, no-store, must-revalidate, max-age=0");httpServletResponse.addHeader("Cache-Control", "no-cache='set-cookie'");httpServletResponse.addHeader("Pragma", "no-cache");filterChain.doFilter(httpServletRequest, httpServletResponse);}
}

2.通过Interceptor

public class HttpResponseInterceptorHandler implements HandlerInterceptor {// 实现HandlerInterceptor  或者 继承HandlerInterceptorAdapter都可以,如果想看着简洁就使用后者@Overridepublic boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {response.addHeader("content-test","123");return true;}@Overridepublic void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {}@Overridepublic void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {}
}

注意：1，在postHandle在添加header已经没有意义 2，切记preHandle返回值一定要是true