Java学习25：反射机制、注解
2020-11-27 本文已影响0人
苦难_69e0
反射
反射机制有什么用？
通过java语言中的反射机制可以操作字节码文件。
有点类似于黑客。（可以读和修改字节码文件）
通过反射机制可以操作代码片段。（class文件。）
反射机制的相关类在哪个包下？
java.lang.reflect.*;
反射机制相关的重要的类有哪些？
java.lang.Class：代表整个字节码，代表一个类型
java.lang.reflect.Method：代表字节码中的方法字节码
java.lang.reflect.Constructor：代表字节码中的构造方法字节码
java.lang.reflect.Field：代表字节码中的属性字节码。代表类中的成员变量（静态变量+实例变量）
举例说明.png
获取class的三种方式
要操作一个类的字节码，需要首先获取到这个类的字节码，怎么获取java.lang.Class实例？
三种方式
第一种：Class c = Class.forName("完整类名带包名");
Class.forName()
1、静态方法
2、方法的参数是一个字符串。
3、字符串需要的是一个完整类名。
4、完整类名必须带有包名。java.lang包也不能省略
第二种：Class c = 对象.getClass();
第三种：Class c = 任何类型.class;
public class ReflectTest01 {
public static void main(String[] args) {
/*
Class.forName()
1、静态方法
2、方法的参数是一个字符串。
3、字符串需要的是一个完整类名。
4、完整类名必须带有包名。java.lang包也不能省略。
*/
Class c1 = null;
Class c2 = null;
try {
c1 = Class.forName("java.lang.String"); // c1代表String.class文件，或者说c1代表String类型。
c2 = Class.forName("java.util.Date"); // c2代表Date类型
Class c3 = Class.forName("java.lang.Integer"); // c3代表Integer类型
Class c4 = Class.forName("java.lang.System"); // c4代表System类型
} catch (ClassNotFoundException e) {
e.printStackTrace();
}
// java中任何一个对象都有一个方法：getClass()
String s = "abc";
Class x = s.getClass(); // x代表String.class字节码文件，x代表String类型。
System.out.println(c1 == x); // true（==判断的是对象的内存地址。）
Date time = new Date();
Class y = time.getClass();
System.out.println(c2 == y); // true (c2和y两个变量中保存的内存地址都是一样的，都指向方法区中的字节码文件。)
// 第三种方式，java语言中任何一种类型，包括基本数据类型，它都有.class属性。
Class z = String.class; // z代表String类型
Class k = Date.class; // k代表Date类型
Class f = int.class; // f代表int类型
Class e = double.class; // e代表double类型
System.out.println(x == z); // true
}
}
第二种获取方式的原理.png
获取到Class，能干什么？
通过Class的newInstance()方法来实例化对象。
注意：newInstance()方法内部实际上调用了无参数构造方法，必须保证无参构造存在才可以。
public class ReflectTest02 {
public static void main(String[] args) {
// 这是不使用反射机制，创建对象
User user = new User();
System.out.println(user);
// 下面这段代码是以反射机制的方式创建对象。
try {
// 通过反射机制，获取Class，通过Class来实例化对象
Class c = Class.forName("User"); // c代表User类型。
// newInstance() 这个方法会调用User这个类的无参数构造方法，完成对象的创建。
// 重点是：newInstance()调用的是无参构造，必须保证无参构造是存在的！
Object obj = c.newInstance();
System.out.println(obj); // com.bjpowernode.java.bean.User@10f87f48
} catch (ClassNotFoundException e) {
e.printStackTrace();
} catch (IllegalAccessException e) {
e.printStackTrace();
} catch (InstantiationException e) {
e.printStackTrace();
}
}
}
public class User {
public User(){
System.out.println("无参数构造方法！");
}
// 定义了有参数的构造方法，无参数构造方法就没了。
public User(String s){
}
}
直接new对象没有反射机制灵活。反射机制更加灵活。
java代码写一遍，再不改变java源代码的基础之上，可以做到不同对象的实例化。
非常之灵活。（符合OCP开闭原则：对扩展开放，对修改关闭。）
后期要学习的是高级框架，而工作过程中，也都是使用高级框架，
包括： ssh ssm
Spring SpringMVC MyBatis
Spring Struts Hibernate
...
这些高级框架底层实现原理：都采用了反射机制。所以反射机制还是重要的。
学会了反射机制有利于你理解剖析框架底层的源代码。
public class ReflectTest03 {
public static void main(String[] args) throws Exception{
// 这种方式代码就写死了。只能创建一个User类型的对象
//User user = new User();
// 以下代码是灵活的，代码不需要改动，可以修改配置文件，配置文件修改之后，可以创建出不同的实例对象。
// 通过IO流读取classinfo.properties文件
FileReader reader = new FileReader("classinfo2.properties");
// 创建属性类对象Map
Properties pro = new Properties(); // key value都是String
// 加载
pro.load(reader);
// 关闭流
reader.close();
// 通过key获取value
String className = pro.getProperty("className");
//System.out.println(className);
// 通过反射机制实例化对象
Class c = Class.forName(className);
Object obj = c.newInstance();
System.out.println(obj);
}
}
classinfo2.properties文件
className=User
Class.forName()发生了什么？
重点：如果你只希望一个类的静态代码块执行，其他代码一律不执行，你可以使用：
Class.forName("完整类名");
这个方法的执行会导致类加载，类加载时，静态代码块执行。
提示：后期学习JDBC的时候我们还要用。
public class ReflectTest04 {
public static void main(String[] args) {
try {
// Class.forName()这个方法的执行会导致：类加载。
Class.forName("MyClass");
} catch (ClassNotFoundException e) {
e.printStackTrace();
}
}
}
class MyClass {
// 静态代码块在类加载时执行，并且只执行一次。
static {
System.out.println("MyClass类的静态代码块执行了！");
}
}
关于路径的问题
FileReader reader = new FileReader("classinfo2.properties");
这种方式的路径缺点是：移植性差，在IDEA中默认的当前路径是project的跟。
这个代码假设离开了IDEA，换到了其他位置，可能当前路径就不是project的根了，这时这个路径就无效了。
/*
研究一下文件路径的问题。
怎么获取一个文件的绝对路径。以下讲解的这种方式是通用的。但前提是：文件需要在类路径下。才能用这种方式。
*/
public class AboutPath {
public static void main(String[] args) throws Exception{
// 这种方式的路径缺点是：移植性差，在IDEA中默认的当前路径是project的根。
// 这个代码假设离开了IDEA，换到了其它位置，可能当前路径就不是project的根了，这时这个路径就无效了。
//FileReader reader = new FileReader("chapter25/classinfo2.properties");
// 接下来说一种比较通用的一种路径。即使代码换位置了，这样编写仍然是通用的。
// 注意：使用以下通用方式的前提是：这个文件必须在类路径下。
// 什么类路径下？凡是在src下的都是类路径下。【记住它】
// src是类的根路径。
/*
解释：
Thread.currentThread() 当前线程对象
getContextClassLoader() 是线程对象的方法，可以获取到当前线程的类加载器对象。
getResource() 【获取资源】这是类加载器对象的方法，当前线程的类加载器默认从类的根路径下加载资源。
*/
String path = Thread.currentThread().getContextClassLoader()
.getResource("classinfo2.properties").getPath(); // 这种方式获取文件绝对路径是通用的。
// 采用以上的代码可以拿到一个文件的绝对路径。
// /C:/Users/Administrator/IdeaProjects/javase/out/production/chapter25/classinfo2.properties
System.out.println(path);
// 获取db.properties文件的绝对路径（从类的根路径下作为起点开始）
String path2 = Thread.currentThread().getContextClassLoader()
.getResource("db.properties").getPath();
System.out.println(path2);
}
}
以IO流的方式返回
import java.io.FileReader;
import java.io.InputStream;
import java.util.Properties;
public class IoPropertiesTest {
public static void main(String[] args) throws Exception{
// 获取一个文件的绝对路径了！！！！！
/*String path = Thread.currentThread().getContextClassLoader()
.getResource("classinfo.properties").getPath();
FileReader reader = new FileReader(path);*/
// 直接以流的形式返回。
InputStream reader = Thread.currentThread().getContextClassLoader()
.getResourceAsStream("classinfo2.properties");
Properties pro = new Properties();
pro.load(reader);
reader.close();
// 通过key获取value
String className = pro.getProperty("className");
System.out.println(className);
}
}
资源绑定器
java.util包下提供了一个资源绑定器，便于获取属性配置文件中的内容。
使用以下这种方式的时候，属性配置文件xxx.properties必须放到类路径下。
import java.util.ResourceBundle;
public class ResourceBundleTest {
public static void main(String[] args) {
// 资源绑定器，只能绑定xxx.properties文件。并且这个文件必须在类路径下。文件扩展名也必须是properties
// 并且在写路径的时候，路径后面的扩展名不能写。
ResourceBundle bundle = ResourceBundle.getBundle("classinfo");
// ResourceBundle bundle = ResourceBundle.getBundle("com/bjpowernode/java/bean/db");
String className = bundle.getString("className");
System.out.println(className);
}
}
类加载器（了解）
什么是类加载器？
专门负责加载类的命令/工具。
ClassLoader
JDK中自带了3个类加载器
启动类加载器：rt.jar
扩展类加载器：ext/*.jar
应用类加载器：classpath
假设有这样一段代码：
String s = "abc";
代码在开始执行之前，会将所需要的类全部加载到JVM当中。
通过类加载器加载，看到以上代码类加载器会找String.class文件，找到就加载，那么是怎么进行加载的呢？
首先通过“启动类加载器”加载
注意：启动类加载器专门加载：jre\lib\rt.jar
rt.jar中都是JDK最核心的类库。
如果通过”启动类加载器“加载不到的时候，会通过”扩展类加载器“加载。
注意：扩展类加载器专门加载：jre\lib\ext*.jar
如果“扩展类加载器”没有加载到，那么会通过“应用类加载器”加载。
注意：应用类加载器专门加载：classpath中的jar包（class文件）
双亲委派机制（了解）
java中为了保证类加载的安全，使用了双亲委派机制。
优先从启动类加载器中加载，这个称为“父”，“父”无法加载到，再从扩展类加载器中加载，这个称为“母”，双亲委派。如果都加载不到，才会考虑从应用类加载器中加载。直到加载到为止。
获取Field
import java.lang.reflect.Field;
import java.lang.reflect.Modifier;
/*
反射Student类当中所有的Field（了解一下）
*/
public class ReflectTest05 {
public static void main(String[] args) throws Exception{
// 获取整个类
Class studentClass = Class.forName("Student");
//com.bjpowernode.java.bean.Student
String className = studentClass.getName();
System.out.println("完整类名：" + className);
String simpleName = studentClass.getSimpleName();
System.out.println("简类名：" + simpleName);
// 获取类中所有的public修饰的Field
Field[] fields = studentClass.getFields();
System.out.println(fields.length); // 测试数组中只有1个元素
// 取出这个Field
Field f = fields[0];
// 取出这个Field它的名字
String fieldName = f.getName();
System.out.println(fieldName);
// 获取所有的Field
Field[] fs = studentClass.getDeclaredFields();
System.out.println(fs.length); // 4
System.out.println("==================================");
// 遍历
for(Field field : fs){
// 获取属性的修饰符列表
int i = field.getModifiers(); // 返回的修饰符是一个数字，每个数字是修饰符的代号！！！
System.out.println(i);
// 可以将这个“代号”数字转换成“字符串”吗？
String modifierString = Modifier.toString(i);
System.out.println(modifierString);
// 获取属性的类型
Class fieldType = field.getType();
//String fName = fieldType.getName();
String fName = fieldType.getSimpleName();
System.out.println(fName);
// 获取属性的名字
System.out.println(field.getName());
}
}
}
// 反射属性Field
public class Student {
// Field翻译为字段，其实就是属性/成员
// 4个Field，分别采用了不同的访问控制权限修饰符
private String name; // Field对象
protected int age; // Field对象
boolean sex;
public int no;
public static final double MATH_PI = 3.1415926;
}
反编译Filed
拿到字节码文件后，对其进行反编译Filed，取出
//通过反射机制，反编译一个类的属性Field（了解一下）
import java.lang.reflect.Field;
import java.lang.reflect.Modifier;
public class ReflectTest06 {
public static void main(String[] args) throws Exception{
// 创建这个是为了拼接字符串。
StringBuilder s = new StringBuilder();
//Class studentClass = Class.forName("com.bjpowernode.java.bean.Student");
Class studentClass = Class.forName("java.lang.Thread");
s.append(Modifier.toString(studentClass.getModifiers()) + " class " + studentClass.getSimpleName() + " {\n");
Field[] fields = studentClass.getDeclaredFields();
for(Field field : fields){
s.append("\t");
s.append(Modifier.toString(field.getModifiers()));
s.append(" ");
s.append(field.getType().getSimpleName());
s.append(" ");
s.append(field.getName());
s.append(";\n");
}
s.append("}");
System.out.println(s);
}
}
反射Field(重点)
怎么通过反射机制访问一个java对象的属性
import java.lang.reflect.Field;
/*
必须掌握：
怎么通过反射机制访问一个java对象的属性？
给属性赋值set
获取属性的值get
*/
public class ReflectTest07 {
public static void main(String[] args) throws Exception{
// 我们不使用反射机制，怎么去访问一个对象的属性呢？
Student s = new Student();
// 给属性赋值
s.no = 1111; //三要素：给s对象的no属性赋值1111
//要素1：对象s
//要素2：no属性
//要素3：1111
// 读属性值
// 两个要素：获取s对象的no属性的值。
System.out.println(s.no);
// 使用反射机制，怎么去访问一个对象的属性。（set get）
Class studentClass = Class.forName("com.bjpowernode.java.bean.Student");
Object obj = studentClass.newInstance(); // obj就是Student对象。（底层调用无参数构造方法）
// 获取no属性（根据属性的名称来获取Field）
Field noFiled = studentClass.getDeclaredField("no");
// 给obj对象(Student对象)的no属性赋值
/*
虽然使用了反射机制，但是三要素还是缺一不可：
要素1：obj对象
要素2：no属性
要素3：2222值
注意：反射机制让代码复杂了，但是为了一个“灵活”，这也是值得的。
*/
noFiled.set(obj, 22222); // 给obj对象的no属性赋值2222
// 读取属性的值
// 两个要素：获取obj对象的no属性的值。
System.out.println(noFiled.get(obj));
// 可以访问私有的属性吗？
Field nameField = studentClass.getDeclaredField("name");
// 打破封装（反射机制的缺点：打破封装，可能会给不法分子留下机会！！！）
// 这样设置完之后，在外部也是可以访问private的。
nameField.setAccessible(true);
// 给name属性赋值
nameField.set(obj, "jackson");
// 获取name属性的值
System.out.println(nameField.get(obj));
}
}
可变长度参数
int... args 这就是可变长度参数
语法是：类型... （注意：一定是3个点。）
1、可变长度参数要求的参数个数是：0~N个。
2、可变长度参数在参数列表中必须在最后一个位置上，而且可变长度参数只能有1个。
3、可变长度参数可以当做一个数组来看待
public class ArgsTest {
public static void main(String[] args) {
m();
m(10);
m(10, 20);
// 编译报错
//m("abc");
m2(100);
m2(200, "abc");
m2(200, "abc", "def");
m2(200, "abc", "def", "xyz");
m3("ab", "de", "kk", "ff");
String[] strs = {"a","b","c"};
// 也可以传1个数组
m3(strs);
// 直接传1个数组
m3(new String[]{"我","是","中","国", "人"}); //没必要
m3("我","是","中","国", "人");
}
public static void m(int... args){
System.out.println("m方法执行了！");
}
//public static void m2(int... args2, String... args1){}
// 必须在最后，只能有1个。
public static void m2(int a, String... args1){
}
public static void m3(String... args){
//args有length属性，说明args是一个数组！
// 可以将可变长度参数当做一个数组来看。
for(int i = 0; i < args.length; i++){
System.out.println(args[i]);
}
}
}
反射Method
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
/*
作为了解内容（不需要掌握）：
反射Method
*/
public class ReflectTest08 {
public static void main(String[] args) throws Exception{
// 获取类了
Class userServiceClass = Class.forName("UserService");
// 获取所有的Method（包括私有的！）
Method[] methods = userServiceClass.getDeclaredMethods();
//System.out.println(methods.length); // 2
// 遍历Method
for(Method method : methods){
// 获取修饰符列表
System.out.println(Modifier.toString(method.getModifiers()));
// 获取方法的返回值类型
System.out.println(method.getReturnType().getSimpleName());
// 获取方法名
System.out.println(method.getName());
// 方法的修饰符列表（一个方法的参数可能会有多个。）
Class[] parameterTypes = method.getParameterTypes();
for(Class parameterType : parameterTypes){
System.out.println(parameterType.getSimpleName());
}
}
}
}
/**
* 用户业务类
*/
public class UserService {
/**
* 登录方法
* @param name 用户名
* @param password 密码
* @return true表示登录成功，false表示登录失败！
*/
public boolean login(String name,String password){
if("admin".equals(name) && "123".equals(password)){
return true;
}
return false;
}
// 可能还有一个同名login方法
// java中怎么区分一个方法，依靠方法名和参数列表。
public void login(int i){
}
/**
* 退出系统的方法
*/
public void logout(){
System.out.println("系统已经安全退出！");
}
}
反编译Method
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
/*
了解一下，不需要掌握（反编译一个类的方法。）
*/
public class ReflectTest09 {
public static void main(String[] args) throws Exception{
StringBuilder s = new StringBuilder();
//Class userServiceClass = Class.forName("UserService");
Class userServiceClass = Class.forName("java.lang.String");
s.append(Modifier.toString(userServiceClass.getModifiers()) + " class "+userServiceClass.getSimpleName()+" {\n");
Method[] methods = userServiceClass.getDeclaredMethods();
for(Method method : methods){
//public boolean login(String name,String password){}
s.append("\t");
s.append(Modifier.toString(method.getModifiers()));
s.append(" ");
s.append(method.getReturnType().getSimpleName());
s.append(" ");
s.append(method.getName());
s.append("(");
// 参数列表
Class[] parameterTypes = method.getParameterTypes();
for(Class parameterType : parameterTypes){
s.append(parameterType.getSimpleName());
s.append(",");
}
// 删除指定下标位置上的字符
s.deleteCharAt(s.length() - 1);
s.append("){}\n");
}
s.append("}");
System.out.println(s);
}
}
通过反射机制调用方法（重点）
重点：必须掌握，通过反射机制怎么调用一个对象的方法？
五颗星*****
反射机制，让代码很具有通用性，可变化的内容都是写到配置文件当中，
将来修改配置文件之后，创建的对象不一样了，调用的方法也不同了，
但是java代码不需要做任何改动。这就是反射机制的魅力。
import java.lang.reflect.Method;
public class ReflectTest10 {
public static void main(String[] args) throws Exception{
// 不使用反射机制，怎么调用方法
// 创建对象
UserService userService = new UserService();
// 调用方法
/*
要素分析：
要素1：对象userService
要素2：login方法名
要素3：实参列表
要素4：返回值
*/
boolean loginSuccess = userService.login("admin","123");
//System.out.println(loginSuccess);
System.out.println(loginSuccess ? "登录成功" : "登录失败");
// 使用反射机制来调用一个对象的方法该怎么做？
Class userServiceClass = Class.forName("UserService");
// 创建对象
Object obj = userServiceClass.newInstance();
// 获取Method
Method loginMethod = userServiceClass.getDeclaredMethod("login", String.class, String.class);
//Method loginMethod = userServiceClass.getDeclaredMethod("login", int.class);
// 调用方法
// 调用方法有几个要素？ 也需要4要素。
// 反射机制中最最最最最重要的一个方法，必须记住。
/*
四要素：
loginMethod方法
obj对象
"admin","123" 实参
retValue 返回值
*/
Object retValue = loginMethod.invoke(obj, "admin","123123");
System.out.println(retValue);
}
}
反射Constructor
import java.lang.reflect.Constructor;
import java.lang.reflect.Modifier;
/*
反编译一个类的Constructor构造方法。
*/
public class ReflectTest11 {
public static void main(String[] args) throws Exception{
StringBuilder s = new StringBuilder();
Class vipClass = Class.forName("java.lang.String");
s.append(Modifier.toString(vipClass.getModifiers()));
s.append(" class ");
s.append(vipClass.getSimpleName());
s.append("{\n");
// 拼接构造方法
Constructor[] constructors = vipClass.getDeclaredConstructors();
for(Constructor constructor : constructors){
//public Vip(int no, String name, String birth, boolean sex) {
s.append("\t");
s.append(Modifier.toString(constructor.getModifiers()));
s.append(" ");
s.append(vipClass.getSimpleName());
s.append("(");
// 拼接参数
Class[] parameterTypes = constructor.getParameterTypes();
for(Class parameterType : parameterTypes){
s.append(parameterType.getSimpleName());
s.append(",");
}
// 删除最后下标位置上的字符
if(parameterTypes.length > 0){
s.deleteCharAt(s.length() - 1);
}
s.append("){}\n");
}
s.append("}");
System.out.println(s);
}
}
public class Vip {
int no;
String name;
String birth;
boolean sex;
public Vip() {
}
public Vip(int no) {
this.no = no;
}
public Vip(int no, String name) {
this.no = no;
this.name = name;
}
public Vip(int no, String name, String birth) {
this.no = no;
this.name = name;
this.birth = birth;
}
public Vip(int no, String name, String birth, boolean sex) {
this.no = no;
this.name = name;
this.birth = birth;
this.sex = sex;
}
@Override
public String toString() {
return "Vip{" +
"no=" + no +
", name='" + name + '\'' +
", birth='" + birth + '\'' +
", sex=" + sex +
'}';
}
}
反射机制调用构造方法
import java.lang.reflect.Constructor;
/*
比上一个例子(ReflectTest11)重要一些！！！
通过反射机制调用构造方法实例化java对象。（这个不是重点）
*/
public class ReflectTest12 {
public static void main(String[] args) throws Exception{
// 不使用反射机制怎么创建对象
Vip v1 = new Vip();
Vip v2 = new Vip(110, "zhangsan", "2001-10-11", true);
// 使用反射机制怎么创建对象呢？
Class c = Class.forName("Vip");
// 调用无参数构造方法
Object obj = c.newInstance();
System.out.println(obj);
// 调用有参数的构造方法怎么办？
// 第一步：先获取到这个有参数的构造方法
Constructor con = c.getDeclaredConstructor(int.class, String.class, String.class,boolean.class);
// 第二步：调用构造方法new对象
Object newObj = con.newInstance(110, "jackson", "1990-10-11", true);
System.out.println(newObj);
// 获取无参数构造方法
Constructor con2 = c.getDeclaredConstructor();
Object newObj2 = con2.newInstance();
System.out.println(newObj2);
}
}
获取父类和父接口
/*
重点：给你一个类，怎么获取这个类的父类，已经实现了哪些接口？
*/
public class ReflectTest13 {
public static void main(String[] args) throws Exception{
// String举例
Class stringClass = Class.forName("java.lang.String");
// 获取String的父类
Class superClass = stringClass.getSuperclass();
System.out.println(superClass.getName());
// 获取String类实现的所有接口（一个类可以实现多个接口。）
Class[] interfaces = stringClass.getInterfaces();
for(Class in : interfaces){
System.out.println(in.getName());
}
}
}
注解
注解，或者叫做注释类型，英文单词是：Annotation
注解Annotation是一种引用数据类型。编译之后也是生成xxx.class文件。
怎么自定义注解呢？语法格式？
[修饰符列表] @interface 注解类型名{
}
注解怎么使用，用在什么地方？
第一：注解使用时的语法格式是：
@注解类型名
第二：注解可以出现在类上、属性上、方法上、变量上等...
注解还可以出现在注解类型上。
默认情况下，注解可以出现在任意位置
JDK中内置了哪些注解呢？
java.lang包下的注释类型：
掌握：
Deprecated 用@Deprecated 注释的程序元素，不鼓励程序员使用这样的元素，通常是因为它很危险或存在更好的选择。
掌握：
Override 表示一个方法声明打算重写超类中的另一个方法声明。
不用掌握：
SuppressWarnings 指示应该在注释元素（以及包含在该注释元素中的所有程序元素）中取消显示指定的编译器警告。
Override注解
源代码：
public @interface Override {
}
标识性注解，给编译器做参考的。
编译器看到方法上有这个注解的时候，编译器会自动检查该方法是否重写了父类的方法。如果没有重写，报错。
@Override 这个注解只能注解方法。
@Override 这个注解是给编译器参考的，和运行阶段没有关系。
凡是java中的方法带有这个注解的，编译器都会进行编译检查，如果这个方法不是重写父类的方法，编译器报错。
元注解
什么是元注解？
用来标注“注解类型”的“注解”，称为元注解。
常见的元注解有哪些？
Target
Retention
关于Target注解：
这是一个元注解，用来标注“注解类型”的“注解”。
这个Target注解用来标注“被标注的注解”可以出现在哪些位置上。
@Target (ElementType.METHOD)：表示“被标注的注解”只能出现在方法上。
关于Retention注解：
这是一个元注解，用来标注“注解类型”的“注解”。
这个Retention注解用来标注“被标注的注解”最终保存在哪里。
@Retention (RetentionPolicy.SOURCE)：表示该注解只被保留在java源文件中。
@Retention (RetentionPolicy.CLASS)：表示该注解被保留在class文件中。
@Retention (RetentionPolicy.RUNTIME)：表示该注解被保留在class文件中,并且可以被反射机制所读取。
Deprecated注解
Deprecated这个注解标注的元素已过时。
这个注解主要是向其它程序员传达一个信息，告知已过时，有更好的解决方案存在。
注解中定义属性
public @interface MyAnnotation {
/**
* 我们通常在注解当中可以定义属性，以下这个是MyAnnotation的name属性。
* 看着像1个方法，但实际上我们称之为属性name。
* @return
*/
String name();
/*
颜色属性
*/
String color();
/*
年龄属性
*/
int age() default 25; //属性指定默认值
}
public class MyAnnotationTest {
// 报错的原因：如果一个注解当中有属性，那么必须给属性赋值。（除非该属性使用default指定了默认值。）
/*@MyAnnotation
public void doSome(){
}*/
//@MyAnnotation(属性名=属性值,属性名=属性值,属性名=属性值)
//指定name属性的值就好了。
@MyAnnotation(name = "zhangsan", color = "红色")
public void doSome(){
}
}
如果一个注解的属性的名字是value并且只有一个属性的话，在使用的时候，该属性名可以省略。
public @interface MyAnnotation {
/*
指定一个value属性。
*/
String value();
//String email();
}
/*
如果一个注解的属性的名字是value，并且只有一个属性的话，在使用的时候，该属性名可以省略。
*/
public class MyAnnotationTest {
// 报错原因：没有指定属性的值。
/*@MyAnnotation
public void doSome(){
}*/
@MyAnnotation(value = "hehe")
public void doSome(){
}
@MyAnnotation("haha")
public void doOther(){
}
}
注解当中的属性
注解当中的属性可以是什么类型？
属性的类型可以是：byte short int long float double boolean char String Class 枚举类型（enum）
以及以上每一种的数组形式。
public enum Season {
SPRING,SUMMER,AUTUMN,WINTER
}
public @interface OtherAnnotation {
/*
年龄属性
*/
int age();
/*
邮箱地址属性，支持多个
*/
String[] email();
/**
* 季节数组，Season是枚举类型
* @return
*/
Season[] seasonArray();
}
public class OtherAnnotationTest {
// 数组是大括号
@OtherAnnotation(age = 25, email = {"zhangsan@123.com", "zhangsan@sohu.com"}, seasonArray = Season.WINTER)
public void doSome(){
}
// 如果数组中只有1个元素：大括号可以省略。
@OtherAnnotation(age = 25, email = "zhangsan@123.com", seasonArray = {Season.SPRING, Season.SUMMER})
public void doOther(){
}
}
反射注解
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
//只允许该注解可以标注类、方法
@Target({ElementType.TYPE, ElementType.METHOD})
// 希望这个注解可以被反射
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
/*
value属性。
*/
String value() default "北京大兴区";
}
@MyAnnotation("上海浦东区")
public class MyAnnotationTest {
//@MyAnnotation
int i;
//@MyAnnotation
public MyAnnotationTest(){
}
@MyAnnotation
public void doSome(){
//@MyAnnotation
int i;
}
}
public class ReflectAnnotationTest {
public static void main(String[] args) throws Exception{
// 获取这个类
Class c = Class.forName("MyAnnotationTest");
// 判断类上面是否有@MyAnnotation
//System.out.println(c.isAnnotationPresent(MyAnnotation.class)); // true
if(c.isAnnotationPresent(MyAnnotation.class)){
// 获取该注解对象
MyAnnotation myAnnotation = (MyAnnotation)c.getAnnotation(MyAnnotation.class);
//System.out.println("类上面的注解对象" + myAnnotation);
// 获取注解对象的属性怎么办？和调接口没区别。
String value = myAnnotation.value();
System.out.println(value);
}
// 判断String类上面是否存在这个注解
Class stringClass = Class.forName("java.lang.String");
System.out.println(stringClass.isAnnotationPresent(MyAnnotation.class)); // false
}
}
通过反射获取注解对象的属性的值
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface MyAnnotation {
/*
username属性
*/
String username();
/*
password属性
*/
String password();
}
import java.lang.reflect.Method;
public class MyAnnotationTest {
@MyAnnotation(username = "admin", password = "456456")
public void doSome(){
}
public static void main(String[] args) throws Exception{
// 获取MyAnnotationTest的doSome()方法上面的注解信息。
Class c = Class.forName("com.bjpowernode.java.annotation6.MyAnnotationTest");
// 获取doSome()方法
Method doSomeMethod = c.getDeclaredMethod("doSome");
// 判断该方法上是否存在这个注解
if(doSomeMethod.isAnnotationPresent(MyAnnotation.class)) {
MyAnnotation myAnnotation = doSomeMethod.getAnnotation(MyAnnotation.class);
System.out.println(myAnnotation.username());
System.out.println(myAnnotation.password());
}
}
}
注解在开发中有什么用？
注解在程序当中等同于一种标记。
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
// 表示这个注解只能出现在类上面
@Target(ElementType.TYPE)
// 该注解可以被反射机制读取到
@Retention(RetentionPolicy.RUNTIME)
public @interface MustHasIdPropertyAnnotation {
}
// 这个注解@Id用来标注类，被标注的类中必须有一个int类型的id属性，没有就报异常。
@MustHasIdPropertyAnnotation
public class User {
int id;
String name;
String password;
}
/*
自定义异常
*/
public class HasNotIdPropertyException extends RuntimeException {
public HasNotIdPropertyException(){
}
public HasNotIdPropertyException(String s){
super(s);
}
}
import java.lang.reflect.Field;
public class Test {
public static void main(String[] args) throws Exception{
// 获取类
Class userClass = Class.forName("com.bjpowernode.java.annotation7.User");
// 判断类上是否存在Id注解
if(userClass.isAnnotationPresent(MustHasIdPropertyAnnotation.class)){
// 当一个类上面有@MustHasIdPropertyAnnotation注解的时候，要求类中必须存在int类型的id属性
// 如果没有int类型的id属性则报异常。
// 获取类的属性
Field[] fields = userClass.getDeclaredFields();
boolean isOk = false; // 给一个默认的标记
for(Field field : fields){
if("id".equals(field.getName()) && "int".equals(field.getType().getSimpleName())){
// 表示这个类是合法的类。有@Id注解，则这个类中必须有int类型的id
isOk = true; // 表示合法
break;
}
}
// 判断是否合法
if(!isOk){
throw new HasNotIdPropertyException("被@MustHasIdPropertyAnnotation注解标注的类中必须要有一个int类型的id属性！");
}
}
}
}
