自定義feignClient的常見坑及解決
自定義feignClient的常見坑
自定義feignClient 踩過的坑,因為spring cloud 需要spring 4 以上的版本,所以對于低版本工程想要使用feign就需要自定義,在定義過程中遇到了很多問題,整理總結(jié)一下。(有需要的結(jié)合github請慢慢看,真的是手寫的,但是有些東西不能全部粘貼出來抱歉了,全部的代碼放在 第四點里面)
整體的過程分為兩個部分:
- 一、從eureka上拉取服務(wù)地址,
- 二、feignClient 發(fā)送請求到目標(biāo)服務(wù)器(其實feignClient 最終是使用httpClient 發(fā)送一個rest的請求,這就是官網(wǎng)給出httpclient和feign-okhttp的原因,這里使用okthhp 因為需要支持path請求)。
一、從eureka上拉取相關(guān)服務(wù)的配置信息
這里使用的是加載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 (名稱可以需要改動),內(nèi)容是聲明服務(wù)必要的配置,具體配置如下:
ribbon.properties
aa.ribbon.DeploymentContextBasedVipAddresses=aa //aa 為feign中使用的服務(wù)名稱 aa.ribbon.NIWSServerListClassName=com.netflix.niws.loadbalancer.DiscoveryEnabledNIWSServerList //服務(wù)調(diào)用策略,輪詢等 aa.ribbon.ServerListRefreshInterval=60000 //客戶端請求eureka 刷新aa 服務(wù)節(jié)點列表時間 ribbon.ConnectTimeout=50000000 //服務(wù)的超時時間 ribbon.ReadTimeout=50000000 eureka.properties eureka.registration.enabled=false //服務(wù)是否注冊到eureka上 eureka.serviceUrl.default=http://discovery.ingageapp.com:9401/eureka //eureka地址 #eureka.preferSameZone=true(其余可以百度下cans參數(shù)太多不一一列舉 #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ā)送請求到目標(biāo)服務(wù)器
1,2兩步是自定義了一個@FeignClient 注解,通過傳經(jīng)來的class拿去請求的服務(wù)名稱即serviceId(如果你不會這個我也沒辦法了,略有尷尬)
3 Feign.builder() .client(new RibbonClient(new OkhttpClient())) (其實feign的負載均衡,發(fā)送請求都是通過ribbon完成的)
這里是初始化ribbonClient,最后的restclient 用的是okhttpclient。
4,5是用來編碼和解碼 (不要用goson的那個有坑)
6 是用來記錄log的 關(guān)于log這個 ,feign默認打印的是debug級別的這個是因為他在代碼里面寫死的可以重寫feign的Slf4jLogger類修改。
7 是設(shè)置log級別(具體哪些級別打印什么東西,自己搜下吧)
8 FeignInterceptor 是將一些請求header向下傳遞的(實現(xiàn)RequestInterceptor 接口重寫即可)
9 拼接參數(shù)發(fā)送信息 拼接完 請求是 "http://aa(服務(wù)名稱)/info (最后會根據(jù)eureka上的服務(wù)名稱拼接成對應(yīng)的ip+端口號,他自己底層實現(xiàn)的)
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.源碼的坑,實現(xiàn)過程中發(fā)現(xiàn)ribbon的配置并未生效,是因為feign-core源碼問題,他總是會new一個 config 然后傳進去,所以你得配置是無效的,這里重寫(整個ribbonClient包copy下來改掉然后引用自己的)
2 這個類好像也是有問題的(忘記了)
四 、以下是現(xiàn)有全部的代碼粘貼出來看一下
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的使用
服務(wù)提供端代碼
@FeignClient(contextId = "remoteUserService", value = ServiceNameConstants.UPMS_SERVICE) public interface RemoteUserService { /** * 通過用戶名查詢用戶、角色信息 * * @param username 用戶名 * @param from 調(diào)用標(biāo)志 * @return R */ @GetMapping("/user/info/{username}") R<UserInfo> info(@PathVariable("username") String username , @RequestHeader(SecurityConstants.FROM) String from); } @GetMapping("/user/info/{username}") 是服務(wù)Controller包中的(@Inner注解代表內(nèi)部方法,不用權(quán)限直接調(diào)用,不會被網(wǎng)管攔截) /** * 獲取指定用戶全部信息 * * @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)); }
服務(wù)調(diào)用端
(SecurityConstants.FROM_IN是系統(tǒng)內(nèi)部服務(wù)調(diào)用的一個標(biāo)識 值為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; } }
以上為個人經(jīng)驗,希望能給大家一個參考,也希望大家多多支持腳本之家。
相關(guān)文章
SpringCloud 服務(wù)網(wǎng)關(guān)路由規(guī)則的坑及解決
這篇文章主要介紹了SpringCloud 服務(wù)網(wǎng)關(guān)路由規(guī)則的坑及解決方案,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2021-07-07Java實戰(zhàn)角色權(quán)限后臺腳手架系統(tǒng)的實現(xiàn)流程
只學(xué)書上的理論是遠遠不夠的,只有在實戰(zhàn)中才能獲得能力的提升,本篇文章手把手帶你用java+Springboot+Maven+myBaits-Plus+Vue+Element-UI+Mysql實現(xiàn)一個角色權(quán)限后臺腳手架系統(tǒng),大家可以在過程中查缺補漏,提升水平2022-01-01關(guān)于Spring源碼深度解析(AOP功能源碼解析)
這篇文章主要介紹了關(guān)于Spring源碼深度解析(AOP功能源碼解析),具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2023-07-07Java異常的幾個謎題_動力節(jié)點Java學(xué)院整理
本文給大家收藏整理java異常的幾個謎題,非常不錯,具有參考借鑒價值,需要的朋友參考下吧2017-06-06Spring CGLlB動態(tài)代理實現(xiàn)過程解析
這篇文章主要介紹了Spring CGLlB動態(tài)代理實現(xiàn)過程解析,文中通過示例代碼介紹的非常詳細,對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下2019-10-10spring?boot+vue實現(xiàn)JSAPI微信支付的完整步驟
JSAPI支付是用戶在微信中打開商戶的H5頁面,商戶在H5頁面通過調(diào)用微信支付提供的JSAPI接口調(diào)起微信支付模塊完成支付,下面這篇文章主要給大家介紹了關(guān)于spring?boot+vue實現(xiàn)JSAPI微信支付的相關(guān)資料,需要的朋友可以參考下2022-05-05