• SpringBoot(自定义注解)


    目录

    1.注解的概念

            1.1 什么是注解

            1.2 java注解分类

            1.3 JDK基本注解

            1.4 JDK元注解

    2.自定义注解

            2.1 自定义注解的组成

            2.2 如何自定义注解

            2.3 案例

                    2.3.1 简单了解基本属性

                    2.3.2 获取类与方法上的注解值

                    2.3.3 获取类属性上的注解属性值

                    2.3.4 获取参数修饰注解对应的属性值

    3.aop的应用自定义注解


    1.注解的概念

            1.1 什么是注解

    Java注解是附加在代码中的一些元信息,用于一些工具在编译、运行时进行解析和使用,起到说明、配置的功能。

            1.2 java注解分类

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

            1.3 JDK基本注解

    @Override
    重写

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

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

    2.自定义注解

            2.1 自定义注解的组成

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

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

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

            2.2 如何自定义注解

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

            2.3 案例

                    2.3.1 简单了解基本属性

    假设这是我们写的一个注解类

    我们使用它时就会报错 

     

     其根本原因是注解类上面的Target, 

    METHOD 注解只能在方法上使用

    TYPE  注解只能在类上使用

    FIELD 注解只能在属性上使用

    我们改成TYPE就可以啦

     

    不报错啦 

     

    如果想用多个

     

    可以写多个tagar

     

     代码:

    1. //1.只能用于类
    2. @Target(ElementType.TYPE)
    3. @Retention(RetentionPolicy.SOURCE)
    4. //2.只能用于属性
    5. @Target(ElementType.FIELD)
    6. @Retention(RetentionPolicy.SOURCE)
    7. //3.只能用于方法
    8. @Target(ElementType.METHOD)
    9. @Retention(RetentionPolicy.SOURCE)
    10. //4.类,属性,方法都可以用
    11. @Target({ElementType.TYPE,ElementType.FIELD,ElementType.METHOD})
    12. @Retention(RetentionPolicy.SOURCE)

    给注解写一个属性

     

    若没有加注解的属性就会报错

     

    写上注解的属性就可以不报错了,value这个属性可以默认不写,其他的属性就不能了 

     

    还可以默认注解的属性

    这样也不会报错啦 

     

     

                    2.3.2 获取类与方法上的注解值

    直接运行我们就会报错

    原因是注解上的source,将它改为runtime运行时可见

     

     

    结果为(获取到啦):

     

     

    测试的代码:

    1. package com.zking.ssm.annaction.dome;
    2. import com.zking.ssm.annaction.MyAnnaction1;
    3. import com.zking.ssm.annaction.MyAnnaction2;
    4. import com.zking.ssm.annaction.RuojuanController;
    5. /**
    6. * @author ruojuan
    7. * @site www.ruojuan.com
    8. * @company 玉渊工作室
    9. * @create 2022年10月27日 14:21
    10. **/
    11. public class Dome1 {
    12. public static void main(String[] args) {
    13. //获取类上的注解
    14. MyAnnaction1 annaction = RuojuanController.class.getAnnotation(MyAnnaction1.class);
    15. System.out.println(annaction.value());
    16. System.out.println(annaction.desc());
    17. }
    18. }

    注解的代码:

    1. package com.zking.ssm.annaction;
    2. import java.lang.annotation.ElementType;
    3. import java.lang.annotation.Retention;
    4. import java.lang.annotation.RetentionPolicy;
    5. import java.lang.annotation.Target;
    6. /**
    7. * @author ruojuan
    8. * @site www.ruojuan.com
    9. * @company 玉渊工作室
    10. * @create 2022年10月27日 11:14
    11. **/
    12. @Target({ElementType.TYPE,ElementType.FIELD,ElementType.METHOD})
    13. @Retention(RetentionPolicy.RUNTIME)
    14. public @interface MyAnnaction1 {
    15. //指的是注解中的属性
    16. public String value() default "可以修饰方法,属性,类";
    17. public String desc() default "可以修饰方法,属性,类";
    18. }

                    2.3.3 获取类属性上的注解属性值

     

     

     

     代码:

    1. package com.zking.ssm.annaction.dome;
    2. import com.zking.ssm.annaction.MyAnnaction1;
    3. import com.zking.ssm.annaction.MyAnnaction2;
    4. import com.zking.ssm.annaction.RuojuanController;
    5. import java.lang.annotation.Annotation;
    6. import java.lang.reflect.Field;
    7. /**
    8. * @author ruojuan
    9. * @site www.ruojuan.com
    10. * @company 玉渊工作室
    11. * @create 2022年10月27日 14:21
    12. **/
    13. public class Dome1 {
    14. public static void main(String[] args) throws Exception {
    15. //获取属性上的
    16. Field id = RuojuanController.class.getDeclaredField("id");
    17. Field name = RuojuanController.class.getDeclaredField("name");
    18. System.out.println(id.getAnnotation(MyAnnaction1.class).value());
    19. System.out.println(name.getAnnotation(MyAnnaction1.class).value());
    20. }
    21. }

     

                    2.3.4 获取参数修饰注解对应的方法值

    效果: 

     

    代码:

    1. package com.zking.ssm.annaction.dome;
    2. import com.zking.ssm.annaction.MyAnnaction1;
    3. import com.zking.ssm.annaction.MyAnnaction2;
    4. import com.zking.ssm.annaction.RuojuanController;
    5. import java.lang.annotation.Annotation;
    6. import java.lang.reflect.Field;
    7. import java.lang.reflect.Method;
    8. /**
    9. * @author ruojuan
    10. * @site www.ruojuan.com
    11. * @company 玉渊工作室
    12. * @create 2022年10月27日 14:21
    13. **/
    14. public class Dome1 {
    15. public static void main(String[] args) throws Exception {
    16. //获取方法上的
    17. Method me1 = RuojuanController.class.getDeclaredMethod("test", long.class, String.class);
    18. System.out.println(me1.getAnnotation(MyAnnaction1.class).value());
    19. }
    20. }

    写一个专门用来修饰属性的 

     

    代码:

    1. package com.zking.ssm.annaction;
    2. import java.lang.annotation.ElementType;
    3. import java.lang.annotation.Retention;
    4. import java.lang.annotation.RetentionPolicy;
    5. import java.lang.annotation.Target;
    6. /**
    7. * @author ruojuan
    8. * @site www.ruojuan.com
    9. * @company 玉渊工作室
    10. * @create 2022年10月27日 11:14
    11. **/
    12. @Target({ElementType.PARAMETER})
    13. @Retention(RetentionPolicy.RUNTIME)
    14. public @interface MyAnnaction2 {
    15. //指的是注解中的属性
    16. public String value() default "可以修饰方法,属性,类";
    17. public String desc() default "可以修饰方法,属性,类";
    18. }

    获取参数上的标识

     

    代码:

    1. package com.zking.ssm.annaction.dome;
    2. import com.zking.ssm.annaction.MyAnnaction1;
    3. import com.zking.ssm.annaction.MyAnnaction2;
    4. import com.zking.ssm.annaction.RuojuanController;
    5. import java.lang.annotation.Annotation;
    6. import java.lang.reflect.Field;
    7. import java.lang.reflect.Method;
    8. import java.lang.reflect.Parameter;
    9. /**
    10. * @author ruojuan
    11. * @site www.ruojuan.com
    12. * @company 玉渊工作室
    13. * @create 2022年10月27日 14:21
    14. **/
    15. public class Dome1 {
    16. public static void main(String[] args) throws Exception {
    17. //获取方法上的
    18. Method me1 = RuojuanController.class.getDeclaredMethod("test", long.class, String.class);
    19. System.out.println(me1.getAnnotation(MyAnnaction1.class).value());
    20. //获取参数上的标识
    21. for(Parameter p:me1.getParameters()){
    22. System.out.println(p.getAnnotation(MyAnnaction2.class).value());
    23. }
    24. }
    25. }

    3.aop的应用自定义注解

    自定义注解

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

    applicationContext.xml

    1. "1.0" encoding="UTF-8"?>
    2. <beans xmlns="http://www.springframework.org/schema/beans"
    3. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    4. xmlns:context="http://www.springframework.org/schema/context" xmlns:tx="http://www.springframework.org/schema/tx"
    5. xmlns:aop="http://www.springframework.org/schema/aop"
    6. xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx.xsd http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd">
    7. <context:annotation-config/>
    8. <context:component-scan base-package="com.zking"/>
    9. <aop:aspectj-autoproxy />
    10. beans>

    应用注解

    1. package com.zking.annotation.aop;
    2. import org.aspectj.lang.JoinPoint;
    3. import org.aspectj.lang.annotation.Aspect;
    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. import org.springframework.stereotype.Component;
    10. @Component
    11. @Aspect
    12. public class MyLogAspect {
    13. private static final Logger logger = LoggerFactory.getLogger(MyLogAspect.class);
    14. /**
    15. * 只要用到了com.javaxl.p2.annotation.springAop.MyLog这个注解的,就是目标类
    16. */
    17. @Pointcut("@annotation(com.zking.annotation.aop.MyLog)")
    18. private void MyValid() {
    19. }
    20. @Before("MyValid()")
    21. public void before(JoinPoint joinPoint) {
    22. MethodSignature signature = (MethodSignature) joinPoint.getSignature();
    23. logger.debug("[" + signature.getName() + " : start.....]");
    24. System.out.println("[" + signature.getName() + " : start.....]");
    25. MyLog myLog = signature.getMethod().getAnnotation(MyLog.class);
    26. logger.debug("【目标对象方法被调用时候产生的日志,记录到日志表中】:"+myLog.desc());
    27. System.out.println("【目标对象方法被调用时候产生的日志,记录到日志表中】:" + myLog.desc());
    28. }
    29. }
    1. package com.zking.annotation.aop;
    2. import org.aspectj.lang.JoinPoint;
    3. import org.aspectj.lang.annotation.Aspect;
    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. import org.springframework.stereotype.Component;
    10. @Component
    11. @Aspect
    12. public class MyLogAspect {
    13. private static final Logger logger = LoggerFactory.getLogger(MyLogAspect.class);
    14. /**
    15. * 只要用到了com.javaxl.p2.annotation.springAop.MyLog这个注解的,就是目标类
    16. */
    17. @Pointcut("@annotation(com.zking.annotation.aop.MyLog)")
    18. private void MyValid() {
    19. }
    20. @Before("MyValid()")
    21. public void before(JoinPoint joinPoint) {
    22. MethodSignature signature = (MethodSignature) joinPoint.getSignature();
    23. logger.debug("[" + signature.getName() + " : start.....]");
    24. System.out.println("[" + signature.getName() + " : start.....]");
    25. MyLog myLog = signature.getMethod().getAnnotation(MyLog.class);
    26. logger.debug("【目标对象方法被调用时候产生的日志,记录到日志表中】:"+myLog.desc());
    27. System.out.println("【目标对象方法被调用时候产生的日志,记录到日志表中】:" + myLog.desc());
    28. }
    29. }
    1. package com.zking.annotation.aop;
    2. import org.junit.runner.RunWith;
    3. import org.springframework.test.context.ContextConfiguration;
    4. import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
    5. @RunWith(SpringJUnit4ClassRunner.class)
    6. @ContextConfiguration(locations={"classpath:applicationContext.xml"})
    7. public class BaseTestCase {
    8. }
    1. package com.zking.annotation.aop;
    2. import org.junit.Test;
    3. import org.springframework.beans.factory.annotation.Autowired;
    4. public class LogControllerTest extends BaseTestCase {
    5. @Autowired
    6. private LogController logController;
    7. @Test
    8. public void testLogAspect(){
    9. logController.testLogAspect();
    10. }
    11. }

    pom.xml

    1. "1.0" encoding="UTF-8"?>
    2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    3. xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    4. <modelVersion>4.0.0modelVersion>
    5. <groupId>com.zkinggroupId>
    6. <artifactId>selenium280artifactId>
    7. <version>1.0-SNAPSHOTversion>
    8. <packaging>warpackaging>
    9. <name>selenium280 Maven Webappname>
    10. <url>http://www.example.comurl>
    11. <properties>
    12. <project.build.sourceEncoding>UTF-8project.build.sourceEncoding>
    13. <maven.compiler.source>1.8maven.compiler.source>
    14. <maven.compiler.target>1.8maven.compiler.target>
    15. <maven.compiler.plugin.version>3.7.0maven.compiler.plugin.version>
    16. <spring.version>5.0.2.RELEASEspring.version>
    17. <mybatis.version>3.4.5mybatis.version>
    18. <mysql.version>5.1.44mysql.version>
    19. <pagehelper.version>5.1.2pagehelper.version>
    20. <mybatis.spring.version>1.3.1mybatis.spring.version>
    21. <commons.dbcp2.version>2.1.1commons.dbcp2.version>
    22. <commons.pool2.version>2.4.3commons.pool2.version>
    23. <log4j2.version>2.9.1log4j2.version>
    24. <log4j2.disruptor.version>3.2.0log4j2.disruptor.version>
    25. <slf4j.version>1.7.13slf4j.version>
    26. <junit.version>4.12junit.version>
    27. <servlet.version>4.0.0servlet.version>
    28. <lombok.version>1.18.2lombok.version>
    29. properties>
    30. <dependencies>
    31. <dependency>
    32. <groupId>org.springframeworkgroupId>
    33. <artifactId>spring-contextartifactId>
    34. <version>${spring.version}version>
    35. dependency>
    36. <dependency>
    37. <groupId>org.springframeworkgroupId>
    38. <artifactId>spring-ormartifactId>
    39. <version>${spring.version}version>
    40. dependency>
    41. <dependency>
    42. <groupId>org.springframeworkgroupId>
    43. <artifactId>spring-txartifactId>
    44. <version>${spring.version}version>
    45. dependency>
    46. <dependency>
    47. <groupId>org.springframeworkgroupId>
    48. <artifactId>spring-aspectsartifactId>
    49. <version>${spring.version}version>
    50. dependency>
    51. <dependency>
    52. <groupId>org.springframeworkgroupId>
    53. <artifactId>spring-webartifactId>
    54. <version>${spring.version}version>
    55. dependency>
    56. <dependency>
    57. <groupId>org.springframeworkgroupId>
    58. <artifactId>spring-testartifactId>
    59. <version>${spring.version}version>
    60. dependency>
    61. <dependency>
    62. <groupId>org.mybatisgroupId>
    63. <artifactId>mybatisartifactId>
    64. <version>${mybatis.version}version>
    65. dependency>
    66. <dependency>
    67. <groupId>mysqlgroupId>
    68. <artifactId>mysql-connector-javaartifactId>
    69. <version>${mysql.version}version>
    70. dependency>
    71. <dependency>
    72. <groupId>com.github.pagehelpergroupId>
    73. <artifactId>pagehelperartifactId>
    74. <version>${pagehelper.version}version>
    75. dependency>
    76. <dependency>
    77. <groupId>org.mybatisgroupId>
    78. <artifactId>mybatis-springartifactId>
    79. <version>${mybatis.spring.version}version>
    80. dependency>
    81. <dependency>
    82. <groupId>org.apache.commonsgroupId>
    83. <artifactId>commons-dbcp2artifactId>
    84. <version>${commons.dbcp2.version}version>
    85. dependency>
    86. <dependency>
    87. <groupId>org.apache.commonsgroupId>
    88. <artifactId>commons-pool2artifactId>
    89. <version>${commons.pool2.version}version>
    90. dependency>
    91. <dependency>
    92. <groupId>org.slf4jgroupId>
    93. <artifactId>slf4j-apiartifactId>
    94. <version>${slf4j.version}version>
    95. dependency>
    96. <dependency>
    97. <groupId>org.slf4jgroupId>
    98. <artifactId>jcl-over-slf4jartifactId>
    99. <version>${slf4j.version}version>
    100. <scope>runtimescope>
    101. dependency>
    102. <dependency>
    103. <groupId>org.apache.logging.log4jgroupId>
    104. <artifactId>log4j-apiartifactId>
    105. <version>${log4j2.version}version>
    106. dependency>
    107. <dependency>
    108. <groupId>org.apache.logging.log4jgroupId>
    109. <artifactId>log4j-coreartifactId>
    110. <version>${log4j2.version}version>
    111. dependency>
    112. <dependency>
    113. <groupId>org.apache.logging.log4jgroupId>
    114. <artifactId>log4j-slf4j-implartifactId>
    115. <version>${log4j2.version}version>
    116. dependency>
    117. <dependency>
    118. <groupId>org.apache.logging.log4jgroupId>
    119. <artifactId>log4j-webartifactId>
    120. <version>${log4j2.version}version>
    121. <scope>runtimescope>
    122. dependency>
    123. <dependency>
    124. <groupId>com.lmaxgroupId>
    125. <artifactId>disruptorartifactId>
    126. <version>${log4j2.disruptor.version}version>
    127. dependency>
    128. <dependency>
    129. <groupId>junitgroupId>
    130. <artifactId>junitartifactId>
    131. <version>${junit.version}version>
    132. dependency>
    133. <dependency>
    134. <groupId>javax.servletgroupId>
    135. <artifactId>javax.servlet-apiartifactId>
    136. <version>${servlet.version}version>
    137. <scope>providedscope>
    138. dependency>
    139. <dependency>
    140. <groupId>org.projectlombokgroupId>
    141. <artifactId>lombokartifactId>
    142. <version>${lombok.version}version>
    143. <scope>providedscope>
    144. dependency>
    145. <dependency>
    146. <groupId>org.springframeworkgroupId>
    147. <artifactId>spring-webmvcartifactId>
    148. <version>${spring.version}version>
    149. dependency>
    150. <dependency>
    151. <groupId>jstlgroupId>
    152. <artifactId>jstlartifactId>
    153. <version>1.2version>
    154. dependency>
    155. <dependency>
    156. <groupId>taglibsgroupId>
    157. <artifactId>standardartifactId>
    158. <version>1.1.2version>
    159. dependency>
    160. <dependency>
    161. <groupId>org.seleniumhq.seleniumgroupId>
    162. <artifactId>selenium-javaartifactId>
    163. <version>3.141.59version>
    164. dependency>
    165. <dependency>
    166. <groupId>redis.clientsgroupId>
    167. <artifactId>jedisartifactId>
    168. <version>2.9.0version>
    169. dependency>
    170. <dependency>
    171. <groupId>org.testnggroupId>
    172. <artifactId>testngartifactId>
    173. <version>RELEASEversion>
    174. <scope>compilescope>
    175. dependency>
    176. dependencies>
    177. <build>
    178. <finalName>selenium280finalName>
    179. <pluginManagement>
    180. <plugins>
    181. <plugin>
    182. <artifactId>maven-clean-pluginartifactId>
    183. <version>3.1.0version>
    184. plugin>
    185. <plugin>
    186. <artifactId>maven-resources-pluginartifactId>
    187. <version>3.0.2version>
    188. plugin>
    189. <plugin>
    190. <artifactId>maven-compiler-pluginartifactId>
    191. <version>3.8.0version>
    192. plugin>
    193. <plugin>
    194. <artifactId>maven-surefire-pluginartifactId>
    195. <version>2.22.1version>
    196. plugin>
    197. <plugin>
    198. <artifactId>maven-war-pluginartifactId>
    199. <version>3.2.2version>
    200. plugin>
    201. <plugin>
    202. <artifactId>maven-install-pluginartifactId>
    203. <version>2.5.2version>
    204. plugin>
    205. <plugin>
    206. <artifactId>maven-deploy-pluginartifactId>
    207. <version>2.8.2version>
    208. plugin>
    209. plugins>
    210. pluginManagement>
    211. <plugins>
    212. <plugin>
    213. <groupId>org.apache.maven.pluginsgroupId>
    214. <artifactId>maven-compiler-pluginartifactId>
    215. <configuration>
    216. <source>8source>
    217. <target>8target>
    218. configuration>
    219. plugin>
    220. plugins>
    221. build>
    222. project>

  • 相关阅读:
    c# --- 列表
    Python+reuqests自动化接口测试
    【机器学习】训练集/验证集/测试集释疑
    P31 JList列表框
    Python数据攻略-递归方式实现json多层级数据展平
    5G试题_1
    CLAHE 算法学习 matlab
    粗俗解释C# 8.0+的变量后面有?问号是什么意思?
    CMMI3认证和CMMI5认证有哪些不同
    EasyAVFilter的初衷:把ffmpeg.c当做SDK来用,而不是当做EXE来用
  • 原文地址:https://blog.csdn.net/weixin_67338832/article/details/127548890