一个基于接口和注解的Java HTTP客户端

kcoufee

发布于 2020-8-30 14:36

浏览

0收藏

easy-http
快速开始
easy-http是一个完全基于注解和接口的http客户端，为简化开发、提高效率而生。
1. 特性
注解简单：遵循大家的命名习惯，@Body、@Query、@Var等注解见名之意。
无侵入：接口不需要继承。
多客户端实现: 底层支持多种客户端，默认已实现Java原生URL和HttpClient，也可以自己实现。
支持自定义编解码：默认已经内置了JSON编解码(返回参数支持泛型)，如需支持xml，可自定义。
支持自定义拦截器：请求前，和请求后的拦截。拦截器可满足大部分业务需求，如：计算请求耗时，动态添加公共请求头，返回错误统一处理等等。
提供spring-boot版本，使用更简单。
未实现：规划实现异步请求、响应式模式、以及Java11的客户端。
2. 安装

<dependency>
  <groupId>com.github.firelcw</groupId>
  <artifactId>easy-http</artifactId>
  <version>1.6.0</version>
</dependency>1.
2.
3.
4.
5.

spring-boot版本移步: easy-http-boot-starter

3. 使用
首先定义一个接口:

public interface BookHttpService {
    @Get("/books/{id}")
    ApiResult<Book> getBookById(@Var("id") String id);
}    1.
2.
3.
4.

这是一个最简单的查询接口，然后通过接口构建执行

BookHttpService bookHttpService = EasyHttp.builder()
            .url("127.0.0.1:8888")
            .build(BookHttpService.class);
ApiResult<Book> bookRet = bookHttpService.getBookById("166895");
System.out.println(bookRet.getData().getName());1.
2.
3.
4.
5.

像类似@GET的注解还有@Post、@Put、@Delete，@Post、@Put可指定content-type，默认是application/json。

4.方法参数注解
@var

路径变量注解，用于替换路径上的变量，路径变量只能是简单参数类型，八大基本类型加String。

@Get("/books/{id}")
ApiResult<Book> getBookById(@Var("id") String id);
@Get("/books?author={author}")
ApiResult<Book> getBookById(@Var("author") String author);

@Query1.
2.
3.
4.
5.
6.

被注解的参数可以是任意类型，如果被注解的参数是简单类型，那么必须指定value(查询参数的key)。当一个参数没有任何注解时默认为查询参数。

@Get("/books")
ApiResult<List<Book>> listBooksByAuthor(@Query("author") String author);
@Get("/books")
ApiResult<List<Book>> listBooksByAuthor(@Query Map<String, String> params);
@Get("/books")
ApiResult<List<Book>> listBooksByAuthor(Map<String, String> params);

@Body1.
2.
3.
4.
5.
6.
7.
8.

body参数，被注解的参数会根据编码器处理放到请求body里面, 如果被注解的参数是简单类型，则不会进行编码。

@Post("/books")
void addBook(@Body Book book);

@Headers

请求头注解，可用于接口、方法和方法参数上，当用于接口和方法需指定value, 格式key: value (冒号后面有和空格)

@Headers({"clent: Easy-http"})
@Post("/books")
ApiResult<Void> addBook(@Body Book book, @Headers Map<String, String> headers);

5. 自定义编码器
编码器：将参数对象解析成http的相关请求参数
编写自定义编码器类CustomEncoder实现Encoder接口

public class CustomEncoder implements Encoder {
     /**
     * 将对象转化成成Map<String,String> 用于编码@Query和@Headers
     * @param object 待编码对象
     * @return map
     */
    @Override
    public Map<String, String> encodeMap(Object object) {
        return null;
    }
  /**
     * 将对象转化成string，用于编码 @Body注解的对象（默认是解析成json字符串）
     * @param object
     * @return string
     */
    @Override
    public String encodeString(Object object) {
        return null;
    }
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.

在构建对象是加入CustomEncoder

BookHttpService bookHttpService = EasyHttp.builder()
                                            .url("127.0.0.1:8888")
                                            .encoder(new CustomEncoder())
                                            .build(BookHttpService.class);1.
2.
3.
4.

6. 自定义解码器
将返回体解析成对象
编写自定义编码器类CustomDecoder实现Decoder接口

public class CustomDecoder implements Decoder {
     /**
     * 响应解码(默认使用fastjon解码)
     * @param response 响应参数
     * @param type 返回值类型
     * @return Object
     */
    @Override
    public Object decode(HttpResponse response, Type type) {
        return null;
    }
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.

在构建对象是加入CustomDecoder

BookHttpService bookHttpService = EasyHttp.builder()
                                        .url("127.0.0.1:8888")
                                        .encoder(new CustomEncoder())
                                        .decoder(new CustomDecoder())
                                        .build(BookHttpService.class);1.
2.
3.
4.
5.

自定义拦截器

在请求发出前和请求响应后进行拦截
编写自定义编码器类ResultInterceptor实现HttpInterceptor接口

public class ResultInterceptor implements HttpInterceptor {
    @Override
    public boolean preHandle(HttpRequest request, HttpRequestConfig config) {
        return true;
    }

    @Override
    public void postHandle(HttpRequest request, HttpResponse response) {
        if (!response.isSuccess()) {
            throw new EasyHttpException("请求错误~");
        }
        if (StringUtils.isBlank(response.getBody())) {
           return;
        }
        JSONObject retJson = JSON.parseObject(response.getBody());
        // 假设业务code：200 为操作成功
        if (retJson.getInteger("code") == 200) {
            // 覆盖包含公共信息的json
            response.setBody(retJson.getString("data"));
        }
    }

    @Override
    public int order() {
        return 4;
    }
    @Override
    public List<ExcludePath> excludes() {
        return Arrays.asList(ExcludePath.instance("/books/**", HttpMethod.DELETE, HttpMethod.POST));
    }
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
29.
30.
31.

preHandle 请求前拦截，返回true则通过，反之则被拦截。postHandle 响应后拦截。order定义拦截器的顺序，值越小，越靠前。excludes定义需要排除使用拦截器的路径列表。这里ResultInterceptor对统一的返回作了处理。不仅判断了请求和业务是否成功，并且还统一包装了返回体，去掉了通过返回部分，具体根据业务定制。

在构建对象是加入拦截器列表

        BookHttpService bookHttpService = EasyHttp.builder()
                                                    .url("127.0.0.1:8888")
                                                    .encoder(new CustomEncoder())
                                                    .decoder(new CustomDecoder())
                                                    .withInterceptor(new ResultInterceptor())
                                                    .withInterceptor(new TimeInterceptor())
                                                    .build(BookHttpService.class);1.
2.
3.
4.
5.
6.
7.

切换客户端

 EasyHttp.builder()
         .url("127.0.0.1:8888")
         .client(ApacheHttpClient.getInstance())
         .build(BookHttpService.class);1.
2.
3.
4.

分类

Java

标签

Java

HTTP

已于2020-8-31 17:26:55修改

51CTO

51CTO博客

51CTO学堂

一个基于接口和注解的Java HTTP客户端

订阅鸿蒙技术特刊，精选内容抢先看