场景:需要写一个带登录态的接口,通过请求传的token转成对象注入到Controller的方法里面去,就类似于@RequestBody,token是存在请求的header里面。
设计思路:使用过滤器把请求里面的token拿到,拿到token转成用户对象,然后把对象存到request的attribute里面,再定义一个参数解析器,把用户对象解析到Controller里面去。
1、先定义一个注解,类似于@RequestBody
import java.lang.annotation.*; @Target({ ElementType.PARAMETER }) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface APPSSOAcctInfo { }
2、再看下Controller里面定义的接口
@GetMapping(value="/getData") public String getData(@APPSSOAcctInfo AccountDTO accountDTO){ ......//业务代码 }
3、定义Filter
@Component public class APPSSOFilter extends OncePerRequestFilter { //不需要解析token的接口 private static final List<String> excludeURIs = new ArrayList<>(); static { excludeURIs.add("/notUser/*"); } @Override public void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws IOException { try { String requestUri = request.getRequestURI(); String contextPath = request.getContextPath(); String url = requestUri.substring(contextPath.length()); if (判断excludeURIs是否包含本次请求的url,如果包含那就不需要从参数中获取token转用户对象) { filterChain.doFilter(request, response); return; } AccountDTO accountDTO = 通过token转成AccountDTO; //把得到的AccountDTO放到request的attribute里面,因为我们等一下要从里面取 request.setAttribute("APPSSOAcctInfo", accountDTO); filterChain.doFilter(request, response);//放行 } catch (Exception e) { errorReturn(request, response); } } //失败的情况,这个可以自由发挥 private void errorReturn(HttpServletRequest request,HttpServletResponse response) throws IOException { response.setContentType("application/json;charset=UTF-8"); response.setStatus(200); PrintWriter writer = response.getWriter(); writer.write(JSON.toJSONString("失败")); writer.close(); } }
4、把上面定义的过滤器添加到Filter的调用链中,这里我使用的是FilterRegistrationBean
@Configuration public class DemoConfiguration { @Autowired private APPSSOFilter appssoFilter;//把上面定义的Filter注入进来 @Bean public FilterRegistrationBean demoFilterRegistration() { FilterRegistrationBean registration = new FilterRegistrationBean(); registration.setFilter(appssoFilter);//添加Filter registration.setOrder(1);//设置优先级 registration.addUrlPatterns("/*"); //设置需要拦截的路径 return registration; } //如果需要注入多个处理不同业务的Filter /* @Autowired private TestFilter2 testFilter2; 这个Filter的定义方式和上面是一样的 @Bean public FilterRegistrationBean nameListFilterRegistration() { FilterRegistrationBean registration = new FilterRegistrationBean(); registration.setFilter(testFilter2); registration.setOrder(2); registration.addUrlPatterns("/*"); return registration; } */ }
5、定义一个参数解析器,做的事就和@RequestBody一样,从请求中把参数解析组装成DTO放入Controller里面去
public class APPSSOAcctInfoMethodArgumentResolver implements HandlerMethodArgumentResolver { @Override public boolean supportsParameter(MethodParameter parameter) { //判断Controller的方法里面是否包含APPSSOAcctInfo注解 return parameter.hasParameterAnnotation(APPSSOAcctInfo.class); } @Override public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) { //Filter那一步我们已经吧DTO存到request的attribute里面去,现在只需要把他取出来。 HttpServletRequest request = webRequest.getNativeRequest(HttpServletRequest.class); return request.getAttribute("APPSSOAcctInfo"); } }
HandlerMethodArgumentResolver小知识:
supportsParameter方法返回true表示会调用resolveArgument方法。
6、把上面定义的参数解析器放到MVC里面,这样启动的时候,就会去加载这个解析器。
@Configuration public class WebAppMvcConfig extends WebMvcConfigurationSupport { @Override public void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers) { //添加我们自定的参数解析器 argumentResolvers.add(new APPSSOAcctInfoMethodArgumentResolver()); } }
WebMvcConfigurationSupport小知识:
这个类扩展性特别好,我们需要在MVC自定义些什么都需要在这类里面实现对应的方法就好了
到这里文章开头描述的问题已经实现了。
再次改造:后来因为有同事用spring的启动器写了一个账户中心,直接引入jar包,在jar包里面定义了Filter去解析用户token,并且把用户对象放到了ThreadLocal里面去了,只需要在代码里面通过ThreadLocal.get()就可以拿到对象。所以我们Filter就不需要去解析token,此时自己需要把自定义的Filter去了,但是又不想改动太多代码,还是希望在Conterller里面通过注解@APPSSOAcctInfo方式拿到用户对象,下面对原有的代码进行一个小改造
改造思路:因为jar里面有很多的Filter,这次我们就不用FIlter来做,Filter多了执行顺序不好把控,比如jar的FIlter解析token在我的Filter之后,那就往request设置不了登录态。所以这次我使用拦截器来实现往request的attribute设置用户对象,这样就可以确保在执行拦截的时候一定是走过token转AccountDTO的
1、定义拦截器
public class AuthenticationInterceptor implements HandlerInterceptor{ @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { accountDTO = ThreadLocal.get();//这是伪代码,通过ThreadLocal得到jar在Filter设置进去的AccountDTO request.setAttribute("APPSSOAcctInfo",accountDTO); return true; } }
不知道怎么往ThreadLocal里面设置对象可以百度一下
2、把拦截器添加到MVC中去
@Configuration public class WebAppMvcConfig extends WebMvcConfigurationSupport { @Override public void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers) { //添加我们自定的参数解析器 argumentResolvers.add(new APPSSOAcctInfoMethodArgumentResolver()); } //只需要追加下面一段就好了 @Override public void addInterceptors(InterceptorRegistry interceptorRegistry) { interceptorRegistry.addInterceptor(new AuthenticationInterceptor())//添加拦截器 .addPathPatterns("/**") //设置需要拦截的路劲 .excludePathPatterns("/health"); //设置忽略的路径 } }
注意:别忘了把前面注册Filter的方法demoFilterRegistration注释掉
到此就完成了项目的改造,下面我们分别介绍下文中所涉及到的几个类