SpringBoot 自定义注解 + AOP实现参数效验,默认值赋值

简介: SpringBoot 自定义注解 + AOP实现参数效验,默认值赋值

在进行Web开发时,对于一些接口,我们需要对参数进行效验来保证接口的正确性。同时,对于参数中某些项缺失的情况,我们需要给这些缺失的参数设置默认值。这时候,SpringBoot的自定义注解和AOP技术就派上用场了。

本文将介绍如何使用SpringBoot的自定义注解和AOP技术,实现参数效验和默认值赋值的功能。首先,我们将介绍一下SpringBoot自定义注解和AOP的相关知识,然后,我们再详细介绍如何使用这两个工具来完成参数效验和默认值赋值。

SpringBoot自定义注解

在SpringBoot中,我们可以通过自定义注解来对类、方法和参数等进行标记。SpringBoot提供了一个@interface关键字,用于定义一个注解接口,其中可以定义多个属性,用于接收注解参数。下面是一个示例代码:

@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyAnnotation {
   
    String value() default "";
}

在上面的代码中,我们定义了一个名为MyAnnotation的注解,它有一个属性value,用于接收注解参数。这个注解是用于参数效验和默认值赋值的。

AOP技术

在SpringBoot中,我们可以通过AOP(面向切面编程)技术来实现对方法的拦截和处理。AOP就是在不修改原有业务逻辑的情况下,通过对一些横切关注点的抽象和封装,实现对业务逻辑的增强或者干预。

在SpringBoot中,我们可以使用@Aspect注解来定义一个切面,用于进行方法的拦截和处理。AOP技术的实现需要依赖于SpringBoot的自定义注解。下面是一个示例代码:

@Aspect
@Component
public class MyAspect {
   
    @Around("execution(* com.example.demo.controller.*.*(..)) && @annotation(annotation)")
    public Object doAround(ProceedingJoinPoint pjp, MyAnnotation annotation) throws Throwable {
   
        // TODO: 在这里进行参数效验和默认值赋值的操作
        return pjp.proceed();
    }
}

在上面的代码中,我们定义了一个名为MyAspect的切面,它使用了@Around注解,表示它会拦截所有在com.example.demo.controller包下的方法,并且这些方法需要被MyAnnotation注解标记。在方法拦截后,我们可以在doAround()方法中对参数进行效验和默认值赋值的操作。

参数效验

在进行Web开发时,我们经常需要对参数进行效验,以确保数据的正确性。我们可以通过自定义注解和AOP技术来实现这个功能。

首先,定义一个用于效验的注解:

@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyNotNull {
   
    String value() default "参数不能为空";
}

在上面的代码中,我们定义了一个MyNotNull注解,它有一个属性value,用于接收注解参数。这个注解是用于参数非空效验的。

下面是一个具体的效验实现:

@Aspect
@Component
public class MyAspect {
   
    @Around("execution(* com.example.demo.controller.*.*(..)) && @annotation(notNull)")
    public Object doAround(ProceedingJoinPoint pjp, MyNotNull notNull) throws Throwable {
   
        // 获取方法参数
        Object[] args = pjp.getArgs();
        for (Object arg : args) {
   
            if (arg == null || arg.toString().trim().equals("")) {
   
                throw new IllegalArgumentException(notNull.value());
            }
        }
        return pjp.proceed();
    }
}

在上面的代码中,我们使用了@Around注解和MyNotNull注解,表示我们需要拦截所有被MyNotNull注解标记的方法,并进行参数的非空效验。在doAround()方法中,我们首先获取方法的参数列表,然后遍历每个参数,如果该参数为null或者为空字符串,则抛出一个IllegalArgumentException异常。

默认值赋值

在进行Web开发时,我们经常需要对参数进行默认值的赋值,以确保参数的完整性。我们可以通过自定义注解和AOP技术来实现这个功能。

首先,定义一个用于默认值赋值的注解:

@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyDefault {
   
    String value() default "";
}

在上面的代码中,我们定义了一个MyDefault注解,它有一个属性value,用于接收注解参数。这个注解是用于参数默认值赋值的。

下面是一个具体的默认值赋值实现:

@Aspect
@Component
public class MyAspect {
   
    @Around("execution(* com.example.demo.controller.*.*(..)) && @annotation(myDefault)")
    public Object doAround(ProceedingJoinPoint pjp, MyDefault myDefault) throws Throwable {
   
        // 获取方法参数
        Object[] args = pjp.getArgs();
        for (int i = 0; i < args.length; i++) {
   
            if (args[i] == null) {
   
                // 设置默认值
                args[i] = myDefault.value();
            }
        }
        return pjp.proceed(args);
    }
}

在上面的代码中,我们使用了@Around注解和MyDefault注解,表示我们需要拦截所有被MyDefault注解标记的方法,并进行参数的默认值赋值。在doAround()方法中,我们首先获取方法的参数列表,然后遍历每个参数,如果该参数为null,则将其设置为MyDefault注解的属性值。

总结

本文介绍了如何使用SpringBoot自定义注解和AOP技术来实现参数效验和默认值赋值的功能。通过自定义注解和AOP技术,我们可以方便地对参数进行效验和默认值赋值,提高了代码的可读性和可维护性。这种方法可以用于各种Web开发场景中,对于一些需要对参数进行效验和默认值赋值的接口特别有用。

目录
相关文章
|
2月前
|
XML Java 数据格式
SpringBoot入门(8) - 开发中还有哪些常用注解
SpringBoot入门(8) - 开发中还有哪些常用注解
60 0
|
6天前
|
存储 安全 Java
Spring Boot 3 集成Spring AOP实现系统日志记录
本文介绍了如何在Spring Boot 3中集成Spring AOP实现系统日志记录功能。通过定义`SysLog`注解和配置相应的AOP切面,可以在方法执行前后自动记录日志信息,包括操作的开始时间、结束时间、请求参数、返回结果、异常信息等,并将这些信息保存到数据库中。此外,还使用了`ThreadLocal`变量来存储每个线程独立的日志数据,确保线程安全。文中还展示了项目实战中的部分代码片段,以及基于Spring Boot 3 + Vue 3构建的快速开发框架的简介与内置功能列表。此框架结合了当前主流技术栈,提供了用户管理、权限控制、接口文档自动生成等多项实用特性。
36 8
|
2月前
|
监控 安全 Java
什么是AOP?如何与Spring Boot一起使用?
什么是AOP?如何与Spring Boot一起使用?
84 5
|
2月前
|
消息中间件 Java 数据库
解密Spring Boot:深入理解条件装配与条件注解
Spring Boot中的条件装配与条件注解提供了强大的工具,使得应用程序可以根据不同的条件动态装配Bean,从而实现灵活的配置和管理。通过合理使用这些条件注解,开发者可以根据实际需求动态调整应用的行为,提升代码的可维护性和可扩展性。希望本文能够帮助你深入理解Spring Boot中的条件装配与条件注解,在实际开发中更好地应用这些功能。
49 2
|
2月前
|
XML Java 数据格式
SpringBoot入门(8) - 开发中还有哪些常用注解
SpringBoot入门(8) - 开发中还有哪些常用注解
50 2
|
2月前
|
JSON Java 数据库
SpringBoot项目使用AOP及自定义注解保存操作日志
SpringBoot项目使用AOP及自定义注解保存操作日志
59 1
|
2月前
|
存储 安全 Java
springboot当中ConfigurationProperties注解作用跟数据库存入有啥区别
`@ConfigurationProperties`注解和数据库存储配置信息各有优劣,适用于不同的应用场景。`@ConfigurationProperties`提供了类型安全和模块化的配置管理方式,适合静态和简单配置。而数据库存储配置信息提供了动态更新和集中管理的能力,适合需要频繁变化和集中管理的配置需求。在实际项目中,可以根据具体需求选择合适的配置管理方式,或者结合使用这两种方式,实现灵活高效的配置管理。
31 0
|
4月前
Micronaut AOP与代理机制:实现应用功能增强,无需侵入式编程的秘诀
AOP(面向切面编程)能够帮助我们在不修改现有代码的前提下,为应用程序添加新的功能或行为。Micronaut框架中的AOP模块通过动态代理机制实现了这一目标。AOP将横切关注点(如日志记录、事务管理等)从业务逻辑中分离出来,提高模块化程度。在Micronaut中,带有特定注解的类会在启动时生成代理对象,在运行时拦截方法调用并执行额外逻辑。例如,可以通过创建切面类并在目标类上添加注解来记录方法调用信息,从而在不侵入原有代码的情况下增强应用功能,提高代码的可维护性和可扩展性。
92 1
|
2月前
|
安全 Java 编译器
什么是AOP面向切面编程?怎么简单理解?
本文介绍了面向切面编程(AOP)的基本概念和原理,解释了如何通过分离横切关注点(如日志、事务管理等)来增强代码的模块化和可维护性。AOP的核心概念包括切面、连接点、切入点、通知和织入。文章还提供了一个使用Spring AOP的简单示例,展示了如何定义和应用切面。
253 1
什么是AOP面向切面编程?怎么简单理解?
|
2月前
|
XML Java 开发者
论面向方面的编程技术及其应用(AOP)
【11月更文挑战第2天】随着软件系统的规模和复杂度不断增加,传统的面向过程编程和面向对象编程(OOP)在应对横切关注点(如日志记录、事务管理、安全性检查等)时显得力不从心。面向方面的编程(Aspect-Oriented Programming,简称AOP)作为一种新的编程范式,通过将横切关注点与业务逻辑分离,提高了代码的可维护性、可重用性和可读性。本文首先概述了AOP的基本概念和技术原理,然后结合一个实际项目,详细阐述了在项目实践中使用AOP技术开发的具体步骤,最后分析了使用AOP的原因、开发过程中存在的问题及所使用的技术带来的实际应用效果。
77 5