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地址
        • 获取URL地址
        • 主机地址
      • 🧀 URL 参数
      • 🚅 请求头
      • 🚋 请求体
      • ⚓ 回调函数
      • 🚁 异步请求
      • 🥯 Cookie
      • 🍜 成功/失败条件
      • 🌶️ 重试机制
      • ⛵ 重定向
      • 🛰️ 请求代理
    • 响应API

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

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

    • 🥪 拦截器
    • 🍏 自定义注解
    • 🍇 组合注解
    • 🥑 自定义转换器
  • v1.5.28文档
  • 编程式接口
  • 请求API
公子骏
2022-07-14
目录

🔮 请求地址

# URL地址

ForestRequest 对象提供设置/获取URL地址的接口方法

url(String url) 设置请求URL

  • 参数 url : URL字符串

url(ForestURL url) 设置请求URL

  • 参数 url : ForestURL 类实例
// 设置请求URL地址,url: http://127.0.0.1:8080/test
request.url("http://127.0.0.1:8080/test");
// 设置路径为 /abc, 主机地址和端口部分保留,url: http://127.0.0.1:8080/abc
request.url("/abc");
// 覆盖掉整个URL地址,url: http://forest.dtflyx.com/111
request.url("http://forest.dtflyx.com/111");
// 使用 ForestURL 类型对象作为参数,url: http://localhost:8080/222
request.url(new ForestURL(new URL("http://localhost:8080/222")));
1
2
3
4
5
6
7
8

host(String host) 设置URL的主机名/域名/IP地址部分

  • 参数 host : 主机名/域名/IP地址
// 修改请求地址中的主机名/IP地址/域名部分,url: http://127.0.0.1:8080/222
request.host("127.0.0.1");
// 同上,修改请求地址中的主机名/IP地址/域名部分
        request.url().setHost("127.0.0.1");
1
2
3
4

port(int port) 设置URL中的端口

  • 参数 port : 端口号
// 修改请求地址中的端口号,url: http://127.0.0.1:8888/222
request.port(8888);
// 同上,修改请求地址中的端口号
        request.url().setPort(8888);
1
2
3
4

scheme(String scheme) 设置URL中的HTTP协议头

  • 参数 scheme : HTTP协议头
// 修改请求地址中的HTTP协议头,url: https://127.0.0.1:8888/222
request.scheme("https");
// 同上,修改请求地址中的HTTP协议头
request.url().setScheme("https");
1
2
3
4

path(String path) 设置URL路径

  • 参数 path : URL路径
// 修改请求地址中的路径部分,和url方法类似,但path方法不接受完整url地址作为参数,url: https://127.0.0.1:8888/333
request.path("/333");
// 同上,修改请求地址中的路径部分
        request.url().setPath("/333");
1
2
3
4

ref(String ref) 设置Reference, 即URL井号后面的字符串

  • 参数 ref: URL井号后面的字符串
// 设置Reference,即URL井号后面的字符串,url: https://127.0.0.1:8888/333#hello
request.ref("hello");
1
2

# 获取URL地址

urlString() 获取请求URL字符串

  • 返回值 : URL字符串

url() 获取请求URL

  • 返回值 : ForestURL 类实例
// 获取URL地址字符串
// 如:http://localhost:8080/test
String urlStr = request.urlString();
// 获取ForestURL类对象
ForestURL url = request.url();
1
2
3
4
5

schema() 获取请求地址的HTTP协议头

  • 返回值 : HTTP协议头
// 获取URL地址的HTTP协议头
String schema = request.scheme();
1
2

host() 获取URL中的主机名/域名/IP地址部分

  • 返回值 : 主机名/域名/IP地址部分字符串
// 获取请求地址中的主机名/IP地址/域名部分
String host = request.host();
// 同上,获取请求地址中的主机名/IP地址/域名部分
host = request.url().getHost();
1
2
3
4

port() 获取URL中的端口号

  • 返回值 : int 整数, URL中的端口号
// 获取请求地址中的端口号
// 如:8080
// 默认为 -1, 即没有端口号
// 没有端口号也可以理解为 http 下的 80 和 https 下的 443
int port = request.port();
// 同上,获取请求地址中的端口号
port = request.url().getPort();
1
2
3
4
5
6
7

path() 获取URL路径

  • 返回值: URL路径
// 获取请求地址中的路径部分,如:/test
String path = request.path();
// 同上,获取请求地址中的路径部分
path = request.url().getPath();
1
2
3
4

ref() 获取Reference, 即URL井号后面的字符串

  • 返回值: URL井号后面的字符串
// 获取Reference,即URL井号后面的字符串
// 如:http://localhost/test#hello 中的 hello 那部分字符串
request.ref(); 
1
2
3

# 主机地址

主机地址包含: 主机名/IP地址/域名 + 端口号

使用 address 方法的好处是,只会修改主机名或端口,不会影响URL的其它部分(比如 Query 参数,HTTP协议头,路径部分等等)

address(String host, int port) 设置请求的主机地址(主机名/域名/IP地址 + 端口号)

  • 参数 host: 主机名/域名/IP地址
  • 参数 port: 端口号
// 创建新的请求对象
// url: http://localhost/test
Forest.get("/test")
     // 设置请求主机地址,不会改变URL地址的其它部分
     // 参数1:主机名/IP地址/域名
     // 参数2:端口号
     // url: http://192.168.0.1:8881/test
    .address("192.168.0.1", 8881)
     // 同上,设置请求主机地址
     // 参数为 ForestAddress 对象
     // url: http://192.168.0.2:8882/test
    .address(new ForestAddress("192.168.0.2", 8882));
1
2
3
4
5
6
7
8
9
10
11
12
帮助我们改善此文档 (opens new window)
上次更新: 2023/03/07, 12:59:48
🎪 请求类型
🧀 URL 参数

← 🎪 请求类型 🧀 URL 参数→

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