• 自定义注解

    目录

    目标：

    一、Java注解简介

    Java注解分类

    JDK基本注解

    JDK元注解

    二、自定义注解

    三、Aop自定义注解的应用

    目标：

    1. 注解的概念
    2. 自定义注解
    3. aop应用自定义注解

    一、Java注解简介

    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关键字为这个成员变量设定默认值；

    @interface注解修饰符

    MyAnnotation1：

     runtime：运行时才能得到注解；source：只存在java代码里面； 

    1. package com.ps.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 彭于晏
    10.  * @site www.pengyuyan.com
    11.  * @company 玉渊工作室
    12.  * @create 2022-10-28 17:58
    13.  */
    14. @Target({ElementType.TYPE,ElementType.METHOD,ElementType.FIELD})
    15. @Retention(RetentionPolicy.RUNTIME)
    16. public @interface MyAnnotation1 {
    17. //    指的是注解中的属性
    18.     public String value() default "value可以修饰类、方法、属性";
    19.     public String desc() default "value可以修饰类、方法、属性";
    20.  
    21. }
    MyAnnotation2：

     

    1. package com.ps.ssm.annotation.demo;
    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 彭于晏
    10.  * @site www.pengyuyan.com
    11.  * @company 玉渊工作室
    12.  * @create 2022-10-28 17:58
    13.  */
    14. @Target({ElementType.PARAMETER})
    15. @Retention(RetentionPolicy.RUNTIME)
    16. public @interface MyAnnotation2 {
    17. //    指的是注解中的属性
    18.     public String value() default "value可以修饰类、方法、属性";
    19.     public String desc() default "value可以修饰类、方法、属性";
    20.  
    21. }
    StudentController：

    如果注解中的属性是value的话，可以省略value=；如果是其他则不可省略 

    1. package com.ps.ssm.annotation;
    2.  
    3. import com.ps.ssm.annotation.demo.MyAnnotation2;
    4.  
    5. /**
    6.  * @author 彭于晏
    7.  * @site www.pengyuyan.com
    8.  * @company 玉渊工作室
    9.  * @create 2022-10-28 18:00
    10.  */
    11. @MyAnnotation1(desc = "标记在类上面")
    12. public class StudentController {
    13.     @MyAnnotation1("标记在属性id上面")
    14.     private String id;
    15.     @MyAnnotation1("标记在属性name上面")
    16.     private String name;
    17.     @MyAnnotation1("标记在方法test上面")
    18.     public void test1(@MyAnnotation2("用来修饰id参数") String id,@MyAnnotation2("用来修饰name参数") String name){
    19.         System.out.println("测试...");
    20.     }
    21. }

    测试：

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

    三、Aop自定义注解的应用

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

    案例：

    先写一个注解类：MyLog

    1. package com.ps.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 彭于晏
    10.  * @site www.pengyuyan.com
    11.  */
    12. @Target(ElementType.METHOD)
    13. @Retention(RetentionPolicy.RUNTIME)
    14. public @interface MyLog {
    15.     String desc();
    16. }

    再创建一个切面类：MyLogAspect

    1. package com.ps.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.ps.ssm.annotation.aop.MyLog这个注解的，就是目标类
    19.      */
    20.     @Pointcut("@annotation(com.zking.ssm.annotation.aop.MyLog)")
    21.     private void MyValid() {
    22.     }
    23.  
    24.     @Before("MyValid()")
    25.     public void before(JoinPoint joinPoint) {
    26. //        joinPoint
    27. //        目标对象、目标方法、传递参数
    28.         MethodSignature signature = (MethodSignature) joinPoint.getSignature();
    29.         logger.debug("[" + signature.getName() + " : start.....]");
    30.         System.out.println("[" + signature.getName() + " : start.....]");
    31.  
    32.         MyLog myLog = signature.getMethod().getAnnotation(MyLog.class);
    33.         logger.debug("【目标对象方法被调用时候产生的日志，记录到日志表中】："+myLog.desc());
    34.         System.out.println("【目标对象方法被调用时候产生的日志，记录到日志表中】：" + myLog.desc());
    35.     }
    36. }

    然后写一个使用注解的类 ：DemoController

    1. package com.ps.ssm.annotation.aop;
    2.  
    3. import org.springframework.stereotype.Controller;
    4.  
    5. /**
    6.  * @author 彭于晏
    7.  * @site www.pengyuyan.com
    8.  * @company 玉渊工作室
    9.  * @create 2022-10-28 19:47
    10.  */
    11. @Controller
    12. public class DemoController {
    13.     @MyLog(desc = "测试类方法")
    14.     public void test(){
    15.         System.out.println("测试方法");
    16.     }
    17. }

     最后就是测试类了：AnnotationTest

    调用一下controller层的方法：

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

     在controller层和切面层打个断点：

     使用debug运行会发现

    它是先跳转到前置通知，然后再到目标方法那里

    最后结束：

    好啦，今天的分享就到这里，以上内容如有问题，欢迎大佬指正！

     

  • 相关阅读:
    遍历的几种方式
    函数类型和函数指针
    C# excel操作
    el-form-item validator 携带额外的参数
    [免费专栏] Android安全之Linux+Windows安装r2Frida环境配置及使用
    [ue5]建模场景学习笔记（6）——必修内容可交互的地形，交互沙（4）
    ThreadLocal 是什么？它的实现原理呢？
    某股份制银行容器云平台建设实践经验
    Vue源码学习(十八):实现组件注册(一)Vue.component()和Vue.extend()
    抽象轻松的java
  • 原文地址：https://blog.csdn.net/weixin_63531940/article/details/127711509