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环境使用
    • 🏹 Springboot3环境安装
    • 📐 Springboot3环境配置
    • 🎯 Springboot3环境使用
    • 🏹 Spring环境安装
    • 📐 Spring环境配置
    • 🎯 Spring环境使用
    • 🏹 Solon环境安装
    • 📐 Solon环境配置
    • 🎯 Solon环境使用
    • 🏹 原生Java环境安装
    • 📐 原生Java环境配置
    • 🎯 原生Java环境使用
    • 🧬 编程式接口
  • 配置项

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

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

      • 请求API

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

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

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

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

    🛸 使用代理

    众所周知,我们平时访问HTTP,就是直接输入URL外加Query参数或Body参数就开始直接发送请求,随后等待服务端响应便可。请求通过内网或公网一般都可以正常工作(如果客户端和服务端设备正常联通网络的话),就如下图所示:

    proxy

    # 正向代理

    但也有很多服务由于网络限制等诸多原因,无法直接访问到。这时候就需要先连接代理服务器,然后再由代理服务器转发请求到您原本要访问的原始服务器。 这种方式,便称为正向代理,过程如下图所示:

    proxy

    当然,正向代理除了能访问原本访问不到的资源这一功能外,还有其它用处:

    • 访问原来无法访问的资源,如: Google、油管、企业私有网络服务等
    • 做缓存,加速访问速度
    • 对客户端访问授权和认证
    • 记录用户访问记录(上网行为管理)

    除了有正向代理外,自然也有反向代理,但这个概念不在本文档讨论范围,有兴趣可以自行搜索查询相关资料。

    # 设置正向代理

    Forest从1.5.0-RC1版本开始支持HTTP网络代理,而作为一个HTTP客户端框架,自然提供的是对正向代理的支持。

    通过@HTTPProxy注解便可以非常简单地为某一个请求方法设置代理,该注解有两个属性:

    • host: 代理服务器主机地址

    • port: 代理服务器端口号

    /**
     * 使用 @HTTPProxy 注解设置代理服务器
     * host属性为代理服务器主机地址
     * port属性为代理服务器端口号
     */
    @Post(
        url = "http://localhost:8080/hello",
        data = "username=foo&password=123456"
    )
    @HTTPProxy(host = "127.0.0.1", port = "10801")
    String simplePostWithProxy(@Header("Accept") String accept);
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11

    @HTTPProxy注解也可以设置在接口类上,批量给接口中所有方法设置相同的代理服务器

    /**
     * 为 PostClient 接口中所有的请发方法设置代理服务器
     */
    @BaseRequest(baseURL = "http://localhost:8080")
    @HTTPProxy(host = "127.0.0.1", port = "10801")
    public interface PostClient {
        
        ... ...
    
    }
    
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11

    # 设置用户名密码

    如果您访问的代理服务器需要进行身份校验,则在 @HTTProxy 注解中设置用户名和密码

    /**
     * 在 @HTTPProxy 注解中有 username 和 password 属性
     * 分别用于设置代理服务的用户名和密码进行身份验证
     */
    @Post(
        url = "http://localhost:8080/hello",
        data = "username=foo&password=123456"
    )
    @HTTPProxy(
            host = "127.0.0.1",
            port = "10801",
            username = "foo",
            password = "bar"
    )
    String simplePostWithProxy(@Header("Accept") String accept);
    
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    帮助我们改善此文档 (opens new window)
    上次更新: 2023/03/13, 15:28:40
    🍪 使用Cookie
    🍉 上传下载

    ← 🍪 使用Cookie 🍉 上传下载→

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