通过自定义注解在 Spring Boot 方法中注入特定逻辑

package com.example.demo.annotation; // 建议放在单独的包中

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 自定义注解，用于标记需要注入特定逻辑的类或方法。
 */
@Target({ElementType.TYPE, ElementType.METHOD}) // 允许注解作用于类和方法
@Retention(RetentionPolicy.RUNTIME) // 运行时保留，以便通过反射读取
public @interface MyCustomAnnotation {
    // 可以在此添加属性，如果逻辑需要基于注解的参数
    // String value() default "";
}

package com.example.demo.aspect; // 建议放在单独的包中

import com.example.demo.annotation.MyCustomAnnotation;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.stereotype.Component;
import org.springframework.ui.Model;

import java.util.Arrays;

/**
 * 自定义注解逻辑切面，用于在被@MyCustomAnnotation标记的方法执行前注入逻辑。
 */
@Aspect // 声明这是一个切面
@Component // 将切面作为Spring组件管理
public class CustomAnnotationLogicAspect {

    /**
     * 定义切点：匹配被 @MyCustomAnnotation 标记的类中的所有方法，
     * 或者直接被 @MyCustomAnnotation 标记的方法。
     */
    @Pointcut("@within(com.example.demo.annotation.MyCustomAnnotation) || @annotation(com.example.demo.annotation.MyCustomAnnotation)")
    public void myCustomAnnotationPointcut() {}

    /**
     * 定义环绕通知：在目标方法执行前后执行自定义逻辑。
     *
     * @param joinPoint 连接点，提供对目标方法的信息和控制
     * @return 目标方法的返回值
     * @throws Throwable 目标方法或通知中抛出的异常
     */
    @Around("myCustomAnnotationPointcut()")
    public Object applyCustomLogic(ProceedingJoinPoint joinPoint) throws Throwable {
        System.out.println("--- 进入 CustomAnnotationLogicAspect: 准备注入逻辑 ---");

        // 尝试从方法参数中查找 Model 对象，并添加属性
        boolean modelModified = false;
        Object[] args = joinPoint.getArgs(); // 获取目标方法的参数
        if (args != null && args.length > 0) {
            for (Object arg : args) {
                if (arg instanceof Model) { // 如果参数是 Model 类型
                    Model model = (Model) arg;
                    model.addAttribute("keyFromAspect", "valueFromCustomAnnotation");
                    System.out.println("    >>> 成功向 Model 添加属性: keyFromAspect='valueFromCustomAnnotation'");
                    modelModified = true;
                    break;
                }
            }
        }

        if (!modelModified) {
            System.out.println("    >>> 警告: 未在方法参数中找到 Model 对象，无法注入 Model 属性。");
        }

        // 继续执行目标方法
        Object result = joinPoint.proceed();

        System.out.println("--- 退出 CustomAnnotationLogicAspect: 逻辑注入完成 ---");
        return result; // 返回目标方法的执行结果
    }
}

package com.example.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.EnableAspectJAutoProxy; // 导入 AOP 启用注解

@SpringBootApplication
@EnableAspectJAutoProxy // 启用 Spring AOP 代理
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

package com.example.demo.controller;

import com.example.demo.annotation.MyCustomAnnotation;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

@MyCustomAnnotation // 将自定义注解应用于 Controller 类
@Controller
public class ExController {

    @RequestMapping(value = "/index", method = RequestMethod.GET)
    public String index(Model model){
        // 注意：这里不需要手动添加 model.addAttribute("key","value");
        // 这段逻辑将由 CustomAnnotationLogicAspect 自动注入。
        System.out.println("    >>> 正在执行 ExController.index() 方法内部逻辑。");
        System.out.println("    >>> Model 是否包含 'keyFromAspect' 属性? " + model.containsAttribute("keyFromAspect"));
        return "index"; // 假设存在一个名为 'index.html' 或 'index.jsp' 的视图
    }

    @GetMapping("/another")
    public String anotherMethod(Model model) {
        // 由于类被 @MyCustomAnnotation 标记，此方法也会被切面处理
        System.out.println("    >>> 正在执行 ExController.anotherMethod() 方法内部逻辑。");
        System.out.println("    >>> Model 是否包含 'keyFromAspect' 属性? " + model.containsAttribute("keyFromAspect"));
        return "another"; // 假设存在一个名为 'another.html' 的视图
    }
}