Java注解和反射

Java注解和反射

注解

• Annotation是从JDK5.0开始引入的新技术.
• Annotation的作用:
  不是程序本身，可以对程序作出解释.(这一点和注释(comment)没什么区别)可以被其他程序(比如:编译器等)读取.
• Annotation的格式︰
  注解是以"@注释名"在代码中存在的，还可以添加一些参数值﹐例如:@SuppressWarnings(value=“unchecked”).
• Annotation在哪里使用:
  可以附加在package , class , method , field等上面﹐相当于给他们添加了额外的辅助信息，我们可以通过反射机制编程实现对这些元数据的访问

内置注解

1. @Override:定义在java.lang.Override中,此注释只适用于修辞方法﹐表示一个方法声明打算重写超类中的另一个方法声明.
2. @Deprecated:定义在java.lang.Deprecated中,此注释可以用于修辞方法﹐属性类，表示不鼓励程序员使用这样的元素,通常是因为它很危险或者存在更好的选择.
3. @SuppressWarnings:定义在java.lang.SuppressWarnings中,用来抑制编译时的警告信息.
   @SuppressWarnings(“all”)
   @SuppressWarnings(“unchecked”)
   @SuppressWarnings(value={“unchecked”,“deprecation”})

元注解

• 元注解的作用就是负责注解其他注解，Java定义了4个标准的meta-annotation类型,他们被用来提供对其他annotation类型作说明．
• 这些类型和它们所支持的类在java.lang.annotation包中可以找到.(@Target , @Retention ,@Documented , @Inherited )

1. @Target:用于描述注解的使用范围(即:被描述的注解可以用在什么地方)
2. @Retention:表示需要在什么级别保存该注释信息﹐用于描述注解的生命周期(SOURCE< CLASS< RUNTIME)
3. @Document:说明该注解将被包含在javadoc中
4. @Inherited:说明子类可以继承父类中的该注解

自定义注解

• 使用@interface自定义注解时﹐自动继承了java.lang.annotation.Annotation接口
• @interface用来声明一个注解﹐格式: public @interface注解名{定义内容}
• 其中的每一个方法实际上是声明了一个配置参数
• 方法的名称就是参数的名称.
• 返回值类型就是参数的类型(返回值只能是基本类型,Class , String , enum)
• 可以通过default来声明参数的默认值
• 如果只有一个参数成员，一般参数名为value
• 注解元素必须要有值﹐我们定义注解元素时,经常使用空字符串,0作为默认值．

反射

Java.Reflection

• Reflection(反射）是Java被视为动态语言的关键，反射机制允许程序在执行期借助于Reflection API取得任何类的内部信息，并能直接操作任意对象的内部属性及方法。
  Class c = Class.forName(“java.lang.String”)
• 加载完类之后，在堆内存的方法区中就产生了一个Class类型的对象（一个类只有一个Class对象），这个对象就包含了完整的类的结构信息。我们可以通过这个对象看到类的结构。这个对象就像一面镜子，透过这个镜子看到类的结构，所以，我们形象的称之为:反射
• 优点:可以实现动态创建对象和编译，体现出很大的灵活性
• 缺点:对性能有影响。使用反射基本上是一种解释操作，我们可以告诉JVM,我们希望做什么并且它满足我们的要求。这类操作总是慢于直接执行相同的操作。

Class类

Java内存分析

动态创建类

实例说明

package reflection;

import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;

//什么叫反射,动态创建对象
public class Test02 {
    public static void main(String[] args) throws ClassNotFoundException, IllegalAccessException, InstantiationException, 
    NoSuchMethodException, InvocationTargetException, NoSuchFieldException {
        //通过反射获取类的Class对象,一个类在内存中只有一个Class对象
        //一个类被加载后,类的整个结构都会被封装在Class对象中
        Class c= Class.forName("reflection.Test02");
        System.out.println(c);

        Class c1= Class.forName("reflection.User");
        System.out.println(c1);

        //构造一个对象
        //本质是调用了类的无参构造器,如果类没有无参构造,会报错
        User user1 = (User)c1.newInstance();    
        System.out.println(user1);

        //通过构造器创建对象
        Constructor constructor = c1.getConstructor(String.class, int.class, int.class);
        User user2 = (User)constructor.newInstance("张三", 1, 100);
        System.out.println(user2);

        //通过反射调用普通方法
        User user3 = (User)c1.newInstance();
        Method setName = c1.getMethod("setName", String.class);
        //invoke:激活的意思 (对象, value)
        setName.invoke(user3, "李四");
        System.out.println(user3);

        //通过反射操作属性
        User user4 = (User)c1.newInstance();
        //Declared用于获取私有private属性,方法,构造器等
        Field name = c1.getDeclaredField("name");      
        //private的属性需要放开权限控制,去除private的限制,否则报错
        name.setAccessible(true);       
        name.set(user4, "王五");
        System.out.println(user4);

    }
}

//实体类:pojo, entity
class User {
    private String name;
    private int id;
    private int age;

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

    public User() {
    }

    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 +
                '}';
    }
}

总结

自定义注解结合反射例:

package reflection;
import java.lang.annotation.*;
import java.lang.reflect.Field;

//反射操作注解
public class annoReflect {
    public static void main(String[] args) throws Exception {
        Class c1 = Class.forName("reflection.Student");

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

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

        //获取属性的注解
        Field id = c1.getDeclaredField("id");
        FieldQSH fieldQSH = id.getAnnotation(FieldQSH.class);
        System.out.println(fieldQSH.columnName());
        System.out.println(fieldQSH.type());
        System.out.println(fieldQSH.length());

        System.out.println("=======================");
        //获取所有属性的注解
        Field[] declaredFields = c1.getDeclaredFields();
        for (Field declaredField : declaredFields) {
            System.out.println(declaredField.getName());
            fieldQSH = declaredField.getAnnotation(FieldQSH.class);
            System.out.println(fieldQSH.columnName());
            System.out.println(fieldQSH.type());
            System.out.println(fieldQSH.length());
        }
    }
}

@TableQSH("db_student")
class Student {
    @FieldQSH(columnName = "db_id", type = "int", length = 10)
    private int id;
    @FieldQSH(columnName = "db_age", type = "int", length = 10)
    private int age;
    @FieldQSH(columnName = "db_name", type = "varchar", length = 3)
    private String name;

    public Student() {
    }

    public Student(int id, int age, String name) {
        this.id = id;
        this.age = age;
        this.name = name;
    }
    
    @Override
    public String toString() {
        return "Student{" +
                "id=" + id +
                ", age=" + age +
                ", 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;
    }
}

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

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@interface FieldQSH {
    String columnName();

    String type();

    int length();
}

@reflection.TableQSH(value=db_student)
db_student
db_student
db_id
int
10
=======================
id
db_id
int
10
age
db_age
int
10
name
db_name
varchar
3