SpringCloud通用请求字段拦截处理方法

 更新时间:2020年07月08日 09:49:02   作者:清茶豆奶  
这篇文章主要介绍了SpringCloud通用请求字段拦截处理,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下

背景

以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对线程访问数据的隔离来实现的,在实际生产项目应用中有很好的借鉴意义,希望对你有帮助。

到此这篇关于SpringCloud通用请求字段拦截处理方法的文章就介绍到这了,更多相关SpringCloud请求字段拦截内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Mybatis中updateBatch实现批量更新

    Mybatis中updateBatch实现批量更新

    本文主要介绍了Mybatis中updateBatch实现批量更新,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-03-03
  • 实例分析Try {} Catch{} 作用

    实例分析Try {} Catch{} 作用

    本文是通过一个简单的实例,向大家介绍了Try {} Catch{}的意义和作用,非常的实用,有需要的小伙伴可以参考下。
    2015-10-10
  • Java创建型设计模式之抽象工厂模式(Abstract Factory)

    Java创建型设计模式之抽象工厂模式(Abstract Factory)

    当系统所提供的工厂所需生产的具体产品并不是一个简单的对象,而是多个位于不同产品等级结构中属于不同类型的具体产品时需要使用抽象工厂模式,抽象工厂模式是所有形式的工厂模式中最为抽象和最具一般性的一种形态
    2022-09-09
  • Spring Boot详解各类请求和响应的处理方法

    Spring Boot详解各类请求和响应的处理方法

    平时只是在用SpringBoot框架,但并没有详细研究过请求和响应执行的一个具体过程,所以本文主要来梳理一下SpringBoot请求和响应的处理过程
    2022-07-07
  • SpringBoot中@ConditionalOnBean实现原理解读

    SpringBoot中@ConditionalOnBean实现原理解读

    这篇文章主要介绍了SpringBoot中@ConditionalOnBean实现原理,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-02-02
  • Java简易学生成绩系统写法实例

    Java简易学生成绩系统写法实例

    在本篇文章里小编给大家分享的是关于Java简易学生成绩系统写法实例以及相关知识点,有需要的朋友们可以学习下。
    2019-09-09
  • MyBatis动态SQL foreach标签实现批量插入的方法示例

    MyBatis动态SQL foreach标签实现批量插入的方法示例

    这篇文章主要介绍了MyBatis动态SQL foreach标签实现批量插入的方法示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-06-06
  • SpringBoot实现单文件与多文件上传功能

    SpringBoot实现单文件与多文件上传功能

    这篇文章主要介绍了SpringBoot实现单文件与多文件上传功能,Spring MVC对文件上传做了简化,而在Spring Boot中对此做了更进一步的简化,文件上传变得更为方便,下面开始演示,需要的小伙伴可以参考一下,希望对你有所帮助
    2022-01-01
  • SpringBoot使用minio及配置代码

    SpringBoot使用minio及配置代码

    MinIO是一个非常轻量的服务,可以很简单的和其他应用的结合,类似 NodeJS, Redis 或者 MySQL。本文重点给大家介绍SpringBoot使用minio及配置代码,感兴趣的朋友一起看看吧
    2022-02-02
  • Java中的Apache Commons Math使用详解

    Java中的Apache Commons Math使用详解

    Java中的Apache Commons Math是一个开源的数学库,它提供了许多常用的数学函数和算法,这个库对于需要处理大量数据的开发者来说非常有用,因为它可以大大简化代码并提高效率,本文给大家详解讲解Java中的Apache Commons Math知识,感兴趣的朋友跟随小编一起看看吧
    2023-08-08

最新评论