设计模式——Visitor(访问者)模式

前言

当我们需要对一个对象中所有元素进行代码检查或者赋值检查等操作，或者想添加一些新的功能，但是当该对象对于产品已经很成熟，可能直接修改对象的类会产生新的缺陷。这时访问者可以帮助我们增添功能，而不影响原始类.

1 定义

Visitor(访问者)模式：表示一个作用与对象结构中各个元素的操作。可以使你不改变原始类的情况下增加对这些元素的新操作。

2 适用性

• 当一个复杂对象包含较多元素，且元素接口各不相同，而你想增加一些对这些元素的新操作。
• 你想对一个对象结构中元素进行很多不同且不相关的操作，而且你不想修改类。
• 定义对象结构的类结构很少改变，而需要经常添加针对对象元素的操作。

3 结构

3.1 结构图

访问者模式结构图：

3.2 参与者

• Glaph：抽象接口，定义了我们需要操纵对象的抽象接口。
• Character：具体实现类，accept接受visitor的访问和操作。
• Visitor：访问者抽象类，定义了缺省的方法。
• ConcreteVisitor：具体访问者，对需要增加的操作在这里实现。

4 Java实际应用举例——以ASM技术为例

java中字节码操纵技术ASM中对字节码的访问，修改就是通过Visitor模式实现的。下面以asm为例进行介绍。

4.1 被访问对象——ClassReader

定义如下：

该类主要是读取和解析读入的class字节码文件，accept接受指定观察者，进行相关操作。b是读取的class文件字节数组。字节码常见结构如下：

4.2 Visitor——ClassVisitor

该抽象类定义如下：

该类定义了各种访问ClassReader中元素的操作，这些访问是按照一定顺序进行处理的。

4.3 具体visitor——ClassParser

定义如下：

public class ClassParser extends ClassVisitor {
    public ClassParser(int i) {
        super(i);
    }
    public ClassParser(ClassWriter cw) {
        super(Opcodes.ASM5, cw);
    }

    @Override
    public void visit(int i, int i1, String s, String s1, String s2, String[] strings) {
        super.visit(i, i1+Opcodes.ACC_ABSTRACT, s, s1, s2, strings);
        System.out.println("类名"+s);
    }

    @Override
    public AnnotationVisitor visitAnnotation(String s, boolean b) {
        System.out.println("注释："+s + "可见性：" + b);
        return super.visitAnnotation(s,b);
//        return new AnnotationParserOne(262144);
    }

    @Override
    public FieldVisitor visitField(int i, String s, String s1, String s2, Object o) {
        System.out.println("字段："+s + "描述符："+ s1);
        return super.visitField(i, s, s1, s2, o);
//        if ("name".equals(s)) {
//            return super.visitField(i, "str", s1, s2, o);
//        }
//        if ("age".equals(s)) {
//            return super.visitField(i + Opcodes.ACC_FINAL, s, s1, s2, (Integer) 10);
//        }
//        return new FiledParser(262144);
    }
}

主要是在访问该类时，输出类名、输出注释和可见性以及字段名称和对应描述符。

4.4 测试demo——AsmReadClassInfo

代码：

public class AsmReadClassInfo {
    public static void main(String[] args) throws IOException {
        ClassReader classReader = new ClassReader(AsmTestClass.class.getName());
        ClassParser classParser = new ClassParser(262144);
        classReader.accept(classParser, ClassReader.SKIP_CODE);
    }
}

• 定义classreader读取我们的AsmTestClass字节码：对应定义如下：

@Component
public class AsmTestClass {
    @NotNull
    private String name;
    private static int age;
    private static final Integer[] arr = {};

}

• 定义我们的访问者classparser处理访问过程
• 之后调用accept即可。

运行结果如下：

结果中字段描述符参考具体jvm字节码内容的定义。

5 总结

当需要处理复杂对象元素，并希望在遍历时应用一些操作，可以使用访问者进行处理，同时不修改原对象类代码。

参考文献

[1]. 《设计模式》