一文带你轻松搞懂注解

hello, 大家好～ 注解在我们日常的开发中，可谓是随处可见。从jdk1.5的@Override，到现在Spring的@Autowired。那么注解到底是什么呢？

什么是注解？

注解(Annotation):是jdk1.5引入的一种代码辅助工具，他的核心作用是对类、方法、
变量、参数和包进行标注，然后通过反射来访问这些标注信息，以此在运行时改变所注解对象的行为。Java中的注解由内置注解和元注解组成。

看完上面的这段话，emmmm… 这提莫的说的是人话吗？我听的一脸茫然，还是啥都不懂呀。没关系，我们继续往下看：

注解和注释的区别：

注解我们不了解，但注释我们了解呀。

• Java注解又称为标注，是jdk1.5开始支持加入源代码的特殊语法元数据。
• 普通的注释在编译成class文件的时候是不存在的
• 而注解附加的信息可以根据需要保存到class文件中，甚至运行期加载的class文件中。

看到这，感觉有点眉目了。原来注解和注释差距也没那么大，注释解释代码的含义。不会保存到class文件中。注解也是标注类、参数、变量，但是可以根据我们的需求，保存到class文件中，甚至到运行的时候，然后反射获取信息，从而进行后续的操作。

我们先来回忆一下反射

反射在我们的日常开发中也是随处可见，特别是在框架的源码中，但往往很多人都忽略了它的重要性。

什么是反射？

反射(Reflection): 在运行状态中，对于任意一个类都能够知道这个类的属性和方法;
对于任意一个对象都能够调用他的方法和属性。这种动态获取信息和动态调用对象的方法的功能成为Java语言的反射。

看完这句话，我不知道大家有没有蒙圈，废话少说，直接看代码：

反射Demo

实体类Person

public class Person {

    private String name;

    private int age;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public void getString(String str) {
        System.out.println(str);
    }
}

反射获取类信息

public class TestReflect {
    public static void main(String[] args) throws Exception {
        // 获取一个类的的字节码对象
        Class<?> clz = Class.forName("com.ma.model.Person");

        // 获取到所有的变量
        Field[] fields = clz.getDeclaredFields();
        for (Field field : fields) {
            System.out.println("--" + field);
        }

        // 获取所有方法名称
        Method[] declaredMethods = clz.getDeclaredMethods();
        for (Method method : declaredMethods) {
            System.out.println("--" + method);
        }
        // 利用反射执行类的方法
        // 1、 获取该类的对象
        Object obj = clz.newInstance();
        // 2、 调用类的方法
        Method method = clz.getMethod("getString", String.class);
        // 3、 如果是私有方法，需要设置访问权限。
        method.setAccessible(true);
        method.invoke(obj,"Hello, world!!!");

    }
}

更多反射信息请移步之前文章

继续回到注解

接下来我们可以自定义一个注解

注解需要元注解修饰

1. 创建注解 public @annotationName{}
2. 元注解（描述注解的一种方式）

• @Retention 定义注解的生命周期.[source / class / runtime]
• @Documented 文档注解，会被Javadoc工具文档化
• @Inherited 是否让子类继承该注解
• @Target定义注解的作用范围：

注意：一个注解可以同时标注多个@Target
@Target 的作用范围： 
1、TYPE: 用来修饰类、接口、注解类型或者枚举类型
2、PACKAGE:可以用来修饰包
3、PARAMTER: 可以用修饰参数
4、ANNOTATION_TYPE：可以用来修饰注解类型
5、METHOD： 可以用来修复方法
6、FIELD: 可以用来修饰变量
7、CONSTRUCTOR: 可以用来修饰构造器
8、LOCAL_VARIABLE:可以用来修饰局部变量

在注解中定义的类型，可以是Java的基本类型，也可以是String[] 数组类型，接下我们演示如何使用自定义注解初始化一个变量
1、自定义一个注解

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.FIELD,ElementType.TYPE})
public @interface MyValue {

    String value();
}

2、定义实体类，使用我们的注解

public class Person {

    @MyValue(value="小王")
    private String name;

    private int age;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public void getString(String str) {
        System.out.println(str);
    }

    @Override
    public String toString() {
        return "Person{" +
                "name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
}

3、使用反射将注解内容初始化到对象。

public class TestAnotation {
    public static void main(String[] args) throws Exception {
        Class<?> clz = Class.forName("com.ma.model.Person");
        Field[] fields = clz.getDeclaredFields();
        Object obj = clz.newInstance();
        for (Field field : fields) {
            MyValue annotation = field.getAnnotation(MyValue.class);
            if (annotation != null) {
                String value = annotation.value();
                Method method = clz.getMethod("setName", String.class);
                method.setAccessible(true);
                method.invoke(obj, value);
            }
        }
        System.out.println(obj.toString());
    }
}

执行结果：

综上我们就是注解的简单介绍和使用，我们将MyValue中注解的内容，在初始化到Person对象中，我们接下来使用注解完成一个实体类字段到sql的映射

具体解析可以参考下一篇。