SpringBoot2中使用@RequestHeader获取请求头的方法

springmvc/springboot中提供了@requestheader注解用来获取请求头。

一、使用@requestheader获取请求头

（一）获取某一个请求头

例如，获取accept-language请求头：

@getmapping("/getlanguage")
public result test(@requestheader("accept-language") string language) {
    // ......
    
    return new result(true, 600, language);
}

使用postman，没有设置accept-language请求头时，响应：

{
    "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请求头后，响应：

{
    "flag": true,
    "code": 600,
    "message": "en-us,en;q=0.9,zh-cn;q=0.8,zh;q=0.7"
} 

（二）获取数值型请求头

@getmapping("/num")
public result getnumber(@requestheader("my-number") int mynumber) {
    return new result(true, httpstatus.ok.value(), string.valueof(mynumber));
}

使用postman设置my-number请求头值为1，响应：

{
    "flag": true,
    "code": 200,
    "message": "1"
}

（三）一次性获取所有请求头

1、使用map接收所有请求头

@getmapping("/getheaders")
public result listallheaders(@requestheader map<string, string> headers) {
    headers.foreach((key, value) -> {
        // 日志中输出所有请求头
        logger.info(string.format("header '%s' = %s", key, value));
    });
    return new result(true, httpstatus.ok.value(), "");
}

使用postman请求该地址，控制台打印：

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接收所有请求头

一个请求头存在多个值的时候，可以使用multivaluemap接收所有请求头

@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接收所用请求头

@getmapping("/getbaseurl")
public result getbaseurl(@requestheader httpheaders headers) {
    // 获取到了所有的请求头，这里只是使用host请求头
    inetsocketaddress host = headers.gethost();
    string url = "http://" + host.gethostname() + ":" + host.getport();
    return new result(true, httpstatus.ok.value(),url);
}

使用postman请求该地址，得到的响应：

{
    "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&lt;string, string&gt;},
 * {@link org.springframework.util.multivaluemap multivaluemap&lt;string, string&gt;},
 * 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)

上面这两行代码效果相同。当然都可以省略为：（因为value是可以省略写的）

public result test(@requestheader("accept-language") string language)

因为从源码中，可以看出name/value互为别名:

   @aliasfor("name")
   string value() default "";

   @aliasfor("value")
   string name() default "";

@aliasfor注解：

• @aliasfor在同一个注解中成对使用，表示两个属性互为别名。比如上面的，value和name就是互为别名。
• @aliasfor标签有一些使用限制，比如要求互为别名的属性的属性值类型、默认值都是相同的。
• 互为别名的注解必须成对出现，比如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，当请求头中没有这个chushiyan请求头时就会报错。

（三）defaultvalue属性

可以使用defaultvalue属性指定默认值

@getmapping("/getheader3")
public result evaluatenonrequiredheader(
        @requestheader(value = "chushiyan", defaultvalue = "hello") string header) {

    return new result(true,httpstatus.ok.value(),"");
}

到此这篇关于springboot2中使用@requestheader获取请求头的方法的文章就介绍到这了,更多相关springboot2 @requestheader获取请求头内容请搜索以前的文章或继续浏览下面的相关文章希望大家以后多多支持！