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的:

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

总结

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

相关文章

  • 基于jvm-sandbox的imock开发指南详解

    基于jvm-sandbox的imock开发指南详解

    这篇文章主要为大家介绍了基于jvm-sandbox的imock开发指南详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-08-08
  • Spring Cloud Alibaba 使用 Feign+Sentinel 完成熔断的示例

    Spring Cloud Alibaba 使用 Feign+Sentinel 完成熔断的示例

    这篇文章主要介绍了Spring Cloud Alibaba 使用 Feign+Sentinel 完成熔断的示例,帮助大家更好的理解和学习使用Spring Cloud,感兴趣的朋友可以了解下
    2021-03-03
  • 浅谈Thread.sleep()为什么要抛出中断异常

    浅谈Thread.sleep()为什么要抛出中断异常

    本文主要介绍了浅谈Thread.sleep()为什么要抛出中断异常,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-04-04
  • 一文了解Java动态代理的原理及实现

    一文了解Java动态代理的原理及实现

    动态代理指的是,代理类和目标类的关系在程序运行的时候确定的,客户通过代理类来调用目标对象的方法,是在程序运行时根据需要动态的创建目标类的代理对象。本文将通过案例详细讲解一下Java动态代理的原理及实现,需要的可以参考一下
    2022-07-07
  • Java算法实现杨辉三角的讲解

    Java算法实现杨辉三角的讲解

    今天小编就为大家分享一篇关于Java算法实现杨辉三角的讲解,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
    2019-01-01
  • 导入maven项目各个注解均报错的解决方案

    导入maven项目各个注解均报错的解决方案

    这篇文章主要介绍了导入maven项目各个注解均报错的解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-12-12
  • 详解Java中的数组与字符串相关知识

    详解Java中的数组与字符串相关知识

    这篇文章主要介绍了详解Java中的数组与字符串相关知识,包括操作字符串的一些基本方法列举,需要的朋友可以参考下
    2015-09-09
  • IntelliJ IDEA 2020常用配置设置大全(方便干活)

    IntelliJ IDEA 2020常用配置设置大全(方便干活)

    这篇文章主要介绍了IntelliJ IDEA 2020常用配置设置大全(方便干活),本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-02-02
  • SpringBoot权限认证Sa-Token的使用总结

    SpringBoot权限认证Sa-Token的使用总结

    Sa-Token是一款轻量级Java权限认证框架,适用于快速搭建权限系统,它提供了丰富的功能,包括登录认证、权限验证、角色验证、Session会话管理等,并且具有良好的社区支持和文档资源,下面重点给大家介绍SpringBoot权限认证Sa-Token的使用,感兴趣的朋友一起看看吧
    2025-02-02
  • Java Mybatis foreach嵌套foreach List<list<Object>>问题

    Java Mybatis foreach嵌套foreach List<list<Object>&

    在MyBatis的mapper.xml文件中,foreach元素常用于动态生成SQL查询条件,此元素包括item(必选,元素别名)、index(可选,元素序号或键)、collection(必选,指定迭代对象)、open、separator、close(均为可选,用于定义SQL结构)
    2024-09-09

最新评论