Springboot Controller接口默认自动填充 业务实体参数值

前言

今天看有小伙伴求救：

 

我还是一贯如此， 有人不明白，没玩过HandlerMethodArgumentResolver 。

那么很可能不止他一个人， 那么我就有必要出手。

不多说，开搞。
 
正文

快速模拟出这个使用场景 ：

 

假如有好多接口，都需要用到 当前的业务参数， 这个业务场景需要的参数 是 当前登录人的信息。

常见的方案核心思路无非有二：

① 后端写个解析+查询函数，哪里需要就调用一下

② 后端提供一个获取登录人信息接口，前端先调用接口，缓存起来；然后哪些接口需要这个参数，前端就从缓存拿出来然后传过来。

     第② 个方案，我直接pass。
     
     1 需要前端配合，前端存拿存拿很麻烦，哪个接口需要还得跟前端沟通
     2 前端的缓存什么时候需要更新？如果涉及改手机号或者一些参数，但是token不失效，也就是业务标识ID 不会变，
     那么前端的缓存数据就不是最新的
     3 xxxx 暂时不想太多

我的想法：

优化第①个方案

做到 减少重复代码的输出，做到简单使用、动态使用、自动填充。

也就是求救的小伙伴的想法思路，是的，自动填充，后端自己整。


事不宜迟，开敲。

需要做什么， 三件套（要玩花样，玩动态，少不了自定义注解+aop）：

 

首先是来个自定义注解，用于标记，哪些接口需要用到我们默认填充业务参数:

①LoginUserX.java

     

    import java.lang.annotation.*;


    /**
     * @Author: JCccc
     * @Date: 2022-4-11 18:45
     * @Description:
     */
    @Target({ElementType.PARAMETER})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    public @interface LoginUserX {
    }

 ② 自定义一个参数解析器 HandlerMethodArgumentResolver

LoginUserParamResolver.java

    import org.springframework.core.MethodParameter;
    import org.springframework.web.bind.support.WebDataBinderFactory;
    import org.springframework.web.context.request.NativeWebRequest;
    import org.springframework.web.method.support.HandlerMethodArgumentResolver;
    import org.springframework.web.method.support.ModelAndViewContainer;

    import java.util.Objects;

    /**
     * @Author: JCccc
     * @Date: 2022-4-11 18:45
     * @Description:
     */
    public class LoginUserParamResolver  implements HandlerMethodArgumentResolver {


        @Override
        public boolean supportsParameter(MethodParameter parameter) {
            if (parameter.getParameterType().isAssignableFrom(LoginUserAnalysis.class) && parameter.hasParameterAnnotation(LoginUserX.class)) {
                return true;
            }
            return false;
        }

        @Override
        public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception {
           if (Objects.nonNull(parameter.getParameterAnnotation(LoginUserX.class))){
               String token = webRequest.getHeader("token");
               //解析token 、获取 登录用户信息等等，或者是 拿你需要的业务参数
               return  new LoginUserAnalysis().setLoginNameAnalysis("JCcccc").setPhoneAnalysis("136919xxxxx").setTopRoleTypeAnalysis(1);
           }
           return null;
        }
    }

代码简析：

可以看到有2个函数

supportsParameter ：看看谁支持谁不支持

resolveArgument ：开始解析,写逻辑代码

③ 默认填充的业务实体示例 LoginUserAnalysis.java

    import lombok.Data;
    import lombok.experimental.Accessors;

    @Data
    @Accessors(chain = true)
    public class LoginUserAnalysis {

        private String loginNameAnalysis;
        private String phoneAnalysis;
        private Integer topRoleTypeAnalysis;
    }

@Configuration
public class WebConfig  extends WebMvcConfigurerAdapter{
    @Autowired
    UserArgumentResolver userArgumentResolver;
    @Override
    public void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers) {
        argumentResolvers.add(userArgumentResolver);
    }
}
8

 最后写2个模拟的测试接口，玩一下，看看效果：
 

    @GetMapping("doGetTest")
    public  String doGetTest(@LoginUserX LoginUserAnalysis loginUserAnalysis,String queryName){
        System.out.println("接收到的参数："+queryName);
        System.out.println("默认填充的参数"+loginUserAnalysis.toString());
        return "ok";
    }

    @PostMapping("doPostTest")
    public  void doPostTest(@LoginUserX LoginUserAnalysis loginUserAnalysis, @RequestBody Car car){
        System.out.println("接收到的参数："+car.toString());
        System.out.println("默认填充的参数"+loginUserAnalysis.toString());
    }

测试：

先看看post接口：

 debug，可以看到进来了，而且能拿到注解杂七杂八的参数：

 最后数据填充成功：

 

 

然后试试get请求效果：

 也是OK的：

 

 好了该篇就到这，想要默认填充哪些业务参数，自己开整吧。

原文链接：https://blog.csdn.net/qq_35387940/article/details/128566792