Forest Forest
💒 首页
  • v1.5.30
  • v1.5.28
  • 🎄 ForestX
🌰 案例
💖 支持
🛫 更新记录
🧢 开发团队
⚒️ 参与贡献
  • MaxKey - 业界领先的身份管理和认证产品 (opens new window)
  • Snowy - 国内首个国密前后端分离快速开发平台 (opens new window)
  • Eoapi - 一个开源、可拓展的 API 工具平台 (opens new window)
  • Gitee (opens new window)
  • Github (opens new window)
💒 首页
  • v1.5.30
  • v1.5.28
  • 🎄 ForestX
🌰 案例
💖 支持
🛫 更新记录
🧢 开发团队
⚒️ 参与贡献
  • MaxKey - 业界领先的身份管理和认证产品 (opens new window)
  • Snowy - 国内首个国密前后端分离快速开发平台 (opens new window)
  • Eoapi - 一个开源、可拓展的 API 工具平台 (opens new window)
  • Gitee (opens new window)
  • Github (opens new window)
  • 序言

    • 🎁 新手介绍
    • 📖 文档
    • 🌰 使用案例
    • 🕵️‍ 关于作者
    • 👨‍🎓 贡献者列表
  • 入门

    • 🎬 安装配置说明
    • 🏹 Springboot环境安装
    • 📐 Springboot环境配置
    • 🎯 Springboot环境使用
    • 🏹 Spring环境安装
    • 📐 Spring环境配置
    • 🎯 Spring环境使用
    • 🏹 原生Java环境安装
    • 📐 原生Java环境配置
    • 🎯 原生Java环境使用
    • 🧬 编程式接口
  • 配置项

    • 👜 Springboot环境配置项
    • 👝 Spring环境配置项
    • 🎒 原生Java环境配置项
    • 📚 配置优先级/作用域
  • 声明式接口

    • 🧱 构建接口
    • 🍀 请求方法
    • 🚚 请求地址
    • 🎈 URL 参数
    • 🍭 请求头
      • 👔 请求体
      • 🍮 后端框架
      • 🧁 接口注解
      • 📬 接收数据
      • 🍛 数据转换
      • 🍓 成功/失败条件
      • 🍌 重试机制
      • 🥂 重定向
      • 🍔 Gzip解压
      • 🎂 日志管理
      • ⚽ 回调函数
      • 🍟 异步请求
      • 🛡️ HTTPS
      • 🍪 使用Cookie
      • 🛸 使用代理
      • 🍉 上传下载
      • 🚑 异常处理
    • 编程式接口

      • 请求API

        • 🚀 请求对象
        • 🚢 请求属性
        • ✨ 执行请求
        • 🎊 后端框架
        • 🎪 请求类型
        • 🔮 请求地址
        • 🧀 URL 参数
        • 🚅 请求头
        • 🚋 请求体
        • ⚓ 回调函数
        • 🚁 异步请求
        • 🥯 Cookie
        • 🍜 成功/失败条件
        • 🌶️ 重试机制
        • ⛵ 重定向
        • 🛰️ 请求代理
      • 响应API

        • 🌠 响应对象
        • ✒️ 读取数据
        • 🦋 响应状态码
        • 🏥 响应错误处理
        • 🎧 响应头
        • 🥞 Cookie
    • 模板表达式

      • 🍬 Hello World
      • 🍹 配置属性引用
      • 🍖 变量引用
      • 🥃 动态变量绑定
      • 🥗 参数序号引用
      • 🍍 引用对象属性
      • 🥝 调用对象方法
    • 高级特性

      • 🥪 拦截器
      • 🍏 自定义注解
      • 🍇 组合注解
      • 🥑 自定义转换器
    • v1.5.28文档
    • 声明式接口
    公子骏
    2022-07-01
    目录

    🍭 请求头

    在《构建接口》的例子中,我们已经知道了可以通过@Request注解的headers属性设置一条 HTTP 请求头。

    现在我们来看看如何添加多条请求头。

    # headers属性

    其中headers属性接受的是一个字符串数组,在接受多个请求头信息时以以下形式填入请求头:

    {
        "请求头名称1: 请求头值1",
        "请求头名称2: 请求头值2",
        "请求头名称3: 请求头值3",
        ...
     }
    
    1
    2
    3
    4
    5
    6

    其中组数每一项都是一个字符串,每个字符串代表一个请求头。请求头的名称和值用:分割。

    具体代码请看如下示例:

    public interface MyClient {
    
        @Request(
                url = "http://localhost:8080/hello/user",
                headers = {
                    "Accept-Charset: utf-8",
                    "Content-Type: text/plain"
                }
        )
        String multipleHeaders();
    }
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11

    该接口调用后所实际产生的 HTTP 请求如下:

    GET http://localhost:8080/hello/user
    HEADER:
        Accept-Charset: utf-8
        Content-Type: text/plain
    

    如果要每次请求传入不同的请求头内容,可以在headers属性的请求头定义中加入数据绑定。

    public interface MyClient {
    
        @Request(
                url = "http://localhost:8080/hello/user",
                headers = {
                    "Accept-Charset: ${encoding}",
                    "Content-Type: text/plain"
                }
        )
        String bindingHeader(@Var("encoding") String encoding);
    }
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11

    如果调用方代码如下所示:

    myClient.bindingHeader("gbk");
    
    1

    这段调用所实际产生的 HTTP 请求如下:

    GET http://localhost:8080/hello/user
    HEADER:
        Accept-Charset: gbk
        Content-Type: text/plain
    

    # @Header 注解

    想必大家都已经了解通过 headers 属性设置请求头的方法了。不过这种方式虽然直观,但如要没通过参数传入到请求头中就显得比较啰嗦了。

    所以Forest还提供了 @Header 注解来帮助您把方法的参数直接绑定到请求体中。

    
    /**
     * 使用 @Header 注解将参数绑定到请求头上
     * @Header 注解的 value 指为请求头的名称,参数值为请求头的值
     * @Header("Accept") String accept将字符串类型参数绑定到请求头 Accept 上
     * @Header("accessToken") String accessToken将字符串类型参数绑定到请求头 accessToken 上
     */
    @Post("http://localhost:8080/hello/user?username=foo")
    void postUser(@Header("Accept") String accept, @Header("accessToken") String accessToken);
    
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10

    如果有很多很多的请求头要通过参数传入,我需要定义很多很多参数吗?当然不用!

    /**
     * 使用 @Header 注解可以修饰 Map 类型的参数
     * Map 的 Key 指为请求头的名称,Value 为请求头的值
     * 通过此方式,可以将 Map 中所有的键值对批量地绑定到请求头中
     */
    @Post("http://localhost:8080/hello/user?username=foo")
    void headHelloUser(@Header Map<String, Object> headerMap);
    
    
    /**
     * 使用 @Header 注解可以修饰自定义类型的对象参数
     * 依据对象类的 Getter 和 Setter 的规则取出属性
     * 其属性名为 URL 请求头的名称,属性值为请求头的值
     * 以此方式,将一个对象中的所有属性批量地绑定到请求头中
     */
    @Post("http://localhost:8080/hello/user?username=foo")
    void headHelloUser(@Header MyHeaderInfo headersInfo);
    
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18

    注意

    • (1) 需要单个单个定义请求头的时候,@Header注解的value值一定要有,比如 @Header("Content-Type") String contentType

    • (2) 需要绑定对象的时候,@Header注解的value值一定要空着,比如 @Header MyHeaders headers 或 @Header Map headerMap

    帮助我们改善此文档 (opens new window)
    上次更新: 2023/03/07, 12:59:48
    🎈 URL 参数
    👔 请求体

    ← 🎈 URL 参数 👔 请求体→

    Theme by Vdoing | Copyright © 2016-2023 公子骏 | MIT License
    • 跟随系统
    • 浅色模式
    • 深色模式
    • 阅读模式