Spring MVC獲取HTTP請(qǐng)求頭的兩種方式小結(jié)
1 前言
請(qǐng)求是任何Web服務(wù)要關(guān)注的對(duì)象，而請(qǐng)求頭也是其中非常重要的信息。本文將通過(guò)代碼講解如何在Spring MVC項(xiàng)目中獲取請(qǐng)求頭的內(nèi)容。主要通過(guò)兩種方式獲取：
（1）通過(guò)注解@RequestHeader獲取，需要在Controller中顯式獲取；
（2）通過(guò)RequestContextHolder獲取，可以任何地方獲取。
接下來(lái)通過(guò)代碼講解。
2 通過(guò)注解@RequestHeader獲取
需要在Controller中顯示使用@RequestHeader。
2.1 獲取某個(gè)請(qǐng)求頭
只獲取其中一個(gè)請(qǐng)求頭，相當(dāng)容易，代碼如下：
@GetMapping("/webSite")
public String webSite(@RequestHeader("webSite")String webSite) {
return "The webSite is " + webSite;
}
這里獲取的是webSite這個(gè)請(qǐng)求頭，測(cè)試如下：
$ 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，如果不配置而客戶端沒(méi)有傳遞該請(qǐng)求頭，會(huì)有報(bào)錯(cuò)。如果配置為false且沒(méi)有請(qǐng)求頭，值為null。代碼如下：
@GetMapping("/webSite-not-required")
public String webSiteNotRequired(@RequestHeader(value = "webSite", required = false)String webSite) {
return "The webSite is " + webSite;
}
測(cè)試結(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更容易理解，通過(guò)它來(lái)設(shè)置默認(rèn)值。如果有傳遞則獲取客戶端傳遞的值，如果沒(méi)有傳遞為默認(rèn)值。代碼如下：
@GetMapping("/webSite-defaultValue")
public String webSiteDefaultValue(@RequestHeader(value = "webSite", defaultValue = "pkslow.com")String webSite) {
return "The webSite is " + webSite;
}
測(cè)試結(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 獲取所有請(qǐng)求頭
注解@RequestHeader除了可以獲取某個(gè)請(qǐng)求頭，還可以一次性獲取所有請(qǐng)求頭，這時(shí)不需要指定名字?？梢酝ㄟ^(guò)Map、MultiValueMap和HttpHeaders來(lái)獲取所有請(qǐng)求頭的值，示例代碼如下：
@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();
}
測(cè)試如下：
$ 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 通過(guò)RequestContextHolder獲取
通過(guò)RequestContextHolder來(lái)獲取則可以在其它層獲取。它先獲取Request對(duì)象，再獲取請(qǐng)求頭。代碼如下：
@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");
}
測(cè)試如下：
$ curl http://localhost:8088/header/webSite-RequestContextHolder -H 'webSite: www.pkslow.com' The webSite is www.pkslow.com
4 總結(jié)
以上兩個(gè)方法，對(duì)于WebFlux而言，通過(guò)注解@RequestHeader獲取是可行的；通過(guò)RequestContextHolder獲取則不行，可參考【在Spring WebFlux的任何地方獲取Request對(duì)象】。
代碼請(qǐng)查看：https://github.com/LarryDpk/pkslow-samples
以上就是Spring MVC獲取HTTP請(qǐng)求頭的兩種方式小結(jié)的詳細(xì)內(nèi)容，更多關(guān)于Spring MVC獲取HTTP請(qǐng)求頭的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！
- SpringMVC集成redis配置的多種實(shí)現(xiàn)方法
- 淺談springMVC中controller的幾種返回類型
- 解決SpringMVC項(xiàng)目連接RabbitMQ出錯(cuò)的問(wèn)題
- SpringMVC和rabbitmq集成的使用案例
- SpringMVC異步處理操作(Callable和DeferredResult)
- Spring MVC數(shù)據(jù)處理和亂碼問(wèn)題詳解
- springmvc 結(jié)合ajax批量新增的實(shí)現(xiàn)方法
- 基于IDEA創(chuàng)建SpringMVC項(xiàng)目流程圖解
- SpringMVC使用@PathVariable接收參數(shù)過(guò)程解析
- 如何理解SpringMVC
相關(guān)文章
SpringBoot中Zookeeper分布式鎖的原理和用法詳解
Zookeeper是一個(gè)分布式協(xié)調(diào)服務(wù)，它提供了高可用、高性能、可擴(kuò)展的分布式鎖機(jī)制，SpringBoot是一個(gè)基于Spring框架的開發(fā)框架，它提供了對(duì)Zookeeper分布式鎖的集成支持，本文將介紹SpringBoot中的 Zookeeper分布式鎖的原理和使用方法,需要的朋友可以參考下2023-07-07
下面小編就為大家?guī)?lái)一篇基于Struts文件上傳(FormFile)詳解。小編覺(jué)得挺不錯(cuò)的，現(xiàn)在就分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2017-08-08
這篇文章主要介紹了java異常機(jī)制,包括異常機(jī)制的捕獲、拋出及常見(jiàn)的異常機(jī)制總結(jié),需要的朋友可以參考下2014-09-09
這篇文章主要介紹了Java下載項(xiàng)目中靜態(tài)文件方式,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2023-08-08
解決ThingsBoard編譯報(bào)錯(cuò)問(wèn)題:Failure?to?find?org.gradle:gradle-too
這篇文章主要介紹了ThingsBoard編譯報(bào)錯(cuò):Failure?to?find?org.gradle:gradle-tooling-api:jar:6.3,本文給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下2023-03-03
這篇文章主要為大家詳細(xì)介紹了java實(shí)現(xiàn)二分法的完整代碼，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2018-11-11
SpringBoot實(shí)現(xiàn)elasticsearch 查詢操作(RestHighLevelClient
這篇文章主要給大家介紹了SpringBoot如何實(shí)現(xiàn)elasticsearch 查詢操作，文中有詳細(xì)的代碼示例和操作流程，具有一定的參考價(jià)值,需要的朋友可以參考下2023-07-07
這篇文章主要介紹了Java中Stream流的常用方法代碼示例,Stream類中每一個(gè)方法都對(duì)應(yīng)集合上的一種操作,將真正的函數(shù)式編程引入到Java中,能 讓代碼更加簡(jiǎn)潔,極大地簡(jiǎn)化了集合的處理操作,提高了開發(fā)的效率和生產(chǎn)力,需要的朋友可以參考下2023-10-10
本篇文章通過(guò)實(shí)例代碼給大家詳細(xì)解釋了java里的“==”和“equels”區(qū)別，對(duì)此有興趣的朋友跟著小編一起學(xué)習(xí)下。2018-02-02
JAVA加密算法數(shù)字簽名實(shí)現(xiàn)原理詳解
這篇文章主要介紹了JAVA加密算法數(shù)字簽名實(shí)現(xiàn)原理詳解,文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-10-10