spring-boot项⽬最优雅的http客户端⼯具，⽤它就够了，太⾹
了!
⼤家都知道okhttp是⼀款由公司开源的java版本http客户端⼯具。实际上，公司还开源了基于okhttp进⼀步封装的⼯具，⽤来⽀持通过接⼝的⽅式发起http请求。如果你的项⽬中还在直接使⽤RestTemplate或者okhttp，或者基于它们封装的HttpUtils，那么你可以尝试使⽤Retrofit。
retrofit-spring-boot-starter实现了Retrofit与spring-boot框架快速整合，并且⽀持了部分功能增强，从⽽极⼤的简化spring-boot项⽬下http接⼝调⽤开发。接下来我们直接通过retrofit-spring-boot-starter，来看看spring-boot项⽬发送http请求有多简单。
retrofit官⽅并没有提供与spring-boot快速整合的starter。retrofit-spring-boot-starter是笔者封装的，已在⽣产环境使⽤，⾮常稳定。造轮⼦不易，跪求各位⼤佬star。
项⽬源码：
引⼊依赖
<dependency>
<groupId>com.github.lianjiatech</groupId>
<artifactId>retrofit-spring-boot-starter</artifactId>
<version>2.0.2</version>
</dependency>
复制代码
配置@RetrofitScan注解
你可以给带有 @Configuration 的类配置@RetrofitScan，或者直接配置到spring-boot的启动类上，如下：
@SpringBootApplication
@RetrofitScan("com.fit.st")
public class RetrofitTestApplication {
public static void main(String[] args) {
SpringApplication.run(RetrofitTestApplication.class, args);
}
}
复制代码
定义http接⼝
接⼝必须使⽤@RetrofitClient注解标记！http相关注解可参考官⽅⽂档：。
@RetrofitClient(baseUrl = "${test.baseUrl}")
public interface HttpApi {
@GET("person")
Result<Person> getPerson(@Query("id") Long id);
}
复制代码
注⼊使⽤
将接⼝注⼊到其它Service中即可使⽤。
@Service
public class TestService {
@Autowired
private HttpApi httpApi;
public void test() {
// 通过httpApi发起http请求
}
}
复制代码
只要通过上述⼏个步骤，就能实现通过接⼝发送http请求了，真的很简单。如果你在spring-boot项⽬⾥⾯使⽤过mybatis，相信你对这种使⽤⽅式会更加熟悉。接下来我们继续介绍⼀下retrofit-spring-boot-starter更⾼级⼀点的功能。
注解式
很多时候，我们希望某个接⼝下的某些http请求执⾏统⼀的拦截处理逻辑。这个时候可以使⽤注解式。使⽤的步骤主要分为2步：
1. 继承BasePathMatchInterceptor编写拦截处理器；
springboot中文2. 接⼝上使⽤@Intercept进⾏标注。
下⾯以给指定请求的url后⾯拼接timestamp时间戳为例，介绍下如何使⽤注解式。
继承BasePathMatchInterceptor编写拦截处理器
@Component
public class TimeStampInterceptor extends BasePathMatchInterceptor {
@Override
public Response doIntercept(Chain chain) throws IOException {
Request request = quest();
HttpUrl url = request.url();
long timestamp = System.currentTimeMillis();
HttpUrl newUrl = wBuilder()
.addQueryParameter("timestamp", String.valueOf(timestamp))
.build();
Request newRequest = wBuilder()
.url(newUrl)
.
build();
return chain.proceed(newRequest);
}
}
复制代码
接⼝上使⽤@Intercept进⾏标注
@RetrofitClient(baseUrl = "${test.baseUrl}")
@Intercept(handler = TimeStampInterceptor.class, include = {"/api/**"}, exclude = "/api/test/savePerson")
public interface HttpApi {
@GET("person")
Result<Person> getPerson(@Query("id") Long id);
@POST("savePerson")
Result<Person> savePerson(@Body Person person);
}
复制代码
上⾯的@Intercept配置表⽰：拦截HttpApi接⼝下/api/**路径下（排除/api/test/savePerson）的请求，拦截处理器使
⽤TimeStampInterceptor。
扩展注解式
有的时候，我们需要在拦截注解动态传⼊⼀些参数，然后再执⾏拦截的时候需要使⽤这个参数。这种时候，我们可以扩展实现⾃定义拦截注解。⾃定义拦截注解必须使⽤@InterceptMark标记，并且注解中必须包括include()、exclude()、handler()属性信息。使⽤的步骤主要分为3步：
1. ⾃定义拦截注解
2. 继承BasePathMatchInterceptor编写拦截处理器
3. 接⼝上使⽤⾃定义拦截注解；
例如我们需要在请求头⾥⾯动态加⼊accessKeyId、accessKeySecret签名信息才能正常发起http请求，这个时候可以⾃定义⼀个加签注解@Sign来实现。下⾯以⾃定义@Sign拦截注解为例进⾏说明。
⾃定义@Sign注解
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@InterceptMark
public @interface Sign {
/**
* 密钥key
* ⽀持占位符形式配置。
*
* @return
*/
String accessKeyId();
/**
* 密钥
* ⽀持占位符形式配置。
*
* @return
*/
String accessKeySecret();
/**
* 匹配路径
*
* @return
*/
String[] include() default {"/**"};
/**
* 排除匹配，排除指定路径拦截
*
* @return
*/
String[] exclude() default {};
/**
* 处理该注解的类
* 优先从spring容器获取对应的Bean，如果获取不到，则使⽤反射创建⼀个！
*
* @return
*/
Class<? extends BasePathMatchInterceptor> handler() default SignInterceptor.class; }
复制代码
扩展⾃定义拦截注解有以下2点需要注意：
1. ⾃定义拦截注解必须使⽤@InterceptMark标记。
2. 注解中必须包括include()、exclude()、handler()属性信息。
实现SignInterceptor
@Component
public class SignInterceptor extends BasePathMatchInterceptor {
private String accessKeyId;
private String accessKeySecret;
public void setAccessKeyId(String accessKeyId) {
this.accessKeyId = accessKeyId;
}
public void setAccessKeySecret(String accessKeySecret) {
this.accessKeySecret = accessKeySecret;
}
@Override
public Response doIntercept(Chain chain) throws IOException {
Request request = quest();
Request newReq = wBuilder()
.addHeader("accessKeyId", accessKeyId)
.addHeader("accessKeySecret", accessKeySecret)
.build();
return chain.proceed(newReq);
}
}
复制代码
上述accessKeyId和accessKeySecret字段值会依据@Sign注解的accessKeyId()和accessKeySecret()值⾃动注⼊，如果@Sign指定的是占位符形式的字符串，则会取配置属性值进⾏注⼊。另外，accessKeyId和accessKeySecret字段必须提供setter⽅法。
接⼝上使⽤@Sign
@RetrofitClient(baseUrl = "${test.baseUrl}")
@Sign(accessKeyId = "${test.accessKeyId}", accessKeySecret = "${test.accessKeySecret}", exclude = {"/api/test/person"})
public interface HttpApi {
@GET("person")
Result<Person> getPerson(@Query("id") Long id);
@POST("savePerson")
Result<Person> savePerson(@Body Person person);
}
复制代码
这样就能在指定url的请求上，⾃动加上签名信息了。
连接池管理
默认情况下，所有通过Retrofit发送的http请求都会使⽤max-idle-connections=5 keep-alive-second=300的默认连接池。当然，我们也可以在配置⽂件中配置多个⾃定义的连接池，然后通过@RetrofitClient的poolName属性来指定使⽤。⽐如我们要让某个接⼝下的请求全部使
⽤poolName=test1的连接池，代码实现如下：
1. 配置连接池。

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。