SpringBoot2中使用@RequestHeader獲取請(qǐng)求頭的方法
springMVC/SpringBoot中提供了@RequestHeader注解用來獲取請(qǐng)求頭。
一、使用@RequestHeader獲取請(qǐng)求頭
(一)獲取某一個(gè)請(qǐng)求頭
例如,獲取accept-language請(qǐng)求頭:
@GetMapping("/getLanguage") public Result test(@RequestHeader("accept-language") String language) { // ...... return new Result(true, 600, language); }
使用postman,沒有設(shè)置accept-language請(qǐng)求頭時(shí),響應(yīng):
{ "timestamp": "2019-12-3T20:43:58.971+0000", "status": 400, "error": "Bad Request", "message": "Missing request header 'accept-language' for method parameter of type String", "path": "/getLanguage" }
添加了accept-language請(qǐng)求頭后,響應(yīng):
{ "flag": true, "code": 600, "message": "en-US,en;q=0.9,zh-CN;q=0.8,zh;q=0.7" }
(二)獲取數(shù)值型請(qǐng)求頭
@GetMapping("/num") public Result getNumber(@RequestHeader("my-number") int myNumber) { return new Result(true, HttpStatus.OK.value(), String.valueOf(myNumber)); }
使用postman設(shè)置my-number請(qǐng)求頭值為1,響應(yīng):
{ "flag": true, "code": 200, "message": "1" }
(三)一次性獲取所有請(qǐng)求頭
1、使用Map接收所有請(qǐng)求頭
@GetMapping("/getHeaders") public Result listAllHeaders(@RequestHeader Map<String, String> headers) { headers.forEach((key, value) -> { // 日志中輸出所有請(qǐng)求頭 logger.info(String.format("Header '%s' = %s", key, value)); }); return new Result(true, HttpStatus.OK.value(), ""); }
使用postman請(qǐng)求該地址,控制臺(tái)打?。?/p>
2019-12-03 21:10:35,993 INFO [http-nio-10000-exec-9] com.chushiyan.test.controller.HttpHeaderController: Header 'user-agent' = PostmanRuntime/7.20.1
2019-12-03 21:10:35,994 INFO [http-nio-10000-exec-9] com.chushiyan.test.controller.HttpHeaderController: Header 'accept' = */*
2019-12-03 21:10:35,994 INFO [http-nio-10000-exec-9] com.chushiyan.test.controller.HttpHeaderController: Header 'cache-control' = no-cache
2019-12-03 21:10:35,995 INFO [http-nio-10000-exec-9] com.chushiyan.test.controller.HttpHeaderController: Header 'postman-token' = 47dce6dd-c082-47b0-8867-720e45205aa1
2019-12-03 21:10:35,995 INFO [http-nio-10000-exec-9] com.chushiyan.test.controller.HttpHeaderController: Header 'host' = localhost:10000
2019-12-03 21:10:35,995 INFO [http-nio-10000-exec-9] com.chushiyan.test.controller.HttpHeaderController: Header 'accept-encoding' = gzip, deflate
2019-12-03 21:10:35,996 INFO [http-nio-10000-exec-9] com.chushiyan.test.controller.HttpHeaderController: Header 'connection' = keep-alive
2、使用MultiValueMap接收所有請(qǐng)求頭
一個(gè)請(qǐng)求頭存在多個(gè)值的時(shí)候,可以使用MultiValueMap接收所有請(qǐng)求頭
@GetMapping("/getHeaders2") public Result multiValue(@RequestHeader MultiValueMap<String, String> headers) { headers.forEach((key, value) -> { logger.info(String.format( "Header '%s' = %s", key, value.stream().collect(Collectors.joining("/")))); }); return new Result(true, HttpStatus.OK.value(), ""); }
3、使用HttpHeaders接收所用請(qǐng)求頭
@GetMapping("/getBaseUrl") public Result getBaseUrl(@RequestHeader HttpHeaders headers) { // 獲取到了所有的請(qǐng)求頭,這里只是使用Host請(qǐng)求頭 InetSocketAddress host = headers.getHost(); String url = "http://" + host.getHostName() + ":" + host.getPort(); return new Result(true, HttpStatus.OK.value(),url); }
使用postman請(qǐng)求該地址,得到的響應(yīng):
{ "flag": true, "code": 200, "message": "http://localhost:10000" }
二、@RequestHeader注解詳解
@RequestHeader源碼如下:
package org.springframework.web.bind.annotation; import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; import org.springframework.core.annotation.AliasFor; /** * Annotation which indicates that a method parameter should be bound to a web request header. * * <p>Supported for annotated handler methods in Spring MVC and Spring WebFlux. * * <p>If the method parameter is {@link java.util.Map Map<String, String>}, * {@link org.springframework.util.MultiValueMap MultiValueMap<String, String>}, * or {@link org.springframework.http.HttpHeaders HttpHeaders} then the map is * populated with all header names and values. * * @author Juergen Hoeller * @author Sam Brannen * @since 3.0 * @see RequestMapping * @see RequestParam * @see CookieValue */ @Target(ElementType.PARAMETER) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface RequestHeader { /** * Alias for {@link #name}. */ @AliasFor("name") String value() default ""; /** * The name of the request header to bind to. * @since 4.2 */ @AliasFor("value") String name() default ""; /** * Whether the header is required. * <p>Defaults to {@code true}, leading to an exception being thrown * if the header is missing in the request. Switch this to * {@code false} if you prefer a {@code null} value if the header is * not present in the request. * <p>Alternatively, provide a {@link #defaultValue}, which implicitly * sets this flag to {@code false}. */ boolean required() default true; /** * The default value to use as a fallback. * <p>Supplying a default value implicitly sets {@link #required} to * {@code false}. */ String defaultValue() default ValueConstants.DEFAULT_NONE; }
(一)name、value屬性
public Result test(@RequestHeader(name="accept-language") String language) public Result test(@RequestHeader(value="accept-language") String language)
上面這兩行代碼效果相同。當(dāng)然都可以省略為:(因?yàn)関alue是可以省略寫的)
public Result test(@RequestHeader("accept-language") String language)
因?yàn)閺脑创a中,可以看出name/value互為別名:
@AliasFor("name") String value() default ""; @AliasFor("value") String name() default "";
@AliasFor注解:
- @AliasFor在同一個(gè)注解中成對(duì)使用,表示兩個(gè)屬性互為別名。比如上面的,value和name就是互為別名。
- @AliasFor標(biāo)簽有一些使用限制,比如要求互為別名的屬性的屬性值類型、默認(rèn)值都是相同的。
- 互為別名的注解必須成對(duì)出現(xiàn),比如value屬性添加了@AliasFor(“name”),那么name屬性就必須添加@AliasFor(“value”)。
(二)required屬性
@GetMapping("/getHeader3") public Result evaluateNonRequiredHeader( @RequestHeader(value = "chushiyan", required = false) String header) { return new Result(true,HttpStatus.OK.value(),""); }
如果沒有添加required = false,當(dāng)請(qǐng)求頭中沒有這個(gè)chushiyan請(qǐng)求頭時(shí)就會(huì)報(bào)錯(cuò)。
(三)defaultValue屬性
可以使用defaultValue屬性指定默認(rèn)值
@GetMapping("/getHeader3") public Result evaluateNonRequiredHeader( @RequestHeader(value = "chushiyan", defaultValue = "hello") String header) { return new Result(true,HttpStatus.OK.value(),""); }
到此這篇關(guān)于SpringBoot2中使用@RequestHeader獲取請(qǐng)求頭的方法的文章就介紹到這了,更多相關(guān)SpringBoot2 @RequestHeader獲取請(qǐng)求頭內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Spring @Transactional注解的聲明式事務(wù)簡化業(yè)務(wù)邏輯中的事務(wù)管理
這篇文章主要為大家介紹了Spring @Transactional注解的聲明式事務(wù)簡化業(yè)務(wù)邏輯中的事務(wù)管理,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-10-10SpringMVC實(shí)現(xiàn)Controller的三種方式總結(jié)
這篇文章主要介紹了SpringMVC實(shí)現(xiàn)Controller的三種方式總結(jié),具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-02-02解決Spring Data Jpa 實(shí)體類自動(dòng)創(chuàng)建數(shù)據(jù)庫表失敗問題
這篇文章主要介紹了解決Spring Data Jpa 實(shí)體類自動(dòng)創(chuàng)建數(shù)據(jù)庫表失敗問題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2021-09-09解決idea每次新建項(xiàng)目都需要重新指定maven目錄
這篇文章主要介紹了解決idea每次新建項(xiàng)目都需要配置maven,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-09-09使用Spring boot + jQuery上傳文件(kotlin)功能實(shí)例詳解
本文通過實(shí)例代碼給大家介紹了使用Spring boot + jQuery上傳文件(kotlin) 功能,需要的朋友可以參考下2017-07-07Java實(shí)現(xiàn)WebSocket四個(gè)步驟
這篇文章主要為大家介紹了Java實(shí)現(xiàn)WebSocket的方法實(shí)例,只需要簡單四個(gè)步驟,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2024-01-01