Springboot之自定义注解

提示：文章写完后，目录可以自动生成，如何生成可参考右边的帮助文档

Springboot

一、自定义注解简介

1.Java注解简介

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

1.1Java注解分类

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

1.2JDK基本注解

@Override
重写

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

1.3JDK元注解

@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.读入数据

其中最重要的是

@Retention(RetentionPolicy.RUNTIME)@Target：指定被修饰的Annotation可以放置的位置(被修饰的目标)

1.4自定义注解

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

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

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

2.反射机制（java.Reflection）

反射最重要的就是类类,一切反射的基础是类类

2.1、静态语言 VS 动态语言

动态语言

是一类在运行时可以改变其结构的原因：例如新的函数、对象、甚至代码可以被引进，已有的函数可以被删除或是其他结构上的变化。通俗点说就是在运行时代码可以根据某些条件改变自身结构
主要动态语言：Object-c、C#、JavaScript、php、Python等
静态语言

与动态语言相对应的，运行时结构不可变的语言就是静态语言。如Java、C、C++。
Java不是动态语言，但Java可以称之为"准动态语言"。即Java有一定的动态性，我们可以利用反射机制获得类似语言的特性。Java的动态性让编程的时候更加灵活！

二、自定义注解的案列

2.1.创建SpringBoot项目

PS: 后面还要使用到, 所以这里创建一个空的项目,通过创建模块的方式完成

2.1.1.点击New Project

2.1.2.创建新项目

2.1.3.创建一个新的Module

2.1.4.创建SpringBoot模块

2.1.5.项目创建完成

2.2.修改pom.xml

2.3.案例一

2.3.1.新建一个annotation包

2.3.2.添加TranscationModel枚举类

packagecom.zking.spboot01.annotation.demo1;publicenumTranscationModel{Read,Write,ReadWrite}

2.3.3.新建MyAnnotation1注解

packagecom.zking.spboot01.annotation.demo1;importjava.lang.annotation.Documented;importjava.lang.annotation.ElementType;importjava.lang.annotation.Target;@Retention(RetentionPolicy.RUNTIME)@Target({ElementType.TYPE,ElementType.FIELD,ElementType.METHOD})@Documentedpublic@interfaceMyAnnotation1{Stringname();}

2.3.4.新建MyAnnotation2注解

packagecom.zking.spboot01.annotation.demo1;importjava.lang.annotation.*;/**
 *  MyAnnotation2注解可以用在方法上
 *  注解运行期也保留
 *  不可继承
 */@Target(ElementType.METHOD)@Retention(RetentionPolicy.RUNTIME)@Documentedpublic@interfaceMyAnnotation2{TranscationModelmodel()defaultTranscationModel.ReadWrite;}

2.3.5.新建MyAnnotation3注解

packagecom.zking.annotation.pi;importjava.lang.annotation.*;/**
 *
 * MyAnnotation3注解可以用在方法上
 * 注解运行期也保留
 * 可继承
 */@Target(ElementType.METHOD)@Retention(RetentionPolicy.RUNTIME)@Inherited@Documentedpublic@interfaceMyAnnotation3{TranscationModel[]models()defaultTranscationModel.ReadWrite;}

2.3.6.新建Demo类

packagecom.zking.annotation.pi;/**
 *
 * 获取类与方法上的注解值
 */@MyAnnotation1(name ="abc")publicclassDemo1{@MyAnnotation1(name ="xyz")privateInteger age;@MyAnnotation2(model =TranscationModel.Read)publicvoidlist(){System.out.println("list");}@MyAnnotation3(models ={TranscationModel.Read,TranscationModel.Write})publicvoidedit(){System.out.println("edit");}}

2.3.7.新建DemoTest类

packagecom.zking.annotation.pi;importorg.junit.Test;/**
 */publicclassDemo1Test{@Testpublicvoidlist()throwsException{//        获取类上的注解MyAnnotation1 annotation1 =Demo1.class.getAnnotation(MyAnnotation1.class);System.out.println(annotation1.name());//abc//        获取方法上的注解MyAnnotation2 myAnnotation2 =Demo1.class.getMethod("list").getAnnotation(MyAnnotation2.class);System.out.println(myAnnotation2.model());//Read//        获取属性上的注解MyAnnotation1 myAnnotation1 =Demo1.class.getDeclaredField("age").getAnnotation(MyAnnotation1.class);System.out.println(myAnnotation1.name());// xyz}@Testpublicvoidedit()throwsException{MyAnnotation3 myAnnotation3 =Demo1.class.getMethod("edit").getAnnotation(MyAnnotation3.class);for(TranscationModel model : myAnnotation3.models()){System.out.println(model);//Read,Write}}}

2.7.8.运行结果:

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

2.4.1.新建demo02包
2.4.2.新建TestAnnotation注解

packagecom.zking.spboot01.annotation.demo2;importjava.lang.annotation.ElementType;importjava.lang.annotation.Retention;importjava.lang.annotation.RetentionPolicy;importjava.lang.annotation.Target;/**
 *///@Retention(RetentionPolicy.SOURCE)@Retention(RetentionPolicy.RUNTIME)@Target(ElementType.FIELD)public@interfaceTestAnnotation{Stringvalue()default"默认value值";Stringwhat()default"这里是默认的what属性对应的值";}

2.4.3.新建Demo2类

packagecom.zking.spboot01.annotation.demo2;/**
 *
 * 获取类属性上的注解属性值
 */publicclassDemo2{@TestAnnotation(value ="这就是value对应的值_msg1", what ="这就是what对应的值_msg1")privatestaticString msg1;@TestAnnotation("这就是value对应的值1")privatestaticString msg2;@TestAnnotation(value ="这就是value对应的值2")privatestaticString msg3;@TestAnnotation(what ="这就是what对应的值")privatestaticString msg4;}

2.4.4.新建Demo2Test

packagecom.zking.spboot01.annotation.demo2;importorg.junit.Test;/**
 */publicclassDemo2Test{@Testpublicvoidtest1()throwsException{TestAnnotation msg1 =Demo2.class.getDeclaredField("msg1").getAnnotation(TestAnnotation.class);System.out.println(msg1.value());System.out.println(msg1.what());}@Testpublicvoidtest2()throwsException{TestAnnotation msg2 =Demo2.class.getDeclaredField("msg2").getAnnotation(TestAnnotation.class);System.out.println(msg2.value());System.out.println(msg2.what());}@Testpublicvoidtest3()throwsException{TestAnnotation msg3 =Demo2.class.getDeclaredField("msg3").getAnnotation(TestAnnotation.class);System.out.println(msg3.value());System.out.println(msg3.what());}@Testpublicvoidtest4()throwsException{TestAnnotation msg4 =Demo2.class.getDeclaredField("msg4").getAnnotation(TestAnnotation.class);System.out.println(msg4.value());System.out.println(msg4.what());}}

2.4.5运行结果:

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

packagecom.zking.spboot01.annotation.demo3;importjava.lang.annotation.*;/**
 *
 * 非空注解：使用在方法的参数上，false表示此参数可以为空，true不能为空
 */@Documented@Target({ElementType.PARAMETER})@Retention(RetentionPolicy.RUNTIME)public@interfaceIsNotNull{booleanvalue()defaultfalse;}

packagecom.zking.spboot01.annotation.demo3;/**
 *
 * 获取参数修饰注解对应的属性值
 */publicclassDemo3{publicvoidhello1(@IsNotNull(true)String name){System.out.println("hello:"+ name);}publicvoidhello2(@IsNotNullString name){System.out.println("hello:"+ name);}}

packagecom.zking.spboot01.annotation.demo3;importorg.junit.Test;importjava.lang.reflect.Parameter;/**
 */publicclassDemo3Test{@Testpublicvoidhello1()throwsException{Demo3 demo3 =newDemo3();for(Parameter parameter : demo3.getClass().getMethod("hello1",String.class).getParameters()){IsNotNull annotation = parameter.getAnnotation(IsNotNull.class);if(annotation !=null){System.out.println(annotation.value());//true}}}@Testpublicvoidhello2()throwsException{Demo3 demo3 =newDemo3();for(Parameter parameter : demo3.getClass().getMethod("hello2",String.class).getParameters()){IsNotNull annotation = parameter.getAnnotation(IsNotNull.class);if(annotation !=null){System.out.println(annotation.value());//false}}}}

运行结果:

三、spring aop集成自定义注解实现日志记录功能

3.1.在pom.xml中添加依赖

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-aop</artifactId></dependency>

3.2.自定义注解

packagecom.zking.spboot01.annotation.aop;importjava.lang.annotation.ElementType;importjava.lang.annotation.Retention;importjava.lang.annotation.RetentionPolicy;importjava.lang.annotation.Target;/**
 */@Target(ElementType.METHOD)@Retention(RetentionPolicy.RUNTIME)public@interfaceMyLog{Stringdesc();}

3.3.定义切面类

packagecom.zking.spboot01.annotation.aop;importorg.aspectj.lang.JoinPoint;importorg.aspectj.lang.annotation.Aspect;importorg.aspectj.lang.annotation.Before;importorg.aspectj.lang.annotation.Pointcut;importorg.aspectj.lang.reflect.MethodSignature;importorg.slf4j.Logger;importorg.slf4j.LoggerFactory;importorg.springframework.stereotype.Component;/**
 */@Component@AspectpublicclassMyLogAspect{privatestaticfinalLogger logger =LoggerFactory.getLogger(MyLogAspect.class);/**
     * 只要用到了com.javaxl.p2.annotation.springAop.MyLog这个注解的，就是目标类
     */@Pointcut("@annotation(com.zking.spboot01.annotation.aop.MyLog)")privatevoidMyValid(){}@Before("MyValid()")publicvoidbefore(JoinPoint joinPoint){MethodSignature signature =(MethodSignature) joinPoint.getSignature();
        logger.debug("["+ signature.getName()+" : start.....]");System.out.println("["+ signature.getName()+" : start.....]");MyLog myLog = signature.getMethod().getAnnotation(MyLog.class);
        logger.debug("【目标对象方法被调用时候产生的日志，记录到日志表中】："+myLog.desc());System.out.println("【目标对象方法被调用时候产生的日志，记录到日志表中】："+ myLog.desc());}}

3.4.新建LogController

packagecom.zking.annotation.aop;importorg.springframework.stereotype.Component;/**
 */@ComponentpublicclassLogController{@MyLog(desc ="这是结合spring aop知识，讲解自定义注解应用的一个案例")publicvoidtestLogAspect(){System.out.println("这里随便来点啥");}}

3.5.新建LogControllerTest

packagecom.zking.annotation.aop;importorg.junit.Test;importorg.springframework.beans.factory.annotation.Autowired;/**
 */publicclassLogControllerTestextendsBaseTestCase{@AutowiredprivateLogController logController;@TestpublicvoidtestLogAspect(){
        logController.testLogAspect();}}

3.6.运行结果:

4.6.MyLogAspect中添加内容

@Around("MyValid()")publicObjectdoAround(ProceedingJoinPoint pjp)throwsThrowable{long startTime =System.currentTimeMillis();Object[] args = pjp.getArgs();System.out.println(Arrays.toString(args));Object ob = pjp.proceed();// ob 为方法的返回值System.out.println("耗时 : "+(System.currentTimeMillis()- startTime)+"ms");return ob;}

4.7.修改LogController.java

packagecom.zking.spboot01.annotation.aop;importorg.springframework.stereotype.Component;/**
 *
 */@ComponentpublicclassLogController{@MyLog(desc ="这是结合spring aop知识，讲解自定义注解应用的一个案例")publicvoidtestLogAspect(String name,int age){try{Thread.sleep(4000);}catch(InterruptedException e){
            e.printStackTrace();}System.out.println("这里随便来点啥");}}

4.8.修改LogConterollerTest.java

packagecom.zking.spboot01.annotation.aop;importorg.junit.Test;importorg.springframework.beans.factory.annotation.Autowired;/**
 */publicclassLogControllerTestextendsBaseTestCase{@AutowiredprivateLogController logController;@TestpublicvoidtestLogAspect(){
        logController.testLogAspect("零零",20);}}

4.9运行结果:

总结

例如：以上就是今天要讲的内容，本文仅仅简单介绍了Springboot的使用，希望对你有所帮助