当前位置：首页 > article >正文

UniHttp框架直接对接第三方Http接口

article 2024/10/23 9:22:20

引入依赖

<dependency>
  <groupId>io.github.burukeyou</groupId>
  <artifactId>uniapi-http</artifactId>
  <version>0.0.4</version>
</dependency>

编写接口

package com.hdx.contractor.util;

import com.burukeyou.uniapi.http.annotation.HttpApi;
import com.burukeyou.uniapi.http.annotation.param.BodyJsonPar;
import com.burukeyou.uniapi.http.annotation.param.HeaderPar;
import com.burukeyou.uniapi.http.annotation.param.QueryPar;
import com.burukeyou.uniapi.http.annotation.request.GetHttpInterface;
import com.burukeyou.uniapi.http.annotation.request.PostHttpInterface;
import com.burukeyou.uniapi.http.core.response.HttpResponse;
import com.hdx.contractor.business.dto.VideoDTO;

@HttpApi(url = "http://localhost:7001/test")
public interface TestHttpApi {

    @GetHttpInterface("/getUser")
    HttpResponse<String> getUser(@QueryPar("name") String param, @HeaderPar("userId") Integer id);

    @PostHttpInterface("/addUser")
    HttpResponse<String> addUser(@BodyJsonPar VideoDTO req);

}

声明定义的HttpAPI的包扫描路径，在spring的配置类上使用@UniAPIScan注解标记定义的@HttpAPI的包扫描路径,会自动为标记了@HttpApi接口生成代理对象并且注入到Spring容器中，之后只需要像使用Spring的其他bean一样，依赖注入使用即可

@UniAPIScan("com.hdx.contractor.util")
@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class,args);
    }
}

依赖注入使用

    @Resource
    TestHttpApi testHttpApi;
    
    @GetMapping(value = "/queryApi")
    public String testApi(){
        HttpResponse<String> test = testHttpApi.getUser("test", 1);
        return test.getContentType();
    }

知识点

@QueryPar 表示将参数值放到Http请求的查询参数内
@HeaderPar 表示将参数值放到Http请求的请求头里
@BodyJsonPar 表示将参数值放到Http请求body内，并且content-type是application/json（序列化和反序列化默认用的是fastjson，所以如果想指定别名，可以在字段上标记 @JSONField 注解取别名）
@PathPar注解标记Http请求路径变量参数，仅支持标记普通值类型
@CookiePar注解用于标记Http请求的cookie请求头
@BodyFormPar注解用于标记Http请求体内容为普通表单形式: 对应content-type为 application/x-www-form-urlencoded
@BodyMultiPartPar注解用于标记Http请求体内容为复杂形式: 对应content-type为 multipart/form-data
@BodyBinaryPar注解用于标记Http请求体内容为二进制形式: 对应content-type为 application/octet-stream

@ComposePar注解（这个注解本身不是对Http请求内容的配置，仅用于标记一个对象，然后会对该对象内的所有标记了其他@Par注解的字段进行嵌套解析处理，目的是减少方法参数数量，支持都内聚到一起传递）

@PostHttpInterface
HttpResponse<String> getUser(@ComposePar UserDTO req);

public class UserDTO {

    @QueryPar
    private String id;

    @HeaderPar
    private String name;

    @BodyJsonPar
    private AddDTO req;

    @CookiePar
    private String cook;
}