Java从入门到实战总结-3.8、Java枚举、注解、反射、内省

Java从入门到实战总结-3.8、Java枚举、注解、反射、内省

---

1. 枚举

(1). 枚举概述

JDK1.5引入了新的类型:枚举。

在JDK1.5 之前，我们定义常量都是： public static fianl… 。很难管理。

枚举，可以把相关的常量分组到一个枚举类型里，而且枚举提供了比常量更多的方法。

用于定义有限数量的一组同类常量，例如：
错误级别： 低、中、高、急
一年的四季： 春、夏、秋、冬
商品的类型： 美妆、手机、电脑、男装、女装…
在枚举类型中定义的常量是该枚举类型的实例。

(2). 定义格式

权限修饰符 enum 枚举名称 {
实例1,实例2，实例3，实例4;
}

(3). 枚举类的主要方法

方法名称	描述
values()	以数组形式返回枚举类型的所有成员
valueOf()	将普通字符串转换为枚举实例
compareTo()	比较两个枚举成员在定义时的顺序
ordinal()	获取枚举成员的索引位置

创建时选择枚举：

package com.xiaoyaoyou.day14;

public enum Level {
     
//    LOW(1), MEDIUM(50), HIGH(100);
//    private int levelValue;
//
//    private Level(int levelValue) {
     
//        this.levelValue = levelValue;
//    }
//
//    public int getLevelValue() {
     
//        return levelValue;
//    }
//
//    public void setLevelValue(int levelValue) {
     
//        this.levelValue = levelValue;
//    }

LOW, MEDIUM, HIGH;
}

package com.xiaoyaoyou.day14;

public class EnumTest {
     
    public static void main(String[] args) {
     
        System.out.println(Level.LOW.compareTo(Level.HIGH));
        System.out.println(Level.LOW.compareTo(Level.MEDIUM));
        System.out.println(Level.HIGH.compareTo(Level.LOW));

        System.out.println(Level.LOW.name());
        System.out.println(Level.LOW.toString());
        System.out.println(Level.LOW.ordinal());

        Level x =  Enum.valueOf(Level.class, "LOW");
        System.out.println(x);
    }
}

结果：

-2
-1
2
LOW
LOW
0
LOW

(4). 实现接口的枚举类

所有的枚举都继承自java.lang.Enum类。由于Java 不支持多继承，所以枚举对象不能再继承其他类。

每个枚举对象，都可以实现自己的抽象方法。

如下图：

package com.xiaoyaoyou.day14;

public interface LShow {
     
    void show();
}

package com.xiaoyaoyou.day14;

public enum Level implements LShow {
     
//    LOW(1), MEDIUM(50), HIGH(100);
//    private int levelValue;
//
//    private Level(int levelValue) {
     
//        this.levelValue = levelValue;
//    }
//
//    public int getLevelValue() {
     
//        return levelValue;
//    }
//
//    public void setLevelValue(int levelValue) {
     
//        this.levelValue = levelValue;
//    }

    LOW{
     
    @Override
    public void show() {
     
        System.out.println("低级别");
    }
    },
    MEDIUM{
     
        @Override
        public void show() {
     
            System.out.println("中级别");
        }
    },
    HIGH{
     
        @Override
        public void show() {
     
            System.out.println("高级别");
        }
    };
}

package com.xiaoyaoyou.day14;

public class EnumTest {
     
    public static void main(String[] args) {
     
        System.out.println(Level.LOW.compareTo(Level.HIGH));
        System.out.println(Level.LOW.compareTo(Level.MEDIUM));
        System.out.println(Level.HIGH.compareTo(Level.LOW));

        System.out.println(Level.LOW.name());
        System.out.println(Level.LOW.toString());
        System.out.println(Level.LOW.ordinal());

        Level x =  Enum.valueOf(Level.class, "LOW");
        System.out.println(x);

        Level.LOW.show();
        Level.MEDIUM.show();
        Level.HIGH.show();
    }
}

结果：

-2
-1
2
LOW
LOW
0
LOW
低级别
中级别
高级别

(5). 枚举注意事项

• 一旦定义了枚举，最好不要妄图修改里面的值，除非修改是必要的。
• 枚举类默认继承的是java.lang.Enum类而不是Object类
• 枚举类不能有子类，因为其枚举类默认被final修饰
• 只能有private构造方法
• switch中使用枚举时，直接使用常量名，不用携带类名
• 不能定义name属性，因为自带name属性
• 不要为枚举类中的属性提供set方法，不符合枚举最初设计初衷。

2. 注解

(1). 简介

Java 注解（Annotation）又称 Java 标注，是 JDK5.0 引入的一种注释机制。

Java语言中的类、方法、变量、参数和包等都可以被标注。和注释不同，Java标注可以通过反射获取标注内容。在编译器生成类文件时，标注可以被嵌入到字节码中。Java 虚拟机可以保留标注内容，在运行时可以获取到标注内容。当然它也支持自定义 Java 标注。

主要用于：

• 编译格式检查
• 反射中解析
• 生成帮助文档
• 跟踪代码依赖等

(2). 重点

• 1. 概念
• 2. 怎么使用内置注解
• 3. 怎么定义注解
• 4. 反射中怎么获取注解内容

(3). 内置注解

• @Override ： 重写 *

  • 定义在java.lang.Override

• @Deprecated：废弃 *

  • 定义在java.lang.Deprecated

• @SafeVarargs

  • Java 7 开始支持，忽略任何使用参数为泛型变量的方法或构造函数调用产生的警告。

• @FunctionalInterface： 函数式接口 *

  • Java 8 开始支持，标识一个匿名函数或函数式接口。

• @Repeatable：标识某注解可以在同一个声明上使用多次

  • Java 8 开始支持，标识某注解可以在同一个声明上使用多次。

• @SuppressWarnings：抑制编译时的警告信息。 *

  • 定义在java.lang.SuppressWarnings

  • 三种使用方式

  • 1. @SuppressWarnings("unchecked") [^ 抑制单类型的警告] 
    2. @SuppressWarnings("unchecked","rawtypes") [^ 抑制多类型的警告] 
    3. @SuppressWarnings("all") [^ 抑制所有类型的警告]
    

  • 参数列表

我们刚学习了proto buf，发现proto的设计和注解有很多类似之处，也可以看出来这些语言语法的设计都是为了解决问题而产生的，所以如果你发现了一个问题，就可以尝试看下是否有解决该问题的方案，如果没有，我们能否自己解决该问题那，解决后是否可开源出来？

(4). 元注解

含义：作用在其他注解的注解（需要结合自定义注解理解）

• @Retention - 标识这个注解怎么保存，是只在代码中，还是编入class文件中，或者是在运行时可以通过反射访问。

• @Documented - 标记这些注解是否包含在用户文档中 javadoc。

• @Target - 标记这个注解应该是哪种 Java 成员。

• @Inherited - 标记这个注解是自动继承的

  1. 子类会继承父类使用的注解中被@Inherited修饰的注解
  2. 接口继承关系中，子接口不会继承父接口中的任何注解，不管父接口中使用的注解有没有被@Inherited修饰
  3. 类实现接口时不会继承任何接口中定义的注解
  

(5). 自定义注解

• 1. 注解架构

• (1) Annotation与RetentionPolicy与ElementType

  每1个 Annotation 对象，都会有唯一的 RetentionPolicy 属性；至于 ElementType 属性，则有 1~n个。

• (2) ElementType(注解的用途类型)
  “每 1 个 Annotation” 都与 “1～n 个 ElementType” 关联。当 Annotation 与某个ElementType关联时，就意味着：Annotation有了某种用途。例如，若一个 Annotation 对象是 METHOD 类型，则该Annotation 只能用来修饰方法。

package java.lang.annotation;
public enum ElementType {
     
    TYPE, /* 类、接口（包括注释类型）或枚举声明 */
    FIELD, /* 字段声明（包括枚举常量） */
    METHOD, /* 方法声明 */
    PARAMETER, /* 参数声明 */
    CONSTRUCTOR, /* 构造方法声明 */
    LOCAL_VARIABLE, /* 局部变量声明 */
    ANNOTATION_TYPE, /* 注释类型声明 */
    PACKAGE /* 包声明 */
}

• (3) RetentionPolicy（注解作用域策略）

  “每 1 个 Annotation” 都与 “1 个 RetentionPolicy” 关联。
  a) 若 Annotation 的类型为 SOURCE，则意味着：Annotation 仅存在于编译器处理期间，编译器处理完之后，该 Annotation 就没用了。 例如，" @Override" 标志就是一个 Annotation。当它修饰一个方法的时候，就意味着该方法覆盖父类的方法；并且在编译期间会进行语法检查！编译器处理完后，"@Override" 就没有任何作用了。

  b) 若 Annotation 的类型为 CLASS，则意味着：编译器将 Annotation 存储于类对应的 .class 文件中，它是 Annotation 的默认行为。

  c) 若 Annotation 的类型为 RUNTIME，则意味着：编译器将 Annotation 存储于 class 文件中，并且可由JVM读入。

package java.lang.annotation;
public enum RetentionPolicy {
     
    SOURCE, /* Annotation信息仅存在于编译器处理期间，编译器处理完之后就没有该 Annotation信息了 */
    CLASS, /* 编译器将Annotation存储于类对应的.class文件中。默认行为 */
    RUNTIME /* 编译器将Annotation存储于class文件中，并且可由JVM读入 */
}

• 2. 定义格式

  @interface 自定义注解名{}

• 3. 注意事项
  • 定义的注解，自动继承了java.lang,annotation.Annotation接口
  • 注解中的每一个方法，实际是声明的注解配置参数
    • 方法的名称就是配置参数的名称
    • 方法的返回值类型，就是配置参数的类型，只能是：基本类型/Class/String/enum
  • 可以通过default来声明参数的默认值
  • 如果只有一个参数成员，一般参数名为value
  • 注解元素必须要有值，我们定义注解元素时，经常使用空字符串、0作为默认值。
• 4. 案例

package com.xiaoyaoyou.day14;

import java.lang.annotation.*;

@MyAnnotation("测试自定义注解")
public class InterfaceTest {
     
    public static void main(String[] args) {
     

    }
}

@Documented
@Target({
     ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@interface MyAnnotation {
     
    String value() default "";
    int num() default 0;
}

等到学完反射后看注解如何获取注解内容。

3. 反射

(1). 概述

JAVA反射机制是在运行状态中，获取任意一个类的结构 , 创建对象 , 得到方法，执行方法 , 属性 !

这种在运行状态动态获取信息以及动态调用对象方法的功能被称为java语言的反射机制，反射被视为动态语言的关键。

(2). 类加载器

Java类加载器（Java Classloader）是Java运行时环境（Java Runtime Environment）的一部分， 负责动态加载Java类到Java虚拟机的内存空间中。

java默认有三种类加载器，BootstrapClassLoader、ExtensionClassLoader、App ClassLoader。

BootstrapClassLoader（引导启动类加载器）：嵌在JVM内核中的加载器，该加载器是用C++语言写的，主要负载加载JAVA_HOME/lib下的类库，引导启动类加载器无法被应用程序直接使用。

ExtensionClassLoader（扩展类加载器）： ExtensionClassLoader是用JAVA编写，且它的父类加载器是Bootstrap。
是由sun.misc.Launcher$ExtClassLoader实现的，主要加载JAVA_HOME/lib/ext目录中的类库。
它的父加载器是BootstrapClassLoader

App ClassLoader（应用类加载器）：App ClassLoader是应用程序类加载器，负责加载应用程序classpath目录下的所有jar和class文件。它的父加载器为Ext ClassLoader

类通常是按需加载，即第一次使用该类时才加载。由于有了类加载器，Java运行时系统不需要知道文件与 文件系统。学习类加载器时，掌握Java的委派概念很重要。

双亲委派模型：如果一个类加载器收到了一个类加载请求，它不会自己去尝试加载这个类，而是把这个请求 转交给父类加载器去完成。每一个层次的类加载器都是如此。因此所有的类加载请求都应该传递到最顶层的 启动类加载器中，只有到父类加载器反馈自己无法完成这个加载请求（在它的搜索范围没有找到这个类）时，子类加载器才会尝试自己去加载。委派的好处就是避免有些类被重复加载。

加载配置文件，给项目添加resource root目录：

汉化后：

代码示例：

package com.xiaoyaoyou.day14;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;

public class LoadResourceTest {
     
    public static void main(String[] args) throws IOException {
     
        InputStream inputStream = LoadResourceTest.class.getClassLoader().getResourceAsStream("config.txt");
        BufferedReader bufferedReader = new BufferedReader(new InputStreamReader(inputStream));
        String text = bufferedReader.readLine();
        System.out.println(text);
        bufferedReader.close();
    }
}

结果：

测试类加载器

(3). 所有类型的Class对象

要想了解一个类,必须先要获取到该类的字节码文件对象.

在Java中，每一个字节码文件，被夹在到内存后，都存在一个对应的Class类型的对象

(4). 得到Class的几种方式

• 如果在编写代码时, 知道类的名称, 且类已经存在, 可以通过包名.类名.class得到一个类的类对象
• 如果拥有类的对象, 可以通过Class 对象.getClass()得到一个类的类对象
• 如果在编写代码时,知道类的名称,可以通过Class.forName(包名+类名):得到一个类的类对象

上述的三种方式, 在调用时, 如果类在内存中不存在, 则会加载到内存!如果类已经在内存中存在, 不会重复加载, 而是重复利用!

(一个class文件 在内存中不会存在两个类对象 )

特殊的类对象

• 基本数据类型的类对象:
  基本数据类型.clss
  包装类.type
• 基本数据类型包装类对象:
  包装类.class

示例：

package com.xiaoyaoyou.day14;

public class GetClassTest {
     
    public static void main(String[] args) throws ClassNotFoundException {
     
        //第一种，通过包名.类名.class加载类
        Class c1 = com.xiaoyaoyou.day14.LoadResourceTest.class;
        System.out.println(c1);

        //第二种，通过类的对象过去类的信息
        LoadResourceTest loadResourceTest = new LoadResourceTest();
        Class c2 = loadResourceTest.getClass();
        System.out.println(c2);

        //第三种方式
        Class c3 = Class.forName("com.xiaoyaoyou.day14.LoadResourceTest");
        System.out.println(c3);
        System.out.println(c1==c2 && c1==c3);
    }
}

结果：

class com.xiaoyaoyou.day14.LoadResourceTest
class com.xiaoyaoyou.day14.LoadResourceTest
class com.xiaoyaoyou.day14.LoadResourceTest
true

(5). 获取Constructor

• 1. 通过获取class对象获取一个类的构造方法
  • (1). 通过指定的参数类型, 获取指定的单个构造方法 getConstructor(参数类型的class对象数组)
    例如:构造方法如下: Person(String name,int age)
    得到这个构造方法的代码如下:
    Constructor c = p.getClass().getConstructor(String.class,int.class);
  • (2). 获取构造方法数组
    getConstructors();
  • (3). 获取所有权限的单个构造方法
    getDeclaredConstructor(参数类型的class对象数组)
  • (4). 获取所有权限的构造方法数组 getDeclaredConstructors();
• 2. Constructor 创建对象
  • 常用方法: newInstance(Object… para)
    调用这个构造方法, 把对应的对象创建出来
    参数: 是一个Object类型可变参数,传递的参数顺序必须匹配构造方法中形式参数列表的顺序!
  • setAccessible(boolean flag) 如果flag为true 则表示忽略访问权限检查 !(可以访问任何权限的方法)

package com.xiaoyaoyou.day14;

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

public class GetConstructorTest {
     
    public static void main(String[] args) throws ClassNotFoundException, NoSuchMethodException, IllegalAccessException, InvocationTargetException, InstantiationException {
     
        Class c1 = Class.forName("com.xiaoyaoyou.day14.LoadResourceTest");
        Constructor c2 = c1.getConstructor();
        LoadResourceTest loadResourceTest = (LoadResourceTest) c2.newInstance();
        System.out.println(loadResourceTest.toString());
    }
}

结果：

LoadResourceTest{
     }

其它的方法和方式可以自己尝试一下(忽略权限检查的接口一定要试试)。

(6). 获取Method

• 1. 通过class对象 获取一个类的方法
  • getMethod(String methodName , class… clss)
    根据参数列表的类型和方法名, 得到一个方法(public修饰的)
  • getMethods();
    得到一个类的所有方法 (public修饰的)
  • getDeclaredMethod(String methodName , class… clss)
    根据参数列表的类型和方法名, 得到一个方法(除继承以外所有的:包含私有, 共有, 保护, 默认)
  • getDeclaredMethods();
    得到一个类的所有方法 (除继承以外所有的:包含私有, 共有, 保护, 默认)
• 2. Method 执行方法
  • invoke(Object o,Object… para):
    调用方法,
    参数1. 要调用方法的对象
    参数2. 要传递的参数列表
  • getName()
    获取方法的方法名称
  • setAccessible(boolean flag)
    如果flag为true 则表示忽略访问权限检查 !(可以访问任何权限的方法)

(7). 获取Field

• 1. 通过class对象 获取一个类的属性
  • getDeclaredField(String filedName)
    根据属性的名称, 获取一个属性对象 (所有属性)
  • getDeclaredFields()
    获取所有属性(属性私有时需要配合忽略权限检查使用)
  • getField(String filedName)
    根据属性的名称, 获取一个属性对象 (public属性)
  • getFields()
    获取所有属性 (public)
• 2. Field 属性的对象类型
     常用方法:
  • get(Object o );
    参数: 要获取属性的对象 获取指定对象的此属性值
  • set(Object o , Object value);
    参数1. 要设置属性值的对象
    参数2. 要设置的值
    设置指定对象的属性的值
  • getName()
    获取属性的名称
  • setAccessible(boolean flag)
    如果flag为true则表示忽略访问权限检查!(可以访问任何权限的属性)

(8). 获取注解信息

• 1. 获取类/属性/方法的全部注解对象

Annotation[] annotations01 = Class/Field/Method.getAnnotations();

for (Annotation annotation : annotations01) {
     
    System.out.println(annotation);
}

• 2. 根据类型获取类/属性/方法的注解对象

注解类型 对象名 = (注解类型) c.getAnnotation(注解类型.class);

示例：

package com.xiaoyaoyou.day14;

import java.lang.annotation.Annotation;

public class GetAnnotationTest {
     
    public static void main(String[] args) throws ClassNotFoundException {
     
        Class c = Class.forName("com.xiaoyaoyou.day14.InterfaceTest");
        Annotation[] annotations = c.getAnnotations();
        for (Annotation a: annotations) {
     
            System.out.println(a);
        }

        MyAnnotation myAnnotation = (MyAnnotation) c.getAnnotation(MyAnnotation.class);
        System.out.println(myAnnotation.value());
        System.out.println(myAnnotation.num());
    }
}

结果：

@com.xiaoyaoyou.day14.MyAnnotation(value=测试自定义注解, num=0)
测试自定义注解
0

还可以扩展对类的属性、方法等增加注解，然后通过获取属性、获取方法的注解来做一些关联操作。

4. 内省

(1). JavaBean

基于反射,java所提供的一套应用到JavaBean的API

一个定义在包中的类:

• 拥有无参构造器
• 所有属性私有
• 所有属性提供get/set方法
• 实现了序列化接口

这种类, 我们称其为bean类.

Java提供了一套java.beans包的api，对于反射的操作, 进行了封装！

(2). Introspector

获取Bean类信息

方法:
BeanInfo getBeanInfo(Class cls)
通过传入的类信息, 得到这个Bean类的封装对象

(3). BeanInfo

常用的方法:
MethodDescriptor[] getPropertyDescriptors():
获取bean类的 get/set方法 数组

(4). MethodDescriptor

常用方法:

• 1. Method getReadMethod();获取一个get方法
• 2. Method getWriteMethod(); 获取一个set方法 有可能返回null 注意加判断

(5). 示例

我们之前写快递E栈项目的时候接触过bean，后续的框架学习还会接触，这里我们也主要学会使用了解一些概念即可，随着接触更多的框架和项目对bean的理解会逐渐加深。

package com.xiaoyaoyou.day14;

import java.io.Serializable;

public class Express implements Serializable {
     
    private String name;
    private String number;
    private String phoneNumber;
    private String address;

    public Express() {
     
    }

    @Override
    public String toString() {
     
        return "Express{" +
                "name='" + name + '\'' +
                ", number='" + number + '\'' +
                ", phoneNumber='" + phoneNumber + '\'' +
                ", address='" + address + '\'' +
                '}';
    }

    public String getName() {
     
        return name;
    }

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

    public String getNumber() {
     
        return number;
    }

    public void setNumber(String number) {
     
        this.number = number;
    }

    public String getPhoneNumber() {
     
        return phoneNumber;
    }

    public void setPhoneNumber(String phoneNumber) {
     
        this.phoneNumber = phoneNumber;
    }

    public String getAddress() {
     
        return address;
    }

    public void setAddress(String address) {
     
        this.address = address;
    }
}

package com.xiaoyaoyou.day14;

import java.beans.BeanInfo;
import java.beans.IntrospectionException;
import java.beans.Introspector;
import java.beans.PropertyDescriptor;
import java.lang.reflect.Method;

public class BeanTest {
     
    public static void main(String[] args) throws IntrospectionException {
     
        Class c = Express.class;
        BeanInfo beanInfo = Introspector.getBeanInfo(c);
        PropertyDescriptor[] propertyDescriptors = beanInfo.getPropertyDescriptors();
        for (PropertyDescriptor p:propertyDescriptors) {
     
            Method get = p.getReadMethod();
            Method set = p.getWriteMethod();
            System.out.println(get);
            System.out.println(set);
            System.out.println(p.getName());
            System.out.println(p.getPropertyType());
        }
    }
}

结果：

public java.lang.String com.xiaoyaoyou.day14.Express.getAddress()
public void com.xiaoyaoyou.day14.Express.setAddress(java.lang.String)
address
class java.lang.String
public final native java.lang.Class java.lang.Object.getClass()
null
class
class java.lang.Class
public java.lang.String com.xiaoyaoyou.day14.Express.getName()
public void com.xiaoyaoyou.day14.Express.setName(java.lang.String)
name
class java.lang.String
public java.lang.String com.xiaoyaoyou.day14.Express.getNumber()
public void com.xiaoyaoyou.day14.Express.setNumber(java.lang.String)
number
class java.lang.String
public java.lang.String com.xiaoyaoyou.day14.Express.getPhoneNumber()
public void com.xiaoyaoyou.day14.Express.setPhoneNumber(java.lang.String)
phoneNumber
class java.lang.String

对bean类型类使用内省时比单纯使用反射要方便很多，所以对bean类创建时注意符合规范，这样更容易结合框架使用。

5. 最后

感觉学完反射等内容后在Android的NDK开发中对如何进行Java和C++的交互就能更好的理解了，后续一些框架的使用也能更好的理解，目前这里的内容主要是了解，做到会使用或者有印象即可，不需要特别深入。