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

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

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

SpringBoot自定义注解

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

代码语言：java复制

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

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

AOP技术

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

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

代码语言：java复制

@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技术来实现这个功能。

首先，定义一个用于效验的注解：

代码语言：java复制

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

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

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

代码语言：java复制

@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技术来实现这个功能。

首先，定义一个用于默认值赋值的注解：

代码语言：java复制

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

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

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

代码语言：java复制

@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开发场景中，对于一些需要对参数进行效验和默认值赋值的接口特别有用。

springboot

0 人点赞