利用自定义注解在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;

/**
 * 自定义注解：用于标记需要额外添加Model属性的Controller方法或类
 */
@Target({ElementType.METHOD, ElementType.TYPE}) // 作用于方法和类
@Retention(RetentionPolicy.RUNTIME) // 运行时可见
public @interface AddCustomModelAttr {
    /**
     * 要添加的Model属性的键
     */
    String key() default "defaultKey";

    /**
     * 要添加的Model属性的值
     */
    String value() default "defaultValue";
}

package com.example.demo.aspect;

import com.example.demo.annotation.AddCustomModelAttr;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.stereotype.Component;
import org.springframework.ui.Model;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import java.lang.reflect.Method;
import java.util.Arrays;

/**
 * 自定义Model属性添加切面
 */
@Aspect
@Component
public class CustomModelAttrAspect {

    /**
     * 定义切点：匹配所有被 @AddCustomModelAttr 注解标记的方法或类
     * 注意：这里为了简化示例，我们假设Controller方法会接收Model参数。
     * 实际应用中可能需要更复杂的逻辑来获取Model对象。
     */
    @Before("@annotation(addCustomModelAttr) || @within(addCustomModelAttr)")
    public void addModelAttributes(JoinPoint joinPoint, AddCustomModelAttr addCustomModelAttr) {
        // 尝试从方法参数中获取Model对象
        Object[] args = joinPoint.getArgs();
        Model model = null;

        for (Object arg : args) {
            if (arg instanceof Model) {
                model = (Model) arg;
                break;
            }
        }

        // 如果方法参数中没有Model对象，则尝试从ModelAndView中获取（如果返回类型是ModelAndView）
        // 或者通过其他方式（如RequestAttributes）来传递数据。
        // 这里为了示例的简洁性，我们假设Model总是作为参数传入。
        if (model == null) {
            // 尝试从请求属性中获取Model，这通常不是直接获取Model的最佳方式，
            // 但可以作为一种备选方案或用于调试。
            // 实际场景中，如果Model不是参数，可能需要改变切点或通知类型。
            System.out.println("警告：目标方法没有Model参数，无法直接添加属性。");
            return;
        }

        // 获取注解的属性值
        String key = addCustomModelAttr.key();
        String value = addCustomModelAttr.value();

        // 向Model中添加属性
        model.addAttribute(key, value);
        System.out.println("AOP: 成功向Model中添加属性 - key: " + key + ", value: " + value);
    }
}

package com.example.demo.controller;

import com.example.demo.annotation.AddCustomModelAttr;
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
@RequestMapping("/ex")
public class ExController {

    // 示例1：在方法上使用注解，使用默认的key和value
    @AddCustomModelAttr
    @GetMapping("/index1")
    public String index1(Model model){
        System.out.println("Controller: index1 方法执行，Model内容：" + model.asMap());
        return "index"; // 假设存在一个名为 index.html 的Thymeleaf模板
    }

    // 示例2：在方法上使用注解，并指定自定义的key和value
    @AddCustomModelAttr(key = "customKey", value = "customValue")
    @GetMapping("/index2")
    public String index2(Model model){
        System.out.println("Controller: index2 方法执行，Model内容：" + model.asMap());
        return "index";
    }

    // 示例3：在类上使用注解，所有方法都将继承该逻辑
    // 为了演示，我们将这个注解移到类级别，并创建一个新的Controller
}

@AddCustomModelAttr(key = "classLevelKey", value = "classLevelValue")
@Controller
@RequestMapping("/class-level")
class ClassLevelAnnotatedController {

    @GetMapping("/home")
    public String home(Model model) {
        System.out.println("Controller: home 方法执行，Model内容：" + model.asMap());
        return "index";
    }

    @GetMapping("/about")
    public String about(Model model) {
        System.out.println("Controller: about 方法执行，Model内容：" + model.asMap());
        return "index";
    }
}

package com.example.demo;

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

@SpringBootApplication
@EnableAspectJAutoProxy // 如果AOP没有自动启用，则需要添加此注解
public class DemoApplication {

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

}

AOP: 成功向Model中添加属性 - key: defaultKey, value: defaultValue
Controller: index1 方法执行，Model内容：{defaultKey=defaultValue}