SpringCloud通用請求字段攔截處理方法
更新時間：2020年07月08日 09:49:02 作者：清茶豆奶
這篇文章主要介紹了SpringCloud通用請求字段攔截處理,本文通過實例代碼給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下
背景
以SpringCloud構建的微服務系統(tǒng)為例，使用前后端分離的架構，每個系統(tǒng)都會提供一些通用的請求參數(shù)，例如移動端的系統(tǒng)版本信息、IMEI信息，Web端的IP信息，瀏覽器版本信息等，這些參數(shù)可能放在header里，也可以放在參數(shù)里，如果這些參數(shù)需要在每個方法內聲明定義，一來工作量太大，二是這些通用參數(shù)與業(yè)務接口方法耦合過緊，本身就是一個不好的設計。
這個問題該如何優(yōu)雅地解決呢？
最佳實踐
- 利用SpringMVC提供攔截器，對匹配的請求，抽取通用的header信息（假設通用字段全部放在header里）
- 將每個請求的信息單獨隔離開，互不干擾。
- Controller層使用時，可以將在該請求線程(http線程)里將通用的header信息提取出來使用。
- 請求線程完成時，相應的header頭信息對象需要回收銷毀。
- 實現(xiàn)方式SpringMVA提供的HandlerInterceptorAdapter可以拿來使用，繼承實現(xiàn)即可。
- 使用ThreadLocal記錄每個請求的信息，ThreadLocal有隔離線程變量的作用。
HandlerInterceptorAdapter的源碼實現(xiàn)及注釋
public abstract class HandlerInterceptorAdapter implements AsyncHandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
throws Exception {
// 在業(yè)務接口方法處理之前被調用，可以在這里對通用的header信息進行提取
return true;
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
@Nullable ModelAndView modelAndView) throws Exception {
// 這個方法在業(yè)務接口方法執(zhí)行完成后，生成SpringMVC ModelAndView之前被調用
// 今天這個案例我們不用此方法，故可以不實現(xiàn)。
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler,
@Nullable Exception ex) throws Exception {
// 這個方法在DispatcherServlet完全處理完成后被調用，可以在這里對ThreadLocal的內容進行釋放
}
@Override
public void afterConcurrentHandlingStarted(HttpServletRequest request, HttpServletResponse response,
Object handler) throws Exception {
// 這個方法用來處理異步主動，但也會先行調用preHandle，然后執(zhí)行此方法，異步線程完成后會執(zhí)行postHandle和afterCompletion兩方法，這里暫時用不上。
}
}
ThreadLocal的源碼主要實現(xiàn)及注釋
public class ThreadLocal<T> {
protected T initialValue() {
return null;
}
public T get() {
// 獲取當前的線程
Thread t = Thread.currentThread();
ThreadLocalMap map = getMap(t);
if (map != null) {
ThreadLocalMap.Entry e = map.getEntry(this);
if (e != null) {
@SuppressWarnings("unchecked")
T result = (T)e.value;
return result;
}
}
return setInitialValue();
}
private T setInitialValue() {
T value = initialValue();
Thread t = Thread.currentThread();
ThreadLocalMap map = getMap(t);
if (map != null)
map.set(this, value);
else
createMap(t, value);
return value;
}
public void set(T value) {
// 獲取當前的線程
Thread t = Thread.currentThread();
ThreadLocalMap map = getMap(t);
if (map != null)
map.set(this, value);
else
createMap(t, value);
}
public void remove() {
ThreadLocalMap m = getMap(Thread.currentThread());
if (m != null)
m.remove(this);
}
ThreadLocalMap getMap(Thread t) {
return t.threadLocals;
}
void createMap(Thread t, T firstValue) {
t.threadLocals = new ThreadLocalMap(this, firstValue);
}
}
簡單來說，ThreadLocal最關鍵的get()和set()方法，都是針對當前線程來操作的，調用set()方法時把值放到ThreadMap(Map的一種實現(xiàn))中，以當前線程的hash值為key，get()方法則對應以當前線程作為key來取值，從而實現(xiàn)每個線程的數(shù)據(jù)是隔離的效果。
另附上ThreadLocal類源碼解讀的導圖，僅供參考
案例實戰(zhàn)
我們對實際業(yè)務系統(tǒng)進行簡化處理，假定header信息固定有ip，uid，deviceId三個信息，按照上文的實現(xiàn)思路，開始案例演示。
DTO定義
通用的header信息，使用Dto對象進行封裝：
@Data
public class CommonHeader implements Serializable {
private static final long serialVersionUID = -3949488282201167943L;
/**
* 真實ip
*/
private String ip;
/**
* 設備id
*/
private String deviceId;
/**
* 用戶uid
*/
private Long uid;
// 省略getter/setter/構造器
}
定義Request請求的封裝類Dto，并引入ThreadLocal：
/**
* 將公共請求頭信息放在ThreadLocal中去
*/
public class RequestWrap {
private static ThreadLocal<CommonHeader> current = new ThreadLocal<>();
/**
* 獲取靜態(tài)的ThreadLocal對象
* @return
*/
public static ThreadLocal<CommonHeader> getCurrent() {
return current;
}
/**
* 獲取ip
* @return
*/
public static String getIp() {
CommonHeader request = current.get();
if (request == null) {
return StringUtils.EMPTY;
}
return request.getIp();
}
/**
* 獲取uid
* @return
*/
public static Long getUid() {
CommonHeader request = current.get();
if (request == null) {
return null;
}
return request.getUid();
}
/**
* 獲取封裝對象
* @return
*/
public static CommonHeader getCommonReq() {
CommonHeader request = current.get();
if (request == null) {
return new CommonHeader(StringUtils.EMPTY, StringUtils.EMPTY,0L);
}
return request;
}
}
工具類
這里添加一個簡單的工具類，將HttpServletRequest通過getHeader方法，生成CommonHeader類：
public class HttpUtil {
/**
* 獲取請求頭信息
*
* @param request
* @return
*/
public static CommonHeader getCommonHeader(HttpServletRequest request) {
String UID = request.getHeader("uid");
Long uid = null;
if (StringUtils.isNotBlank(UID)) {
uid = Long.parseLong(UID);
}
return new CommonHeader(HttpUtil.getIp(request), request.getHeader("deviceId"), uid);
}
/**
* 獲取IP
*
* @param request
* @return
*/
public static String getIp(HttpServletRequest request) {
String ip = request.getHeader("X-Forwarded-For");
if (null != ip && !"".equals(ip.trim()) && !"unknown".equalsIgnoreCase(ip)) {
int index = ip.indexOf(',');
if (index != -1) {
return ip.substring(0, index);
} else {
return ip;
}
}
ip = request.getHeader("X-Real-IP");
if (null != ip && !"".equals(ip.trim()) && !"unknown".equalsIgnoreCase(ip)) {
return ip;
}
return request.getRemoteAddr();
}
}
攔截器類實現(xiàn)
最核心的實現(xiàn)終于出場了，這里繼承HandlerInterceptorAdapter，這里作了簡化處理：
/**
* 請求頭處理
*
* @author yangfei
*/
@Component
public class BaseInterceptor extends HandlerInterceptorAdapter {
private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(BaseInterceptor.class);
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
throws Exception {
RequestWrap.getThreadLocal().set(HttpUtil.getCommonHeader(request));
return true;
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
ModelAndView modelAndView) throws Exception {
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
throws Exception {
RequestWrap.getThreadLocal().remove();
}
@Override
public void afterConcurrentHandlingStarted(HttpServletRequest request, HttpServletResponse response, Object handler)
throws Exception {
}
}
如上一章節(jié)描述的邏輯，在preHandle方法內將request中的ip,uid,deviceId封裝到RequestWrap對象里，在afterCompletion中對該線程的ThreadLocal值進行釋放。
業(yè)務接口方法的使用
在Controller類的接口方法中，如要獲取uid信息，只需要調用RequestWrap.getUid()方法即可，再也不需要在每個接口上聲明uid參數(shù)了，如下示例：
/**
* 獲取用戶基礎信息
*/
@PostMapping(value = "/user/info")
public Response<UserInfo> getUserInfo() {
return userManager.getUserInfo(RequestWrap.getUid());
}
總結
這個實戰(zhàn)的目標是解決通用header信息的在接口的重復定義問題，基于HandlerInterceptorAdapter攔截器的實現(xiàn)，ThreadLocal對線程訪問數(shù)據(jù)的隔離來實現(xiàn)的，在實際生產項目應用中有很好的借鑒意義，希望對你有幫助。
到此這篇關于SpringCloud通用請求字段攔截處理方法的文章就介紹到這了,更多相關SpringCloud請求字段攔截內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
解決java啟動時報線程占用報錯:Exception?in?thread?“Thread-14“?java.ne
這篇文章主要給大家介紹了關于解決java啟動時報線程占用:Exception?in?thread?“Thread-14“?java.net.BindException:?Address?already?in?use:?bind的相關資料,文中將解決的辦法介紹的非常詳細,需要的朋友可以參考下2023-04-04
大家好，本篇文章主要講的是Java多線程中的Balking模式詳解，感興趣的同學趕快來看一看吧，對你有幫助的話記得收藏一下2022-01-01
這篇文章主要介紹了SpringBoot中的Redis?緩存,本文給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下2022-10-10
這篇文章主要介紹了JVM對象創(chuàng)建和內存分配原理解析,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2020-02-02
本文將對使用MultipartResolver處理文件上傳的步驟，兩種文件下載方式（直接向response的輸出流中寫入對應的文件流、使用 ResponseEntity<byte[]>來向前端返回文件）等進行詳盡介紹，需要的可以參考一下2022-12-12
這篇文章主要介紹了Gradle修改本地倉庫的位置方法實現(xiàn)，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2020-07-07
這篇文章主要介紹了Java中的動態(tài)綁定機制，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2023-06-06
SpringBoot將多個文件夾進行壓縮的兩種方法(瀏覽器下載和另存為)
Spring Boot項目通常不會自動對文件夾進行壓縮,不過,在打包應用時,如果你使用了Maven或Gradle這樣的構建工具,并且配置了相應的插件,可以在打成jar或war包的時候將依賴的庫文件合并并壓縮,本文介紹了SpringBoot將多個文件夾進行壓縮的兩種方法2024-07-07
本篇文章主要介紹了java 中涉及到客戶端的系統(tǒng)經常需要用到比較版本號的功能,并附小示例,希望能幫助需要的小伙伴2016-07-07
這篇文章主要介紹了java多線程編程實例，分享了幾則多線程的實例代碼，具有一定參考價值，加深多線程編程的理解還是很有幫助的，需要的朋友可以參考下2021-08-08