Java ASM详解：模块 | Nickid2018的博客

在前两篇专栏中我们讨论了各种类的结构，将各种类组织一起它们就组成了模块（Module）。

模块的定义

模块是在 Java 9 中引入的，它在module-info.java文件中定义。这个文件的内容是一个模块的描述，下面就是一个例子：

open module JavaASMTest {
    requires org.objectweb.asm;
    exports io.github.nickid2018.asmtest to nickid2018.asm;
    uses java.sql.Driver;
    provides java.sql.Driver with io.github.nickid2018.asmtest.TestDriver;
}

上面的代码声明了一个模块，名称为JavaASMTest，并依赖模块org.objectweb.asm。

在模块中，我们可以定义以下信息：

requires 语句，它代表了这个模块需要依赖于什么其它的模块。所有的模块都隐式定义了requires java.base。

requires 语句可以使用 static 修饰符，代表静态依赖。这种依赖在编译期是必须的，但是在运行时可以不存在。

requires 语句也可以使用 transitive 修饰符，它代表了依赖此模块的模块将隐式获得对本模块依赖的模块的可读性。举一个例子：如果 A 依赖于 B，B 依赖于 C，那么 C 对 A 来说不可读，除非 A 显式定义 requires C；但是加上这个关键词，C 将对 A 可读。
exports 语句，它代表了模块内某个包内的 public 成员可以被其他模块访问，也就是开放了可读性。如果一个模块代码中直接访问了一个其他模块没有 exports 的成员，那么代码不通过编译。 exports 语句可以和 to 搭配，代表对指定模块开放这些成员。
opens 语句，和 exports 类似，但是它开放的是访问性。也就是说，允许通过反射访问模块中的类。这个语句也可以和 to 搭配。当模块被定义为open module时，模块内的所有成员都将开放访问，并且不允许在模块中重新定义 opens。
uses 语句，用于使用服务。服务通常是抽象类，比如说java.sql.Driver。服务类所在的模块必须使用 requires 进行依赖。
provides … with … 语句，它代表提供服务的实现类。

下面是 opens 和 exports 搭配使用的情况：

opens	exports	通过类名直接访问	通过反射访问和执行
false	false	编译错误	运行时异常
true	false	编译错误	正常访问
false	true	正常访问	运行时异常
true	true	正常访问	正常访问

模块的字节码表示

和普通的类一样，模块也是使用 ClassWriter 写入的，但是写入类信息的时候和普通的类不一样：它要求类名称是module-info，仅带有ACC_MODULE访问标志，并且没有超类和签名。

cw.visit(V17, ACC_MODULE, "module-info", null, null, null);

接下来就是写入模块信息，这里用到了visitModule方法。如果模块是open的，那么访问标志要写为ACC_OPEN，否则写为0。最后一个参数是模块的版本，可以为null。

ModuleVisitor mv = cw.visitModule("JavaASMTest", ACC_OPEN, null);

模块中有三种定义信息的模式：显式定义，也就是在文件中显式写出；隐式定义，由模块的依赖关系自行推断而出；既不是显式定义也不是隐式定义，由编译器编译时决定添加。如果访问标志含有ACC_MANDATED，则说明这个信息是被隐式定义的；如果访问标志含有ACC_SYNTHETIC，则这个模块信息既不是显式定义也不是隐式定义。所有使用访问标志的模块信息都可以使用这两个标志，下文将不再重复出现。

接下来就是填充模块的信息，这些信息与ModuleVisitor类中的方法一一对应。

requires 语句对应visitRequire方法，第一个参数是依赖模块的名称，最后一个参数是依赖模块的版本。第二个参数访问标志可以使用ACC_TRANSITIVE和ACC_STATIC_PHASE，分别代表了 transitive 和 static。

由于所有的模块都隐式定义了requires java.base，所以所有模块都必须像下面一样写入：

mv.visitRequire("java.base", ACC_MANDATED, "17"); // 最后一个参数是对应 Java 版本

exports 和 opens 语句分别使用了visitExport和visitOpen方法，参数分别是全限定包名、访问标志和指定模块列表，最后一个参数可以为null，代表向所有模块开放。

mv.visitExport("io/github/nickid2018/asmtest", 0, "nickid2018.asm");

uses 语句使用visitUse方法写入，它唯一的参数代表服务类全限定名。

mv.visitUse("java/sql/Driver");

provides … with … 语句使用visitProvide方法，其中第一个参数代表服务类的全限定名，第二个则是实现类的列表。

mv.visitProvide("java/sql/Driver", "io/github/nickid2018/asmtest/TestDriver");

现在，ModuleVisitor 类中还有两个方法我们没有说到：visitPackage和visitMainClass。这两个方法的实际作用不大，所以不讲解它的用法。

到这里模块的知识就结束了，下一篇专栏将讲述注解的使用。

若无特殊说明，所有字节码均以 Java 17 为标准。

参考资料：