快捷導(dǎo)航

Spring MVC如何設(shè)置請(qǐng)求頭和響應(yīng)頭的Header

更新時(shí)間：2025年03月25日 09:36:44 作者：付聰1210

這篇文章主要介紹了Spring MVC如何設(shè)置請(qǐng)求頭和響應(yīng)頭的Header問(wèn)題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教

設(shè)置請(qǐng)求頭

使用@RequestHeader注解

這個(gè)注解用于讀取請(qǐng)求中的單個(gè)HTTP頭部值，并將其作為一個(gè)參數(shù)傳遞給控制器方法。

@RequestMapping("/example")
public String handleRequest(@RequestHeader(name = "X-Custom-Header", required = false) String customHeaderValue) {
    // 使用customHeaderValue...
    return "viewName";
}

使用ControllerAdvice

通過(guò)ControllerAdvice類(lèi)，你可以全局地添加響應(yīng)頭。

@ControllerAdvice
public class GlobalHeaderControllerAdvice {
    @AfterResponseBodyAdvice
    public void addGlobalHeader(@RequestHeader HttpHeaders headers) {
        headers.set("X-Global-Response-Header", "GlobalValue");
    }
}

使用@RequestMapping注解的headers屬性

對(duì)于@RequestMapping及其派生注解（如@GetMapping、@PostMapping等），可以使用headers屬性來(lái)指定請(qǐng)求的約束條件，這可以用來(lái)模擬請(qǐng)求頭的效果。

@RequestMapping(value = "/example", method = RequestMethod.GET, headers = "X-Custom-Header=someValue")
public String conditionalRequestMapping() {
    // 方法實(shí)現(xiàn)...
}

使用HttpServletRequest

通過(guò)注入HttpServletRequest對(duì)象，可以讀取和修改請(qǐng)求頭（通常用于讀取，因?yàn)镠TTP請(qǐng)求頭在請(qǐng)求到達(dá)servlet時(shí)已經(jīng)設(shè)置好了，不能修改）。

@RequestMapping("/example")
public String handleRequest(HttpServletRequest request) {
    String customValue = request.getHeader("X-Custom-Header");
    // 使用customValue...
    return "viewName";
}

使用ClientHttpRequestInterceptor

實(shí)現(xiàn)ClientHttpRequestInterceptor接口，可以在請(qǐng)求發(fā)送前動(dòng)態(tài)添加或修改請(qǐng)求頭。

public class CustomRequestHeaderInterceptor implements ClientHttpRequestInterceptor {
    @Override
    public ClientHttpResponse intercept(HttpRequest request, byte[] body, ClientHttpRequestExecution execution) throws IOException {
        request.getHeaders().set("X-Custom-Request-Header", "DynamicValue");
        return execution.execute(request, body);
    }
}

使用Filter

通常，HTTP請(qǐng)求頭是在客戶端發(fā)送請(qǐng)求時(shí)設(shè)置的，一旦請(qǐng)求被發(fā)送到服務(wù)器，請(qǐng)求頭就不能再被修改。Filter可以讀取和修改HttpServletRequest對(duì)象，但它不能修改已經(jīng)接收到的請(qǐng)求頭，因?yàn)镠TTP協(xié)議本身不支持修改請(qǐng)求頭。

如果你需要在服務(wù)器端“偽造”或“添加”請(qǐng)求頭，這通常是通過(guò)在Filter中設(shè)置屬性到HttpServletRequest中實(shí)現(xiàn)的，但這些屬性不會(huì)成為HTTP請(qǐng)求頭的一部分，它們僅可以被下游的Servlet或控制器方法所使用。

public class CustomRequestHeaderFilter implements Filter {
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        HttpServletRequest httpRequest = (HttpServletRequest) request;
        httpRequest.setAttribute("X-Custom-Header", "HeaderValue");
        chain.doFilter(request, response);
    }
}

使用RestTemplate自定義請(qǐng)求

如果你在控制器中使用RestTemplate發(fā)起請(qǐng)求，可以在請(qǐng)求頭中動(dòng)態(tài)設(shè)置值。

HttpHeaders headers = new HttpHeaders();
headers.set("X-Custom-Request-Header", dynamicHeaderValue);
HttpEntity<String> entity = new HttpEntity<>("Request Body", headers);
restTemplate.exchange(...);

設(shè)置響應(yīng)頭

使用@ResponseHeader注解

在控制器類(lèi)或方法上使用@ResponseHeader注解直接添加響應(yīng)頭。

@Controller
@ResponseHeader("X-Custom-Response-Header: DynamicValue")
public class ExampleController {
    // 控制器方法...
}

使用HttpServletResponse

通過(guò)注入HttpServletResponse對(duì)象，在控制器方法中調(diào)用setHeader或addHeader方法來(lái)設(shè)置響應(yīng)頭。

@RequestMapping("/example")
public String handleRequest(HttpServletResponse response) {
    response.setHeader("X-Custom-Response-Header", "DynamicValue");
    return "viewName";
}

使用ResponseEntity對(duì)象

返回一個(gè)ResponseEntity對(duì)象，允許你設(shè)置狀態(tài)碼、頭部和響應(yīng)體。

@RequestMapping("/example")
public ResponseEntity<String> handleRequest() {
    HttpHeaders headers = new HttpHeaders();
    headers.set("X-Custom-Response-Header", "DynamicValue");
    return new ResponseEntity<>("Response Body", headers, HttpStatus.OK);
}

使用HandlerInterceptor

實(shí)現(xiàn)HandlerInterceptor接口，可以在請(qǐng)求處理后動(dòng)態(tài)添加響應(yīng)頭。

public class CustomResponseHeaderInterceptor implements HandlerInterceptor {
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        response.setHeader("X-Custom-Response-Header", "DynamicValue");
    }
}

使用Filter

創(chuàng)建一個(gè)過(guò)濾器，在請(qǐng)求處理之后動(dòng)態(tài)設(shè)置響應(yīng)頭。

public class CustomHeaderFilter implements Filter {
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        filterChain.doFilter(servletRequest, servletResponse);
        HttpServletResponse response = (HttpServletResponse) servletResponse;
        response.setHeader("X-Custom-Response-Header", "DynamicValue");
    }
}

使用RestClient響應(yīng)式調(diào)用

如果你使用響應(yīng)式編程，可以在調(diào)用外部服務(wù)時(shí)動(dòng)態(tài)設(shè)置響應(yīng)頭。

public Mono<ResponseEntity<String>> callExternalService(Data data) {
    return webClient.post()
                    .uri("/example")
                    .header("X-Custom-Response-Header", dynamicHeaderValue)
                    .retrieve()
                    .bodyToMono(String.class);
}