利用Spring AOP与自定义注解实现方法逻辑扩展

package com.example.annotation;

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

/**
 * 自定义注解，用于标记需要额外逻辑增强的Controller或方法
 */
@Target(ElementType.TYPE) // 目标是类、接口（包括注解类型）或枚举声明
@Retention(RetentionPolicy.RUNTIME) // 注解在运行时可用，可以通过反射读取
public @interface MyCustomAnnotation {
    // 可以在这里定义注解的属性，例如一个描述信息
    String value() default "Default custom logic";
}

package com.example.aspect;

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

/**
 * 自定义注解的切面，用于实现逻辑增强
 */
@Aspect // 声明这是一个切面
@Component // 将切面作为Spring组件管理
public class CustomAnnotationAspect {

    /**
     * 定义一个环绕通知（@Around），拦截被MyCustomAnnotation注解的类中所有公共方法。
     *
     * 切点表达式解释：
     * - @within(com.example.annotation.MyCustomAnnotation)：匹配所有被MyCustomAnnotation注解的类。
     * - execution(public * *(..))：匹配该类中所有的公共方法。
     *
     * @param joinPoint 连接点，提供对被拦截方法的信息和控制
     * @return 目标方法的返回值
     * @throws Throwable 目标方法或切面逻辑可能抛出的异常
     */
    @Around("@within(com.example.annotation.MyCustomAnnotation) && execution(public * *(..))")
    public Object applyCustomLogic(ProceedingJoinPoint joinPoint) throws Throwable {
        System.out.println("--- 进入自定义逻辑增强切面 ---");

        // 1. 在方法执行前添加逻辑
        System.out.println("切面：准备为方法 " + joinPoint.getSignature().getName() + " 添加Model属性...");

        // 获取方法参数，查找Model对象
        Object[] args = joinPoint.getArgs();
        for (Object arg : args) {
            if (arg instanceof Model) {
                Model model = (Model) arg;
                // 根据需求添加Model属性
                model.addAttribute("customKey", "customValueFromAspect");
                System.out.println("切面：成功向Model中添加属性 'customKey:customValueFromAspect'");
                break; // 假设每个方法最多只有一个Model参数
            }
        }

        // 2. 执行原始目标方法
        Object result = joinPoint.proceed(); // 调用目标方法

        // 3. 在方法执行后添加逻辑（可选）
        System.out.println("切面：方法 " + joinPoint.getSignature().getName() + " 执行完毕。");
        System.out.println("--- 退出自定义逻辑增强切面 ---");

        return result; // 返回目标方法的执行结果
    }
}

package com.example;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.EnableAspectJAutoProxy;

@SpringBootApplication
@EnableAspectJAutoProxy // 启用Spring AOP的自动代理功能
public class DemoApplication {

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

package com.example.controller;

import com.example.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;

/**
 * 示例Controller，被MyCustomAnnotation标记
 */
@MyCustomAnnotation // 应用自定义注解
@Controller
public class ExController {

    @RequestMapping(value = "/index", method = RequestMethod.GET)
    public String index(Model model){
        System.out.println("Controller：进入index方法。");
        // 这里不需要手动添加model.addAttribute("customKey","customValueFromAspect");
        // 它会由切面自动添加

        // 验证切面是否已添加属性
        if (model.containsAttribute("customKey")) {
            System.out.println("Controller：Model中已包含 'customKey'，值为：" + model.getAttribute("customKey"));
        } else {
            System.out.println("Controller：Model中未包含 'customKey'。");
        }

        model.addAttribute("message", "Hello from ExController!");
        return "index"; // 返回视图名称
    }

    @GetMapping("/hello")
    public String hello(Model model) {
        System.out.println("Controller：进入hello方法。");
        // 这个方法也会被切面拦截，因为MyCustomAnnotation在类级别
        if (model.containsAttribute("customKey")) {
            System.out.println("Controller：Model中已包含 'customKey'，值为：" + model.getAttribute("customKey"));
        }
        model.addAttribute("greeting", "Greetings from another method!");
        return "hello";
    }

    @GetMapping("/no-model")
    public String noModel() {
        System.out.println("Controller：进入noModel方法，无Model参数。");
        // 这个方法也会被切面拦截，但切面不会找到Model参数，所以不会添加属性
        return "no-model";
    }
}