• 自定义注解

    目录

    一，注解的概念

    Java注解分类

    JDK基本注解

    JDK元注解

    如何自定义注解？

    二，自定义注解

    编写两个自定义注解类

    @interface 注解修饰符

    使用注解

    StudentController

    测试获取注解中的值

    Demo1

    测试结果

    三，Aop应用自定义注解

    自定义注解日志的使用

     自定义注解类

    使用注解的类

    切面类

    测试类

    一，注解的概念

    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工具提取成文档.

    如何自定义注解？

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

    二，自定义注解

    编写两个自定义注解类

    @interface 注解修饰符

    如果属性是value的话，可以省略value=;如果是其他，则不可以省略。

    MyAnnotation1

    1. package com.zking.ssm.annotation;
    2.  
    3. import javax.swing.*;
    4. import java.lang.annotation.ElementType;
    5. import java.lang.annotation.Retention;
    6. import java.lang.annotation.RetentionPolicy;
    7. import java.lang.annotation.Target;
    8.  
    9. /**
    10.  * @author ljj
    11.  * @site www.xiaomage.com
    12.  * @company
    13.  * @create  2022-11-03 2:52
    14.  *
    15.  * 自定义注解类
    16.  */
    17. @Target({ElementType.TYPE,ElementType.METHOD,ElementType.FIELD})//（接口|类，方法，属性）决定此注解可以修饰什么内容
    18. @Retention(RetentionPolicy.RUNTIME)
    19. //注解修饰符 @interface
    20. public @interface MyAnnotation1 {
    21.  
    22.     //注解中属性
    23.     //如果属性是value的话，可以省略value=，其他的属性不行
    24.     public String value() default "可以修饰属性，类，方法";
    25.     public String desc() default "可以修饰属性，类，方法";
    26.  
    27.  
    28. }

    MyAnnotation2

    1. package com.zking.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 ljj
    10.  * @site www.xiaomage.com
    11.  * @company
    12.  * @create  2022-11-03 2:52
    13.  *
    14.  * 放在参数中的注解 ElementType.PARAMETER
    15.  */
    16. @Target(ElementType.PARAMETER)
    17. @Retention(RetentionPolicy.RUNTIME)
    18. //注解修饰符 @interface
    19. public @interface MyAnnotation2 {
    20.  
    21.     //注解中属性
    22.     //如果属性是value的话，可以省略value=，其他的属性不行
    23.     public String value() default "可以修饰属性，类，方法";
    24.     public String desc() default "可以修饰属性，类，方法";
    25.  
    26.  
    27. }

    使用注解

    StudentController

     此类用作于使用自定义的注解

    1. package com.zking.ssm.annotation;
    2.  
    3. /**
    4.  * @author ljj
    5.  * @site www.xiaomage.com
    6.  * @company
    7.  * @create  2022-11-03 3:01
    8.  *
    9.  * 使用注解
    10.  */
    11. @MyAnnotation1(desc = "标记在类上面")
    12. public class StudentController {
    13.  
    14.     @MyAnnotation1("标记在属性id上面")
    15.     private String id;
    16.     @MyAnnotation1("标记在name上面")
    17.     private String name;
    18.  
    19.     @MyAnnotation1
    20.     public void test1(@MyAnnotation2("用来修饰id参数") String id,@MyAnnotation2("用来修饰name参数") String name){
    21.         System.out.println("测试");
    22.     }
    23.  
    24. }

    测试获取注解中的值

    Demo1

    1. package com.zking.ssm.annotation.demo;
    2.  
    3. import com.zking.ssm.annotation.MyAnnotation1;
    4. import com.zking.ssm.annotation.MyAnnotation2;
    5. import com.zking.ssm.annotation.StudentController;
    6.  
    7. import java.lang.reflect.Field;
    8. import java.lang.reflect.Method;
    9. import java.lang.reflect.Parameter;
    10.  
    11. /**
    12.  * @author ljj
    13.  * @site www.xiaomage.com
    14.  * @company
    15.  * @create  2022-11-03 3:44
    16.  *
    17.  * 目标
    18.  * 1：获取studentControler 类上自定义注解 中的内容
    19.  * 2：获取studentControler 方法上自定义注解 中的内容
    20.  * 3：获取studentControler 属性上自定义注解 中的内容
    21.  */
    22. public class Demo1 {
    23.     public static void main(String[] args) throws Exception {
    24.         MyAnnotation1 annotation = StudentController.class.getAnnotation(MyAnnotation1.class);
    25.  
    26.         //获取类上自定义注解中的内容
    27.         System.out.println(annotation.value());
    28.         System.out.println(annotation.desc());
    29.  
    30.  
    31.         //获取属性上自定义注解中的内容
    32.         Field id = StudentController.class.getDeclaredField("id");
    33.         Field name = StudentController.class.getDeclaredField("name");
    34.         System.out.println(id.getAnnotation(MyAnnotation1.class).value());
    35.         System.out.println(name.getAnnotation(MyAnnotation1.class).value());
    36.  
    37.         //获取方法上自定义注解中的内容
    38.         Method m1 = StudentController.class.getDeclaredMethod("test1", String.class, String.class);
    39.         System.out.println(m1.getAnnotation(MyAnnotation1.class).value());
    40.  
    41.         //获取参数上自定义注解中的内容
    42.         for (Parameter p : m1.getParameters()) {
    43.             System.out.println(p.getAnnotation(MyAnnotation2.class).value());
    44.         }
    45.     }
    46. }

    测试结果

    三，Aop应用自定义注解

    自定义注解日志的使用

    自定义注解的介入，可以在使用注解的地方，才触发aop切面

     自定义注解类

    MyLog

    1. package com.zking.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 ljj
    10.  * @site www.xiaomage.com
    11.  * @company
    12.  * @create  2022-11-03 19:38
    13.  */
    14. @Target(ElementType.METHOD)//可以用作于方法中
    15. @Retention(RetentionPolicy.RUNTIME)//运行时使用
    16. public @interface MyLog {
    17.     String desc();
    18. }

    使用注解的类

    DemoController

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

    切面类

    MyLogAspect 

    1. package com.zking.ssm.annotation.aop;
    2.  
    3. import org.aspectj.lang.JoinPoint;
    4. import org.aspectj.lang.annotation.Aspect;
    5. import org.aspectj.lang.annotation.Before;
    6. import org.aspectj.lang.annotation.Pointcut;
    7. import org.aspectj.lang.reflect.MethodSignature;
    8. import org.slf4j.Logger;
    9. import org.slf4j.LoggerFactory;
    10. import org.springframework.stereotype.Component;
    11.  
    12. @Component
    13. @Aspect
    14. public class MyLogAspect {
    15.     private static final Logger logger = LoggerFactory.getLogger(MyLogAspect.class);
    16.  
    17.     /**
    18.      * 只要用到了com.javaxl.p2.annotation.springAop.MyLog这个注解的，就是目标类
    19.      */
    20.     @Pointcut("@annotation(com.zking.ssm.annotation.aop.MyLog)")
    21.     private void MyValid() {
    22.  
    23.     }
    24.  
    25.     @Before("MyValid()")
    26.     public void before(JoinPoint joinPoint) {
    27. //        JoinPoint
    28. //        可以获取到目标对象，目标方法，传递参数
    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. }

    测试类

    AnnotationTest 

    1. package com.zking.shiro;
    2.  
    3. import com.zking.ssm.annotation.aop.DemoController;
    4. import com.zking.ssm.annotation.demo.Demo1;
    5. import com.zking.ssm.biz.ClazzBiz;
    6. import org.junit.Test;
    7. import org.junit.runner.RunWith;
    8. import org.springframework.beans.factory.annotation.Autowired;
    9. import org.springframework.test.context.ContextConfiguration;
    10. import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
    11.  
    12. /**
    13.  * @author小李飞刀
    14.  * @site www.javaxl.com
    15.  * @company xxx公司
    16.  * @create  2022-10-26 15:29
    17.  */
    18. @RunWith(SpringJUnit4ClassRunner.class)
    19. @ContextConfiguration(locations={"classpath:applicationContext.xml"})
    20. public class AnnotationTest {
    21.     @Autowired
    22.     private DemoController demoController;
    23.  
    24.     @Test
    25.     public void test1(){
    26.         demoController.test();
    27.     }
    28.  
    29. }

    两个断点，一个在切面类中，一个在注解使用类中

     执行测试类中的方法

    Debug第一次到达的地方 进入@Before 前置通知中

     进入下一个断点

  • 相关阅读:
    Python处理word的常用操作详解
    浅谈C++|文件篇
    Unity Render Streaming通过Js与Unity自定义通讯
    阿里开源的32B大模型到底强在哪里？
    小菜学前端笔记-06-03
    制造业到底要不要做数字化改革？_光点科技
    【经典总线协议】IIC
    BFC（边距重叠解决方案）
    Mysql003：基础查询
    【MySQL数据库笔记 - 进阶篇】（一）存储引擎
  • 原文地址：https://blog.csdn.net/weixin_64313980/article/details/127662546