• 【SpringMVC】自定义注解与AOP结合使用

    目录

    一、SpringMVC之自定义注解

    1.1 Java注解简介

    1.2 为什么要用注解

    1.3 注解的分类 ⭐

    1.3.1 JDK基本注解

    1.3.2 JDK元注解 

    1.3.3 自定义注解 

    1.4 自定义注解三种使用案例

    1.4.1 案例一（获取类与方法上的注解值）

    1.4.2 案例二（获取类属性上的注解属性值）

    1.4.3 案例三（获取参数修饰注解对应的属性值）

    二、Aop自定义注解的应用  

    2.1 自定义注解类

    2.2 切面类

    2.3 Controller层代码

    2.4 测试

    一、SpringMVC之自定义注解

    1.1 Java注解简介

            注解（Annotation）是Java语言的一种元数据（metadata）机制，它提供了一种在代码中添加额外信息的方式。注解可以用于标记代码的特定元素，如类、方法、字段、参数等，以便在编译时、运行时或者通过工具进行处理。

    注解相关类都包含在java.lang.annotation包中。

    1.2 为什么要用注解

    使用注解的主要目的是为了提供更多的元数据信息，以便在编译时或运行时进行处理。注解可以用于以下几个方面：

    1. 编译时处理：注解可以在编译时被编译器识别和处理。通过在代码中添加注解，我们可以告诉编译器执行特定的操作，如生成额外的代码、进行静态检查、生成文档等。例如，JUnit框架中的@Test注解用于标记测试方法，在编译时会被JUnit运行器识别并执行相应的测试。

    2. 运行时处理：注解可以在程序运行时通过反射机制被读取和处理。通过读取注解，我们可以获取代码中的元数据信息，并根据注解的定义执行相应的逻辑。例如，Spring框架中的@Autowired注解用于自动注入依赖，通过读取注解，Spring容器可以自动将依赖注入到相应的对象中。

    3. 工具处理：注解可以被工具读取和处理，以实现特定的功能。例如，JavaDoc工具可以读取代码中的注解，并生成相应的文档。其他工具，如代码生成器、静态分析工具等，也可以利用注解来实现特定的功能。

    使用注解的好处包括：

    1. 提供更多的元数据信息：注解可以为代码添加额外的元数据信息，使得代码更加丰富和可读。通过注解，我们可以标记代码的特定含义、行为和规则，提高代码的可理解性和可维护性。

    2. 简化开发流程：注解可以简化开发流程，减少重复的代码和配置。通过使用注解，我们可以自动化一些常见的任务，如依赖注入、配置解析、路由映射等，提高开发效率。

    3. 增强代码的可靠性和安全性：注解可以用于进行静态检查和约束，以确保代码的正确性和安全性。通过在代码中添加注解，我们可以在编译时或运行时进行验证，避免一些常见的错误和问题。

            总之，注解是一种强大的元数据机制，它可以为代码添加额外的信息和行为，提高代码的可读性、可维护性和可靠性。通过使用注解，我们可以简化开发流程，提高开发效率，并实现更灵活和可扩展的功能。

    1.3 注解的分类 ⭐

    1.3.1 JDK基本注解

            JDK基本注解是Java开发工具包（JDK）中提供的一组预定义注解，用于标记代码的特定元素。这些注解包括：

    1. @Override：用于标记方法覆盖（重写）父类中的方法。当一个方法使用了该注解时，编译器会检查该方法是否正确地覆盖了父类中的方法。

    2. @Deprecated：用于标记已过时的方法、类或字段。当一个方法或类被标记为过时时，编译器会发出警告，提醒开发者不再推荐使用该方法或类。

    3. @SuppressWarnings：用于抑制编译器产生的警告信息。可以在方法、类或整个代码块上使用该注解，以忽略特定类型的警告。

    1.3.2 JDK元注解 

            JDK元注解是用于注解其他注解的注解，它们提供了更多的元数据和行为来定义注解的行为。JDK中提供了四个元注解：

    1. @Retention：用于指定注解的生命周期。可以设置为SOURCE（只在源代码中可见）、CLASS（在编译时可见）或RUNTIME（在运行时可见）。

    2. @Target：用于指定注解可以应用的目标元素类型。可以设置为TYPE（类、接口、枚举）、METHOD（方法）、FIELD（字段）等。

    3. @Documented：用于指定注解是否包含在Java文档中。如果一个注解被@Documented注解修饰，那么它的信息将包含在生成的文档中。

    4. @Inherited：用于指定注解是否可以被继承。如果一个注解被@Inherited注解修饰，那么它的子类将自动继承该注解（不常用）。

    @Target：指定被修饰的Annotation可以放置的位置(被修饰的目标)
    @Target(ElementType.TYPE)      //接口、类
    @Target(ElementType.FIELD)     //属性
    @Target(ElementType.METHOD)     //方法
    @Target(ElementType.PARAMETER)     //方法参数
    @Target(ElementType.CONSTRUCTOR)     //构造函数
    @Target(ElementType.LOCAL_VARIABLE)    //局部变量
    @Target(ElementType.ANNOTATION_TYPE)   //注解
    @Target(ElementType.PACKAGE)    //包


    注：可以指定多个位置，例如：
    @Target({ElementType.METHOD, ElementType.TYPE})，也就是此注解可以在方法和类上面使用 

    1.3.3 自定义注解 

            自定义注解是开发者根据自己的需求创建的注解。通过自定义注解，开发者可以为代码添加特定的元数据信息，并定义相应的处理逻辑。自定义注解的创建步骤包括：

    1. 使用@interface关键字定义一个注解类型。
    2. 在注解中定义需要的元素，可以包括基本类型、枚举类型、Class类型、注解类型等。
    3. 使用元注解对注解进行修饰，例如@Retention、@Target等，以定义注解的生命周期和使用范围。
    4. 在代码中使用自定义注解，可以通过反射获取注解的元素值，并根据注解的定义进行相应的处理。

    要创建一个自定义注解，你需要使用Java的注解机制。下面是一个简单的示例，展示了如何创建一个自定义注解：

    1. import java.lang.annotation.ElementType;
    2. import java.lang.annotation.Retention;
    3. import java.lang.annotation.RetentionPolicy;
    4. import java.lang.annotation.Target;
    5.  
    6. @Retention(RetentionPolicy.RUNTIME)
    7. @Target(ElementType.METHOD)
    8. public @interface CustomAnnotation {
    9.     // 在这里定义注解的属性
    10.     String value();
    11. }

    在上面的示例中，我们创建了一个名为CustomAnnotation的注解。它有一个属性value，可以用来传递一些自定义的信息。

            通过自定义注解，开发者可以实现更灵活和可扩展的功能，如自定义验证规则、日志记录、权限控制等。自定义注解可以在类、方法、字段、参数等级别上使用，以满足不同的需求。

    1.4 自定义注解三种使用案例

    注解（根据Annotation是否包含成员变量,可以把Annotation分为两类）:

    1. 标记注解（Marker Annotation）：这种注解没有成员变量，它们仅通过自身的存在与否来提供信息。

    例如：Java中的@Override注解就是一个标记注解，用于标记方法覆盖（重写）父类中的方法。

    2. 元数据注解（Meta Annotation）：这种注解包含成员变量，它们可以接受和提供更多的元数据信息。元数据注解除了标记代码的特定元素外，还可以携带额外的数据或参数。通过元数据注解，我们可以为代码添加更多的元数据信息，以便在编译时、运行时或者通过工具进行处理。元数据注解可以用于配置、约束、验证等方面。

    例如：Spring框架中的@RequestMapping注解就是一个元数据注解，它不仅可以标记请求处理方法，还可以指定请求的URL路径、请求方法、请求参数等。

    1.4.1 案例一（获取类与方法上的注解值）

    1. 定义一个枚举类：用来表示一组固定的值。

    1. package com.ycxw.model;
    2.  
    3. public enum  TranscationModel {
    4.     Read, Write, ReadWrite
    5. }

    2. 定义三个不同注解方式的类：

    MyAnnotation1 :  

    1. package com.ycxw.annotation;
    2.  
    3. import java.lang.annotation.*;
    4.  
    5. /**
    6.  * MyAnnotation1注解可以用在类、接口、属性、方法上
    7.  * 注解运行期也保留
    8.  * 不可继承
    9.  */
    10. @Target({ElementType.TYPE, ElementType.FIELD,ElementType.METHOD})
    11. @Retention(RetentionPolicy.RUNTIME)
    12. @Documented
    13. public @interface MyAnnotation1 {
    14.     String name();
    15. }

    MyAnnotation2 :  

    1. package com.ycxw.annotation;
    2.  
    3. import com.ycxw.model.TranscationModel;
    4.  
    5. import java.lang.annotation.*;
    6.  
    7. /**
    8.  *  MyAnnotation2注解可以用在方法上
    9.  *  注解运行期也保留
    10.  *  不可继承
    11.  */
    12. @Target(ElementType.METHOD)
    13. @Retention(RetentionPolicy.RUNTIME)
    14. @Documented
    15. public @interface MyAnnotation2 {
    16.     TranscationModel model() default TranscationModel.ReadWrite;
    17. }

    MyAnnotation3 :  

    1. package com.ycxw.annotation;
    2.  
    3. import com.ycxw.model.TranscationModel;
    4.  
    5. import java.lang.annotation.*;
    6.  
    7.  
    8. /**
    9.  * MyAnnotation3注解可以用在方法上
    10.  * 注解运行期也保留
    11.  * 可继承
    12.  */
    13. @Target(ElementType.METHOD)
    14. @Retention(RetentionPolicy.RUNTIME)
    15. @Inherited
    16. @Documented
    17. public @interface MyAnnotation3 {
    18.     TranscationModel[] models() default TranscationModel.ReadWrite;
    19. }

     Demo1测试类 : 获取类与方法上的注解值

    1. package com.ycxw.annotation.demo;
    2.  
    3. import com.ycxw.annotation.MyAnnotation1;
    4. import com.ycxw.annotation.MyAnnotation2;
    5. import com.ycxw.annotation.MyAnnotation3;
    6. import com.ycxw.model.TranscationModel;
    7.  
    8. /**
    9.  * 获取类与方法上的注解值
    10.  */
    11. @MyAnnotation1(name = "abc")
    12. public class Demo1 {
    13.  
    14.     @MyAnnotation1(name = "xyz")
    15.     private Integer age;
    16.  
    17.     @MyAnnotation2(model = TranscationModel.Read)
    18.     public void list() {
    19.         System.out.println("list");
    20.     }
    21.  
    22.     @MyAnnotation3(models = {TranscationModel.Read, TranscationModel.Write})
    23.     public void edit() {
    24.         System.out.println("edit");
    25.     }
    26. }

     Demo1Test测试类：

    1. package com.ycxw.annotation.demo;
    2.  
    3. import com.ycxw.annotation.MyAnnotation1;
    4. import com.ycxw.annotation.MyAnnotation2;
    5. import com.ycxw.annotation.MyAnnotation3;
    6. import com.ycxw.model.TranscationModel;
    7. import org.junit.Test;
    8.  
    9. public class Demo1Test {
    10.     @Test
    11.     public void list() throws Exception {
    12. //        获取类上的注解
    13.         MyAnnotation1 annotation1 = Demo1.class.getAnnotation(MyAnnotation1.class);
    14.         System.out.println(annotation1.name());//abc
    15.  
    16. //        获取方法上的注解
    17.         MyAnnotation2 myAnnotation2 = Demo1.class.getMethod("list").getAnnotation(MyAnnotation2.class);
    18.         System.out.println(myAnnotation2.model());//Read
    19.  
    20. //        获取属性上的注解
    21.         MyAnnotation1 myAnnotation1 = Demo1.class.getDeclaredField("age").getAnnotation(MyAnnotation1.class);
    22.         System.out.println(myAnnotation1.name());// xyz
    23.     }
    24.  
    25.     @Test
    26.     public void edit() throws Exception {
    27.         MyAnnotation3 myAnnotation3 = Demo1.class.getMethod("edit").getAnnotation(MyAnnotation3.class);
    28.         for (TranscationModel model : myAnnotation3.models()) {
    29.             System.out.println(model);//Read,Write
    30.         }
    31.     }
    32. }

    运行list方法结果：

    运行edit方法结果：

    1.4.2 案例二（获取类属性上的注解属性值）

    1. 自定义注解类：

    1. package com.ycxw.annotation;
    2.  
    3. import java.lang.annotation.ElementType;
    4. import java.lang.annotation.Retention;
    5. import java.lang.annotation.RetentionPolicy;
    6. import java.lang.annotation.Target;
    7.  
    8. //@Retention(RetentionPolicy.SOURCE)
    9. @Retention(RetentionPolicy.RUNTIME)
    10. @Target(ElementType.FIELD)
    11. public @interface TestAnnotation {
    12.     String value() default "默认value值";
    13.  
    14.     String what() default "这里是默认的what属性对应的值";
    15. }

    2. 定义测试类：获取类属性上的注解属性值

    1. package com.ycxw.annotation.demo2;
    2.  
    3. import com.ycxw.annotation.TestAnnotation;
    4.  
    5. /**
    6.  * 获取类属性上的注解属性值
    7.  */
    8. public class Demo2 {
    9.     @TestAnnotation(value = "这就是value对应的值_msg1", what = "这就是what对应的值_msg1")
    10.     private static String msg1;
    11.  
    12.     @TestAnnotation("这就是value对应的值1")
    13.     private static String msg2;
    14.  
    15.     @TestAnnotation(value = "这就是value对应的值2")
    16.     private static String msg3;
    17.  
    18.     @TestAnnotation(what = "这就是what对应的值")
    19.     private static String msg4;
    20. }

     3. 测试

    1. package com.ycxw.annotation.demo2;
    2.  
    3. import com.ycxw.annotation.TestAnnotation;
    4. import org.junit.Test;
    5.  
    6. public class Demo2Test {
    7.     @Test
    8.     public void test1() throws Exception {
    9.         TestAnnotation msg1 = Demo2.class.getDeclaredField("msg1").getAnnotation(TestAnnotation.class);
    10.         System.out.println(msg1.value());
    11.         System.out.println(msg1.what());
    12.     }
    13.  
    14.     @Test
    15.     public void test2() throws Exception{
    16.         TestAnnotation msg2 = Demo2.class.getDeclaredField("msg2").getAnnotation(TestAnnotation.class);
    17.         System.out.println(msg2.value());
    18.         System.out.println(msg2.what());
    19.     }
    20.  
    21.     @Test
    22.     public void test3() throws Exception{
    23.         TestAnnotation msg3 = Demo2.class.getDeclaredField("msg3").getAnnotation(TestAnnotation.class);
    24.         System.out.println(msg3.value());
    25.         System.out.println(msg3.what());
    26.     }
    27.  
    28.     @Test
    29.     public void test4() throws Exception{
    30.         TestAnnotation msg4 = Demo2.class.getDeclaredField("msg4").getAnnotation(TestAnnotation.class);
    31.         System.out.println(msg4.value());
    32.         System.out.println(msg4.what());
    33.     }
    34. }

    1.4.3 案例三（获取参数修饰注解对应的属性值）

    1， 创建自定义注解：

    1. package com.ycxw.annotation;
    2.  
    3. import java.lang.annotation.*;
    4.  
    5. /**
    6.  * 非空注解：使用在方法的参数上，false表示此参数可以为空，true不能为空
    7.  */
    8. @Documented
    9. @Target({ElementType.PARAMETER})
    10. @Retention(RetentionPolicy.RUNTIME)
    11. public @interface IsNotNull {
    12.     boolean value() default false;
    13. }

    2. 创建测试类：获取参数修饰注解对应的属性值

    1. package com.ycxw.annotation.demo3;
    2.  
    3. import com.ycxw.annotation.IsNotNull;
    4.  
    5. /**
    6.  * 获取参数修饰注解对应的属性值
    7.  */
    8. public class Demo3 {
    9.  
    10.     public void hello1(@IsNotNull(true) String name) {
    11.         System.out.println("hello:" + name);
    12.     }
    13.  
    14.     public void hello2(@IsNotNull String name) {
    15.         System.out.println("hello:" + name);
    16.     }
    17. }

    3. 测试

    1. package com.ycxw.annotation.demo3;
    2.  
    3. import com.ycxw.annotation.IsNotNull;
    4. import org.junit.Test;
    5.  
    6. import java.lang.reflect.Method;
    7. import java.lang.reflect.Parameter;
    8.  
    9. public class Demo3Test {
    10.  
    11.     @Test
    12.     public void hello1() throws Exception {
    13.         Demo3 demo3 = new Demo3();
    14.         for (Parameter parameter : demo3.getClass().getMethod("hello1", String.class).getParameters()) {
    15.             IsNotNull annotation = parameter.getAnnotation(IsNotNull.class);
    16.             if(annotation != null){
    17.                 System.out.println(annotation.value());//true
    18.             }
    19.         }
    20.     }
    21.  
    22.     @Test
    23.     public void hello2() throws Exception {
    24.         Demo3 demo3 = new Demo3();
    25.         for (Parameter parameter : demo3.getClass().getMethod("hello2", String.class).getParameters()) {
    26.             IsNotNull annotation = parameter.getAnnotation(IsNotNull.class);
    27.             if(annotation != null){
    28.                 System.out.println(annotation.value());//false
    29.             }
    30.         }
    31.     }
    32.  
    33.     @Test
    34.     public void hello3() throws Exception {
    35. //        模拟浏览器传递到后台的参数 解读@requestParam
    36.         String name = "zs";
    37.         Demo3 demo3 = new Demo3();
    38.         Method method = demo3.getClass().getMethod("hello1", String.class);
    39.         for (Parameter parameter : method.getParameters()) {
    40.             IsNotNull annotation = parameter.getAnnotation(IsNotNull.class);
    41.             if(annotation != null){
    42.                 System.out.println(annotation.value());//true
    43.                 if (annotation.value() && !"".equals(name)){
    44.                     method.invoke(demo3,name);
    45.                 }
    46.             }
    47.         }
    48.     }
    49. }

     

    二、Aop自定义注解的应用  

    2.1 自定义注解类

    1. package com.ycxw.annotation;
    2.  
    3. import java.lang.annotation.ElementType;
    4. import java.lang.annotation.Retention;
    5. import java.lang.annotation.RetentionPolicy;
    6. import java.lang.annotation.Target;
    7.  
    8. @Target(ElementType.METHOD)
    9. @Retention(RetentionPolicy.RUNTIME)
    10. public @interface MyLog {
    11.     String desc();
    12. }

    2.2 切面类

    1. package com.ycxw.aspect;
    2.  
    3. import com.ycxw.annotation.MyLog;
    4. import org.aspectj.lang.JoinPoint;
    5. import org.aspectj.lang.annotation.Aspect;
    6. import org.aspectj.lang.annotation.Before;
    7. import org.aspectj.lang.annotation.Pointcut;
    8. import org.aspectj.lang.reflect.MethodSignature;
    9. import org.slf4j.Logger;
    10. import org.slf4j.LoggerFactory;
    11. import org.springframework.stereotype.Component;
    12.  
    13. @Component
    14. @Aspect
    15. public class MyLogAspect {
    16.     private static final Logger logger = LoggerFactory.getLogger(MyLogAspect.class);
    17.  
    18.     /**
    19.      * 只要用到了com.javaxl.p2.annotation.springAop.MyLog这个注解的，就是目标类
    20.      */
    21.     @Pointcut("@annotation(com.ycxw.annotation.MyLog)")
    22.     private void MyValid() {
    23.     }
    24.  
    25.     @Before("MyValid()")
    26.     public void before(JoinPoint joinPoint) {
    27.         MethodSignature signature = (MethodSignature) joinPoint.getSignature();
    28.         logger.debug("[" + signature.getName() + " : start.....]");
    29.         System.out.println("[" + signature.getName() + " : start.....]");
    30.  
    31.         MyLog myLog = signature.getMethod().getAnnotation(MyLog.class);
    32.         logger.debug("【目标对象方法被调用时候产生的日志，记录到日志表中】："+myLog.desc());
    33.         System.out.println("【目标对象方法被调用时候产生的日志，记录到日志表中】：" + myLog.desc());
    34.     }
    35. }

    2.3 Controller层代码

    1. package com.ycxw.web;
    2.  
    3. import com.ycxw.annotation.MyLog;
    4. import org.springframework.stereotype.Component;
    5.  
    6. @Component
    7. public class LogController {
    8.     @MyLog(desc = "这是结合spring aop知识，讲解自定义注解应用的一个案例")
    9.     public void testLogAspect(){
    10.         System.out.println("记录日志...");
    11.     }
    12. }

    2.4 测试

    访问地址：http://localhost:8080/log/mylog

  • 相关阅读:
    小试从Intel MediaSDK迁移到OneVPL
    敏捷开发的特点及敏捷工具
    总结万字长文笔记webpack5打包资源优化
    腾讯技术创作特训营开班！用写作开启职业生涯新爆点 | 内含福利
    Lsm树学习笔记
    useLayoutEffect和useEffect的区别
    R语言使用fs包的file_move函数对指定文件进行重命名（rename）、使用file_move函数将指定文件从一个位置拷贝（copy）到另一个位置
    为什么我在领英上搜到的客户都是显示领英会员（Linkedin Member）？
    ElementUI之登陆+注册-＞饿了吗完成用户登录界面搭建，axios之get请求，axios之post请求，跨域,注册界面
    Python跳盆算法，来自物质结构的优化算法
  • 原文地址：https://blog.csdn.net/Justw320/article/details/132886879