脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → SpringBoot参数自动填充

SpringBoot使用AOP与注解实现请求参数自动填充流程详解

 更新时间：2023年02月03日 14:52:46   作者：愿做无知一猿  
面向切面编程（aspect-oriented programming，AOP）主要实现的目的是针对业务处理过程中的切面进行提取，诸如日志、事务管理和安全这样的系统服务，从而使得业务逻辑各部分之间的耦合度降低，提高程序的可重用性，同时提高了开发的效率

首先定义一个加在方法上的注解

import java.lang.annotation.*;
/**
 * 开启自动参数填充
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
@Documented
@Inherited
public @interface AutoParameterFill {
    /**
     * 要填充的字段名,不写的话默认下面类的子类中的字段都要填充
     *
     * @see AutoParameterFillConstantsBase
     */
    String[] includes() default {};
}

编写参数常量类

也就是参数名称，例如 String username 的 username ；

基础常量类：

/**
 * 便于扩展，后续反射获取所有子类的常量值
 */
public class AutoParameterFillConstantsBase {
    //do nothing
}

扩展的一个常量，拆分是为了将要填充的参数可以进行分类管理，避免一个类过大。

/**
 * 需要自动填充参数的字段名称
 */
public class AutoParameterFillConstants extends AutoParameterFillConstantsBase {
    public final static String ID = "id";
    public final static String ZHANG_SAN = "zhangsan";
    public final static String TEST_ENTITY = "testEntity";
}

定义一个接口

    @AutoParameterFill
    @RequestMapping("/test1")
    public Object test1(@RequestParam(required = false) String id,
                        @RequestParam(required = false) String zhangsan,
                        @RequestBody TestEntity testEntity) {
        return id + "----" + zhangsan + "----" + testEntity;
    }

TestEntity：

import lombok.Data;
@Data
public class TestEntity {
    private String id;
    private String name;
}

编写对于不同参数的处理接口及实现

该类用于根据参数名获得指定实现：

import org.apache.commons.lang3.StringUtils;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.stereotype.Component;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
/**
 * 处理并找到适配的实现
 */
@Component
public class AutoParameterAdapter implements InitializingBean {
    private final Map<String, AutoParameterHandler> handlerMap = new ConcurrentHashMap<>();
    @Autowired
    private ApplicationContext applicationContext;
    @Override
    public void afterPropertiesSet() throws Exception {
        applicationContext.getBeansOfType(AutoParameterHandler.class).forEach((k, v) -> {
                    if (StringUtils.isBlank(v.support())) {
                        return;
                    }
                    handlerMap.put(v.support(), v);
                }
        );
    }
    public void addParameter(String support, Object[] args, int i) {
        handlerMap.get(support).handle(args, i);
    }
}

该类为统一接口：

/**
 * 处理统一接口
 */
public interface AutoParameterHandler {
    /**
     * 处理参数赋值
     *
     */
    void handle(Object[] args, int i);
    /**
     * 支持的类型
     */
    String support();
}

该类为id参数处理实现：

import com.kusch.ares.annos.AutoParameterFillConstants;
import org.springframework.stereotype.Component;
/**
 * 处理ID参数
 */
@Component
public class IdAutoParameterFillHandler implements AutoParameterHandler {
    @Override
    public void handle(Object[] args, int i) {
        args[i] = "idididiidididididididid";
    }
    @Override
    public String support() {
        return AutoParameterFillConstants.ID;
    }
}

该类为zhangsan参数处理实现：

import com.kusch.ares.annos.AutoParameterFillConstants;
import org.springframework.stereotype.Component;
/**
 * 处理zhangsan参数
 */
@Component
public class ZhangSanAutoParameterFillHandler implements AutoParameterHandler {
    @Override
    public void handle(Object[] args, int i) {
        args[i] = "0000000000000000";
    }
    @Override
    public String support() {
        return AutoParameterFillConstants.ZHANG_SAN;
    }
}

该类为TestEntity参数处理实现：

import com.kusch.ares.annos.AutoParameterFillConstants;
import com.kusch.ares.annos.TestEntity;
import org.springframework.stereotype.Component;
/**
 * 处理TestEntity参数
 */
@Component
public class TestEntityAutoParameterFillHandler implements AutoParameterHandler {
    @Override
    public void handle(Object[] args, int i) {
        TestEntity testEntity = new TestEntity();
        testEntity.setId("TestEntityAutoParameterFillHandler");
        testEntity.setName("TestEntityAutoParameterFillHandler");
        args[i] = testEntity;
    }
    @Override
    public String support() {
        return AutoParameterFillConstants.TEST_ENTITY;
    }
}

AOP具体实现

import com.kusch.ares.annos.handler.AutoParameterAdapter;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.reflect.MethodSignature;
import org.reflections.Reflections;
import org.springframework.core.MethodParameter;
import org.springframework.stereotype.Component;
import org.springframework.util.ObjectUtils;
import org.springframework.web.method.HandlerMethod;
import javax.annotation.Resource;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Set;
/**
 * 处理参数自动填充
 */
@Aspect
@Component
public class AutoParameterFillAop {
    @Resource
    private AutoParameterAdapter autoParameterAdapter;
    @Around(value = "@annotation(com.kusch.ares.annos.AutoParameterFill)")
    public Object around(ProceedingJoinPoint joinPoint) throws Throwable {
        Object[] args = joinPoint.getArgs();
        MethodSignature methodSignature = (MethodSignature) joinPoint.getSignature();
        Method method = methodSignature.getMethod();
        HandlerMethod handlerMethod = new HandlerMethod(joinPoint.getTarget(), method);
        //方法参数
        MethodParameter[] methodParameters = handlerMethod.getMethodParameters();
        //先获取方法注解，如果没有方法注解再去寻找参数注解
        AutoParameterFill annotation = method.getAnnotation(AutoParameterFill.class);
        List<String> list = new ArrayList<>();
        //获取注解的 includes 属性的值
        String[] includes = annotation.includes();
        if (ObjectUtils.isEmpty(includes)) {
            //获取 AutoParameterFillConstantsBase 所有子类常量类中的所有值
            Reflections reflections = new Reflections();
            Set<Class<? extends AutoParameterFillConstantsBase>> classes =
                    reflections.getSubTypesOf(AutoParameterFillConstantsBase.class);
            for (Class<? extends AutoParameterFillConstantsBase> item : classes) {
                Field[] fields = item.getDeclaredFields();
                for (Field field : fields) {
                    list.add(String.valueOf(field.get(field.getName())));
                }
            }
        } else {
            list.addAll(Arrays.asList(includes));
        }
        //遍历方法参数
        for (MethodParameter methodParameter : methodParameters) {
            for (String autoParameterFillConstants : list) {
                if (autoParameterFillConstants.equals(methodParameter.getParameter().getName())) {
                    autoParameterAdapter.addParameter(autoParameterFillConstants, args,
                            methodParameter.getParameterIndex());
                }
            }
        }
        return joinPoint.proceed(args);
    }
}

开启AOP记得在启动类加上 @EnableAspectJAutoProxy

补充关键jar包：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>
<!-- 反射工具包 -->
<dependency>
    <groupId>org.reflections</groupId>
    <artifactId>reflections</artifactId>
    <version>0.10.2</version>
</dependency>
<dependency>
    <groupId>org.apache.commons</groupId>
    <artifactId>commons-lang3</artifactId>
</dependency>

使用方式

将你自己的参数名编写到 AutoParameterFillConstants 中，你也可以自己新建常量类，继承AutoParameterFillConstantsBase即可。

实现AutoParameterHandler接口，完成其中两个方法的编写。

在要填充的接口上，加上该注解，例如上述controller

    @AutoParameterFill
    @RequestMapping("/test1")
    public Object test1(@RequestParam(required = false) String id,
                        @RequestParam(required = false) String zhangsan,
                        @RequestBody TestEntity testEntity) {
        return id + "----" + zhangsan + "----" + testEntity;
    }

不带参数，就说明只要参数名和 常量类中的匹配上，并且存在对应的实现类，就会自动填充参数。

带参数例如 @AutoParameterFill(includes = {AutoParameterFillConstants.ID,AutoParameterFillConstants.ZHANG_SAN}) 这就代表这个接口只需要填充id和张三两个属性。

到此这篇关于SpringBoot使用AOP与注解实现请求参数自动填充流程详解的文章就介绍到这了,更多相关SpringBoot参数自动填充内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

相关文章

  • quartz的简单使用、SpringBoot使用和自定义数据源集成方式

    quartz的简单使用、SpringBoot使用和自定义数据源集成方式

    这篇文章主要介绍了quartz的简单使用、SpringBoot使用和自定义数据源集成方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教<BR>
    2024-01-01
  • Spring MVC的完整执行流程和常用组件详解

    Spring MVC的完整执行流程和常用组件详解

    SpringMvc是Spring的一个基于MVC开发的一个框架,用来处理前端请求,可以和Spring无缝整合,下面这篇文章主要给大家介绍了关于Spring MVC的完整执行流程和常用组件的相关资料,需要的朋友可以参考下
    2022-06-06
  • Java正则表达式判断字符串中是否包含中文示例

    Java正则表达式判断字符串中是否包含中文示例

    之前一个朋友问我，如何判断字符串中是否包含中文，其实解决的方法很简单，但觉着有必要写出给不知道的朋友们以参考，所以下面这篇文章主要介绍了利用Java正则表达式判断字符串中是否包含中文的方法，需要的朋友可以参考。
    2017-03-03
  • Spring如何使用通知 Advice 管理事务

    Spring如何使用通知 Advice 管理事务

    Spring 默认采用声明式事务管理(通过配置的方式) ，也可以实现编程式事务管理，这篇文章主要介绍了Spring使用通知Advice管理事务,需要的朋友可以参考下
    2023-06-06
  • Java代码是如何被CPU狂飙起来的

    Java代码是如何被CPU狂飙起来的

    无论是刚刚入门Java的新手还是已经工作了的老司机，恐怕都不容易把Java代码如何一步步被CPU执行起来这个问题完全讲清楚。本文就带你详细了解Java代码到底是怎么运行起来的。感兴趣的同学可以参考阅读
    2023-03-03
  • SpringBoot favicon Chrome设置问题解决方案

    SpringBoot favicon Chrome设置问题解决方案

    在本篇文章里小编给大家分享的是关于SpringBoot favicon Chrome设置问题实例内容，小的朋友们可以参考学习下。
    2020-02-02
  • Spring Boot如何优雅的使用多线程实例详解

    Spring Boot如何优雅的使用多线程实例详解

    这篇文章主要给大家介绍了关于Spring Boot如何优雅的使用多线程的相关资料，文中通过示例代码介绍的非常详细，对大家学习或者使用Spring Boot具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧
    2020-05-05
  • 多jdk环境下指定springboot外部配置文件详解

    多jdk环境下指定springboot外部配置文件详解

    这篇文章主要为大家介绍了多jdk环境下指定springboot外部配置文件详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
    2023-03-03
  • 基于Java 利用Mybatis实现oracle批量插入及分页查询

    基于Java 利用Mybatis实现oracle批量插入及分页查询

    这篇文章主要介绍了基于Java 利用Mybatis实现oracle批量插入及分页查询，文章围绕主题展开详细的内容介绍，需要的小伙伴可以参考一下
    2022-07-07
  • 详解Java的面向对象和面向过程

    详解Java的面向对象和面向过程

    我们知道，Java是面向对象的编程语言，但是至今仍有不少同学还不太懂”面向对象“的确切含义，今天这篇文章就带大家真正地认识面向对象，感兴趣的同学可以跟着小编一起来学习
    2023-05-05

最新评论