Spring MVC獲取HTTP請求頭的兩種方式小結(jié)
1 前言
請求是任何Web服務(wù)要關(guān)注的對象，而請求頭也是其中非常重要的信息。本文將通過代碼講解如何在Spring MVC項目中獲取請求頭的內(nèi)容。主要通過兩種方式獲取：
（1）通過注解@RequestHeader獲取，需要在Controller中顯式獲??；
（2）通過RequestContextHolder獲取，可以任何地方獲取。
接下來通過代碼講解。
2 通過注解@RequestHeader獲取
需要在Controller中顯示使用@RequestHeader。
2.1 獲取某個請求頭
只獲取其中一個請求頭，相當(dāng)容易，代碼如下：
@GetMapping("/webSite")
public String webSite(@RequestHeader("webSite")String webSite) {
return "The webSite is " + webSite;
}
這里獲取的是webSite這個請求頭，測試如下：
$ curl http://localhost:8088/header/webSite -H 'webSite: www.pkslow.com' The webSite is www.pkslow.com
我們查看@RequestHeader的源碼，它還有其它屬性，如下所示：
public @interface RequestHeader {
@AliasFor("name")
String value() default "";
@AliasFor("value")
String name() default "";
boolean required() default true;
String defaultValue() default "\n\t\t\n\t\t\n\ue000\ue001\ue002\n\t\t\t\t\n";
}
2.1.1 屬性required
required屬性默認(rèn)為true，如果不配置而客戶端沒有傳遞該請求頭，會有報錯。如果配置為false且沒有請求頭，值為null。代碼如下：
@GetMapping("/webSite-not-required")
public String webSiteNotRequired(@RequestHeader(value = "webSite", required = false)String webSite) {
return "The webSite is " + webSite;
}
測試結(jié)果如下：
$ curl http://localhost:8088/header/webSite-not-required -H 'webSite: www.pkslow.com' The webSite is www.pkslow.com $ curl http://localhost:8088/header/webSite-not-required The webSite is null
2.1.2 屬性defaultValue
defaultValue更容易理解，通過它來設(shè)置默認(rèn)值。如果有傳遞則獲取客戶端傳遞的值，如果沒有傳遞為默認(rèn)值。代碼如下：
@GetMapping("/webSite-defaultValue")
public String webSiteDefaultValue(@RequestHeader(value = "webSite", defaultValue = "pkslow.com")String webSite) {
return "The webSite is " + webSite;
}
測試結(jié)果如下：
$ curl http://localhost:8088/header/webSite-defaultValue -H 'webSite: www.pkslow.com' The webSite is www.pkslow.com $ curl http://localhost:8088/header/webSite-defaultValue The webSite is pkslow.com
2.2 獲取所有請求頭
注解@RequestHeader除了可以獲取某個請求頭，還可以一次性獲取所有請求頭，這時不需要指定名字?？梢酝ㄟ^Map、MultiValueMap和HttpHeaders來獲取所有請求頭的值，示例代碼如下：
@GetMapping("/allMap")
public Map<String, String> allMap(@RequestHeader Map<String, String> headers) {
return headers;
}
@GetMapping("/allMultiValueMap")
public Map<String, String> allMultiValueMap(@RequestHeader MultiValueMap<String, String> headers) {
return headers.toSingleValueMap();
}
@GetMapping("/allHttpHeaders")
public String allHttpHeaders(@RequestHeader HttpHeaders headers) {
return headers.toString();
}
測試如下：
$ curl http://localhost:8088/header/allMap -H 'Authorization: Basic cGtzbG93OjEyMzQ1Ng==' -H 'webSite: www.pkslow.com'
{"host":"localhost:8088","user-agent":"curl/7.64.1","accept":"*/*","authorization":"Basic cGtzbG93OjEyMzQ1Ng==","website":"www.pkslow.com"}
$ curl http://localhost:8088/header/allMultiValueMap -H 'Authorization: Basic cGtzbG93OjEyMzQ1Ng==' -H 'webSite: www.pkslow.com'
{"host":"localhost:8088","user-agent":"curl/7.64.1","accept":"*/*","authorization":"Basic cGtzbG93OjEyMzQ1Ng==","website":"www.pkslow.com"}
$ curl http://localhost:8088/header/allHttpHeaders -H 'Authorization: Basic cGtzbG93OjEyMzQ1Ng==' -H 'webSite: www.pkslow.com'
[host:"localhost:8088", user-agent:"curl/7.64.1", accept:"*/*", authorization:"Basic cGtzbG93OjEyMzQ1Ng==", website:www.pkslow.com]
3 通過RequestContextHolder獲取
通過RequestContextHolder來獲取則可以在其它層獲取。它先獲取Request對象，再獲取請求頭。代碼如下：
@GetMapping("/webSite-RequestContextHolder")
public String webSiteRequestContextHolder() {
ServletRequestAttributes requestAttributes = (ServletRequestAttributes)RequestContextHolder.getRequestAttributes();
// get the request
HttpServletRequest request = requestAttributes.getRequest();
return "The webSite is " + request.getHeader("webSite");
}
測試如下：
$ curl http://localhost:8088/header/webSite-RequestContextHolder -H 'webSite: www.pkslow.com' The webSite is www.pkslow.com
4 總結(jié)
以上兩個方法，對于WebFlux而言，通過注解@RequestHeader獲取是可行的；通過RequestContextHolder獲取則不行，可參考【在Spring WebFlux的任何地方獲取Request對象】。
代碼請查看：https://github.com/LarryDpk/pkslow-samples
以上就是Spring MVC獲取HTTP請求頭的兩種方式小結(jié)的詳細(xì)內(nèi)容，更多關(guān)于Spring MVC獲取HTTP請求頭的資料請關(guān)注腳本之家其它相關(guān)文章！
- SpringMVC集成redis配置的多種實(shí)現(xiàn)方法
- 淺談springMVC中controller的幾種返回類型
- 解決SpringMVC項目連接RabbitMQ出錯的問題
- SpringMVC和rabbitmq集成的使用案例
- SpringMVC異步處理操作(Callable和DeferredResult)
- Spring MVC數(shù)據(jù)處理和亂碼問題詳解
- springmvc 結(jié)合ajax批量新增的實(shí)現(xiàn)方法
- 基于IDEA創(chuàng)建SpringMVC項目流程圖解
- SpringMVC使用@PathVariable接收參數(shù)過程解析
- 如何理解SpringMVC
相關(guān)文章
這篇文章主要介紹了Java的方法重載與變量作用域,是Java入門學(xué)習(xí)中的基礎(chǔ)知識,需要的朋友可以參考下2015-10-10
這篇文章主要介紹了BlockingQueue隊列處理高并發(fā)下的日志示例詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步2022-03-03
SpringBoot使用jasypt加解密密碼的實(shí)現(xiàn)方法
這篇文章主要介紹了SpringBoot使用jasypt加解密密碼的實(shí)現(xiàn)方法,本文給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值，需要的朋友可以參考下2020-10-10
Java的MyBatis框架中實(shí)現(xiàn)多表連接查詢和查詢結(jié)果分頁
這篇文章主要介紹了Java的MyBatis框架中實(shí)現(xiàn)多表連接查詢和查詢結(jié)果分頁,借助MyBatis框架中帶有的動態(tài)SQL查詢功能可以比普通SQL查詢做到更多,需要的朋友可以參考下2016-04-04
springcloud引入spring-cloud-starter-openfeign失敗的解決
這篇文章主要介紹了springcloud?引入spring-cloud-starter-openfeign失敗的解決方案，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2022-03-03
Spring通過三級緩存解決循環(huán)依賴問題的過程詳解
循環(huán)依賴指的是在對象之間存在相互依賴關(guān)系,形成一個閉環(huán),導(dǎo)致無法準(zhǔn)確地完成對象的創(chuàng)建和初始化,本文主要介紹了Spring通過三級緩存解決循環(huán)依賴的方法,需要的可以參考下2023-10-10
這篇文章主要介紹了springmvc重定向?qū)崿F(xiàn)方法解析,文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下2020-01-01
Spring Security permitAll()不允許匿名訪問的操作
這篇文章主要介紹了Spring Security permitAll()不允許匿名訪問的操作，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-06-06
Spring Boot監(jiān)視器是一個用于監(jiān)控和管理Spring Boot應(yīng)用程序的工具集,本文就來介紹一下SpringBoot監(jiān)視器的具體使用,感興趣的可以了解一下2025-01-01
在java多線程程序中，所有線程都不允許拋出未捕獲的checked exception，也就是說各個線程需要自己把自己的checked exception處理掉,需要了解的朋友可以參考下2012-11-11