小米降噪藍(lán)牙耳機(jī)Necklace分享：聽一首歌 讀懂一個(gè)故事
在今天下午的小米Civi 2新品發(fā)布會(huì)上，小米還帶來了一款新的降噪藍(lán)牙耳機(jī)Necklace，我們也在發(fā)布結(jié)束的第一時(shí)間給大家?guī)磉@款耳機(jī)的簡(jiǎn)單分享。現(xiàn)在大家能見到最多的藍(lán)牙耳機(jī)
大家好，我是飄渺。
在上一篇文章中，我們解決了網(wǎng)關(guān)層認(rèn)證后向后端服務(wù)傳遞用戶信息的問題。今天我們來解決另外一個(gè)問題：如何在 OpenFeign 中傳遞 Token，并且保證多線程情況下也能適用。
這是DDD&微服務(wù)系列文章的第34篇，歡迎持續(xù)關(guān)注！
為了方便演示，首先定義一個(gè)接口，在接口中通過 Feign 調(diào)用其他服務(wù)：
@Operation(summary = "用戶測(cè)試接口") @GetMapping("/api/pd/customer/info") public String info() { String currentUser = UserContextHolder.getInstance().getCurrentUser(); log.info("feign調(diào)用方獲取當(dāng)前登錄用戶:" + currentUser); //通過feign調(diào)用遠(yuǎn)程服務(wù) String info = experimentClient.info(); log.info("遠(yuǎn)程獲取用戶:" + info); return currentUser; }然后在遠(yuǎn)程接口中通過上文定義的UserContextHolder對(duì)象獲取用戶信息：
@GetMapping("/api/pd/experiment/info") public String userInfo() { String currentUser = UserContextHolder.getInstance().getCurrentUser(); log.info("feign被調(diào)用方獲取userToken : {} ",currentUser); return currentUser == null ? "" : currentUser; }
圖片
通過調(diào)用結(jié)果可知，當(dāng)使用OpenFeign調(diào)用遠(yuǎn)程服務(wù)時(shí)，接口是無法獲取到用戶 ID 的。
在使用OpenFeign請(qǐng)求其他服務(wù)接口時(shí)，默認(rèn)不攜帶header信息，這樣就導(dǎo)致無法攜帶登錄用戶信息。常規(guī)情況下，我們只需要在使用 OpenFeign 調(diào)用時(shí)先從 Header 獲取 Token 信息，放入新請(qǐng)求即可，在項(xiàng)目中可以定義一個(gè)OpenFeign的攔截器來實(shí)現(xiàn)此功能，代碼如下所示：
public class FeignRequestConfiguration { @Bean public RequestInterceptor requestInterceptor(){ return new RequestInterceptor() { @Override public void apply(RequestTemplate template) { RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes(); ServletRequestAttributes attributes = (ServletRequestAttributes) requestAttributes; // 當(dāng)主線程的請(qǐng)求執(zhí)行完畢后，Servlet容器會(huì)被銷毀當(dāng)前的Servlet，因此在這里需要做判空 if (attributes != null) { HttpServletRequest request = attributes.getRequest(); // 獲取userId 并傳遞 userId String userId = request.getHeader(CommonConstant.X_CLIENT_TOKEN); if (StringUtils.hasText(userId)) { template.header(CommonConstant.X_CLIENT_TOKEN, userId); } } } }; } }經(jīng)過上述配置以后再次調(diào)用即可在 Feign 接口中也獲取到用戶ID，如下圖所示：
圖片
上面是單線程的情況，假如我們?cè)诋?dāng)前線程中又開啟了子線程去進(jìn)行 Feign 調(diào)用，那么是無法從 RequestContextHolder 獲取到 Header 的。測(cè)試代碼如下：
public String info() { String currentUser = UserContextHolder.getInstance().getCurrentUser(); log.info("feign調(diào)用方獲取當(dāng)前登錄用戶:" + currentUser); CompletableFuture<String> infoFuture = CompletableFuture.supplyAsync(experimentClient::info,executor); String info = ""; try{ info = infoFuture.get(); } catch (Exception e) { e.printStackTrace(); throw new RuntimeException(e); } log.info("遠(yuǎn)程獲取用戶:" + info); return currentUser; }在上述代碼中，通過 CompletableFuture 開啟異步線程去調(diào)用 experimentClient ，可以發(fā)現(xiàn)此時(shí)無法獲取到用戶信息，效果如下所示：
圖片
出現(xiàn)上述問題的原因是，RequestContextHolder.getRequestAttributes() 方法里面使用的一個(gè) ThreadLocal，默認(rèn)不是線程共享的，源碼如下：
public static RequestAttributes getRequestAttributes() { RequestAttributes attributes = requestAttributesHolder.get(); if (attributes == null) { attributes = inheritableRequestAttributesHolder.get(); } return attributes; }所以主線程調(diào)用子線程時(shí)，無法獲取到主線程請(qǐng)求里面的 RequestAttributes。
原因已經(jīng)清楚了，繼續(xù)觀察 RequestContextHolder.getRequestAttributes() 方法源碼，注意到如果當(dāng)前線程拿不到 RequestAttributes ，它會(huì)從 inheritableRequestAttributesHolder 里面拿，再仔細(xì)觀察發(fā)現(xiàn)源碼設(shè)置 RequestAttributes 到 ThreadLocal 的時(shí)候有這樣一個(gè)重載方法。
/** * 給當(dāng)前線程綁定屬性 * @param inheritable 是否要將屬性暴露給子線程 */public static void setRequestAttributes(@Nullable RequestAttributes attributes, boolean inheritable) { ......}這看起來符合我們的要求，只需要在主線程調(diào)用其他線程前將 RequestAttributes 對(duì)象設(shè)置為子線程共享，就能把 Header 等信息傳遞下去。
所以，在異步調(diào)用 Feign 接口時(shí)添加如下代碼即可：
RequestContextHolder.setRequestAttributes(RequestContextHolder.getRequestAttributes(),true);CompletableFuture<String> infoFuture = CompletableFuture.supplyAsync(experimentClient::info,executor);......再次執(zhí)行發(fā)現(xiàn)，是可以獲取到 userId 的。
這里使用CompletableFuture異步調(diào)用時(shí)需要使用自定義線程池,而不能使用默認(rèn)線程池ForkJoinPool，這是為什么呢？
雖然可以在異步調(diào)用時(shí)設(shè)置 RequestContextHolder.setRequestAttributes(RequestContextHolder.getRequestAttributes(), true); 可以實(shí)現(xiàn)請(qǐng)求頭透?jìng)?，但是每次調(diào)用都需要加上這一句，實(shí)現(xiàn)上還略顯麻煩。
并且我們知道了獲取不到請(qǐng)求頭的原因是子線程無法獲取主線程的 header 屬性，那么我們只需要定義一個(gè)數(shù)據(jù)結(jié)構(gòu)，使用 InheritableThreadLocal 在內(nèi)存中保存一份 header 屬性即可。在上篇文章中通過網(wǎng)關(guān)進(jìn)行 UserID 透?jìng)鲿r(shí)我們是使用 ThreadLocal 保存數(shù)據(jù)，現(xiàn)在只需要將其換成 InheritableThreadLocal，同時(shí)在 RequestInterceptor#apply() 方法中不再通過請(qǐng)求頭獲取而是直接從 InheritableThreadLocal 中獲取數(shù)據(jù)。
實(shí)現(xiàn)過程如下:
1、重命名并修改數(shù)據(jù)結(jié)構(gòu)：
首先，將 UserContextHolder 重命名為 RequestHeaderHolder，同時(shí)使用 InheritableThreadLocal 替換 ThreadLocal，以便子線程也能獲取數(shù)據(jù)。
public class RequestHeaderHolder { private final ThreadLocal<Map<String,String>> REQUEST_HEADER_HOLDER; //使用InheritableThreadLocal，使得共享變量可被子線程繼承 private RequestHeaderHolder() { this.REQUEST_HEADER_HOLDER = new InheritableThreadLocal<>() { @Override protected Map<String, String> initialValue() { return new HashMap<>(); } }; } public String getCurrentUser(){ return this.REQUEST_HEADER_HOLDER.get().get(CommonConstant.X_CLIENT_TOKEN); } ......}2、修改請(qǐng)求攔截器：
將請(qǐng)求攔截器 UserTokenInterceptor 重命名為 RequestHeaderInterceptor，并將請(qǐng)求頭放入 RequestHeaderHolder 中。
@Slf4jpublic class RequestHeaderInterceptor implements HandlerInterceptor { @Override public boolean preHandle(HttpServletRequest request, @NonNull HttpServletResponse response, @NonNull Object handler) throws Exception { Enumeration<String> headerNames = request.getHeaderNames(); RequestHeaderHolder requestHeaderHolder = RequestHeaderHolder.getInstance(); //重新設(shè)置請(qǐng)求頭 while (headerNames.hasMoreElements()){ String key = headerNames.nextElement(); requestHeaderHolder.set(key,request.getHeader(key)); } return true; } ......}3、修改 Feign 配置類：在 FeignRequestConfiguration 中不再?gòu)?nbsp;RequestContextHolder 獲取數(shù)據(jù)，而是從 RequestHeaderHolder 獲取數(shù)據(jù)。
@Slf4jpublic class FeignRequestConfiguration { @Bean public RequestInterceptor requestInterceptor(){ return template -> { Map<String, String> headerMap = RequestHeaderHolder.getInstance().get(); if(headerMap != null){ headerMap.forEach((key, value) -> { template.header(key, value); }); } }; }}通過上面的改造，不管是同步調(diào)用還是子線程異步調(diào)用都可以直接通過RequestHeaderHolder.getInstance().getCurrentUser();獲取用戶信息，并且調(diào)用方無須做任何改動(dòng)。
本文鏈接：http://www.www897cc.com/showinfo-26-79599-0.htmlSpringCloud微服務(wù)中Feign如何傳遞用戶Token，并保證多線程環(huán)境也可適用？
聲明：本網(wǎng)頁(yè)內(nèi)容旨在傳播知識(shí)，若有侵權(quán)等問題請(qǐng)及時(shí)與本網(wǎng)聯(lián)系，我們將在第一時(shí)間刪除處理。郵件：2376512515@qq.com
上一篇： 你的Css選擇器可視化備忘錄
Copyright ? 2016-2023 天津谷騏科技有限公司 版權(quán)所有 sitemap.xml
違法及侵權(quán)請(qǐng)聯(lián)系：2376512515@qq.com 津ICP備18001702號(hào)
津公網(wǎng)安備 12010102000574號(hào)