java注解讲解

Java注解简介

1. Java注解(Annotation)
Java注解是附加在代码中的一些元信息，用于一些工具在编译、
运行时进行解析和使用，起到说明、配置的功能。
注解相关类都包含在java.lang.annotation包中。
2. Java注解分类
1 JDK基本注解
2 JDK元注解
3 自定义注解

3. JDK基本注解

  1 @Override
      重写
  2 @Deprecated
      已过时 
  3 @SuppressWarnings(value = "unchecked") 
      压制编辑器警告

Java元注解

作用：元注解用于修饰其他的注解

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

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


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


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

java自定义注解

注解分类（根据Annotation是否包含成员变量,可以把Annotation分为两类）:
标记Annotation:
没有成员变量的Annotation; 这种Annotation仅利用自身的存在与否来提供信息
元数据Annotation:
包含成员变量的Annotation; 它们可以接受(和提供)更多的元数据;

如何自定义注解？
使用@interface关键字, 其定义过程与定义接口非常类似, 需要注意的是:
Annotation的成员变量在Annotation定义中是以无参的方法形式来声明的, 其方法名和返回值类型定义了该成员变量的名字和类型,
而且我们还可以使用default关键字为这个成员变量设定默认值；
注意：只有名字为“value”属性，赋值时可以省略属性名

案例：

案列一：（获取类与方法上的注解值）
TranscationModel
定义枚举

package com.thf.annotation.p1;

/**
 * @author tanhaifang
 * @site www.thf.com
 * @company
 * @create 2019-11-23 18:34
 */
public enum  TranscationModel {
    Read, Write, ReadWrite
}

Demo1

package com.thf.annotation.p1;

/**
 * @author tanhaifang
 * @site www.thf.com
 * @company
 * @create 2019-11-23 18:35
 *
 * 获取类与方法上的注解值
 */
@MyAnnotation1(name = "tanhaifang")
public class Demo1 {

    @MyAnnotation1(name = "thf")
    private Integer age;

    @MyAnnotation2(model = TranscationModel.Read)
    public void list() {
        System.out.println("list");
    }

    @MyAnnotation3(models = {TranscationModel.Read, TranscationModel.Write})
    public void edit() {
        System.out.println("edit");
    }
}

MyAnnotation1

package com.thf.annotation.p1;

import java.lang.annotation.*;

/**
 * @author tanhaifang
 * @site www.thf.com
 * @company
 * @create 2019-11-23 18:33
 *
 * MyAnnotation1注解可以用在类、接口、属性、方法上
 * 注解运行期也保留
 * 不可继承
 */
@Target({ElementType.TYPE, ElementType.FIELD,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyAnnotation1 {
    String name();
}

MyAnnotation2

package com.thf.annotation.p1;

import java.lang.annotation.*;

/**
 * @author tanhaifang
 * @site www.thf.com
 * @company
 * @create 2019-11-23 18:33
 *
 *  MyAnnotation2注解可以用在方法上
 *  注解运行期也保留
 *  不可继承
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyAnnotation2 {
    TranscationModel model() default TranscationModel.ReadWrite;
}

MyAnnotation3

package com.thf.annotation.p1;

import java.lang.annotation.*;

/**
 * @author tanhaifang
 * @site www.thf.com
 * @company
 * @create 2019-11-23 18:33
 *
 * MyAnnotation3注解可以用在方法上
 * 注解运行期也保留
 * 可继承
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface MyAnnotation3 {
    TranscationModel[] models() default TranscationModel.ReadWrite;
}

案例二： 获取类属性上的注解属性值
TestAnnotation

package com.thf.annotation.p2;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * @author tanhaifang
 * @site www.thf.com
 * @company
 * @create 2019-11-23 18:34
 */
//@Retention(RetentionPolicy.SOURCE)
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface TestAnnotation {
    String value() default "默认value值";

    String what() default "这里是默认的what属性对应的值";
}

Demo2

package com.thf.annotation.p2;

/**
 * @author tanhaifang
 * @site www.thf.com
 * @company
 * @create 2019-11-23 18:35
 *
 * 获取类属性上的注解属性值
 */
public class Demo2 {
    @TestAnnotation(value = "这就是value对应的值_msg1", what = "这就是what对应的值_msg1")
    private static String msg1;

    @TestAnnotation("这就是value对应的值1")
    private static String msg2;

    @TestAnnotation(value = "这就是value对应的值2")
    private static String msg3;

    @TestAnnotation(what = "这就是what对应的值")
    private static String msg4;
}

Demo2Test

package com.thf.annotation.p2;

import org.junit.Test;

/**
 * @author tanhaifang
 * @site www.thf.com
 * @company
 * @create 2019-11-23 18:42
 */
public class Demo2Test {
    @Test
    public void test1() throws Exception {
        TestAnnotation msg1 = Demo2.class.getDeclaredField("msg1").getAnnotation(TestAnnotation.class);
        System.out.println(msg1.value());
        System.out.println(msg1.what());
    }

    @Test
    public void test2() throws Exception{
        TestAnnotation msg2 = Demo2.class.getDeclaredField("msg2").getAnnotation(TestAnnotation.class);
        System.out.println(msg2.value());
        System.out.println(msg2.what());
    }

    @Test
    public void test3() throws Exception{
        TestAnnotation msg3 = Demo2.class.getDeclaredField("msg3").getAnnotation(TestAnnotation.class);
        System.out.println(msg3.value());
        System.out.println(msg3.what());
    }

    @Test
    public void test4() throws Exception{
        TestAnnotation msg4 = Demo2.class.getDeclaredField("msg4").getAnnotation(TestAnnotation.class);
        System.out.println(msg4.value());
        System.out.println(msg4.what());
    }
}

案例三： 获取参数修饰注解对应的属性值
IsNotNull

package com.thf.annotation.p3;

import java.lang.annotation.*;

/**
 * @author tanhaifang
 * @site www.thf.com
 * @company
 * @create 2019-11-23 18:35
 *
 * 非空注解：使用在方法的参数上，false表示此参数可以为空，true不能为空
 */
@Documented
@Target({ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
public @interface IsNotNull {
    boolean value() default false;
}

Demo3

package com.thf.annotation.p3;

/**
 * @author tanhaifang
 * @site www.thf.com
 * @company
 * @create 2019-11-23 18:58
 *
 * 获取参数修饰注解对应的属性值
 */
public class Demo3 {

    public void hello1(@IsNotNull(true) String name,@IsNotNull(false) Integer age) {

        System.out.println("hello:" + name);
    }

    public void hello2(@IsNotNull String name) {
        System.out.println("hello:" + name);
    }
}

Demo3Test

package com.thf.annotation.p3;

import org.junit.Test;

import java.lang.reflect.Parameter;

/**
 * @author tanhaifang
 * @site www.thf.com
 * @company
 * @create 2019-11-23 18:42
 */
public class Demo3Test {

    @Test
    public void hello1() throws Exception {
        Demo3 demo3 = new Demo3();
        for (Parameter parameter : demo3.getClass().getMethod("hello1", String.class,Integer.class).getParameters()) {
            IsNotNull annotation = parameter.getAnnotation(IsNotNull.class);
            if(annotation != null){
                System.out.println(annotation.value());//true
            }
        }
    }

    @Test
    public void hello2() throws Exception {
        Demo3 demo3 = new Demo3();
        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
            }
        }
    }
}

案例四
利用aop切面（aspect），在调用方法前先执行前置通知里面的方法，然后在执行调用方法,来实现一个日志监控的效果
首先我们先定义一个切面MyLogAspect

package com.thf.annotation.springAop;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;


/**
 * @author tanhaifang
 * @site www.thf.com
 * @company
 * @create 2019-11-23 18:42
 */
@Component
@Aspect
public class MyLogAspect {
    private static final Logger logger = LoggerFactory.getLogger(MyLogAspect.class);

    /**
     * 只要用到了com.thf.annotation.springAop.MyLog这个注解的，就是目标类
     */
    @Pointcut("@annotation(com.thf.annotation.springAop.MyLog)")
    private void MyValid() {
    }

    @Before("MyValid()")
    public void before(JoinPoint joinPoint) {
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        logger.debug("[" + signature.getName() + " : start.....]");

        MyLog myLog = signature.getMethod().getAnnotation(MyLog.class);
        logger.debug("【目标对象方法被调用时候产生的日志，记录到日志表中】："+myLog.desc());
    }
}

MyLog元注解

package com.thf.annotation.springAop;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * @author tanhaifang
 * @site www.thf.com
 * @company
 * @create 2019-11-23 18:42
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyLog {
    String desc();
}

LogController

package com.thf.annotation.springAop;

import org.springframework.stereotype.Component;

/**
 * @author tanhaifang
 * @site www.thf.com
 * @company
 * @create 2019-11-23 18:42
 */
@Component
public class LogController {

    @MyLog(desc = "这是结合spring aop知识，讲解自定义注解应用的一个案例")
    public void testLogAspect(){
        System.out.println("这里随便来点啥");
    }
}

LogControllerTest

package com.thf.controller;

import com.thf.SpringBaseTest;
import com.thf.annotation.springAop.LogController;
import org.junit.Test;
import org.springframework.beans.factory.annotation.Autowired;

/**
 * @author tanhaifang
 * @site www.thf.com
 * @company
 * @create 2019-11-23 18:42
 */
public class LogControllerTest extends SpringBaseTest {
    @Autowired
    private LogController logController;

    @Test
    public void testLogAspect(){
        logController.testLogAspect();
    }
}

运行结果：