• SpringBoot:自定义注解

    目录

    一、注释简介

     二、自定义注解

    MyAnnotation注解

     获取注释内标记类的内容

     获取注释内标记属性的内容

     获取注释内标记方法的内容

      获取注释内标记参数的内容

     三、自定义注解日志的使用

    一、注释简介

    Java注解是附加在代码中的一些元信息，用于一些工具在编译、运行时进行解析和使用，起到说明、配置的功能。 注解相关类都包含在java.lang.annotation包中。

     Java注解分类

            JDK基本注解
            JDK元注解
            自定义注解

     JDK基本注解

    @Override
    重写

    @SuppressWarnings(value = "unchecked")
    压制编辑器警告

     JDK元注解

    @Retention：定义注解的保留策略
    @Retention(RetentionPolicy.SOURCE)             //注解仅存在于源码中，在class字节码文件中不包含
    @Retention(RetentionPolicy.CLASS)              //默认的保留策略，注解会在class字节码文件中存在，但运行时无法获得，
    @Retention(RetentionPolicy.RUNTIME)            //注解会在class字节码文件中存在，在运行时可以通过反射获取到

    @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})，也就是此注解可以在方法和类上面使用

    @Inherited：指定被修饰的Annotation将具有继承性

    @Documented：指定被修饰的该Annotation可以被javadoc工具提取成文档.

     自定义注解

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

    标记Annotation:
    没有成员变量的Annotation; 这种Annotation仅利用自身的存在与否来提供信息

    元数据Annotation:
    包含成员变量的Annotation; 它们可以接受(和提供)更多的元数据;

     如何自定义注解？

    使用@interface关键字, 其定义过程与定义接口非常类似, 需要注意的是:
       Annotation的成员变量在Annotation定义中是以无参的方法形式来声明的, 其方法名和返回值类型定义了该成员变量的名字和类型,
       而且我们还可以使用default关键字为这个成员变量设定默认值；

     二、自定义注解

    MyAnnotation注解

    1. package com.cdl.ssm.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. /**
    9.  * @author cdl
    10.  * @site www.cdl.com
    11.  * @create 2022-10-27 11:21
    12.  *
    13.  * MyAnnotation注解可以用在类、接口、属性、方法上
    14.  * 注解运行期也保留
    15.  * 不可继承
    16.  */
    17. @Target({ElementType.TYPE, ElementType.FIELD,ElementType.METHOD})
    18. @Retention(RetentionPolicy.SOURCE)
    19. public @interface  MyAnnotation {
    20.     String name();//注解中的属性
    21. }
    StudentController
    1. package com.cdl.ssm.annotation;
    2.  
    3. /**
    4.  * @author cdl
    5.  * @site www.cdl.com
    6.  * @create 2022-10-27 11:27
    7.  */
    8. @MyAnnotation(name = "注解中的属性标记在类上")
    9. public class StudentController {
    10.  
    11.     @MyAnnotation(name="注解中的属性标记在属性上")
    12.     private int age;
    13.  
    14.     @MyAnnotation(name="注解中的属性标记在方法上")
    15.     public void edit(){
    16.  
    17.     }
    18.  
    19. }

     

     

     获取注释内标记类的内容

    MyAnnotation 

    1. package com.cdl.ssm.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. /**
    9.  * @author cdl
    10.  * @site www.cdl.com
    11.  * @create 2022-10-27 11:21
    12.  *
    13.  * MyAnnotation注解可以用在类、接口、属性、方法上
    14.  * 注解运行期也保留
    15.  * 不可继承
    16.  */
    17. @Target({ElementType.TYPE, ElementType.FIELD,ElementType.METHOD})
    18. @Retention(RetentionPolicy.SOURCE)
    19. public @interface  MyAnnotation {
    20.     public  String value() default "value修饰类、方法、属性";
    21.   public  String des() default "desc修饰类、方法、属性";//注解中的属性
    22. }

     MyAnnotation2 

    1. package com.cdl.ssm.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. /**
    9.  * @author cdl
    10.  * @site www.cdl.com
    11.  * @create 2022-10-27 11:21
    12.  *
    13.  * MyAnnotation注解可以用在类、接口、属性、方法上
    14.  * 注解运行期也保留
    15.  * 不可继承
    16.  */
    17. @Target({ElementType.PARAMETER})
    18. @Retention(RetentionPolicy.SOURCE)
    19. public @interface MyAnnotation2 {
    20.     public  String value() default "value修饰类、方法、属性";
    21.     public  String des() default "desc修饰类、方法、属性";//注解中的属性
    22. }

     StudentController 

    1. package com.cdl.ssm.annotation;
    2.  
    3. /**
    4.  * @author cdl
    5.  * @site www.cdl.com
    6.  * @create 2022-10-27 11:27
    7.  */
    8. @MyAnnotation(value = "注解中的属性标记在类上")
    9. public class StudentController {
    10.  
    11.     @MyAnnotation(value="注解中的属性标记在属性上")
    12.     private int age;
    13.  
    14.     @MyAnnotation(value="注解中的属性标记在方法上")
    15.     public void test1(@MyAnnotation2("用来修饰id参数")String id,@MyAnnotation2("用来修饰name参数")String name){
    16.  
    17.     }
    18.  
    19. }

     Demo1 

    获取类上的内容

    1. package com.cdl.ssm.annotation.demo;
    2.  
    3. import com.cdl.ssm.annotation.MyAnnotation;
    4. import com.cdl.ssm.annotation.StudentController;
    5.  
    6. /**
    7.  * @author cdl
    8.  * @site www.cdl.com
    9.  * @create 2022-10-27 11:43
    10.  *
    11.  * 目标：
    12.  * 1.拿到类自定义注释的内容
    13.  * 2.拿到方法自定义注释的内容
    14.  * 3.拿到属性自定义注释的内容
    15.  */
    16. public class Demo1 {
    17.  
    18.     public static void main(String[] args) {
    19.  
    20.         //获取到注释类
    21.         MyAnnotation myAnnotation = StudentController.class.getAnnotation(MyAnnotation.class);
    22.         System.out.println(myAnnotation.value());
    23.         System.out.println(myAnnotation.des());
    24.  
    25.     }
    26.  
    27.  
    28.  
    29.  
    30. }

    结果：

     修改注解的代码 表示只有在运行时才能够拿到类中的注解

    1. @Target({ElementType.TYPE, ElementType.FIELD,ElementType.METHOD})
    2. @Retention(RetentionPolicy.RUNTIME)

    效果：

     获取注释内标记属性的内容

    StudentController 

    1. package com.cdl.ssm.annotation;
    2.  
    3. /**
    4.  * @author cdl
    5.  * @site www.cdl.com
    6.  * @create 2022-10-27 11:27
    7.  */
    8. @MyAnnotation(value = "注解中的属性标记在类上")
    9. public class StudentController {
    10.  
    11.     @MyAnnotation(value="注解中的属性id标记在属性上")
    12.     private String id;
    13.  
    14.     @MyAnnotation(value="注解中的属性name标记在属性上")
    15.     private String name;
    16.  
    17.  
    18.  
    19.     @MyAnnotation(value="注解中的属性标记在方法上")
    20.     public void test1(@MyAnnotation2("用来修饰id参数")String id,@MyAnnotation2("用来修饰name参数")String name){
    21.  
    22.     }
    23.  
    24. }

     Demo1 

    1. package com.cdl.ssm.annotation.demo;
    2.  
    3. import com.cdl.ssm.annotation.MyAnnotation;
    4. import com.cdl.ssm.annotation.StudentController;
    5.  
    6. import java.lang.reflect.Field;
    7.  
    8. /**
    9.  * @author cdl
    10.  * @site www.cdl.com
    11.  * @create 2022-10-27 11:43
    12.  *
    13.  * 目标：
    14.  * 1.拿到类自定义注释的内容
    15.  * 2.拿到方法自定义注释的内容
    16.  * 3.拿到属性自定义注释的内容
    17.  */
    18. public class Demo1 {
    19.  
    20.     public static void main(String[] args) throws Exception{
    21.  
    22.         //获取到注释类
    23.         MyAnnotation myAnnotation = StudentController.class.getAnnotation(MyAnnotation.class);
    24. //        System.out.println(myAnnotation.value());
    25. //        System.out.println(myAnnotation.des());
    26.  
    27.         //获取属性上的
    28.         Field id = StudentController.class.getDeclaredField("id");
    29.         Field name = StudentController.class.getDeclaredField("name");
    30.         System.out.println(id.getAnnotation(MyAnnotation.class).value());
    31.         System.out.println(name.getAnnotation(MyAnnotation.class).value());
    32.  
    33.         //使用场景
    34. //       // MyAnnotation2 annotation2 = id.getAnnotation(MyAnnotation2.class);
    35. //        Field[] declaredFields = StudentController.class.getDeclaredFields();
    36. //        for (Field f : declaredFields) {
    37. //            Annotation annotation1 = f.getAnnotation(myAnnotation.getClass());
    38. //            if(annotation1 !=null){
    39. //
    40. //            }
    41. //        }
    42.  
    43.     }
    44.  
    45.  
    46.  
    47.  
    48. }

    效果：

     获取注释内标记方法的内容

    Demo1
    1. //获取方法上的
    2.         Method m1 = StudentController.class.getDeclaredMethod("test1", String.class, String.class);
    3.         System.out.println(m1.getAnnotation(MyAnnotation.class).value());

      获取注释内标记参数的内容

    Demo1

    1.   //获取方法上的
    2.        Method m1 = StudentController.class.getDeclaredMethod("test1", String.class, String.class);
    3. //        System.out.println(m1.getAnnotation(MyAnnotation.class).value());
    4.  
    5.         //获取参数上的
    6.         for (Parameter p : m1.getParameters()) {
    7.             System.out.println(p.getAnnotation(MyAnnotation2.class).value());
    8.         }

     三、自定义注解日志的使用

    MyLog 

    1. package com.cdl.ssm.annotation.aop;
    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. /**
    9.  * @author cdl
    10.  * @site www.cdl.com
    11.  * @create 2022-10-27 15:47
    12.  */
    13. @Target(ElementType.METHOD)
    14. @Retention(RetentionPolicy.RUNTIME)
    15. public @interface MyLog {
    16.     String desc();
    17. }

     MyLogAspect 

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

     DemoController 

    1. package com.cdl.ssm.annotation.aop;
    2.  
    3. import org.springframework.stereotype.Controller;
    4.  
    5. /**
    6.  * @author cdl
    7.  * @site www.cdl.com
    8.  * @create 2022-10-27 15:48
    9.  */
    10. @Controller
    11. public class DemoController {
    12.  
    13.     @MyLog(desc="这是一个测试类的方法")
    14.     public void test(){
    15.         System.out.println("测试方法");
    16.     }
    17.  
    18. }

     AnnotationTest 

    1. package com.cdl.shiro;
    2.  
    3. import com.cdl.ssm.annotation.aop.DemoController;
    4. import org.junit.Test;
    5. import org.junit.runner.RunWith;
    6. import org.springframework.beans.factory.annotation.Autowired;
    7. import org.springframework.test.context.ContextConfiguration;
    8. import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
    9.  
    10. /**
    11.  * @author cdl
    12.  * @site www.cdl.com
    13.  * @create 2022-10-26 19:34
    14.  */
    15. @RunWith(SpringJUnit4ClassRunner.class)
    16. @ContextConfiguration(locations={"classpath:applicationContext.xml"})
    17. public class AnnotationTest {
    18.  
    19.     @Autowired
    20.     private DemoController demoController;
    21.  
    22.  @Test
    23.     public void test(){
    24.      demoController.test();
    25.     }
    26.  
    27.  
    28.  
    29.  
    30.  
    31.  
    32.  
    33.  
    34. }

    若在AnnotationTest 和MyLogAspect 中各打一个断点 则会先进入MyLogAspect，其中有前置通知

  • 相关阅读:
    JAVA设计模式3：抽象工厂模式，这是一种创建型设计模式
    一篇打通，pytest自动化测试框架详细，从0到1精通实战（一）
    第二章：String类
    唤醒手腕 2023年 B 站课程 Golang 语言详细教程笔记（更新中）
    java spring cloud 企业工程管理系统源码+二次开发+定制化服务
    【小月电子】安路国产FPGA开发板系统学习教程-LESSON3 LED流水灯
    Java 24 Design Pattern 之
    命令执行相关函数及各类命令执行绕过技巧
    业务网关之AK中心建设
    秋招知识点总结-FPGA基础知识
  • 原文地址：https://blog.csdn.net/weixin_62735525/article/details/127551294