Java从萌新小白到顶级大牛(4完结)

自定义异常

Java标准库定义的常用异常包括:

Exception
│
├─ RuntimeException
│  │
│  ├─ NullPointerException
│  │
│  ├─ IndexOutOfBoundsException
│  │
│  ├─ SecurityException
│  │
│  └─ IllegalArgumentException
│     │
│     └─ NumberFormatException
│
├─ IOException
│  │
│  ├─ UnsupportedCharsetException
│  │
│  ├─ FileNotFoundException
│  │
│  └─ SocketException
│
├─ ParseException
│
├─ GeneralSecurityException
│
├─ SQLException
│
└─ TimeoutException

当我们在代码中需要抛出异常时,尽量使用JDK已定义的异常类型。例如,参数检查不合法,应该抛出IllegalArgumentException

static void process1(int age) {

    if (age <= 0) {

        throw new IllegalArgumentException();

    }

}

在一个大型项目中,可以自定义新的异常类型,但是,保持一个合理的异常继承体系是非常重要的。

一个常见的做法是自定义一个BaseException作为“根异常”,然后,派生出各种业务类型的异常。

BaseException需要从一个适合的Exception派生,通常建议从RuntimeException派生:

public class BaseException extends RuntimeException {

}

其他业务类型的异常就可以从BaseException派生:

public class UserNotFoundException extends BaseException {

}

public class LoginFailedException extends BaseException {

}



...

自定义的BaseException应该提供多个构造方法:

public class BaseException extends RuntimeException {

    public BaseException() {

        super();

    }



    public BaseException(String message, Throwable cause) {

        super(message, cause);

    }



    public BaseException(String message) {

        super(message);

    }



    public BaseException(Throwable cause) {

        super(cause);

    }

}

上述构造方法实际上都是原样照抄RuntimeException。这样,抛出异常的时候,就可以选择合适的构造方法。通过IDE可以根据父类快速生成子类的构造方法。

小结

抛出异常时,尽量复用JDK已定义的异常类型;

自定义异常体系时,推荐从RuntimeException派生“根异常”,再派生出业务异常;

自定义异常时,应该提供多种构造方法。

NullPointerException

在所有的RuntimeException异常中,Java程序员最熟悉的恐怕就是NullPointerException了。

NullPointerException即空指针异常,俗称NPE。如果一个对象为null,调用其方法或访问其字段就会产生NullPointerException,这个异常通常是由JVM抛出的,例如:

// NullPointerException



public class Main {

    public static void main(String[] args) {

        String s = null;

        System.out.println(s.toLowerCase());

    }

}

指针这个概念实际上源自C语言,Java语言中并无指针。我们定义的变量实际上是引用,Null Pointer更确切地说是Null Reference,不过两者区别不大。

处理NullPointerException

如果遇到NullPointerException,我们应该如何处理?首先,必须明确,NullPointerException是一种代码逻辑错误,遇到NullPointerException,遵循原则是早暴露,早修复,严禁使用catch来隐藏这种编码错误:

// 错误示例: 捕获NullPointerExceptiontry {

    transferMoney(from, to, amount);

} catch (NullPointerException e) {

}

好的编码习惯可以极大地降低NullPointerException的产生,例如:

成员变量在定义时初始化:

public class Person {

    private String name = "";

}

使用空字符串""而不是默认的null可避免很多NullPointerException,编写业务逻辑时,用空字符串""表示未填写比null安全得多。

返回空字符串""、空数组而不是null

public String[] readLinesFromFile(String file) {

    if (getFileSize(file) == 0) {

        // 返回空数组而不是null:

        return new String[0];

    }

    ...

}

这样可以使得调用方无需检查结果是否为null

如果调用方一定要根据null判断,比如返回null表示文件不存在,那么考虑返回Optional<T>

public Optional<String> readFromFile(String file) {

    if (!fileExist(file)) {

        return Optional.empty();

    }

    ...

}

这样调用方必须通过Optional.isPresent()判断是否有结果。

定位NullPointerException

如果产生了NullPointerException,例如,调用a.b.c.x()时产生了NullPointerException,原因可能是:

  • anull
  • a.bnull
  • a.b.cnull

确定到底是哪个对象是null以前只能打印这样的日志:

System.out.println(a);

System.out.println(a.b);

System.out.println(a.b.c);

从Java 14开始,如果产生了NullPointerException,JVM可以给出详细的信息告诉我们null对象到底是谁。我们来看例子:

public class Main {

    public static void main(String[] args) {

        Person p = new Person();

        System.out.println(p.address.city.toLowerCase());

    }

}



class Person {

    String[] name = new String[2];

    Address address = new Address();

}



class Address {

    String city;

    String street;

    String zipcode;

}

可以在NullPointerException的详细信息中看到类似... because "<local1>.address.city" is null,意思是city字段为null,这样我们就能快速定位问题所在。

这种增强的NullPointerException详细信息是Java 14新增的功能,但默认是关闭的,我们可以给JVM添加一个-XX:+ShowCodeDetailsInExceptionMessages参数启用它:

java -XX:+ShowCodeDetailsInExceptionMessages Main.java

小结

NullPointerException是Java代码常见的逻辑错误,应当早暴露,早修复;

可以启用Java 14的增强异常信息来查看NullPointerException的详细错误信息。

使用断言

断言(Assertion)是一种调试程序的方式。在Java中,使用assert关键字来实现断言。

我们先看一个例子:

public static void main(String[] args) {

    double x = Math.abs(-123.45);

    assert x >= 0;

    System.out.println(x);

}

语句assert x >= 0;即为断言,断言条件x >= 0预期为true。如果计算结果为false,则断言失败,抛出AssertionError

使用assert语句时,还可以添加一个可选的断言消息:

assert x >= 0 : "x must >= 0";

这样,断言失败的时候,AssertionError会带上消息x must >= 0,更加便于调试。

Java断言的特点是:断言失败时会抛出AssertionError,导致程序结束退出。因此,断言不能用于可恢复的程序错误,只应该用于开发和测试阶段。

对于可恢复的程序错误,不应该使用断言。例如:

void sort(int[] arr) {

    assert arr != null;

}

应该抛出异常并在上层捕获:

void sort(int[] arr) {

    if (arr == null) {

        throw new IllegalArgumentException("array cannot be null");

    }

}

当我们在程序中使用assert时,例如,一个简单的断言:

// assert



public class Main {

    public static void main(String[] args) {

        int x = -1;

        assert x > 0;

        System.out.println(x);

    }

}

断言x必须大于0,实际上x-1,断言肯定失败。执行上述代码,发现程序并未抛出AssertionError,而是正常打印了x的值。

这是怎么肥四?为什么assert语句不起作用?

这是因为JVM默认关闭断言指令,即遇到assert语句就自动忽略了,不执行。

要执行assert语句,必须给Java虚拟机传递-enableassertions(可简写为-ea)参数启用断言。所以,上述程序必须在命令行下运行才有效果:

$ java -ea Main.javaException in thread "main" java.lang.AssertionError

at Main.main(Main.java:5)

还可以有选择地对特定地类启用断言,命令行参数是:-ea:com.itranswarp.sample.Main,表示只对com.itranswarp.sample.Main这个类启用断言。

或者对特定地包启用断言,命令行参数是:-ea:com.itranswarp.sample...(注意结尾有3个.),表示对com.itranswarp.sample这个包启动断言。

实际开发中,很少使用断言。更好的方法是编写单元测试,后续我们会讲解JUnit的使用。

小结

断言是一种调试方式,断言失败会抛出AssertionError,只能在开发和测试阶段启用断言;

对可恢复的错误不能使用断言,而应该抛出异常;

断言很少被使用,更好的方法是编写单元测试。

使用JDK Logging

在编写程序的过程中,发现程序运行结果与预期不符,怎么办?当然是用System.out.println()打印出执行过程中的某些变量,观察每一步的结果与代码逻辑是否符合,然后有针对性地修改代码。

代码改好了怎么办?当然是删除没有用的System.out.println()语句了。

如果改代码又改出问题怎么办?再加上System.out.println()

反复这么搞几次,很快大家就发现使用System.out.println()非常麻烦。

怎么办?

解决方法是使用日志。

那什么是日志?日志就是Logging,它的目的是为了取代System.out.println()

输出日志,而不是用System.out.println(),有以下几个好处:

  1. 可以设置输出样式,避免自己每次都写"ERROR: " + var
  2. 可以设置输出级别,禁止某些级别输出。例如,只输出错误日志;
  3. 可以被重定向到文件,这样可以在程序运行结束后查看日志;
  4. 可以按包名控制日志级别,只输出某些包打的日志;
  5. 可以……

总之就是好处很多啦。

那如何使用日志?

因为Java标准库内置了日志包java.util.logging,我们可以直接用。先看一个简单的例子:

// logging

import java.util.logging.Level;

import java.util.logging.Logger;



public class Hello {

    public static void main(String[] args) {

        Logger logger = Logger.getGlobal();

        logger.info("start process...");

        logger.warning("memory is running out...");

        logger.fine("ignored.");

        logger.severe("process will be terminated...");

    }

}

运行上述代码,得到类似如下的输出:

Mar 02, 2019 6:32:13 PM Hello main

INFO: start process...

Mar 02, 2019 6:32:13 PM Hello main

WARNING: memory is running out...

Mar 02, 2019 6:32:13 PM Hello main

SEVERE: process will be terminated...

对比可见,使用日志最大的好处是,它自动打印了时间、调用类、调用方法等很多有用的信息。

再仔细观察发现,4条日志,只打印了3条,logger.fine()没有打印。这是因为,日志的输出可以设定级别。JDK的Logging定义了7个日志级别,从严重到普通:

  • SEVERE
  • WARNING
  • INFO
  • CONFIG
  • FINE
  • FINER
  • FINEST

因为默认级别是INFO,因此,INFO级别以下的日志,不会被打印出来。使用日志级别的好处在于,调整级别,就可以屏蔽掉很多调试相关的日志输出。

使用Java标准库内置的Logging有以下局限:

Logging系统在JVM启动时读取配置文件并完成初始化,一旦开始运行main()方法,就无法修改配置;

配置不太方便,需要在JVM启动时传递参数-Djava.util.logging.config.file=<config-file-name>

因此,Java标准库内置的Logging使用并不是非常广泛。更方便的日志系统我们稍后介绍。

练习

使用logger.severe()打印异常:

import java.io.UnsupportedEncodingException;

import java.util.logging.Logger;



public class Main {

    public static void main(String[] args) {

        Logger logger = Logger.getLogger(Main.class.getName());

        logger.info("Start process...");

        try {

            "".getBytes("invalidCharsetName");

        } catch (UnsupportedEncodingException e) {

            // TODO: 使用logger.severe()打印异常

        }

        logger.info("Process end.");



    }

}

小结

日志是为了替代System.out.println(),可以定义格式,重定向到文件等;

日志可以存档,便于追踪问题;

日志记录可以按级别分类,便于打开或关闭某些级别;

可以根据配置文件调整日志,无需修改代码;

Java标准库提供了java.util.logging来实现日志功能。

使用Commons Logging

和Java标准库提供的日志不同,Commons Logging是一个第三方日志库,它是由Apache创建的日志模块。

Commons Logging的特色是,它可以挂接不同的日志系统,并通过配置文件指定挂接的日志系统。默认情况下,Commons Loggin自动搜索并使用Log4j(Log4j是另一个流行的日志系统),如果没有找到Log4j,再使用JDK Logging。

使用Commons Logging只需要和两个类打交道,并且只有两步:

第一步,通过LogFactory获取Log类的实例; 第二步,使用Log实例的方法打日志。

示例代码如下:

import org.apache.commons.logging.Log;

import org.apache.commons.logging.LogFactory;



public class Main {

    public static void main(String[] args) {

        Log log = LogFactory.getLog(Main.class);

        log.info("start...");

        log.warn("end.");

    }

}

运行上述代码,肯定会得到编译错误,类似error: package org.apache.commons.logging does not exist(找不到org.apache.commons.logging这个包)。因为Commons Logging是一个第三方提供的库,所以,必须先把它下载下来。下载后,解压,找到commons-logging-1.2.jar这个文件,再把Java源码Main.java放到一个目录下,例如work目录:

work
│
├─ commons-logging-1.2.jar
│
└─ Main.java

然后用javac编译Main.java,编译的时候要指定classpath,不然编译器找不到我们引用的org.apache.commons.logging包。编译命令如下:

javac -cp commons-logging-1.2.jar Main.java

如果编译成功,那么当前目录下就会多出一个Main.class文件:

work
│
├─ commons-logging-1.2.jar
│
├─ Main.java
│
└─ Main.class

现在可以执行这个Main.class,使用java命令,也必须指定classpath,命令如下:

java -cp .;commons-logging-1.2.jar Main

注意到传入的classpath有两部分:一个是.,一个是commons-logging-1.2.jar,用;分割。.表示当前目录,如果没有这个.,JVM不会在当前目录搜索Main.class,就会报错。

如果在Linux或macOS下运行,注意classpath的分隔符不是;,而是:

java -cp .:commons-logging-1.2.jar Main

运行结果如下:

Mar 02, 2019 7:15:31 PM Main mainINFO: start...Mar 02, 2019 7:15:31 PM Main mainWARNING: end.

Commons Logging定义了6个日志级别:

  • FATAL
  • ERROR
  • WARNING
  • INFO
  • DEBUG
  • TRACE

默认级别是INFO

使用Commons Logging时,如果在静态方法中引用Log,通常直接定义一个静态类型变量:

// 在静态方法中引用Log:public class Main {

    static final Log log = LogFactory.getLog(Main.class);



    static void foo() {

        log.info("foo");

    }

}

在实例方法中引用Log,通常定义一个实例变量:

// 在实例方法中引用Log:public class Person {

    protected final Log log = LogFactory.getLog(getClass());



    void foo() {

        log.info("foo");

    }

}

注意到实例变量log的获取方式是LogFactory.getLog(getClass()),虽然也可以用LogFactory.getLog(Person.class),但是前一种方式有个非常大的好处,就是子类可以直接使用该log实例。例如:

// 在子类中使用父类实例化的log:public class Student extends Person {

    void bar() {

        log.info("bar");

    }

}

由于Java类的动态特性,子类获取的log字段实际上相当于LogFactory.getLog(Student.class),但却是从父类继承而来,并且无需改动代码。

此外,Commons Logging的日志方法,例如info(),除了标准的info(String)外,还提供了一个非常有用的重载方法:info(String, Throwable),这使得记录异常更加简单:

try {

    ...

} catch (Exception e) {

    log.error("got exception!", e);

}

练习

使用log.error(String, Throwable)打印异常。

小结

Commons Logging是使用最广泛的日志模块;

Commons Logging的API非常简单;

Commons Logging可以自动检测并使用其他日志模块。

使用Log4j

前面介绍了Commons Logging,可以作为“日志接口”来使用。而真正的“日志实现”可以使用Log4j。

Log4j是一种非常流行的日志框架,最新版本是2.x。

Log4j是一个组件化设计的日志系统,它的架构大致如下:

log.info("User signed in.");
 │
 │   ┌──────────┐    ┌──────────┐    ┌──────────┐    ┌──────────┐
 ├──>│ Appender │───>│  Filter  │───>│  Layout  │───>│ Console  │
 │   └──────────┘    └──────────┘    └──────────┘    └──────────┘
 │
 │   ┌──────────┐    ┌──────────┐    ┌──────────┐    ┌──────────┐
 ├──>│ Appender │───>│  Filter  │───>│  Layout  │───>│   File   │
 │   └──────────┘    └──────────┘    └──────────┘    └──────────┘
 │
 │   ┌──────────┐    ┌──────────┐    ┌──────────┐    ┌──────────┐
 └──>│ Appender │───>│  Filter  │───>│  Layout  │───>│  Socket  │
     └──────────┘    └──────────┘    └──────────┘    └──────────┘

当我们使用Log4j输出一条日志时,Log4j自动通过不同的Appender把同一条日志输出到不同的目的地。例如:

  • console:输出到屏幕;
  • file:输出到文件;
  • socket:通过网络输出到远程计算机;
  • jdbc:输出到数据库

在输出日志的过程中,通过Filter来过滤哪些log需要被输出,哪些log不需要被输出。例如,仅输出ERROR级别的日志。

最后,通过Layout来格式化日志信息,例如,自动添加日期、时间、方法名称等信息。

上述结构虽然复杂,但我们在实际使用的时候,并不需要关心Log4j的API,而是通过配置文件来配置它。

以XML配置为例,使用Log4j的时候,我们把一个log4j2.xml的文件放到classpath下就可以让Log4j读取配置文件并按照我们的配置来输出日志。下面是一个配置文件的例子:

<?xml version="1.0" encoding="UTF-8"?>

<Configuration>

<Properties>

        <!-- 定义日志格式 -->

<Property name="log.pattern">%d{MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36}%n%msg%n%n</Property>

        <!-- 定义文件名变量 -->

<Property name="file.err.filename">log/err.log</Property>

<Property name="file.err.pattern">log/err.%i.log.gz</Property>

</Properties>

    <!-- 定义Appender,即目的地 -->

<Appenders>

        <!-- 定义输出到屏幕 -->

<Console name="console" target="SYSTEM_OUT">

            <!-- 日志格式引用上面定义的log.pattern -->

<PatternLayout pattern="${log.pattern}" />

</Console>

        <!-- 定义输出到文件,文件名引用上面定义的file.err.filename -->

<RollingFile name="err" bufferedIO="true" fileName="${file.err.filename}" filePattern="${file.err.pattern}">

<PatternLayout pattern="${log.pattern}" />

<Policies>

                <!-- 根据文件大小自动切割日志 -->

<SizeBasedTriggeringPolicy size="1 MB" />

</Policies>

            <!-- 保留最近10份 -->

<DefaultRolloverStrategy max="10" />

</RollingFile>

</Appenders>

<Loggers>

<Root level="info">

            <!-- 对info级别的日志,输出到console -->

<AppenderRef ref="console" level="info" />

            <!-- 对error级别的日志,输出到err,即上面定义的RollingFile -->

<AppenderRef ref="err" level="error" />

</Root>

</Loggers>

</Configuration>

虽然配置Log4j比较繁琐,但一旦配置完成,使用起来就非常方便。对上面的配置文件,凡是INFO级别的日志,会自动输出到屏幕,而ERROR级别的日志,不但会输出到屏幕,还会同时输出到文件。并且,一旦日志文件达到指定大小(1MB),Log4j就会自动切割新的日志文件,并最多保留10份。

有了配置文件还不够,因为Log4j也是一个第三方库,我们需要从这里下载Log4j,解压后,把以下3个jar包放到classpath中:

  • log4j-api-2.x.jar
  • log4j-core-2.x.jar
  • log4j-jcl-2.x.jar

因为Commons Logging会自动发现并使用Log4j,所以,把上一节下载的commons-logging-1.2.jar也放到classpath中。

要打印日志,只需要按Commons Logging的写法写,不需要改动任何代码,就可以得到Log4j的日志输出,类似:

03-03 12:09:45.880 [main] INFO  com.itranswarp.learnjava.MainStart process...

最佳实践

在开发阶段,始终使用Commons Logging接口来写入日志,并且开发阶段无需引入Log4j。如果需要把日志写入文件, 只需要把正确的配置文件和Log4j相关的jar包放入classpath,就可以自动把日志切换成使用Log4j写入,无需修改任何代码。

练习

根据配置文件,观察Log4j写入的日志文件。

小结

通过Commons Logging实现日志,不需要修改代码即可使用Log4j;

使用Log4j只需要把log4j2.xml和相关jar放入classpath;

如果要更换Log4j,只需要移除log4j2.xml和相关jar;

只有扩展Log4j时,才需要引用Log4j的接口(例如,将日志加密写入数据库的功能,需要自己开发)。

使用SLF4J和Logback

前面介绍了Commons Logging和Log4j这一对好基友,它们一个负责充当日志API,一个负责实现日志底层,搭配使用非常便于开发。

有的童鞋可能还听说过SLF4J和Logback。这两个东东看上去也像日志,它们又是啥?

其实SLF4J类似于Commons Logging,也是一个日志接口,而Logback类似于Log4j,是一个日志的实现。

为什么有了Commons Logging和Log4j,又会蹦出来SLF4J和Logback?这是因为Java有着非常悠久的开源历史,不但OpenJDK本身是开源的,而且我们用到的第三方库,几乎全部都是开源的。开源生态丰富的一个特定就是,同一个功能,可以找到若干种互相竞争的开源库。

因为对Commons Logging的接口不满意,有人就搞了SLF4J。因为对Log4j的性能不满意,有人就搞了Logback。

我们先来看看SLF4J对Commons Logging的接口有何改进。在Commons Logging中,我们要打印日志,有时候得这么写:

int score = 99;

p.setScore(score);

log.info("Set score " + score + " for Person " + p.getName() + " ok.");

拼字符串是一个非常麻烦的事情,所以SLF4J的日志接口改进成这样了:

int score = 99;

p.setScore(score);

logger.info("Set score {} for Person {} ok.", score, p.getName());

我们靠猜也能猜出来,SLF4J的日志接口传入的是一个带占位符的字符串,用后面的变量自动替换占位符,所以看起来更加自然。

如何使用SLF4J?它的接口实际上和Commons Logging几乎一模一样:

import org.slf4j.Logger;import org.slf4j.LoggerFactory;

class Main {

    final Logger logger = LoggerFactory.getLogger(getClass());

}

对比一下Commons Logging和SLF4J的接口:

Commons Logging

SLF4J

org.apache.commons.logging.Log

org.slf4j.Logger

org.apache.commons.logging.LogFactory

org.slf4j.LoggerFactory

不同之处就是Log变成了Logger,LogFactory变成了LoggerFactory。

使用SLF4J和Logback和前面讲到的使用Commons Logging加Log4j是类似的,先分别下载SLF4JLogback,然后把以下jar包放到classpath下:

  • slf4j-api-1.7.x.jar
  • logback-classic-1.2.x.jar
  • logback-core-1.2.x.jar

然后使用SLF4J的Logger和LoggerFactory即可。和Log4j类似,我们仍然需要一个Logback的配置文件,把logback.xml放到classpath下,配置如下:

<?xml version="1.0" encoding="UTF-8"?>

<configuration>



<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">

<encoder>

<pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>

</encoder>

</appender>



<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">

<encoder>

<pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>

<charset>utf-8</charset>

</encoder>

<file>log/output.log</file>

<rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">

<fileNamePattern>log/output.log.%i</fileNamePattern>

</rollingPolicy>

<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">

<MaxFileSize>1MB</MaxFileSize>

</triggeringPolicy>

</appender>



<root level="INFO">

<appender-ref ref="CONSOLE" />

<appender-ref ref="FILE" />

</root>

</configuration>

运行即可获得类似如下的输出:

13:15:25.328 [main] INFO  com.itranswarp.learnjava.Main - Start process...

从目前的趋势来看,越来越多的开源项目从Commons Logging加Log4j转向了SLF4J加Logback。

练习

根据配置文件,观察Logback写入的日志文件。

小结

SLF4J和Logback可以取代Commons Logging和Log4j;

始终使用SLF4J的接口写入日志,使用Logback只需要配置,不需要修改代码。

反射

什么是反射?

反射就是Reflection,Java的反射是指程序在运行期可以拿到一个对象的所有信息。

正常情况下,如果我们要调用一个对象的方法,或者访问一个对象的字段,通常会传入对象实例:

// Main.java

import com.itranswarp.learnjava.Person;

public class Main {

    String getFullName(Person p) {

        return p.getFirstName() + " " + p.getLastName();

    }

}

但是,如果不能获得Person类,只有一个Object实例,比如这样:

String getFullName(Object obj) {

    return ???

}

怎么办?有童鞋会说:强制转型啊!

String getFullName(Object obj) {

    Person p = (Person) obj;

    return p.getFirstName() + " " + p.getLastName();

}

强制转型的时候,你会发现一个问题:编译上面的代码,仍然需要引用Person类。不然,去掉import语句,你看能不能编译通过?

所以,反射是为了解决在运行期,对某个实例一无所知的情况下,如何调用其方法。

Class类

除了int等基本类型外,Java的其他类型全部都是class(包括interface)。例如:

  • String
  • Object
  • Runnable
  • Exception
  • ...

仔细思考,我们可以得出结论:class(包括interface)的本质是数据类型(Type)。无继承关系的数据类型无法赋值:

Number n = new Double(123.456); // OK

String s = new Double(123.456); // compile error!

class是由JVM在执行过程中动态加载的。JVM在第一次读取到一种class类型时,将其加载进内存。

每加载一种class,JVM就为其创建一个Class类型的实例,并关联起来。注意:这里的Class类型是一个名叫Classclass。它长这样:

public final class Class {

    private Class() {}

}

String类为例,当JVM加载String类时,它首先读取String.class文件到内存,然后,为String类创建一个Class实例并关联起来:

Class cls = new Class(String);

这个Class实例是JVM内部创建的,如果我们查看JDK源码,可以发现Class类的构造方法是private,只有JVM能创建Class实例,我们自己的Java程序是无法创建Class实例的。

所以,JVM持有的每个Class实例都指向一个数据类型(classinterface):

┌───────────────────────────┐
│      Class Instance       │──────> String
├───────────────────────────┤
│name = "java.lang.String"  │
└───────────────────────────┘

┌───────────────────────────┐
│      Class Instance       │──────> Random
├───────────────────────────┤
│name = "java.util.Random"  │
└───────────────────────────┘

┌───────────────────────────┐
│      Class Instance       │──────> Runnable
├───────────────────────────┤
│name = "java.lang.Runnable"│
└───────────────────────────┘

一个Class实例包含了该class的所有完整信息:

┌───────────────────────────┐
│      Class Instance       │──────> String
├───────────────────────────┤
│name = "java.lang.String"  │
├───────────────────────────┤
│package = "java.lang"      │
├───────────────────────────┤
│super = "java.lang.Object" │
├───────────────────────────┤
│interface = CharSequence...│
├───────────────────────────┤
│field = value[],hash,...   │
├───────────────────────────┤
│method = indexOf()...      │
└───────────────────────────┘

由于JVM为每个加载的class创建了对应的Class实例,并在实例中保存了该class的所有信息,包括类名、包名、父类、实现的接口、所有方法、字段等,因此,如果获取了某个Class实例,我们就可以通过这个Class实例获取到该实例对应的class的所有信息。

这种通过Class实例获取class信息的方法称为反射(Reflection)。

如何获取一个classClass实例?有三个方法:

方法一:直接通过一个class的静态变量class获取:

Class cls = String.class;

方法二:如果我们有一个实例变量,可以通过该实例变量提供的getClass()方法获取:

String s = "Hello";

Class cls = s.getClass();

方法三:如果知道一个class的完整类名,可以通过静态方法Class.forName()获取:

Class cls = Class.forName("java.lang.String");

因为Class实例在JVM中是唯一的,所以,上述方法获取的Class实例是同一个实例。可以用==比较两个Class实例:

Class cls1 = String.class;

String s = "Hello";

Class cls2 = s.getClass();



boolean sameClass = cls1 == cls2; // true

注意一下Class实例比较和instanceof的差别:

Integer n = new Integer(123);

boolean b1 = n instanceof Integer; // true,因为n是Integer类型boolean b2 = n instanceof Number; // true,因为n是Number类型的子类

boolean b3 = n.getClass() == Integer.class; // true,因为n.getClass()返回Integer.classboolean b4 = n.getClass() == Number.class; // false,因为Integer.class!=Number.class

instanceof不但匹配指定类型,还匹配指定类型的子类。而用==判断class实例可以精确地判断数据类型,但不能作子类型比较。

通常情况下,我们应该用instanceof判断数据类型,因为面向抽象编程的时候,我们不关心具体的子类型。只有在需要精确判断一个类型是不是某个class的时候,我们才使用==判断class实例。

因为反射的目的是为了获得某个实例的信息。因此,当我们拿到某个Object实例时,我们可以通过反射获取该Objectclass信息:

void printObjectInfo(Object obj) {

    Class cls = obj.getClass();

}

要从Class实例获取获取的基本信息,参考下面的代码:

// reflection



public class Main {

    public static void main(String[] args) {

        printClassInfo("".getClass());

        printClassInfo(Runnable.class);

        printClassInfo(java.time.Month.class);

        printClassInfo(String[].class);

        printClassInfo(int.class);

    }



    static void printClassInfo(Class cls) {

        System.out.println("Class name: " + cls.getName());

        System.out.println("Simple name: " + cls.getSimpleName());

        if (cls.getPackage() != null) {

            System.out.println("Package name: " + cls.getPackage().getName());

        }

        System.out.println("is interface: " + cls.isInterface());

        System.out.println("is enum: " + cls.isEnum());

        System.out.println("is array: " + cls.isArray());

        System.out.println("is primitive: " + cls.isPrimitive());

    }

}

注意到数组(例如String[])也是一种类,而且不同于String.class,它的类名是[Ljava.lang.String;。此外,JVM为每一种基本类型如int也创建了Class实例,通过int.class访问。

如果获取到了一个Class实例,我们就可以通过该Class实例来创建对应类型的实例:

// 获取String的Class实例:

Class cls = String.class;

// 创建一个String实例:

String s = (String) cls.newInstance();

上述代码相当于new String()。通过Class.newInstance()可以创建类实例,它的局限是:只能调用public的无参数构造方法。带参数的构造方法,或者非public的构造方法都无法通过Class.newInstance()被调用。

​​​​​​​

动态加载

JVM在执行Java程序的时候,并不是一次性把所有用到的class全部加载到内存,而是第一次需要用到class时才加载。例如:

// Main.java

public class Main {

    public static void main(String[] args) {

        if (args.length > 0) {

            create(args[0]);

        }

    }



    static void create(String name) {

        Person p = new Person(name);

    }

}

当执行Main.java时,由于用到了Main,因此,JVM首先会把Main.class加载到内存。然而,并不会加载Person.class,除非程序执行到create()方法,JVM发现需要加载Person类时,才会首次加载Person.class。如果没有执行create()方法,那么Person.class根本就不会被加载。

这就是JVM动态加载class的特性。

动态加载class的特性对于Java程序非常重要。利用JVM动态加载class的特性,我们才能在运行期根据条件加载不同的实现类。例如,Commons Logging总是优先使用Log4j,只有当Log4j不存在时,才使用JDK的logging。利用JVM动态加载特性,大致的实现代码如下:

// Commons Logging优先使用Log4j:

LogFactory factory = null;

if (isClassPresent("org.apache.logging.log4j.Logger")) {

    factory = createLog4j();

} else {

    factory = createJdkLog();

}

boolean isClassPresent(String name) {

    try {

        Class.forName(name);

        return true;

    } catch (Exception e) {

        return false;

    }

}

这就是为什么我们只需要把Log4j的jar包放到classpath中,Commons Logging就会自动使用Log4j的原因。

小结

JVM为每个加载的classinterface创建了对应的Class实例来保存classinterface的所有信息;

获取一个class对应的Class实例后,就可以获取该class的所有信息;

通过Class实例获取class信息的方法称为反射(Reflection);

JVM总是动态加载class,可以在运行期根据条件来控制加载class。

访问字段

对任意的一个Object实例,只要我们获取了它的Class,就可以获取它的一切信息。

我们先看看如何通过Class实例获取字段信息。Class类提供了以下几个方法来获取字段:

  • Field getField(name):根据字段名获取某个public的field(包括父类)
  • Field getDeclaredField(name):根据字段名获取当前类的某个field(不包括父类)
  • Field[] getFields():获取所有public的field(包括父类)
  • Field[] getDeclaredFields():获取当前类的所有field(不包括父类)

我们来看一下示例代码:

// reflection



public class Main {

    public static void main(String[] args) throws Exception {

        Class stdClass = Student.class;

        // 获取public字段"score":

        System.out.println(stdClass.getField("score"));

        // 获取继承的public字段"name":

        System.out.println(stdClass.getField("name"));

        // 获取private字段"grade":

        System.out.println(stdClass.getDeclaredField("grade"));

    }

}



class Student extends Person {

    public int score;

    private int grade;

}



class Person {

    public String name;

}

上述代码首先获取StudentClass实例,然后,分别获取public字段、继承的public字段以及private字段,打印出的Field类似:

public int Student.scorepublic java.lang.String Person.nameprivate int Student.grade

一个Field对象包含了一个字段的所有信息:

  • getName():返回字段名称,例如,"name"
  • getType():返回字段类型,也是一个Class实例,例如,String.class
  • getModifiers():返回字段的修饰符,它是一个int,不同的bit表示不同的含义。

String类的value字段为例,它的定义是:

public final class String {

    private final byte[] value;

}

我们用反射获取该字段的信息,代码如下:

Field f = String.class.getDeclaredField("value");

f.getName(); // "value"

f.getType(); // class [B 表示byte[]类型

int m = f.getModifiers();

Modifier.isFinal(m); // true

Modifier.isPublic(m); // false

Modifier.isProtected(m); // false

Modifier.isPrivate(m); // true

Modifier.isStatic(m); // false

获取字段值

利用反射拿到字段的一个Field实例只是第一步,我们还可以拿到一个实例对应的该字段的值。

例如,对于一个Person实例,我们可以先拿到name字段对应的Field,再获取这个实例的name字段的值:

// reflection

import java.lang.reflect.Field;



public class Main {



    public static void main(String[] args) throws Exception {

        Object p = new Person("Xiao Ming");

        Class c = p.getClass();

        Field f = c.getDeclaredField("name");

        Object value = f.get(p);

        System.out.println(value); // "Xiao Ming"

    }

}



class Person {

    private String name;



    public Person(String name) {

        this.name = name;

    }

}

上述代码先获取Class实例,再获取Field实例,然后,用Field.get(Object)获取指定实例的指定字段的值。

运行代码,如果不出意外,会得到一个IllegalAccessException,这是因为name被定义为一个private字段,正常情况下,Main类无法访问Person类的private字段。要修复错误,可以将private改为public,或者,在调用Object value = f.get(p);前,先写一句:

f.setAccessible(true);

调用Field.setAccessible(true)的意思是,别管这个字段是不是public,一律允许访问。

可以试着加上上述语句,再运行代码,就可以打印出private字段的值。

有童鞋会问:如果使用反射可以获取private字段的值,那么类的封装还有什么意义?

答案是正常情况下,我们总是通过p.name来访问Personname字段,编译器会根据publicprotectedprivate决定是否允许访问字段,这样就达到了数据封装的目的。

而反射是一种非常规的用法,使用反射,首先代码非常繁琐,其次,它更多地是给工具或者底层框架来使用,目的是在不知道目标实例任何信息的情况下,获取特定字段的值。

此外,setAccessible(true)可能会失败。如果JVM运行期存在SecurityManager,那么它会根据规则进行检查,有可能阻止setAccessible(true)。例如,某个SecurityManager可能不允许对javajavax开头的package的类调用setAccessible(true),这样可以保证JVM核心库的安全。

设置字段值

通过Field实例既然可以获取到指定实例的字段值,自然也可以设置字段的值。

设置字段值是通过Field.set(Object, Object)实现的,其中第一个Object参数是指定的实例,第二个Object参数是待修改的值。示例代码如下:

// reflection

import java.lang.reflect.Field;



public class Main {



    public static void main(String[] args) throws Exception {

        Person p = new Person("Xiao Ming");

        System.out.println(p.getName()); // "Xiao Ming"

        Class c = p.getClass();

        Field f = c.getDeclaredField("name");

        f.setAccessible(true);

        f.set(p, "Xiao Hong");

        System.out.println(p.getName()); // "Xiao Hong"

    }

}



class Person {

    private String name;



    public Person(String name) {

        this.name = name;

    }



    public String getName() {

        return this.name;

    }

}

运行上述代码,打印的name字段从Xiao Ming变成了Xiao Hong,说明通过反射可以直接修改字段的值。

同样的,修改非public字段,需要首先调用setAccessible(true)

小结

Java的反射API提供的Field类封装了字段的所有信息:

通过Class实例的方法可以获取Field实例:getField()getFields()getDeclaredField()getDeclaredFields()

通过Field实例可以获取字段信息:getName()getType()getModifiers()

通过Field实例可以读取或设置某个对象的字段,如果存在访问限制,要首先调用setAccessible(true)来访问非public字段。

通过反射读写字段是一种非常规方法,它会破坏对象的封装。

调用方法

我们已经能通过Class实例获取所有Field对象,同样的,可以通过Class实例获取所有Method信息。Class类提供了以下几个方法来获取Method

  • Method getMethod(name, Class...):获取某个publicMethod(包括父类)
  • Method getDeclaredMethod(name, Class...):获取当前类的某个Method(不包括父类)
  • Method[] getMethods():获取所有publicMethod(包括父类)
  • Method[] getDeclaredMethods():获取当前类的所有Method(不包括父类)

我们来看一下示例代码:

// reflection

public class Main {

    public static void main(String[] args) throws Exception {

        Class stdClass = Student.class;

        // 获取public方法getScore,参数为String:

        System.out.println(stdClass.getMethod("getScore", String.class));

        // 获取继承的public方法getName,无参数:

        System.out.println(stdClass.getMethod("getName"));

        // 获取private方法getGrade,参数为int:

        System.out.println(stdClass.getDeclaredMethod("getGrade", int.class));

    }

}



class Student extends Person {

    public int getScore(String type) {

        return 99;

    }

    private int getGrade(int year) {

        return 1;

    }

}



class Person {

    public String getName() {

        return "Person";

    }

}

上述代码首先获取StudentClass实例,然后,分别获取public方法、继承的public方法以及private方法,打印出的Method类似:

public int Student.getScore(java.lang.String)

public java.lang.String Person.getName()

private int Student.getGrade(int)

一个Method对象包含一个方法的所有信息:

  • getName():返回方法名称,例如:"getScore"
  • getReturnType():返回方法返回值类型,也是一个Class实例,例如:String.class
  • getParameterTypes():返回方法的参数类型,是一个Class数组,例如:{String.class, int.class}
  • getModifiers():返回方法的修饰符,它是一个int,不同的bit表示不同的含义。

调用方法

当我们获取到一个Method对象时,就可以对它进行调用。我们以下面的代码为例:

String s = "Hello world";String r = s.substring(6); // "world"

如果用反射来调用substring方法,需要以下代码:

// reflection

import java.lang.reflect.Method;



public class Main {

    public static void main(String[] args) throws Exception {

        // String对象:

        String s = "Hello world";

        // 获取String substring(int)方法,参数为int:

        Method m = String.class.getMethod("substring", int.class);

        // 在s对象上调用该方法并获取结果:

        String r = (String) m.invoke(s, 6);

        // 打印调用结果:

        System.out.println(r);

    }

}

注意到substring()有两个重载方法,我们获取的是String substring(int)这个方法。思考一下如何获取String substring(int, int)方法。

Method实例调用invoke就相当于调用该方法,invoke的第一个参数是对象实例,即在哪个实例上调用该方法,后面的可变参数要与方法参数一致,否则将报错。

调用静态方法

如果获取到的Method表示一个静态方法,调用静态方法时,由于无需指定实例对象,所以invoke方法传入的第一个参数永远为null。我们以Integer.parseInt(String)为例:​​​​​​​

// reflection

import java.lang.reflect.Method;



public class Main {

    public static void main(String[] args) throws Exception {

        // 获取Integer.parseInt(String)方法,参数为String:

        Method m = Integer.class.getMethod("parseInt", String.class);

        // 调用该静态方法并获取结果:

        Integer n = (Integer) m.invoke(null, "12345");

        // 打印调用结果:

        System.out.println(n);

    }

}

调用非public方法

和Field类似,对于非public方法,我们虽然可以通过Class.getDeclaredMethod()获取该方法实例,但直接对其调用将得到一个IllegalAccessException。为了调用非public方法,我们通过Method.setAccessible(true)允许其调用:

// reflection

import java.lang.reflect.Method;



public class Main {

    public static void main(String[] args) throws Exception {

        Person p = new Person();

        Method m = p.getClass().getDeclaredMethod("setName", String.class);

        m.setAccessible(true);

        m.invoke(p, "Bob");

        System.out.println(p.name);

    }

}



class Person {

    String name;

    private void setName(String name) {

        this.name = name;

    }

}

此外,setAccessible(true)可能会失败。如果JVM运行期存在SecurityManager,那么它会根据规则进行检查,有可能阻止setAccessible(true)。例如,某个SecurityManager可能不允许对javajavax开头的package的类调用setAccessible(true),这样可以保证JVM核心库的安全。

多态

我们来考察这样一种情况:一个Person类定义了hello()方法,并且它的子类Student也覆写了hello()方法,那么,从Person.class获取的Method,作用于Student实例时,调用的方法到底是哪个?​​​​​​​

// reflection

import java.lang.reflect.Method;



public class Main {

    public static void main(String[] args) throws Exception {

        // 获取Person的hello方法:

        Method h = Person.class.getMethod("hello");

        // 对Student实例调用hello方法:

        h.invoke(new Student());

    }

}



class Person {

    public void hello() {

        System.out.println("Person:hello");

    }

}



class Student extends Person {

    public void hello() {

        System.out.println("Student:hello");

    }

}

运行上述代码,发现打印出的是Student:hello,因此,使用反射调用方法时,仍然遵循多态原则:即总是调用实际类型的覆写方法(如果存在)。上述的反射代码:

Method m = Person.class.getMethod("hello");

m.invoke(new Student());

实际上相当于:

Person p = new Student();

p.hello();

小结

Java的反射API提供的Method对象封装了方法的所有信息:

通过Class实例的方法可以获取Method实例:getMethod()getMethods()getDeclaredMethod()getDeclaredMethods()

通过Method实例可以获取方法信息:getName()getReturnType()getParameterTypes()getModifiers()

通过Method实例可以调用某个对象的方法:Object invoke(Object instance, Object... parameters)

通过设置setAccessible(true)来访问非public方法;

通过反射调用方法时,仍然遵循多态原则。

调用构造方法

我们通常使用new操作符创建新的实例:

Person p = new Person();

如果通过反射来创建新的实例,可以调用Class提供的newInstance()方法:

Person p = Person.class.newInstance();

调用Class.newInstance()的局限是,它只能调用该类的public无参数构造方法。如果构造方法带有参数,或者不是public,就无法直接通过Class.newInstance()来调用。

为了调用任意的构造方法,Java的反射API提供了Constructor对象,它包含一个构造方法的所有信息,可以创建一个实例。Constructor对象和Method非常类似,不同之处仅在于它是一个构造方法,并且,调用结果总是返回实例:

import java.lang.reflect.Constructor;



public class Main {

    public static void main(String[] args) throws Exception {

        // 获取构造方法Integer(int):

        Constructor cons1 = Integer.class.getConstructor(int.class);

        // 调用构造方法:

        Integer n1 = (Integer) cons1.newInstance(123);

        System.out.println(n1);



        // 获取构造方法Integer(String)

        Constructor cons2 = Integer.class.getConstructor(String.class);

        Integer n2 = (Integer) cons2.newInstance("456");

        System.out.println(n2);

    }

}

通过Class实例获取Constructor的方法如下:

  • getConstructor(Class...):获取某个publicConstructor
  • getDeclaredConstructor(Class...):获取某个Constructor
  • getConstructors():获取所有publicConstructor
  • getDeclaredConstructors():获取所有Constructor

注意Constructor总是当前类定义的构造方法,和父类无关,因此不存在多态的问题。

调用非publicConstructor时,必须首先通过setAccessible(true)设置允许访问。setAccessible(true)可能会失败。

小结

Constructor对象封装了构造方法的所有信息;

通过Class实例的方法可以获取Constructor实例:getConstructor()getConstructors()getDeclaredConstructor()getDeclaredConstructors()

通过Constructor实例可以创建一个实例对象:newInstance(Object... parameters); 通过设置setAccessible(true)来访问非public构造方法。

获取继承关系

当我们获取到某个Class对象时,实际上就获取到了一个类的类型:

Class cls = String.class; // 获取到String的Class

还可以用实例的getClass()方法获取:

String s = "";Class cls = s.getClass(); // s是String,因此获取到String的Class

最后一种获取Class的方法是通过Class.forName(""),传入Class的完整类名获取:

Class s = Class.forName("java.lang.String");

这三种方式获取的Class实例都是同一个实例,因为JVM对每个加载的Class只创建一个Class实例来表示它的类型。

获取父类的Class

有了Class实例,我们还可以获取它的父类的Class

// reflection



public class Main {

    public static void main(String[] args) throws Exception {

        Class i = Integer.class;

        Class n = i.getSuperclass();

        System.out.println(n);

        Class o = n.getSuperclass();

        System.out.println(o);

        System.out.println(o.getSuperclass());

    }

}

运行上述代码,可以看到,Integer的父类类型是NumberNumber的父类是ObjectObject的父类是null。除Object外,其他任何非interfaceClass都必定存在一个父类类型。

获取interface

由于一个类可能实现一个或多个接口,通过Class我们就可以查询到实现的接口类型。例如,查询Integer实现的接口:

// reflection

import java.lang.reflect.Method;



public class Main {

    public static void main(String[] args) throws Exception {

        Class s = Integer.class;

        Class[] is = s.getInterfaces();

        for (Class i : is) {

            System.out.println(i);

        }

    }

}

运行上述代码可知,Integer实现的接口有:

  • java.lang.Comparable
  • java.lang.constant.Constable
  • java.lang.constant.ConstantDesc

要特别注意:getInterfaces()只返回当前类直接实现的接口类型,并不包括其父类实现的接口类型:

// reflection

import java.lang.reflect.Method;



public class Main {

    public static void main(String[] args) throws Exception {

        Class s = Integer.class.getSuperclass();

        Class[] is = s.getInterfaces();

        for (Class i : is) {

            System.out.println(i);

        }

    }

}

Integer的父类是NumberNumber实现的接口是java.io.Serializable

此外,对所有interfaceClass调用getSuperclass()返回的是null,获取接口的父接口要用getInterfaces()

System.out.println(java.io.DataInputStream.class.getSuperclass()); // java.io.FilterInputStream,

因为DataInputStream继承自FilterInputStreamSystem.out.println(java.io.Closeable.class.getSuperclass()); // null,对接口调用getSuperclass()总是返回null,获取接口的父接口要用getInterfaces()

如果一个类没有实现任何interface,那么getInterfaces()返回空数组。

继承关系

当我们判断一个实例是否是某个类型时,正常情况下,使用instanceof操作符:

Object n = Integer.valueOf(123);

boolean isDouble = n instanceof Double; // false

boolean isInteger = n instanceof Integer; // true

boolean isNumber = n instanceof Number; // true

boolean isSerializable = n instanceof java.io.Serializable; // true

如果是两个Class实例,要判断一个向上转型是否成立,可以调用isAssignableFrom()

// Integer i = ?

Integer.class.isAssignableFrom(Integer.class); // true,因为Integer可以赋值给Integer// Number n = ?

Number.class.isAssignableFrom(Integer.class); // true,因为Integer可以赋值给Number// Object o = ?

Object.class.isAssignableFrom(Integer.class); // true,因为Integer可以赋值给Object// Integer i = ?

Integer.class.isAssignableFrom(Number.class); // false,因为Number不能赋值给Integer

小结

通过Class对象可以获取继承关系:

  • Class getSuperclass():获取父类类型;
  • Class[] getInterfaces():获取当前类实现的所有接口。

通过Class对象的isAssignableFrom()方法可以判断一个向上转型是否可以实现。

动态代理

我们来比较Java的classinterface的区别:

  • 可以实例化class(非abstract);
  • 不能实例化interface

所有interface类型的变量总是通过某个实例向上转型并赋值给接口类型变量的:

CharSequence cs = new StringBuilder();

有没有可能不编写实现类,直接在运行期创建某个interface的实例呢?

这是可能的,因为Java标准库提供了一种动态代理(Dynamic Proxy)的机制:可以在运行期动态创建某个interface的实例。

什么叫运行期动态创建?听起来好像很复杂。所谓动态代理,是和静态相对应的。我们来看静态代码怎么写:

定义接口:

public interface Hello {

    void morning(String name);

}

编写实现类:

public class HelloWorld implements Hello {

    public void morning(String name) {

        System.out.println("Good morning, " + name);

    }

}

创建实例,转型为接口并调用:

Hello hello = new HelloWorld();

hello.morning("Bob");

这种方式就是我们通常编写代码的方式。

还有一种方式是动态代码,我们仍然先定义了接口Hello,但是我们并不去编写实现类,而是直接通过JDK提供的一个Proxy.newProxyInstance()创建了一个Hello接口对象。这种没有实现类但是在运行期动态创建了一个接口对象的方式,我们称为动态代码。JDK提供的动态创建接口对象的方式,就叫动态代理。

一个最简单的动态代理实现如下:​​​​​​​

import java.lang.reflect.InvocationHandler;

import java.lang.reflect.Method;

import java.lang.reflect.Proxy;



public class Main {

    public static void main(String[] args) {

        InvocationHandler handler = new InvocationHandler() {

            @Override

            public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {

                System.out.println(method);

                if (method.getName().equals("morning")) {

                    System.out.println("Good morning, " + args[0]);

                }

                return null;

            }

        };

        Hello hello = (Hello) Proxy.newProxyInstance(

            Hello.class.getClassLoader(), // 传入ClassLoader

            new Class[] { Hello.class }, // 传入要实现的接口

            handler); // 传入处理调用方法的InvocationHandler

        hello.morning("Bob");

    }

}



interface Hello {

    void morning(String name);

}

在运行期动态创建一个interface实例的方法如下:

  1. 定义一个InvocationHandler实例,它负责实现接口的方法调用;
  2. 通过Proxy.newProxyInstance()创建interface实例,它需要3个参数:
        1. 使用的ClassLoader,通常就是接口类的ClassLoader
        2. 需要实现的接口数组,至少需要传入一个接口进去;
        3. 用来处理接口方法调用的InvocationHandler实例。
  3. 将返回的Object强制转型为接口。

动态代理实际上是JVM在运行期动态创建class字节码并加载的过程,它并没有什么黑魔法,把上面的动态代理改写为静态实现类大概长这样:

public class HelloDynamicProxy implements Hello {

    InvocationHandler handler;

    public HelloDynamicProxy(InvocationHandler handler) {

        this.handler = handler;

    }

    public void morning(String name) {

        handler.invoke(

           this,

           Hello.class.getMethod("morning", String.class),

           new Object[] { name });

    }

}

其实就是JVM帮我们自动编写了一个上述类(不需要源码,可以直接生成字节码),并不存在可以直接实例化接口的黑魔法。

小结

Java标准库提供了动态代理功能,允许在运行期动态创建一个接口的实例;

动态代理是通过Proxy创建代理对象,然后将接口方法“代理”给InvocationHandler完成的。

注解

本节我们将介绍Java程序的一种特殊“注释”——注解(Annotation)。

使用注解

什么是注解(Annotation)?注解是放在Java源码的类、方法、字段、参数前的一种特殊“注释”:

// this is a component:@Resource("hello")public class Hello {

    @Inject

    int n;



    @PostConstruct

    public void hello(@Param String name) {

        System.out.println(name);

    }



    @Override

    public String toString() {

        return "Hello";

    }

}

注释会被编译器直接忽略,注解则可以被编译器打包进入class文件,因此,注解是一种用作标注的“元数据”。

注解的作用

从JVM的角度看,注解本身对代码逻辑没有任何影响,如何使用注解完全由工具决定。

Java的注解可以分为三类:

第一类是由编译器使用的注解,例如:

  • @Override:让编译器检查该方法是否正确地实现了覆写;
  • @SuppressWarnings:告诉编译器忽略此处代码产生的警告。

这类注解不会被编译进入.class文件,它们在编译后就被编译器扔掉了。

第二类是由工具处理.class文件使用的注解,比如有些工具会在加载class的时候,对class做动态修改,实现一些特殊的功能。这类注解会被编译进入.class文件,但加载结束后并不会存在于内存中。这类注解只被一些底层库使用,一般我们不必自己处理。

第三类是在程序运行期能够读取的注解,它们在加载后一直存在于JVM中,这也是最常用的注解。例如,一个配置了@PostConstruct的方法会在调用构造方法后自动被调用(这是Java代码读取该注解实现的功能,JVM并不会识别该注解)。

定义一个注解时,还可以定义配置参数。配置参数可以包括:

  • 所有基本类型;
  • String;
  • 枚举类型;
  • 基本类型、String、Class以及枚举的数组。

因为配置参数必须是常量,所以,上述限制保证了注解在定义时就已经确定了每个参数的值。

注解的配置参数可以有默认值,缺少某个配置参数时将使用默认值。

此外,大部分注解会有一个名为value的配置参数,对此参数赋值,可以只写常量,相当于省略了value参数。

如果只写注解,相当于全部使用默认值。

举个栗子,对以下代码:

public class Hello {

    @Check(min=0, max=100, value=55)

    public int n;



    @Check(value=99)

    public int p;



    @Check(99) // @Check(value=99)

    public int x;



    @Check

    public int y;

}

@Check就是一个注解。第一个@Check(min=0, max=100, value=55)明确定义了三个参数,第二个@Check(value=99)只定义了一个value参数,它实际上和@Check(99)是完全一样的。最后一个@Check表示所有参数都使用默认值。

小结

注解(Annotation)是Java语言用于工具处理的标注:

注解可以配置参数,没有指定配置的参数使用默认值;

如果参数名称是value,且只有一个参数,那么可以省略参数名称。

定义注解

Java语言使用@interface语法来定义注解(Annotation),它的格式如下:

public @interface Report {

    int type() default 0;

    String level() default "info";

    String value() default "";

}

注解的参数类似无参数方法,可以用default设定一个默认值(强烈推荐)。最常用的参数应当命名为value

元注解

有一些注解可以修饰其他注解,这些注解就称为元注解(meta annotation)。Java标准库已经定义了一些元注解,我们只需要使用元注解,通常不需要自己去编写元注解。

@Target

最常用的元注解是@Target。使用@Target可以定义Annotation能够被应用于源码的哪些位置:

  • 类或接口:ElementType.TYPE
  • 字段:ElementType.FIELD
  • 方法:ElementType.METHOD
  • 构造方法:ElementType.CONSTRUCTOR
  • 方法参数:ElementType.PARAMETER

例如,定义注解@Report可用在方法上,我们必须添加一个@Target(ElementType.METHOD)

@Target(ElementType.METHOD)public @interface Report {

    int type() default 0;

    String level() default "info";

    String value() default "";

}

定义注解@Report可用在方法或字段上,可以把@Target注解参数变为数组{ ElementType.METHOD, ElementType.FIELD }

@Target({

    ElementType.METHOD,

    ElementType.FIELD

})public @interface Report {

    ...

}

实际上@Target定义的valueElementType[]数组,只有一个元素时,可以省略数组的写法。

@Retention

另一个重要的元注解@Retention定义了Annotation的生命周期:

  • 仅编译期:RetentionPolicy.SOURCE
  • 仅class文件:RetentionPolicy.CLASS
  • 运行期:RetentionPolicy.RUNTIME

如果@Retention不存在,则该Annotation默认为CLASS。因为通常我们自定义的Annotation都是RUNTIME,所以,务必要加上@Retention(RetentionPolicy.RUNTIME)这个元注解:

@Retention(RetentionPolicy.RUNTIME)public @interface Report {

    int type() default 0;

    String level() default "info";

    String value() default "";

}
@Repeatable

使用@Repeatable这个元注解可以定义Annotation是否可重复。这个注解应用不是特别广泛。

@Repeatable(Reports.class)@Target(ElementType.TYPE)public @interface Report {

    int type() default 0;

    String level() default "info";

    String value() default "";

}

@Target(ElementType.TYPE)public @interface Reports {

    Report[] value();

}

经过@Repeatable修饰后,在某个类型声明处,就可以添加多个@Report注解:

@Report(type=1, level="debug")@Report(type=2, level="warning")public class Hello {

}

@Inherited

使用@Inherited定义子类是否可继承父类定义的Annotation@Inherited仅针对@Target(ElementType.TYPE)类型的annotation有效,并且仅针对class的继承,对interface的继承无效:

@Inherited@Target(ElementType.TYPE)public @interface Report {

    int type() default 0;

    String level() default "info";

    String value() default "";

}

在使用的时候,如果一个类用到了@Report

@Report(type=1)public class Person {

}

则它的子类默认也定义了该注解:

public class Student extends Person {

}

如何定义Annotation

我们总结一下定义Annotation的步骤:

第一步,用@interface定义注解:

public @interface Report {

}

第二步,添加参数、默认值:

public @interface Report {

    int type() default 0;

    String level() default "info";

    String value() default "";

}

把最常用的参数定义为value(),推荐所有参数都尽量设置默认值。

第三步,用元注解配置注解:

@Target(ElementType.TYPE)@Retention(RetentionPolicy.RUNTIME)public @interface Report {

    int type() default 0;

    String level() default "info";

    String value() default "";

}

其中,必须设置@Target@Retention@Retention一般设置为RUNTIME,因为我们自定义的注解通常要求在运行期读取。一般情况下,不必写@Inherited@Repeatable

小结

Java使用@interface定义注解:

可定义多个参数和默认值,核心参数使用value名称;

必须设置@Target来指定Annotation可以应用的范围;

应当设置@Retention(RetentionPolicy.RUNTIME)便于运行期读取该Annotation

  • 64
    点赞
  • 5
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值