设计模式 - ASM 中的访问者模式

本文首发于本人的博客, 欢迎关注

ASM 是一个 Java 字节码操做和分析框架, 可直接用二进制的方式(无需编译/反编译)修改已存在的类或动态生成新的类.

问题

要开发像 ASM 这样的框架, 主要面临如下几个问题:

动态添加操做方法

既然是一个字节码的操做和分析框架, 那么就要提供对字节码进行各类各样的操做, 且容许用户自定义操做类型. 如在 ASM 中, 除了内置对字节码进行输出和转换等默认实现以外, 还要容许用户对字节码进行加/解密等各类自定义的操做, 对于公开的商业代码这多是相当重要的.

何处安放操做方法

虽然构成一个类的字节码的各个元素有弱的层次关系: 表明类的字节码可能包含 N 个表明字段/方法/注解的字节码, 表明字段/方法的字节码又可能包含 N 个表明注解的字节码. 对这些元素所进行的操做, 应该如何安放. 一种直接的方法是在表明每种字节码元素的类中定义相应的方法, 如 print() 用于输出, transform() 用于转换, 但在字节码元素的类层次结构中加入这些毫无联系的操做方法, 会使代码变得难以理解和维护.

访问者模式

做用在多种类对象上的操做, 访问者能够在不修改其操做对象所属类的状况下, 增长对其操做方式.

ASM 源代码中主要使用了访问者模式来解决以上问题:

动态添加操做方法

以对类的字段的字节码进行操做为例, ASM 中定义了 org.objectweb.asm.FieldVisitor 用来表示对字段的操做:

package org.objectweb.asm;

public abstract class FieldVisitor {
  // ...

  public AnnotationVisitor visitAnnotation(final String descriptor, final boolean visible) {
    // ...
    return null;
  }

  public AnnotationVisitor visitTypeAnnotation( final int typeRef, final TypePath typePath, final String descriptor, final boolean visible) {
    // ...
    return null;
  }

  public void visitAttribute(final Attribute attribute) {
    // ...
  }

  public void visitEnd() {
    // ...
  }
}
复制代码

这样一来, 当用户须要新增对字段进行操做的时候, 只须要继承 FieldVisitor, 实现相应的方法便可, 以 ASM 中打印字段字节码的类 FieldWriter 为例:

package org.objectweb.asm;

final class FieldWriter extends FieldVisitor {
  // ...

  @Override
  public void visitAttribute(final Attribute attribute) {
    // Store the attributes in the <i>reverse</i> order of their visit by this method.
    attribute.nextAttribute = firstAttribute;
    firstAttribute = attribute;
  }

  void putFieldInfo(final ByteVector output) {
    // ...
  }

  // ...
}
复制代码

FieldWriter 每访问到一个字段, 就在内部保存该字段(按访问顺序逆序), 最终调用 putFieldInfo 将全部字段信息打印到 ByteVector 中.

其中 org.objectweb.asm.FieldVisitor#visitAttribute 方法是对类属性的操做, Attribute 自己的设计并无加入如 print, transform 等方法, 而是将对 Attribute 的操做方法被抽离至 FieldVisitor 中, 不然就没法知足"动态添加操做方法"的要求了.

经过应用访问者模式, ASM 将对字节码操做的方法从封装了字节码的类中抽离, 避免无关的方法污染类的设计.

何处安放操做方法

从上面的代码能够看出, ASM 并无对各类类元素的字节码定义相应的类, 而且将对这些元素的操做直接放置在对应的访问者 (Visitor) 中, 这正是访问者模式典型应用: 统一管理对类层级中各类类的操做方法.

什么时候使用访问者模式

对象层次结构对应类层次结构差别很大

一个类包含 N 个注解, 字段和方法, 用于表示注解, 字段和方法的类型差别比较大, 可是对这些类型的操做须要相互结合, 才能对一个完整的类字节码进行操做.

类中须要添加与类自己毫无关系的方法

表明字节码的类和对其进行的操做毫无关系, 换句话说, 一个类自己的字节码与别人如何操做它无关, 这些方法应该被抽离到访问对象中, 而不是强行定义在表明字节码的类中.