Feign 入门，注解篇

发布于 更新于

技术文章接口测试

在定义接口时，需要使用Feign接口注解定义Http请求类型、请求头、请求体、请求参数等等。

在定义接口时，需要使用Feign接口注解定义Http请求类型、请求头、请求体、请求参数等等。

注解

类型

说明

@RequestLine

Method

定义其请求方式和请求路径（UriTemplate）。请求路径以斜杠开始，中间可以使用{变量名称}，表达式的值由@Param注解提供。

@Param

Parameter

定义变量模板，可通过表达式{变量名称}引用变量的值。

@Headers

Method, Type

定义请求头，可以使用{变量名称}，表达式的值由@Param注解提供。

@QueryMap

Parameter

定义Map或者POJO类型参数。

@HeaderMap

Parameter

定义Map类型的请求头。

@Body

Method

对@Param扩展，配合@Headers使用可定义JSON、xml类型参数。

例子：

//请求方式POST，请求路径/user/formPost
@RequestLine("POST /user/formPost")
//请求头表单提交方式
@Headers("Content-Type: application/x-www-form-urlencoded;charset=UTF-8")
//参数格式name1=value1&name2=value2，参数值由@Param对应提供
@Body("username={username}&password={password}")
String formPost(@Param("username") String username, @Param("password") String password);
//请求方式GET 请求路径/user/formGet?name1=value1&name2=value2，参数值由@Param对应提供
@RequestLine("GET /user/formGet?username={username}&password={password}")
String formGet(@Param("username") String username, @Param("password") String password);

//请求方式GET 请求路径/find，参数值由@QueryMap 提供，自动添加到uri后面
@RequestLine("GET /find")
String find(@QueryMap Map<String, Object> queryMap);

Feign.builder() API介绍。

  1. target() 指定接口类型和URL地址返回接口Http代理对象，从而通过代理对象调用方法发送HTTP请求。 除了target方法之外，还有一些可选方法。如下：

  2. client() Feign 在默认情况下使用的是 JDK 原生的 URLConnection 发送HTTP请求，通过client方法可配置其他HTTP客户端，如HttpClient、OkHttpClient、Http2Client等。

  3. options() 指定连接超时时长及响应超时时长，单位毫秒。

  4. retryer() 指定重试策略，参数分别是最小时间，最大时间，重连次数。

  5. encoder() decoder() 指定编码/解码方式默认是String，可配置Gson、Jackson、Sax等。

  6. logger() logLevel() 指定日志和日志等级，可配置SLF4J等。 注意：如果需要使用Jackson、SLF4J、Gson、Sax、OkHttpClient、Http2Client、HttpClient等需要导入对应坐标。 例子：

LemonApi lemonApi = Feign.builder()
		.client(new OkHttpClient())
		//1000ms连接超时、5000ms响应超时
		.options(new Options(1000, 5000))
		//基础重连时间500ms，最大重连时间5000ms，尝试重连次数3次（每次重连时间在基础上*1.5但不能大于最大重连时间）
		.retryer(new  Retryer.Default(500,5000,3))
		//使用Jackson编码和解码
		.encoder(new JacksonEncoder())
		.decoder(new JacksonDecoder())
		//使用Feign自带日志并输出到项目路径logs/http.log下
		.logger(new Logger.JavaLogger().appendToFile("logs/http.log"))
		//日志级别FULL，记录请求和响应所有信息。
		.logLevel(Logger.Level.FULL)
		//设置请求URL，对LemonApi接口创建HTTP代理类。
		.target(LemonApi.class, "http://localhost:8899");
//使用代理类发起HTTP请求
String formGet = lemonApi.formGet("abc", "123");

来源：testingpai

继续阅读