注解(Annotation)与反射
程序员文章站
2024-01-20 17:26:22
...
注解(Annotation)与反射
注解入门
什么是注解？
1. Annotation是从JDK5.0开始引入的新技术
2. Annotation的作用：
- 不是程序本身，可以对程序作出结束(这一点和注释没什么区别)
- **可以被其他程序(如：编译器等)读取**
3. Annotation的格式
- 注释是以“@注释名”在代码中存在的，还可以添加一些参数值，例如：@SuppressWarnings(value=“unchecked”)
4. Annotation在哪里使用？
- 可以附加在package，class，method，field等上面，相当于给她们添加了额外的辅助信息，我们可以通过反射机制编程实现对这些元数据的访问
内置注解
- @Override：定义在java.lang.Override中，此注释只适用于修辞方法，表示一个方法声明打算重写超类中的另一个方法声明。
- @Deprecate：定义在java.lang.Deprecated中，此注解可以用于修辞方法，属性，类，表示不鼓励程序员使用这样的元素，通常是因为它很危险或者存在更好的选择。
- @SuppressWarnings：定义在java.lang.SuppressWarnings中，用来抑制编译时的警告信息。
- 与前两个注释有所不同，，你需要添加一个参数才能正确使用，这些参数都是已经定义好了的，我们选择性的使用就可以。
- @SuppressWarnings(“all”)
- @SuppressWarnings(“unchecked”)
- @SuppressWarnings(“value={“unchecked”,“deprecation”}”)
- 等等…
- 与前两个注释有所不同，，你需要添加一个参数才能正确使用，这些参数都是已经定义好了的，我们选择性的使用就可以。
元注解
- 元注解的作用就是负责注解其他注解，Java定义了4个标准的meta-annotation类型，他们被用来提供对其他annotation类型做说明
- 这些类型和他们所支持的类在java.lang.annotation包中可以找到.（@Target，@Retention，@Documented，@Inherited）
- @Target：用于描述注解的使用范围(即：被描述的注解可以用在什么地方)
- @Retention：表示需要在什么级别保存该注释信息，用于描述注解的生命周期
- （SOURCE < CLASS < RUNTIME）
- @Documented：说明该注解将被包含在javadoc中
- @Inherited：说明子类可以继承父类中的该注解
自定义注解
- 使用@interface自定义注解时，自动继承了java.lang.annotation.Annotation接口
- 分析：
- @interface用来声明一个注解，格式：public @interface 注解名{定义内容}。
- 其中的每一个方法实际上是声明了一个配置参数。
- 方法的名称就是参数的名称。
- 返回值类型就是参数的类型（返回值只能是基本类型，Class，String，Enum）。
- 可以通过default来声明参数的默认值。
- 如果只有一个参数成员，一般参数名为value。
- 注解元素必须要有值，我们定义注解元素时，经常使用空字符串，0作为默认值。
反射机制（Reflection）
反射的概述
静态|动态语言
动态语言
- 是一类在运行时可以改变其结构的语言：例如新的函数、对象、甚至代码可以被引进，已有的函数可以被删除或是其他结构上的变化。通俗点说就是在运行是代码可以根据某些条件改变自身结构
- 主要动态语言：Object-C、C#、JavaScript、PHP、Python等。
静态语言
- 与动态语言相对应的，运行时结构不可变的语言就是静态语言。如Java、C、C++。
- Java不是动态语言，但Java可以称为“准动态语言”。即Java有一定的动态性，我们可以利用反射机制获得类似动态语言的特性。Java的动态性让编程的时候更加灵活
Java Reflection
-
Reflection（反射）是Java被视为动态语言的关键，反射机制允许程序在执行期借助于Reflection API取得任何类的内部信息，并内直接操作任意对象的内部属性及方法。
-
Class c = Class.forName("java.lang.String") -
加载完类之后，在堆内存的方法区中就产生了一个Class类型的对象(一个类只有一个Class对象)，这个对象就包含了完整的类的结构信息。我们可以通过这个对象看到类的结构。这个对象就像一面镜子，透过这个镜子看到类的结构，所以，我们形象的称之为：反射
- 正常方式：引入需要的"包类"名称 --》通过new实例化 --》取得实例对象
- 反射方式：实例化对象 --》getClass()方法 --》去的完整的"包类"名称
-
Java反射机制研究及应用
java反射机制提供的功能
- 在运行时判断任意一个对象所属的类
- 在运行时构造任意一个类的对象
- 在运行时判断任意一个类所具有的成员变量和方法
- 在运行时获取泛型信息
- 在运行时调用任意一个对象的成员变量和方法
- 在运行时处理注解
- 生成动态代理
- …
反射优点和缺点
-
优点：
- 可以实现动态创建对象和编译，体现出很大的灵活性
-
缺点：
- 对性能有影响。使用反射基本上是一种解释操作，我们可以告诉JVM，我们希望做什么并且它满足我们的要求。这类操作总是慢于 直接执行相同的操作
反射的API
- java.lang.Class：代表一个类
- java.lang.reflect.Method：代表类的方法
- java.lang.reflect.Field：代表类的成员变量
- java.lang.reflect.Constructor：代表类的构造器
- …
//读取路径下的类
Class c1 = Class.forName("...")
Class类
在Object类中定义了以下的方法，此方法将被所有子类继承
public final Class getClass()
- 以上的方法返回值的类型是一个Class类，此类是Java反射的源头，实际上所谓反射从程序的运行结果来看也很好理解，即：可以通过对象反射求出类的名称。
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-FdPJ03uY-1626745734496)(C:/Users/aaa/AppData/Roaming/Typora/typora-user-images/image-20210617115858901.png)]
对象照镜子后可以得到的信息：某个类的属性、方法和构造器、某个类到底实现了那些接口。对于每个类而言，JRE都为其保留一个不变的Class类型的对象。一个Class对象包含了特定某个结构(class/interface/enum/annotation/primitive type/void/[])的有关信息
- Class本身也是一个类
- Class对象只能由系统建立对象
- 一个加载的类在JVM中只会有一个Class实例
- 一个Class对象对应的是一个加载到JVM中的一个.class文件
- 每个类的实例都会记得自己是由哪个Class实例所生成的
- 通过CLass可以完整的得到一个类中的所有被夹在的结构
- Class类是Reflection的根源，针对任何你想动态加载、运行的类，唯有先获得相应的Class对象
Class类的常用方法
| 方法名 | 功能说明 |
|---|---|
| static ClassforName(String name) | 返回指定类名name的Class对象 |
| Object newInstance() | 调用缺省构造函数，返回Class对象的一个实例 |
| getName() | 返回此Class对象所表示的实体(类，接口，数组类或void)的名称 |
| Class getSuperClass() | 返回当前Class对象的父类的Class对象 |
| Class[] getinterfaces() | 获取当前Class对象的接口 |
| ClassLoader getClassLoader() | 返回该类的类加载器 |
| Constructor[] getConstructors() | 返回一个包含某些Constructor对象的数组 |
| Method getMothed(String name,Class… T) | 返回一个Method对象，此对象的形参类型为paramType |
| Field[] getDeclaredFields() | 返回Field对象的一个数组 |
获取Class类的实例
-
若已知具体的类，通过了的class属性获取，该方法最为安全可靠，程序性能最高。
Class clazz = Person.class; -
已知某个了的实例，调用该实例的getClass()方法获取Class对象
Class clazz = Person.getClass(); -
已知一个类的全名，且该类在路径下，可通过Class类的静态方法forName()获取，可能抛出ClassNotFoundException
Class clazz = Class.forName("demo1.Student") -
内置基本数据类型可以直接用类型.Type
Integer.Type -
还可以利用ClassLoader
哪些类型应该有Class对象
- class：外部类，成员(成员内部类，静态内部类)，局部内部类，匿名内部类
- interface：接口
- []：数组
- enum：枚举
- annotation：注解@interface
- primitive type：基本数据类型
- void
类的加载与ClassLoader的理解
- 加载：将class文件字节码内容加载到内存中，并将这些静态数据换成方法区的运行时数据结构，然后生成一个代表这个类的java.lang.Class对象
- 链接：将Java类的二进制代码合并到JVM的运行状态之中的过程。
- 验证：确保加载的类信息符合JVM规范，没有安全方面的问题
- 准备：正式为类变量（static）分配内存并设置类变量默认初始值的阶段，这些内存都将在方法区中进行分配
- 解析：虚拟机常量池内的符号引用（常量名）替换为直接引用（地址）的过程
- 初始化：
- 执行类构造器()方法的过程。类构造器()方法是由编译期自动收集类中所有类变量的赋值动作和静态代码块中的语句合并产生的。（类构造器是构造类信息的，不是构造该类对象的构造器）。
- 当初始化一个类的时候，如果发现其父类还没有进行初始化，则需要先触发其父类的初始化。
- 虚拟机会保证一个类()方法在多线程环境中被正确加锁和同步。
public class test{
public static void main(String[] args){
A a = new A();
System.out.println(a.m);
}
}
class A{
static{
System.out.println("A类静态代码块初始化");
}
static int m = 100;
public A(){
System.out.println("A类的无参构造初始化");
}
}
运行结果：
A类静态代码块初始化
A类的无参构造初始化
100
类的初始化
- 类的主动引用（一定会发生类的初始化）
- 当虚拟机启动，先初始化main方法所在的类
- new一个类的对象
- 调用类的静态成员（除了final常量）和静态方法
- 使用java.lang.reflect包的方法对类进行反射调用
- 当初始化一个类，如果其父类没有被初始化，则先会初始化它的父类
- 类的被动引用（不会发生类的初始化）
- 当访问一个静态域时，只有真正声明这个域的类才会被初始化。如：当通过子类引用父类的静态变量，不会导致子类的初始化
- 通过数组定义类引用，不会触发此类的初始化
- 引用常量不会触发此类的初始化（常量在链接阶段就存入调用类的常量池中了）
类加载器的作用
- 类加载器的作用：将class文件字节码内容加载到内存中，并将这些静态数据转换成方法区的运行时数据结构，然后在堆中生成一个代表这个类的java.lang.Class对象，作为方法区的类数据的访问入口。
- 类缓存：标准的JavaSE类加载器可以按要求查找类，但一旦某个类被加载到类加载器中，他将维持加载（缓存）一段时间。不过JVM垃圾回收机制可以回收这些Class对象
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-D5jw4Tgg-1626745734500)(F:/%E6%A1%8C%E9%9D%A2%E7%AC%94%E8%AE%B0/%E6%B3%A8%E8%A7%A3(Annotation)]%E4%B8%8E%E5%8F%8D%E5%B0%84.assets/image-20210618161655613.png)
- 引导类加载器：用C++编写的，是JVM自带的类加载器，负责Java平台核心库，用来装在核心类库。该加载器无法直接获取。
- 扩展类加载器：负责jre/lib/ext目录下的jar包或-D java.ext.dirs指定目录下的jar包装入工作库
- 系统加载器：负责java -classpath或-D java.class.path所指的目录下的类与jar包装入工作，是最常用的加载器
//获得系统类
ClassLoader systemClassLoader = ClassLoader.getSystemClassLoader();
System.out.println(systemClassLoader);
//获得系统类加载器的父类加载器
ClassLoader parent = systemClassLoader.getParent();
System.out.println(parent);
//获得扩展类加载器的父类加载器 --> 根加载器
ClassLoader parentParent = parent.getParent();
System.out.println(parentParent);
//测试当前类是哪个加载器加载的
ClassLoader classLoader = Class.forName("com.chen.demo.test02").getClassLoader();
System.out.println(classLoader);
//测试JDK内置的类是谁加载的
classLoader = Class.forName("java.lang.Object").getClassLoader();
System.out.println(classLoader);
//如何获得系统类加载器可以加载的路径
System.out.println(System.getProperty("java.class.path"));
/**
* C:\Program Files\Java\jdk1.8.0_251\jre\lib\charsets.jar;
* C:\Program Files\Java\jdk1.8.0_251\jre\lib\deploy.jar;
* C:\Program Files\Java\jdk1.8.0_251\jre\lib\ext\access-bridge-64.jar;
* C:\Program Files\Java\jdk1.8.0_251\jre\lib\ext\cldrdata.jar;
* C:\Program Files\Java\jdk1.8.0_251\jre\lib\ext\dnsns.jar;
* C:\Program Files\Java\jdk1.8.0_251\jre\lib\ext\jaccess.jar;
* C:\Program Files\Java\jdk1.8.0_251\jre\lib\ext\jfxrt.jar;
* C:\Program Files\Java\jdk1.8.0_251\jre\lib\ext\localedata.jar;
* C:\Program Files\Java\jdk1.8.0_251\jre\lib\ext\nashorn.jar;
* C:\Program Files\Java\jdk1.8.0_251\jre\lib\ext\sunec.jar;
* C:\Program Files\Java\jdk1.8.0_251\jre\lib\ext\sunjce_provider.jar;
* C:\Program Files\Java\jdk1.8.0_251\jre\lib\ext\sunmscapi.jar;
* C:\Program Files\Java\jdk1.8.0_251\jre\lib\ext\sunpkcs11.jar;
* C:\Program Files\Java\jdk1.8.0_251\jre\lib\ext\zipfs.jar;
* C:\Program Files\Java\jdk1.8.0_251\jre\lib\javaws.jar;
* C:\Program Files\Java\jdk1.8.0_251\jre\lib\jce.jar;
* C:\Program Files\Java\jdk1.8.0_251\jre\lib\jfr.jar;
* C:\Program Files\Java\jdk1.8.0_251\jre\lib\jfxswt.jar;
* C:\Program Files\Java\jdk1.8.0_251\jre\lib\jsse.jar;
* C:\Program Files\Java\jdk1.8.0_251\jre\lib\management-agent.jar;
* C:\Program Files\Java\jdk1.8.0_251\jre\lib\plugin.jar;
* C:\Program Files\Java\jdk1.8.0_251\jre\lib\resources.jar;
* C:\Program Files\Java\jdk1.8.0_251\jre\lib\rt.jar;
* G:\idea\solidity\out\production\solidity;
* C:\Users\aaa\.m2\repository\org\hamcrest\hamcrest-core\1.3\hamcrest-core-1.3.jar;
* G:\idea\IntelliJ IDEA 2021.1\lib\idea_rt.jar
*/
获取运行时类的完整结构
通过反射获取运行时类的完整结构
Field、Method、Constructor、Superclass、Interface、Annotation
- 实现的全部接口
- 所继承的父类
- 全部的构造器
- 全部的方法
- 全部的Field
- 注解
- …
public class test03 {
public static void main(String[] args) throws ClassNotFoundException, NoSuchFieldException, NoSuchMethodException {
Class user = Class.forName("com.chen.demo.User");
User user1 = new User();
user = user1.getClass();
//获取类的名字
System.out.println(user.getName());
//获取类的简单名字
System.out.println(user.getSimpleName());
System.out.println("=========================================");
//获得类的属性 --- 只能找到public属性
Field[] fields = user.getFields();
//获取类的属性 --- 找到全部的属性
fields = user.getDeclaredFields();
for (Field field:fields) {
System.out.println(field);
}
//获得指定属性的值
Field name = user.getDeclaredField("name");
System.out.println(name);
System.out.println("=========================================");
//获得类的方法 --- 获得本类及其父类的全部的public方法
Method[] methods = user.getMethods();
for (Method method: methods) {
System.out.println(method);
}
System.out.println("666666666666666666666666666666666666666666666666666666");
//获得类的方法 --- 获得本类的全部的方法
Method[] declaredMethods = user.getDeclaredMethods();
for (Method method :
declaredMethods) {
System.out.println(method);
}
//获得指定方法
Method getName = user.getMethod("getName", null);
Method setName = user.getMethod("setName", String.class);
System.out.println(getName);
System.out.println(setName);
System.out.println("=========================================");
//获得构造器
//获得public构造方法
Constructor[] constructors = user.getConstructors();
//获得本类的所有构造方法
Constructor[] declaredConstructors = user.getDeclaredConstructors();
for (Constructor constructor :
constructors) {
System.out.println(constructor);
}
System.out.println("6=========================================6");
for (Constructor constructor :
declaredConstructors) {
System.out.println(constructor);
}
System.out.println("7=========================================7");
//获得指定的构造器
Constructor constructor = user.getConstructor(String.class,int.class,int.class);
System.out.println(constructor);
}
}
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 +
'}';
}
}
Class对象的作用
- 创建类的对象：调用Class对象的newInstance()方法
- 类必须有一个无参数的构造器
- 类的构造器的访问权限需要足够
- 在没有无参构造器的情况下创建对象
Class<?> name = Class.forName("com.chen.demo.User");
Constructor<?> declaredConstructor = name.getDeclaredConstructor(String.class, int.class, int.class);
User chen = (User) declaredConstructor.newInstance("chen", 01, 02);
- 测试源码
public class test04 {
public static void main(String[] args) throws ClassNotFoundException, InstantiationException, IllegalAccessException, NoSuchMethodException, InvocationTargetException, NoSuchFieldException {
Class<?> name = Class.forName("com.chen.demo.User");
//构造一个对象 --- 本质是调用user的无参构造
User user = (User) name.newInstance();
System.out.println(user);
//通过构造器创建对象
Constructor<?> declaredConstructor = name.getDeclaredConstructor(String.class, int.class, int.class);
User chen = (User) declaredConstructor.newInstance("chen", 01, 02);
System.out.println(chen);
//通过反射调用普通方法
User user1 = (User) name.newInstance();
//通过反射获取一个方法
Method setName = name.getDeclaredMethod("setName", String.class);
/**
* invoke : **
* （对象，“方法的值”）
*/
setName.invoke(user1,"chen");
System.out.println(user1.getName());
//通过反射操作属性
User user2 = (User) name.newInstance();
Field nameDeclaredField = name.getDeclaredField("name");
//不能直接操作私有属性 --- 关闭私有检测
nameDeclaredField.setAccessible(true);
//属性赋值
nameDeclaredField.set(user2,"chen2");
System.out.println(user2.getName());
}
}
setAccessible
- Method和Field、Constructor对象都有setAccessible()方法。
- setAccessible作用是启动和禁用访问安全检查的开关
- 参数值为true则只是反射的对象在使用是应该取消java语言访问检查
- 提高反射的效率。如果代码中必须用反射，而该句代码需要频繁的被调用，那么请设置为true。
- 是的原本无法访问的私有成员也可以访问
- 参数值为false则指示反射的对象应该实施java语言访问检查
反射操作泛型
- Java采用泛型擦除的机制来引入泛型，Java中的泛型仅仅是给编译器javac使用的，确保数据的安全性和免去强制类型转换问题，但是，一旦编译完成，所有和泛型有关的全部擦除
- 为了通过反射操作这些类型，Java新增了 ParameterizedType , GenericArrayType , TypeVariable 和 WildcardType 几种类型来代表不能被归一到Class类中的类型，但是又和原始类型齐名的类型
- ParameterizedType：表示一种参数化类型，比如Collection
- GenericArrayType：表示一种元素类型是参数化类型或者类型变量额数组类型
- TypeVariable：是各种类型变量的公共父接口
- WildcardType：代表一种通配符类型表达式
public void test01(Map<String,User> map , List<User> list){
}
public Map<String,User> test02(){
System.out.println("test02");
return null;
}
public static void main(String[] args) throws NoSuchMethodException {
Method method = test05.class.getMethod("test01", Map.class, List.class);
//获取参数类型
Type[] genericParameterTypes = method.getGenericParameterTypes();
for (Type genericParameterType : genericParameterTypes) {
System.out.println("#"+genericParameterType);
//判断泛型的类型是否属于参数化类型
if (genericParameterType instanceof ParameterizedType){
//获取该方法的参数的泛型的类型
Type[] actualTypeArguments =
((ParameterizedType) genericParameterType).getActualTypeArguments();
for (Type actualTypeArgument : actualTypeArguments) {
System.out.println("# --- "+actualTypeArgument);
}
}
}
//获取返回值类型
method = test05.class.getMethod("test02");
Type returnType = method.getGenericReturnType();
System.out.println("$"+returnType);
//获取返回值泛型类型
if (returnType instanceof ParameterizedType){
Type[] typeArguments = ((ParameterizedType) returnType).getActualTypeArguments();
for (Type typeArgument : typeArguments) {
System.out.println("$ --- "+typeArgument);
}
}
}
反射操作注解
- getAnnotations
- getAnnotation
ORM
- 定义：Object relationship Mapping --> 对象关系映射
public class test06 {
public static void main(String[] args) throws ClassNotFoundException, NoSuchFieldException {
Class clazz = Class.forName("com.chen.demo.Student");
//通过反射获得注解
Annotation[] annotations = clazz.getAnnotations();
for (Annotation annotation : annotations) {
System.out.println("# --- "+annotation);
}
//获得注解value的值
TableChen tableChen = (TableChen)clazz.getAnnotation(TableChen.class);
System.out.println("# ---- "+tableChen.value());
//获得类指定的注解
Field name = clazz.getDeclaredField("name");
FieldChen nameAnnotation = name.getAnnotation(FieldChen.class);
System.out.println("# -- "+nameAnnotation.columnName());
System.out.println("# -- "+nameAnnotation.type());
System.out.println("# -- "+nameAnnotation.length());
}
}
@TableChen("db_student")
class Student{
@FieldChen(columnName = "db_id" , type = "int" , length = 10)
private int id;
@FieldChen(columnName = "db_age" , type = "int" , length = 10)
private int age;
@FieldChen(columnName = "db_name" , type = "varchar" , length = 50)
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;
}
}
//类名的注解
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@interface TableChen{
String value();
}
//属性的注解
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@interface FieldChen{
String columnName();
String type();
int length();
}
t 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 TableChen{
String value();
}
//属性的注解
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@interface FieldChen{
String columnName();
String type();
int length();
}