自定義feignClient的常見坑及解決
自定義feignClient的常見坑
自定義feignClient 踩過的坑,因為spring cloud 需要spring 4 以上的版本,所以對于低版本工程想要使用feign就需要自定義,在定義過程中遇到了很多問題,整理總結一下。(有需要的結合github請慢慢看,真的是手寫的,但是有些東西不能全部粘貼出來抱歉了,全部的代碼放在 第四點里面)
整體的過程分為兩個部分:
- 一、從eureka上拉取服務地址,
- 二、feignClient 發(fā)送請求到目標服務器(其實feignClient 最終是使用httpClient 發(fā)送一個rest的請求,這就是官網給出httpclient和feign-okhttp的原因,這里使用okthhp 因為需要支持path請求)。
一、從eureka上拉取相關服務的配置信息
這里使用的是加載eureka的默認配置,初始化時使用單例。代碼如下
1,2的目的是加載項目中的配置,常量定義如下
private static final String CLIENT_CONFIG_FILE_NAME = "eureka"; private static final String CLIENT_RIBBON_CONFIG_FILE_NAME = "ribbon";
resource下定義兩個文件:eureka.properties和ribbon.properties (名稱可以需要改動),內容是聲明服務必要的配置,具體配置如下:

ribbon.properties
aa.ribbon.DeploymentContextBasedVipAddresses=aa //aa 為feign中使用的服務名稱 aa.ribbon.NIWSServerListClassName=com.netflix.niws.loadbalancer.DiscoveryEnabledNIWSServerList //服務調用策略,輪詢等 aa.ribbon.ServerListRefreshInterval=60000 //客戶端請求eureka 刷新aa 服務節(jié)點列表時間 ribbon.ConnectTimeout=50000000 //服務的超時時間 ribbon.ReadTimeout=50000000 eureka.properties eureka.registration.enabled=false //服務是否注冊到eureka上 eureka.serviceUrl.default=http://discovery.ingageapp.com:9401/eureka //eureka地址 #eureka.preferSameZone=true(其余可以百度下cans參數太多不一一列舉 #eureka.shouldUseDns=false
具體代碼如下,看下代碼的具體解釋:
1,2兩步分別shi是加載ribbon和eureka配置,
3 通過DiscoveryManager加載配置信息。
private XsyServiceLocator() {
try {
ConfigurationManager.loadCascadedPropertiesFromResources(CLIENT_RIBBON_CONFIG_FILE_NAME); //1
ConfigurationManager.loadCascadedPropertiesFromResources(CLIENT_CONFIG_FILE_NAME); //2
} catch (IOException e) {
throw new IllegalStateException("Xsy client config load error! Please check your client.properties");
}
DiscoveryManager.getInstance().initComponent(new MyDataCenterInstanceConfig(), new DefaultEurekaClientConfig()); //3
}
二、feignClient 發(fā)送請求到目標服務器
1,2兩步是自定義了一個@FeignClient 注解,通過傳經來的class拿去請求的服務名稱即serviceId(如果你不會這個我也沒辦法了,略有尷尬)
3 Feign.builder() .client(new RibbonClient(new OkhttpClient())) (其實feign的負載均衡,發(fā)送請求都是通過ribbon完成的)
這里是初始化ribbonClient,最后的restclient 用的是okhttpclient。
4,5是用來編碼和解碼 (不要用goson的那個有坑)
6 是用來記錄log的 關于log這個 ,feign默認打印的是debug級別的這個是因為他在代碼里面寫死的可以重寫feign的Slf4jLogger類修改。
7 是設置log級別(具體哪些級別打印什么東西,自己搜下吧)
8 FeignInterceptor 是將一些請求header向下傳遞的(實現RequestInterceptor 接口重寫即可)
9 拼接參數發(fā)送信息 拼接完 請求是 "http://aa(服務名稱)/info (最后會根據eureka上的服務名稱拼接成對應的ip+端口號,他自己底層實現的)
public <T> T lookup(Class<T> clazz) {
FeignClient feignClient = clazz.getAnnotation(FeignClient.class);// 1
String serviceId = feignClient.value();//2
T service = Feign.builder()
.client(new RibbonClient(new OkhttpClient()))//3
.encoder(new JacksonEncoder)//4
.decoder(new JacksonDecoder)//5
.logger(logger)//6
.logLevel(Logger.Level.HEADERS)//7
.requestInterceptor(new FeignInterceptor())//8
.target(clazz, "http://" + serviceId);//9
return service;
}
三、一些坑
1.源碼的坑,實現過程中發(fā)現ribbon的配置并未生效,是因為feign-core源碼問題,他總是會new一個 config 然后傳進去,所以你得配置是無效的,這里重寫(整個ribbonClient包copy下來改掉然后引用自己的)


2 這個類好像也是有問題的(忘記了)

四 、以下是現有全部的代碼粘貼出來看一下
public class XsyServiceLocator {
private static final String CLIENT_CONFIG_FILE_NAME = "eureka";
private static final Object synRoot = new Object();
private static final String CLIENT_CONFIG_CUSTOM_FILED_NAME = "eureka.name";
private static final String CLIENT_RIBBON_CONFIG_FILE_NAME = "ribbon";
private static final JacksonEncoder jacksonEncoder = new JacksonEncoder();
private static final JacksonDecoder jacksonDecoder = new JacksonDecoder();
private static final RibbonClient ribbonClient = new RibbonClient(new OkHttpClient());
private static String ipAddress = null;
private static boolean isLoadEureka = true;//為true表示需要加載默認eureka 配置文件如 crm,false則加載自定義eureka配置文件如paas-aggregator-service
private static XsyFeignLogger logger = null;
private XsyServiceLocator() {
try {
ConfigurationManager.loadCascadedPropertiesFromResources(CLIENT_RIBBON_CONFIG_FILE_NAME);
ConfigurationManager.loadCascadedPropertiesFromResources(CLIENT_CONFIG_FILE_NAME);
Object eurekaName = ConfigurationManager.getConfigInstance().getProperty(CLIENT_CONFIG_CUSTOM_FILED_NAME);
if (eurekaName != null) {
isLoadEureka = false;
}
} catch (IOException e) {
throw new IllegalStateException("Xsy client config load error! Please check your client.properties");
}
while (isLoadEureka && ipAddress == null) {
DiscoveryManager.getInstance().initComponent(new MyDataCenterInstanceConfig(), new DefaultEurekaClientConfig());
ipAddress = DiscoveryManager.getInstance().getEurekaInstanceConfig().getIpAddress();
}
}
public <T> T lookup(Class<T> clazz) {
if (isLoadEureka && ipAddress == null) {
DiscoveryManager.getInstance().initComponent(new MyDataCenterInstanceConfig(), new DefaultEurekaClientConfig());
ipAddress = DiscoveryManager.getInstance().getEurekaInstanceConfig().getIpAddress();
}
FeignClient feignClient = clazz.getAnnotation(FeignClient.class);
String serviceId = feignClient.value();
if(logger == null){
synchronized (synRoot){
if(logger == null){
logger = new XsyFeignLogger(clazz);
}
}
}
T service = Feign.builder()
.client(ribbonClient)
.encoder(jacksonEncoder)
.decoder(jacksonDecoder)
.logger(logger)
.logLevel(Logger.Level.HEADERS)
.requestInterceptor(new FeignInterceptor())
.target(clazz, "http://" + serviceId);
return service;
}
feignClient的使用
服務提供端代碼
@FeignClient(contextId = "remoteUserService", value = ServiceNameConstants.UPMS_SERVICE)
public interface RemoteUserService {
/**
* 通過用戶名查詢用戶、角色信息
*
* @param username 用戶名
* @param from 調用標志
* @return R
*/
@GetMapping("/user/info/{username}")
R<UserInfo> info(@PathVariable("username") String username
, @RequestHeader(SecurityConstants.FROM) String from);
}
@GetMapping("/user/info/{username}") 是服務Controller包中的(@Inner注解代表內部方法,不用權限直接調用,不會被網管攔截)
/**
* 獲取指定用戶全部信息
*
* @return 用戶信息
*/
@Inner
@GetMapping("/info/{username}")
public R info(@PathVariable String username) {
SysUser user = userService.getOne(Wrappers.<SysUser>query()
.lambda().eq(SysUser::getUsername, username));
if (user == null) {
return R.failed(null, String.format("用戶信息為空 %s", username));
}
return R.ok(userService.findUserInfo(user));
}
服務調用端
(SecurityConstants.FROM_IN是系統(tǒng)內部服務調用的一個標識 值為IN)
@Slf4j
@AllArgsConstructor
public class HzUserDetailsServiceImpl implements HzUserDetailsService {
private final RemoteUserService remoteUserService;
private final CacheManager cacheManager;
/**
* 用戶密碼登錄
*
* @param username 用戶名
* @return
* @throws UsernameNotFoundException
*/
@Override
@SneakyThrows
public UserDetails loadUserByUsername(String username) {
Cache cache = cacheManager.getCache(CacheConstants.USER_DETAILS);
if (cache != null && cache.get(username) != null) {
return (HzUser) cache.get(username).get();
}
R<UserInfo> result = remoteUserService.info(username, SecurityConstants.FROM_IN);
UserDetails userDetails = getUserDetails(result);
cache.put(username, userDetails);
return userDetails;
}
}
以上為個人經驗,希望能給大家一個參考,也希望大家多多支持腳本之家。

