lucky-httpclient模块与SpringBoot整合
🍀 简介
lucky-httpclient-spring-boot-starter用于整合lucky-httpclient和springboot，提供了HTTP接口自动扫描自动注册的功能，以及提供了一些可配置的参数方便开发者能
更方便的使用lucky-httpclient。
项目Github地址：https://github.com/lucklike/lucky-spring/tree/1.0.0/lucky-httpclient-spring-boot-starter
⚙️ 安装
🪶 Maven
在项目的pom.xml的dependencies中加入以下内容:
<dependency>
<groupId>io.github.lucklike</groupId>
<artifactId>lucky-httpclient-spring-boot-starter</artifactId>
<version>1.0.0</version>
</dependency>
🐘 Gradle
implementation group: 'io.github.lucklike', name: 'lucky-httpclient-spring-boot-starter', version: '1.0.0'
🏄♂️ 开始使用
一、在SpingBoot的启动类上添加
@EnableLuckyHttpClient注解来开启lucky-httpclient的注解开发功能
import io.github.lucklike.httpclient.EnableLuckyHttpClient;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
/*
添加@EnableLuckyHttpClient注解来开启lucky-httpclient的注解开发的功能
*/
@EnableLuckyHttpClient
@SpringBootApplication
public class SpringbootTestApplication {
public static void main(String[] args) {
SpringApplication.run(SpringbootTestApplication.class, args);
}
}
//----------------------------------------------------------------
// @EnableLuckyHttpClient注解的介绍
//----------------------------------------------------------------
/**
* lucky-httpclient自动导入注解
*
* @author fukang
* @version 1.0.0
* @date 2023/8/30 01:45
*/
@Target({ElementType.TYPE, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Import({LuckyHttpAutoConfiguration.class, LuckyHttpClientImportBeanDefinitionRegistrar.class})
public @interface EnableLuckyHttpClient {
/**
* 配置需要扫描的包，不做任何配置时默认扫描classpath下所有包中的class
*/
@AliasFor("basePackages")
String[] value() default {};
/**
* 配置需要扫描的包，不做任何配置时默认扫描classpath下所有包中的class
*/
@AliasFor("value")
String[] basePackages() default {};
/**
* 配置一些基本类，使用这些类的包名作为扫描包进行扫描
*/
Class<?>[] basePackageClasses() default {};
/**
* Http接口代理对象是依赖{@link HttpClientProxyObjectFactory}来生成的，这里需要配置这个Bean的名称
*/
String proxyFactoryName() default PROXY_FACTORY_BEAN_NAME;
/**
* 是否启用Cglib代码方法，默认使用Jdk的代码方式
*/
boolean useCglibProxy() default false;
}
二、创建HTTP接口，并使用
@HttpClient注解进行标注(lucky底层会识别@HttpClient注解，并会为所有被注解的接口生成代理对象之后注入到Spring容器中)
/**
* 高德开放平台API
*
* @author fukang
* @version 1.0.0
* @date 2023/8/30 05:32
*/
@PrintLog
@HttpClient("#{gaoDeApi}")
public interface GaoDeApi {
@ResultSelect(key="@resp.lives1", defaultValue = "#{new ArrayList()}")
@Get("/{version}/weather/weatherInfo")
Object queryWeather(String city);
@ResultSelect("@resp.data.paths")
@Get("/v4/direction/bicycling")
Object bicycling(String origin, String destination);
@ResultSelect("@resp.geocodes[0].location")
@Get("/{version}/geocode/geo")
Future<String> getGeocode(String address);
}
三、在其他Spring组件中导入HTTP组件进行使用
package com.springboot.testdemo.springboottest.controller;
import com.luckyframework.async.EnhanceFuture;
import com.luckyframework.common.StopWatch;
import com.springboot.testdemo.springboottest.api.GaoDeApi;
import lombok.AllArgsConstructor;
import org.springframework.context.ApplicationContext;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@AllArgsConstructor
@RestController
public class LuckyHttpClientController {
private static final EnhanceFuture<String> enhanceFuture = new EnhanceFuture<>();
private final GaoDeApi gaoDeApi;
@GetMapping("weather")
public Object call(String city) {
StopWatch sw = new StopWatch();
sw.start("http");
Object result = gaoDeApi.queryWeather(city);
sw.stopWatch();
System.out.println(sw.prettyPrintMillis());
return result;
}
@GetMapping("bicycling")
public Object bicycling(String origin, String destination){
enhanceFuture.addFuture("origin", gaoDeApi.getGeocode(origin));
enhanceFuture.addFuture("destination", gaoDeApi.getGeocode(destination));
Object bicycling = gaoDeApi.bicycling(enhanceFuture.getTaskResult("origin"), enhanceFuture.getTaskResult("destination"));
enhanceFuture.clearTasks();
return bicycling;
}
}
🪛 常用配置
-
spring.lucky.http-client.connection-timeout
设置连接超时时间 -
spring.lucky.http-client.read-timeout
设置读超时时间 -
spring.lucky.http-client.write-timeout
设置写超时时间 -
spring.lucky.http-client.header-params
设置公共请求头参数，支持给指定接口配置特有的参数spring: lucky: http-client: #公共请求头参数 header-params: # 使用"[全类名]"的写法可以为接口配置特有的参数 "[com.springboot.testdemo.springboottest.api.GaoDeApi]": gaoDe-header: 高德API特有的参数 # 所有HTTP接口公用的请求头参数 Cookie: - c1=12345666 - c2=token-uuidm -
spring.lucky.http-client.http-executor-factory
设置HTTP执行器工厂的类的全类名spring: lucky: http-client: # 设置SpEL运行时环境工厂的类的全类名 http-executor-factory: io.github.lucklike.httpclient.config.impl.OkHttpExecutorFactory -
spring.lucky.http-client.query-params
设置公共URL参数，支持给指定接口配置特有的参数 -
spring.lucky.http-client.path-params
设置公共URL占位符'{}'参数，支持给指定接口配置特有的参数 -
spring.lucky.http-client.form-params
设置公共表单参数，支持给指定接口配置特有的参数 -
spring.lucky.http-client.resource-param
设置公共文件资源参数，支持给指定接口配置特有的参数 -
spring.lucky.http-client.thread-pool-param.core-pool-size
设置执行异步调用的线程池参数：核心线程数 -
spring.lucky.http-client.thread-pool-param.maximum-pool-size
设置执行异步调用的线程池参数：最大线程数 -
spring.lucky.http-client.thread-pool-param.blocking-queue-size
设置执行异步调用的线程池参数：阻塞队列的长度 -
spring.lucky.http-client.thread-pool-param.keep-alive-time
设置执行异步调用的线程池参数：保活时间，空闲等待时间 -
spring.lucky.http-client.thread-pool-param.name-format
设置执行异步调用的线程池参数：线程名格式 -
spring.lucky.http-client.thread-pool-param.blocking-queue-factory
设置执行异步调用的线程池参数：设置阻塞队列的工厂的全类名 -
spring.lucky.http-client.thread-pool-param.rejected-execution-handler-factory
设置执行异步调用的线程池参数：设置拒绝策略的工厂的全类名 -
spring.lucky.http-client.expression-params
配置SpEL表达式参数，这里配置的参数可以在lucky-httpclient中支持SpEL表达式的注解中直接使用。spring: lucky: http-client: #SpEL表达式参数，例如：在进行如下配置后使用@HttpClient("#{gaoDeApi}")，便可以直接获取到值 'https://restapi.amap.com' expression-params: userModel: http://localhost:8080/users gaoDeApi: https://restapi.amap.com mirrors: https://mirrors.sohu.com -
spring.lucky.http-client.spring-el-package-imports
向SpEL运行时环境中导包，导入后在SpEL表达式中使用包中的类时便可以不用使用全类名，直接使用类名即可.spring: lucky: http-client: #向SpEL运行时环境导入的包， #导入前创建ArrayList实例(#{new java.util.ArrayList()}) #导入后创建ArrayList实例(#{new ArrayList()}) spring-el-package-imports: - java.util -
spring.lucky.http-client.object-creator-factory
设置对象创建器工厂的类的全类名spring: lucky: http-client: # 设置对象创建器工厂的类的全类名 object-creator-factory: io.github.lucklike.httpclient.config.impl.BeanObjectCreatorFactory -
spring.lucky.http-client.spring-el-runtime-factory
设置SpEL运行时环境工厂的类的全类名spring: lucky: http-client: # 设置SpEL运行时环境工厂的类的全类名 spring-el-runtime-factory: io.github.lucklike.httpclient.config.impl.BeanSpELRuntimeFactoryFactory -
spring.lucky.http-client.http-exception-handle-factory
设置异常处理器工厂的类的全类名spring: lucky: http-client: # 设置异常处理器工厂的类的全类名 http-exception-handle-factory: io.github.lucklike.httpclient.config.impl.DefaultHttpExceptionHandleFactory -
spring.lucky.http-client.request-after-processors-factory
设置请求处理器工厂的类的全类名spring: lucky: http-client: # 设置请求处理器工厂的类的全类名 request-after-processors-factory: io.github.lucklike.httpclient.config.impl.PrintLogProcessorFactory -
spring.lucky.http-client.response-after-processors-factory
设置响应处理器工厂的类的全类名spring: lucky: http-client: # 设置响应处理器工厂的类的全类名 response-after-processors-factory: io.github.lucklike.httpclient.config.impl.PrintLogProcessorFactory
1293
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
