JavaSE：注解和反射

一、注解（Annotation）

注解的作用：不是程序本身，可以对程序作出解释，可以被其他程序读取。

1.1 注解的格式

注解是以”@注释名“在代码中存在的，还可以添加一些参数值，例如@SuppressWarnings(value="unchecked")

1.2 内置注解

• @Override：表示打算重写一个方法。
• @Deprecated：表示不鼓励程序员使用的危险元素。
• @SuppressWarnings：用来抑制编译时的警告信息。

public class Test01 extends Object{
    // @Override 重写的注解
    @Override
    public String toString() {
        return super.toString();
    }

    // @Deprecated 不推荐使用的注解
    @Deprecated
    public static void test()
    {
        System.out.println("Deprecated");
    }

    // @SuppressWarnings 镇压警告的注解，需要传入参数
    @SuppressWarnings("all")
    public void test02()
    {
        List list = new ArrayList();
    }

    public static void main(String[] args) {
        test();
    }
}

1.3 元注解（meta-annotation）

元注解的作用是负责注解其他注解，在java中定义了4个元注解。

• @Target:用于描述注解的使用范围；
• @Retention:表示需要在什么级别保存该注解信息，用于描述注解的生命周期（Source<Class<RunTime）;
• @Document:说明该注解将被包含在javadoc中；
• @Inherited:说明子类可以继承父类中的该注解；

// 测试元注解
public class Test02 {
    @MyAnnotation
    public void test()
    {
    }
}
// 定义一个注解
// Target 表示我们的注解可以用在哪些地方（TYPE:类  METHOD:方法）
@Target(value = {ElementType.TYPE,ElementType.METHOD})

// Retention 表示我们的注解在什么地方还有效
@Retention(value = RetentionPolicy.RUNTIME)

// Documented表示是否将我们的注解生成在JAVAdoc中
@Documented

//Inherited 子类可以继承父类的注解
@Inherited
@interface MyAnnotation
{
}

1.4 自定义注解

使用@interface自定义注解

// 自定义注解
public class Test03 {

    @MyAnnotation2(name="hurunqiao",schools = {"buaa","bit"},age = 18)
    public void test() {}

    @MyAnnotation3("hurunqiao")
    public void test2() {}
}

@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation2
{
    // 注解的参数：参数类型 参数名() default 默认值;
    String name() default "";
    int age() default 0;
    int id() default -1;   // 如果默认值为-1，代表不存在
    String[] schools();
}

@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation3
{
    String value();
}

二、反射（Reflection）

2.1 反射的概述

反射机制： 允许程序在执行期间借助于Reflection API取得任何类的内部信息，并能直接操作任意对象的内部属性及方法

• 在加载了类之后，在堆内存的方法区中，就产生了一个Class类型的对象（一个类只有一个Class对象）。
• 该对象包含了完整的类的结构信息。我们可以通过该对象来看到类的完整的结构。
• 这个对象就像是一个镜子一样，透过镜子看到类的结构，因此成为反射。

正常方式： 引入需要的"包类"名称 > 通过new实例化 > 取得实例化对象

反射方式： 实例化对象 > getClass()对象方法 > 得到完整的"包类"名称

public class TestReflection01 {
    public static void main(String[] args) throws ClassNotFoundException {
        // 通过反射获取类的class对象
        Class c1 = Class.forName("com.buaa.reflection.user");

        Class c2 = Class.forName("com.buaa.reflection.user");
        Class c3 = Class.forName("com.buaa.reflection.user");
        Class c4 = Class.forName("com.buaa.reflection.user");

        // 一个类在内存中只有一个class对象
        // 一个类被加载后，类的整个结构都会被封装在class对象中
        System.out.println(c1.hashCode());
        System.out.println(c2.hashCode());
        System.out.println(c3.hashCode());
    }
}

// 实体类：
class user
{
    private String name;
    private int id;
    private int age;

    public user()
    {}

    public user(String name,int id,int age)
    {
        this.name = name;
        this.id = id;
        this.age = age;
    }

    public String getName() {
        return name;
    }

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

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public int getAge() {
        return age;
    }

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

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

2.2 获得Class类的几种方式

Class类： 对于每个类而言，JRE都为其保留了一个不变的Class类型的对象。一个Class对象包含了特定某个结构的有关信息，通过Class可以完整地得到一个类中的所有被加载的结构。

// 若已知是具体的类，通过类的class属性获取，该方法最为安全可靠，程序性能最高：
Class clazz1 = Person.class;
// 已知某个类的实例，调用该实例的getClass()方法获取Class对象：
Class clazz2 = Person.getClass();
// 已知一个类的全名，且该类在类路径中，可通过Class类的静态方法forName()获取：
Class clazz3 = Class.forName(…);
// 内置基本数据类型的包装类可以直接用
Class clazz4 = Integer.TYPE;
// 还可以利用ClassLoader加载器

2.3 获取类运行时的结构

可以通过反射获取运行时类的完整结构：Field,Method,Constructor,Superclass,Interface,Annotation；

public class TestUser {
    public static void main(String[] args) throws ClassNotFoundException, 
            NoSuchMethodException, NoSuchFieldException, 
            InvocationTargetException, IllegalAccessException, 
            InstantiationException {
        Class user = Class.forName("com.zstu.sso.User");
        //获得类的名字
        System.out.println(user.getName());
        System.out.println(user.getSimpleName());
        System.out.println("==============================");
        //获得类的属性
        //user.getFields()只能找到类的public属性
        Field[] fields = user.getDeclaredFields(); //找到全部属性
        for(Field field:fields) {
            System.out.println(field);
        }
        //获得类的指定属性
        Field field = user.getDeclaredField("name");
        System.out.println(field);
        System.out.println("==============================");
        //获得类的方法
        Method[] methods = user.getMethods(); //获得本类以及父类的所有public方法
        for(Method method:methods){
            System.out.println("所有的方法："+method);
        }
        methods = user.getDeclaredMethods(); //获得本类的所有方法(包含私有方法)
        for(Method method:methods){
            System.out.println("本类的方法："+method);
        }
        //获取指定方法
        Method test = user.getDeclaredMethod("test",null);
        Method test1 = user.getDeclaredMethod("test1", String.class);
        System.out.println(test);
        System.out.println(test1);
        System.out.println("==============================");
        //获取类的构造器
        Constructor[] constructors = user.getConstructors(); //获得public的构造器
        for (Constructor constructor : constructors) {
            System.out.println("public构造器："+constructor);
        }
        constructors = user.getDeclaredConstructors(); //获得所有构造器
        for (Constructor constructor : constructors) {
            System.out.println("所有的构造器："+constructor);
        }
        //获得指定的构造器
        Constructor constructor = user.getDeclaredConstructor(String.class, String.class);
        System.out.println(constructor);

        // 调用某个实例化类的方法，会抛出InvocationTargetException, IllegalAccessException,InstantiationException
        test.invoke(user.newInstance());
        test1.invoke(user.newInstance(),"hello");
    }
}

@Data
@AllArgsConstructor
@NoArgsConstructor
class User {
    private String name;
    private String password;

    public void test(){
        System.out.println("我执行了test的方法啦");
    }

    public void test1(String test1){
        System.out.println("我执行了test1的方法啦，内容是" + test1);
    }
}

2.4 动态创建对象的执行方法

• 可以通过Class对象创建该类的对象，然后执行该类的方法；
• 如何利用反射机制动态创建对象：

（1）调用Class对象的 newInstance() 方法，要求类必须有一个无参数的构造器，而且类的构造器的访问权限足够；
（2）当类没有无参的构造器的时候，只要在操作的过程中明确指定类中的构造器即可创建对象，步骤如下：首先，通过Class对象获取本类的指定形参类型的构造器；第二步，向构造器的形参中传递一个对象数组进去，里面包含了构造器所需的各个参数；第三步，通过Constructor实例化对象；

• 通过 .invoke(Object obj,Object[] args) 调用指定的方法；
• 通过. .set(Object obj,Object[] args) 调用指定的属性；
• 若原方法声明为private，则在调用invoke或set方法之前，需要先调用setAccessible(true) 方法，即可访问private的方法；另外反射执行的速度比普通方式要慢很多，如果非得要用反射，而且是多次用的情况下，可以通过关闭检测来提高速度。

public class Test03 {
    public static void main(String[] args) throws ClassNotFoundException, NoSuchMethodException, InvocationTargetException, InstantiationException, IllegalAccessException, NoSuchFieldException {
        Class c1 = Class.forName("com.buaa.reflection.user");

        // 通过构造器创建对象
        Constructor constructor = c1.getDeclaredConstructor(String.class, int.class, int.class);
        user user2 = (user) constructor.newInstance("hurunqiao", 01, 18);
        System.out.println(user2);

        //通过反射调用方法
        //invoke:激活（对象，”方法的值“）
        Method setName = c1.getDeclaredMethod("setName", String.class);
        setName.invoke(user2,"hurunqiao");
        System.out.println(user2.getName());

        // 通过反射操作属性
        Field name = c1.getDeclaredField("name");

        name.setAccessible(true);   // 赋予私有属性的操作权限
        name.set(user2,"xuziqi");
        System.out.println(user2.getName());

    }
}

2.5 反射操作注解的方法

在类上、字段和方法上的注解都可以通过反射进行读取，通过getAnnotation()方法来获得。

// 反射操作注解
public class Test04 {
    public static void main(String[] args) throws ClassNotFoundException, NoSuchFieldException {
        Class c1 = Class.forName("com.buaa.reflection.Student");

        // 通过反射获得注解
        Annotation[] annotations = c1.getAnnotations();
        for (Annotation annotation : annotations) {
            System.out.println(annotation);
        }

        // 获得注解的value的值
        Table table = (Table)c1.getAnnotation(Table.class);
        String value = table.value();
        System.out.println(value);

        // 获得类指定注解
        java.lang.reflect.Field f = c1.getDeclaredField("name");
        Field annotation = f.getAnnotation(Field.class);
        System.out.println(annotation.columnName());
        System.out.println(annotation.type());
        System.out.println(annotation.length());

    }

}

// 创建一个注解
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@interface Table
{
    String value();
}

@Table("db_Student")
class Student
{
    @Field(columnName = "db_id",type = "int",length = 10)
    private int id;
    @Field(columnName = "db_age",type = "int",length = 10)
    private int age;
    @Field(columnName = "db_name",type = "String",length = 10)
    private String name;

    public Student()
    {}

    public Student(int id, int age, String name) {
        this.id = id;
        this.age = age;
        this.name = name;
    }

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public int getAge() {
        return age;
    }

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

    public String getName() {
        return name;
    }

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

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

// 属性的注解
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@interface Field
{
    String columnName();
    String type();
    int length();
}

参考链接：
注解的讲解博客
反射的讲解博客