自定义注解的使用

Spring项目中自定义注解的使用

参考：

1.创建spring boot项目及相关类

类的内容如下所示：
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {

private Integer id;

private String name;

}

@Component
public class UserDao {

public User findUserById(Integer id) {
    if(id > 10) {
        return null;
    }
    return new User(id, "user-" + id);
}

}

@Service
public class UserService {

private final UserDao userDao;

public UserService(UserDao userDao) {
    this.userDao = userDao;
}

public User findUserById(Integer id) {
    return userDao.findUserById(id);
}

}

@RestController
public class UserController {

private final UserService userService;

public UserController(UserService userService) {
    this.userService = userService;
}

@RequestMapping("user/{id}")
public User findUser(@PathVariable("id") Integer id) {
    return userService.findUserById(id);
}

}

先创建一个annotation包，里面创建我们自定义的注解类KthLog：
package com.example.demo.annotation;

import java.lang.annotation.*;

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface KthLog {

String value() default "";

}
@Documented：注解信息会被添加到Java文档中
@Retention：注解的生命周期，表示注解会被保留到什么阶段，可以选择编译阶段、类加载阶段，或运行阶段
@Target：注解作用的位置，ElementType.METHOD表示该注解仅能作用于方法上

然后我们可以把注解添加到方法上：
@KthLog(“这是日志内容”)
@RequestMapping(“user/{id}”)
public User findUser(@PathVariable(“id”) Integer id) {
return userService.findUserById(id);
}

创建切面类，如下：
@Component
@Aspect
public class KthLogAspect {

@Pointcut("@annotation(com.example.demo.annotation.KthLog)")
private void pointcut() {}

@Before("pointcut() && @annotation(logger)")
public void advice(KthLog logger) {
    System.out.println("--- Kth日志的内容为[" + logger.value() + "] ---");
}

}
@Pointcut声明了切点（这里的切点是我们自定义的注解类）
@Before声明了通知内容
@annotation(logger)拿到了自定义的注解对象，所以就能够获取我们在使用注解时赋予的值了

控制台成功输出：

2.使用注解获取更详细的信息

只需要在切面类的advice()方法中添加一个JoinPoint参数即可

@Before("pointcut() && @annotation(logger)")
public void advice(JoinPoint joinPoint, KthLog logger) {
    System.out.println("注解作用的方法名: " + joinPoint.getSignature().getName());
    
    System.out.println("所在类的简单类名: " + joinPoint.getSignature().getDeclaringType().getSimpleName());
    
    System.out.println("所在类的完整类名: " + joinPoint.getSignature().getDeclaringType());
    
    System.out.println("目标方法的声明类型: " + Modifier.toString(joinPoint.getSignature().getModifiers()));
}

输出结果：

3.使用注解修改参数和返回值
ProceedingJoinPoint继承了JoinPoint接口，在JoinPoint中，存在一个getArgs()方法，用于获取方法参数，返回的是一个Object数组，与之匹配的则是proceed(args)方法，这两个方法结合起来，就能够实现我们的目的：
@Around(“pointcut() && @annotation(logger)”)
public Object advice(ProceedingJoinPoint joinPoint, KthLog logger) {
System.out.println(“[”
+ joinPoint.getSignature().getDeclaringType().getSimpleName()
+ “][” + joinPoint.getSignature().getName()
+ “]-日志内容-[” + logger.value() + “]”);

    Object result = null;

    Object[] args = joinPoint.getArgs();
    for (int i = 0; i < args.length; i++) {
        if(args[i] instanceof Integer) {
            args[i] = (Integer)args[i] - 1;
            break;
        }
    }

    try {
        result = joinPoint.proceed(args);
    } catch (Throwable throwable) {
        throwable.printStackTrace();
    }

    if(result instanceof User) {
        User user = (User) result;
        user.setId(user.getId() + 1);
        return user;
    }
    return result;
}