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

 更新时间:2025年05月12日 09:10:48   作者:小目标青年  
这篇文章主要介绍了Springboot Controller接口默认自动填充业务实体参数值,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教

前言

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

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

不多说,开搞。

快速模拟出这个使用场景

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

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

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

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

第② 个方案,我直接pass。

  • 需要前端配合,前端存拿存拿很麻烦,哪个接口需要还得跟前端沟通
  • 前端的缓存什么时候需要更新?如果涉及改手机号或者一些参数,但是token不失效,也就是业务标识ID 不会变,那么前端的缓存数据就不是最新的
  • 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;
}

最后写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的:

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

总结

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • Java实战之在线寄查快递系统的实现

    Java实战之在线寄查快递系统的实现

    这篇文章主要介绍了如何利用Java制作一个在线寄查快递系统,文中采用的技术有java、SpringBoot、FreeMarker、Mysql,需要的可以参考一下
    2022-02-02
  • java设计优化之单例模式

    java设计优化之单例模式

    这篇文章主要为大家详细介绍了java设计优化中的单例模式,深入学习java单例模式,感兴趣的朋友可以参考一下
    2016-03-03
  • Java中Object类的理解和使用

    Java中Object类的理解和使用

    Object类是java.lang包下的核心类,Object类是所有类的父类,何一个类时候如果没有明确的继承一个父类的话,那么它就是Object的子类,本文将通过代码示例详细介绍一下Java中Object类的理解和使用,需要的朋友可以参考下
    2023-06-06
  • Java跳出多重嵌套循环代码实例

    Java跳出多重嵌套循环代码实例

    这篇文章主要介绍了Java跳出多重嵌套循环,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-03-03
  • Java中关于size()>0 和isEmpt()的性能考量

    Java中关于size()>0 和isEmpt()的性能考量

    这篇文章主要介绍了Java中关于size()>0 和isEmpt()性能考量,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-02-02
  • Flutter实现文本组件、图标及按钮组件的代码

    Flutter实现文本组件、图标及按钮组件的代码

    这篇文章主要介绍了Flutter实现文本组件、图标及按钮组件的代码,本文给大家介绍的非常详细,具有一定的参考借鉴价值 ,需要的朋友可以参考下
    2019-07-07
  • 解决使用security和静态资源被拦截的问题

    解决使用security和静态资源被拦截的问题

    这篇文章主要介绍了解决使用security和静态资源被拦截的问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-08-08
  • SpringBoot+Shiro+Redis+Mybatis-plus 实战项目及问题小结

    SpringBoot+Shiro+Redis+Mybatis-plus 实战项目及问题小结

    最近也是一直在保持学习课外拓展技术,所以想自己做一个简单小项目,于是就有了这个快速上手 Shiro 和 Redis 的小项目,说白了就是拿来练手调调 API,然后做完后拿来总结的小项目,感兴趣的朋友一起看看吧
    2021-04-04
  • Java异常(Exception)处理以及常见异常总结

    Java异常(Exception)处理以及常见异常总结

    在《Java编程思想》中这样定义异常,阻止当前方法或作用域继续执行的问题,虽然java中有异常处理机制,但是要明确一点,决不应该用"正常"的态度来看待异常,这篇文章主要给大家介绍了关于Java异常(Exception)处理以及常见异常的相关资料,需要的朋友可以参考下
    2021-10-10
  • Mybatis结果集映射一对多简单入门教程

    Mybatis结果集映射一对多简单入门教程

    本文给大家介绍Mybatis结果集映射一对多简单入门教程,包括搭建数据库环境的过程,idea搭建maven项目的代码详解,本文通过实例代码给大家介绍的非常详细,需要的朋友参考下吧
    2021-06-06

最新评论