欧博亚洲客户端:实战SpringCloud通用请求字段阻挡处置

admin/2020-07-08/ 分类:科技/阅读:

靠山

以SpringCloud构建的微服务系统为例,使用前后端星散的架构,每个系统都市提供一些通用的请求参数,例如移动端的系统版本信息、IMEI信息,Web端的IP信息,浏览器版本信息等,这些参数可能放在header里,也可以放在参数里,若是这些参数需要在每个方式内声明界说,一来工作量太大,二是这些通用参数与营业接口方式耦合过紧,自己就是一个欠好的设计。

这个问题该若何优雅地解决呢?

最佳实践

实现思绪

  • 行使SpringMVC提供拦截器,对匹配的请求,抽取通用的header信息(假设通用字段所有放在header里)
  • 将每个请求的信息单独隔脱离,互不滋扰。
  • Controller层使用时,可以将在该请求线程(http线程)里将通用的header信息提取出来使用。
  • 请求线程完成时,响应的header头信息工具需要接纳销毁。

实现方式

  • SpringMVA提供的HandlerInterceptorAdapter可以拿来使用,继续实现即可。
  • 使用ThreadLocal纪录每个请求的信息,ThreadLocal有隔离线程变量的作用。
HandlerInterceptorAdapter的源码实现及注释
public abstract class HandlerInterceptorAdapter implements AsyncHandlerInterceptor { @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { // 在营业接口方式处置之前被挪用,可以在这里对通用的header信息举行提取 return true; } @Override public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable ModelAndView modelAndView) throws Exception { // 这个方式在营业接口方式执行完成后,天生SpringMVC ModelAndView之前被挪用 // 今天这个案例我们不用此方式,故可以不实现。 } @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,然后执行此方式,异步线程完成后会执行postHandle和afterCompletion两方式,这里暂时用不上。 } } 
ThreadLocal的源码主要实现及注释
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的一种实现)中,以当前线程的hash值为key,get()方式则对应以当前线程作为key来取值,从而实现每个线程的数据是隔离的效果。

另附上ThreadLocal类源码解读的导图,仅供参考

案例实战

我们对现实营业系统举行简化处置,假定header信息牢固有ip,uid,deviceId三个信息,根据上文的实现思绪,最先案例演示。

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<>(); /** * 获取静态的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(); } } 

拦截器类实现

最焦点的实现终于进场了,这里继续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 { } } 

如上一章节形貌的逻辑,在preHandle方式内将request中的ip,uid,deviceId封装到RequestWrap工具里,在afterCompletion中对该线程的ThreadLocal值举行释放。

营业接口方式的使用

在Controller类的接口方式中,如要获取uid信息,只需要挪用RequestWrap.getUid()方式即可,再也不需要在每个接口上声明uid参数了,如下示例:

/** * 获取用户基础信息 */ @PostMapping(value = "/user/info") public Response<UserInfo> getUserInfo() { return userManager.getUserInfo(RequestWrap.getUid()); } 

总结

这个实战的目的是解决通用header信息的在接口的重复界说问题,基于HandlerInterceptorAdapter拦截器的实现,ThreadLocal对线程接见数据的隔离来实现的,在现实生产项目应用中有很好的借鉴意义,希望对你有辅助。

专注Java高并发、分布式架构,更多手艺干货分享与心得,请关注民众号:Java架构社区
可以扫左边二维码添加密友,约请你加入Java架构社区微信群配合探讨手艺

,

AllbetGmaing客户端下载

欢迎进入AllbetGmaing客户端下载(Allbet Game):www.aLLbetgame.us,欧博官网是欧博集团的官方网站。欧博官网开放Allbet注册、Allbe代理、Allbet电脑客户端、Allbet手机版下载等业务。

TAG:
阅读:
广告 330*360
广告 330*360

热门文章

HOT NEWS
  • 周榜
  • 月榜
Sunbet_进入申博sunbet官网
微信二维码扫一扫
关注微信公众号
新闻自媒体 Copyright © 2002-2019 Sunbet 版权所有
二维码
意见反馈 二维码