SpringCloud通过Feign实现服务间调用线程变量传输

前言

  在开发项目的过程中，经常需要跨服务传输一些数据，比如将登录的信息从一个服务传递给另一个服务，那么这种情况下需要尽可能少的去动已有的代码，更加体现了编程的封装思想。
  由于SpringCloud并不像dubbo一样，在服务间调用的时候通过本身的线程变量去传输，但是SpringCloud肯定是有它自己的机制可以支持实现的，基于这种考虑，于是有了此篇博客。

实现思路

1. 准备一个ThreadLoad变量，供线程之间共享
2. 每个服务对所有过来的Feign调用进行过滤，然后从请求头中获取用户信息，并存在ThreadLocal变量中
3. 每个服务在使用FeignClient调用其他服务时，先从ThreadLocal变量中取出用户信息，并放在Fegin的request请求头中
4. 封装一个注解，在启动类中标记即可

关键代码

1、ThreadLocal工具类

public class UserContext {
	//此处线程变量传递的，可以是实体，也可以是某一个变量
    private static ThreadLocal<User> userInfo = new ThreadLocal<User>();
    //此处定义的是要塞到request请求头中的名称
    public static String KEY_USER_IN_HTTP_HEADER = "X-AUTO-FP-USER";

    public UserContext() {
    }

    public static User getUser(){
        return (User)user.get();
    }

    public static void setUser(User user){
        user.set(user);
    }
}

2、用户信息实体类

/**
 * @author 刘子腾
 * @DESCRIPTION 用户信息实体
 * @create 2019/3/28
 */
@Data
public class User {
    /**
     * 用户id
     */
    private String id;
    /**
     * 用户编码
     */
    private String userCode;
    /**
     * 用户名称
     */
    private String userName;
    /**
     * 公司id
     */
    private String companyId;
    /**
     * token
     */
    private String token;
    /**
     * 用户角色id
     */
    private String roleId;
    /**
     *
     * qq登录唯一标示
     */
    private String qqOpenId;
    /**
     *
     * 微信登录唯一标识
     */
    private String weChatOpenId;
    /**
     *
     * 微信公众号唯一标识
     */
    private String wxPlantForm;
}

3、FeignClient拦截器

public class TransmitUserFeighClientIntercepter implements RequestInterceptor {

    private static final Logger log = LoggerFactory.getLogger(TransmitUserFeighClientIntercepter.class);
    public TransmitUserFeighClientIntercepter() {
    }

    @Override
    public void apply(RequestTemplate requestTemplate) {
        //从应用上下文中取出user信息，放入Feign的请求头中
        User user = UserContext.getUser();
        if (user != null) {
            try {
                String userJson = JSON.toJSONString(user);
                requestTemplate.header("KEY_USER_IN_HTTP_HEADER",new String[]{URLDecoder.decode(userJson,"UTF-8")});
            } catch (UnsupportedEncodingException e) {
                log.error("用户信息设置错误",e);
            }
        }
    }
}

4、Filter过滤器

public class TransmitUserFilter implements Filter {

    private static final Logger log = LoggerFactory.getLogger(TransmitUserFeighClientIntercepter.class);
    public TransmitUserFilter() {
    }
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
    }
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
       this.initUserInfo((HttpServletRequest)request);
       chain.doFilter(request,response);
    }

    private void initUserInfo(HttpServletRequest request){
        String userJson = request.getHeader("KEY_USER_IN_HTTP_HEADER");
        if (StringUtils.isNotBlank(userJson)) {
            try {
                userJson = URLDecoder.decode(userJson,"UTF-8");
                User userInfo = (User) JSON.parseObject(userJson,UserInfo.class);
                //将用户信息放入上下文中
                UserContext.setUser(user);
            } catch (UnsupportedEncodingException e) {
               log.error("init userInfo error",e);
            }
        }
    }

    @Override
    public void destroy() {
    }
}

5、自定义注解

@Documented
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Import({EnableUserTransmitterAutoConfiguration.class})
public @interface EnableUserTransmitter {
}

6、自定义注解实现类

@Configuration
public class EnableUserTransmitterAutoConfiguration {

    public EnableUserTransmitterAutoConfiguration() {
    }

    @Bean
    public TransmitUserFeighClientIntercepter transmitUser2FeighHttpHeader(){
       return new TransmitUserFeighClientIntercepter();
    }

    @Bean
    public TransmitUserFilter transmitUserFromHttpHeader(){
        return new TransmitUserFilter();
    }
}

7、在启动类上标记自定义注解