slow-creator-http: slow-creator-http用于http请求的调用与解析，通过接口与注解即可实现http请求的调用与解析，避免项目出现多处重复请求与解析代码。 - Gitee.com

forked from 阔落/slow-creator-http

加入 Gitee

与超过 1200万开发者一起发现、参与优秀开源项目，私有仓库也完全免费：）

克隆/下载

添加支持http代理实现类 7147faf

Loading...

README

MIT

# Slow-Creator-Http 一款Http请求的调用工具

Slow-Creator-Http是项目Slow-Creator的一个模块，用于http请求的调用与解析，通过接口与注解即可实现http请求的调用与解析，避免项目出现多处重复请求与解析代码。

# 项目介绍

项目需要对接第三方的时候，即使封装了Http的请求工具类但是也避免不了需要各种自定义的情况，并且对于返回值的解析，例如json格式，需要先反序列化，然后判断返回的状态是否成功。

本项目的思路来源于[转转支付网关之注解式HTTP客户端 - 掘金](https://juejin.cn/post/7182460718506049594) ，但是本项目未接入spring相关依赖，可以在非spring环境下使用

## 工作流程

![流程图](https://gitee.com/kelr/slow-creator-http/raw/master/doc/pic/%E6%B5%81%E7%A8%8B%E5%9B%BE.png)


通过构建请求参数，调用对应的请求接口（接口类需要~~标注`com.gitee.slowcreator.http.annotation.HttpInterface`注解~~，
由于增加了实现类，避免歧义，该注解已废弃，使用`com.gitee.slowcreator.http.annotation.HttpEnhance`标注接口或实现类），
请求接口会进行动态代理，进入执行流程后会先进行前置处理，此时可以进行相应的设置，实际请求通过spi的方式查找用户项目中引入的http工具。

如果请求失败或者是在后置处理的过程中发现请求失败了会进行再次调用（如果配置了重试，可通过`com.gitee.slowcreator.http.annotation.Retry` 注解配置）。如果不重试或者到达重试上限会通过是否抛出异常配置检测当前调用结果是通过抛出异常接受还是返回调用失败结果。

## 调用

> 第一次获取代理类之前可通过 `ScHttpConfig.setInterfacePackage("com.xxx");`设置接口的扫描的路径，如果不设置会进行全包扫描，耗时会很久。

> 如果项目中存在hutool和okhttp两种依赖，可以通过`ScHttpConfig.setFixedHttp(HttpExecutorConstant.XXX);`设置指定执行器，可参考测试类。<br/>
> 如果重写了`com.gitee.slowcreator.http.executor.HttpExecutor`(SPI方式)，并且重写了executorType()，
> 也可以使用`ScHttpConfig.setFixedHttp(XXX);`传入使用用户自定义的执行器，
> 请在第一次调用前设置，否则设置会失败，会使用第一次获取的http执行器。<br/>
> okhttp相关配置如果需要定制化或者项目以已存在OkHttpClient，
> 可以通过`com.gitee.slowcreator.http.config.ScHttpConfig#setAndGetOkHttpClient(OkHttpClient)`传入。
> 如果传入了OkHttpClient，请设置OkHttpClient#addInterceptor(new OkhttpTimeoutInterceptor()) 否则超时时间定制化的功能设置会失效，
> 默认调用不需要配置这个参数

### 使用

以下以测试类为例

设置扫描路径并获取代理类

```java
ITestHttpRequest proxy = null;

@Before
public void before() {
    // 设置扫描包路径
    ScHttpConfig.setInterfacePackage("com.gitee");
    proxy = HttpClientContext.getHttpClient(ITestHttpRequest.class);
}
```

接口类设置

```java
@HttpInterface(desc = "测试接口")
public interface ITestHttpRequest {
    /**
    * 测试post请求
    *
    * @param header
    * @param params
    * @param returnHeader
    * @param body
    * @return
    */
  @HttpClient(
          desc = "测试POST",
          url = "http://127.0.0.1:8080/annotationHttp/testPost",
          failThrow = true,
          throwException = HttpRequestException.class,
          timeout = 10000,
          requestType = RequestType.POST
  )
  ScReturn testPost(@HttpHeader Map<String, String> header,
                    @HttpParams Map<String, String[]> params,
                    @HttpReturnHeader Set<String> returnHeader,
                    ScBody body);

  /**
    * 测试ScUnionParams直接请求
    *
    * @param unionParams
    * @return
    */
  @HttpClient(
          desc = "测试UNION",
          url = "http://127.0.0.1:8080/annotationHttp/testPost",
          failThrow = true,
          throwException = HttpRequestException.class,
          timeout = 10000,
          requestType = RequestType.POST
  )
  ScReturn testUnion(ScUnionParams unionParams);

  /**
    * 测试url覆盖
    *
    * @param url
    * @return
    */
  @HttpClient(desc = "测试GET", url = "666")
  ScReturn testUrlChange(@HttpUrl String url);
}
```

`测试POST 说明`

requestType 默认为RequestType.GET，如果是非GET调用需要指定，此处演示了两种传参方式，可通过注解标注传参也可通过指定类进行传参，可以避免写注解。具体类型可见`com.gitee.slowcreator.http.params.ScUnionParams`

如果参数为指定类型传入，则可以省略对应的注解，使用非自带类型（实现了`com.gitee.slowcreator.http.params.ScBase`的类）的话，类型需要符合规范并且添加注解

注解详细说明可见`com.gitee.slowcreator.http.annotation.HttpClient`

`测试UNION 说明`

如果需要的参数很多，可以使用`com.gitee.slowcreator.http.params.ScUnionParams`传入，通过注解或者是自带类型传入最终也是封装成`com.gitee.slowcreator.http.params.ScUnionParams`,使用`ScUnionParams`传入会自动忽略其他参数，包括注解和自带类型，`ScUnionParams`传入不需要注解。

`测试url覆盖 说明`

如果是进行一次简单的调用可以参考`测试GET`进行，只需要传入一个url即可，desc非必须，只是加了个说明。

此次演示了url替换，由于有些时候调用存在生产、开发、测试多种环境，在注解是写死不现实，可以通过`@HttpUrl`进行替换。

> 不同传参方式存在不同的优先级 ScUnionParams > 自带类型 > 注解

### retry

如果需要支持retry可以通过`@HttpClient`的`retry`进行配置，相应参数可查阅`com.gitee.slowcreator.http.annotation.Retry`，默认不开启retry。

### 后置处理

目前后置处理增加了一个json解析，通过传入状态标准和状态值判断本次调用是否成功，json解析类型也是通过一个Type传入，这些新增的参数通过ThreadLocal进行传入。

### 自定义代理接口实现类

如果需要自定义接口的实现类去处理逻辑 需要在请求方法上加上`@HttpResult ScReturn scReturn` 则会把http请求的结果传入，实现类可以通过这个类获取http请求的结果信息
如果实现了接口 则返回值可以根据需要返回自定义类型 非强制返回 `ScReturn`（未实现http接口的话返回值必须是`ScReturn`类型）
具体可以参考`com.gitee.slowcreator.module.http.request.intface.ITestHttpEnhance`以及对应的实现类，使用方法参考`com.gitee.slowcreator.module.http.request#testImpl`

## 说明

本项目借鉴了:

- 转转支付网关之注解式HTTP客户端

- Spring-Retry

- Mybatis

- Hutool

由于只用了一个周末大致完成了第一版，时间有限，很多地方写的还是很混乱，后续继续调整。

测试相关可见test包相关代码，测试Controller代码在doc包下TestAnnotationHttp.java，本项目未引入web相关依赖，需要在其他引入springboot相关项目中使用。

### todo

- [ ] retry的延迟实现 

- [x] okhttp等其他工具接入

slow-creator-http用于http请求的调用与解析，通过接口与注解即可实现http请求的调用与解析，避免项目出现多处重复请求与解析代码。

Java

取消

暂无发行版

马建仓 AI 助手

尝试更多

代码解读

代码找茬

代码优化

Java

1

https://gitee.com/wwm0103/slow-creator-http.git

git@gitee.com:wwm0103/slow-creator-http.git

wwm0103

slow-creator-http

slow-creator-http

master