最新Classworking工具箱分析泛型数据结构汇总

C l a s s w o r k i n g工具箱分析泛型数据结构Java™ 5 泛型把详细的类型信息编码到类文件中。

许多类型的工具都可以从全面的类型信息提供的改进的数据结构中受益，但是要把这个信息变成有用的形式可能有些困难。

为了让这个工作更容易些，系列作者 Dennis Sosnoski 围绕ASM Java 字节码操纵框架构建了一个数据结构分析程序，可以解释泛型信息，为应用程序使用的数据的实际数据类型创建深度的视图。

类处理工具实际上就是一个把其他程序当成数据的程序，通常会修改或重新塑造目标程序，以满足某些目的。

在把程序当成数据的时候，如果构建一个关于程序自身内部数据结构的模型，协助对修改进行指导，那么通常是有用的。

可以利用反射，在第一次把目标程序的类文件装入 JVM 之后，创建这种类型的模型。

也可以用框架直接从类文件解码出数据结构信息，甚至从源代码进行解码。

不论采用何种技术，目的都是得到应用程序使用的对象之间关系的尽可能全面的视图。

Java 5 程序中的泛型信息，提供了应用程序数据结构的详细地图。

泛型之前的程序，只要运行到 Java 集合类或使用无类型引用的应用程序类时，数据结构的分析就走进了死胡同。

如果没有某种形式的外部信息，就没有办法知道无类型引用链接到什么类型的对象。

在使用泛型时，可以提供附加信息作为源代码的一部分，然后编译器会把附加的引用类型信息直接整合到二进制的类文件中。

利用这种内嵌的泛型信息是建立对象之间关系的更丰富视图的关键所在。

向专家 Dennis Sosnoski 请教关于 JVM 和字节码的问题如果对于这个文章系列中涉及的材料有意见和问题，以及有其他任何关于 Java 字节码、Java 二进制类格式或一型与ASM”）中，我首先介绍了使用反射得到泛型信息的基础知识，然后对于使用 ASM 字节码框架处理类文件的原始泛型信息作了详细介绍。

在这篇文章中，我把 ASM 技术用得更深入一点儿，在泛型类定义中使用类型替换来构建目标应用程序数据结构的增强视图。

在进入分析类所使用的实际 ASM 代码之前，我先介绍表示和组织数据结构信息时一些比较简单的问题。

表示数据结构在构建分析程序时的第一个问题是，定义目标程序使用的数据结构的表示形式。

这必须不仅包含每个字段值的表示，还要包含每个值的类型信息的表示。

因为我想在这一期中演示泛型的解码，所以类型信息需要包含泛型引用所使用的具体的参数类型。

清单 1 显示了我用作基本数据结构表示的类。

FieldDescription 类只是个简单的数据类，容纳字段名称、签名和字段类型的引用。

正如我在前一期中介绍的，签名是泛型添加到类文件格式中的项目；只有对泛型的引用才有签名。

签名定义了泛型实际使用的参数类型，所以它提供了处理类型替换时需要的信息。

对于没有签名的字段，将只使用 null 值。

最后，字段类型都是 TypeDescription 类的实例，如清单 1 所示：清单 1. 基本数据结构类private final String m_name;// only fields that are of generic types have signaturesprivate final String m_signature;// type only defined when parameter types are definedprivate final TypeDescription m_type;public FieldDescription(String name, String sig, TypeDescription type) { m_name = name;m_signature = sig;m_type = type;}public String getName() {return m_name;}public String getSignature() {return m_signature;}public TypeDescription getType() {return m_type;}}public abstract class TypeDescription{public static final FieldDescription[] EMPTY_FIELD_ARRAY = {};private final String m_descriptor;protected TypeDescription(String dtor) {m_descriptor = dtor;}public boolean isArray() {return false;}public TypeDescription getArrayItemType() {throw new IllegalStateException("Not an array");}public boolean isPrimitive() {return false;}public FieldDescription[] getFields() {return EMPTY_FIELD_ARRAY;}public String getDescriptor() {return m_descriptor;}public boolean equals(Object obj) {if (obj == this) {return true;} else if (obj instanceof TypeDescription) {return m_descriptor.equals(((TypeDescription)obj).m_descriptor);} else {return false;}}public int hashCode() {return m_descriptor.hashCode();}public abstract String toString();}TypeDescription 类只是个抽象基类，其中定义了处理三种类型的方法：原生类型、数组和类实例。

这个基类以类型描述符的形式包含了一个值。

我用于这个类的类型描述符大致符合 JVM 规范定义的类型描述符的形式，但是有些扩展，添加了泛型具体“版本” 的实际参数类型列表。

这个扩展允许把Ljava/util/Map<Ljava/lang/String;Ljava/lang/String;>; 这种形式的描述符作为类型系统的一部分。

回页首组织数据结构组织数据结构信息的问题比表示信息的问题略微复杂一些。

组织信息的基本问题在于数据结构经常是递归的：一个类中可能有一个字段，这个字段引用这个类的一个实例，或者它引用的一个类可能直接或间接地引用回到原来的类。

所以，只想直接展开结构，可能会形成无限的递归循环。

我使用目录技术来处理这种递归引用。

在找到类引用时，检查目标，查看这个类以前是否已经看到过。

如果是，那么目录就返回现有的描述。

如果没有，则目录创建新的描述实例，并立即把描述添加到目录（甚至在描述的完整细节可用之前就添加）。

清单 2 显示了这个 TypeDirectory 类的基本代码，现在暂时不管它，以后会添加处理泛型的一些细节：清单 2. TypeDirectory 类public class TypeDirectory{/** Source for binary class representations. */private final BinaryClassLoader m_loader;/** Field list for all arrays. */private final FieldDescription[] m_arrayFields;/** Map from descriptor or signature to type for all non-generic types,* including generics with substitutions. */private HashMap<String,TypeDescription> m_typeMap =new HashMap<String,TypeDescription>();.../*** Constructor. Initializes the type directory with descriptions of* primitive types.** @param loader binary class loader*/public TypeDirectory(BinaryClassLoader loader) {m_loader = loader;addType(new PrimitiveTypeDescription("B", "byte"));addType(new PrimitiveTypeDescription("C", "char"));addType(new PrimitiveTypeDescription("D", "double"));addType(new PrimitiveTypeDescription("F", "float"));TypeDescription inttype = new PrimitiveTypeDescription("I", "int");addType(inttype);addType(new PrimitiveTypeDescription("J", "long"));addType(new PrimitiveTypeDescription("S", "short"));addType(new PrimitiveTypeDescription("V", "void"));addType(new PrimitiveTypeDescription("Z", "boolean"));m_arrayFields = new FieldDescription[] {new FieldDescription("int", null, inttype)};}/*** Add type description to type directory.** @param desc type description to add*/public void addType(TypeDescription desc) {m_typeMap.put(desc.getDescriptor(), desc);}/*** Add generic class to template directory.** @param tmpl generic template to add*/public void addTemplate(GenericTemplate tmpl) {m_templateMap.put(tmpl.getDescriptor(), tmpl);}/*** Get description for the type. The type may be a primitive, an array, or a * class. If the type is a generic class, it will be treated as though all* type variables used their lower bounds.** @param dtor type descriptor* @return type description*/public TypeDescription getTypeInstance(String dtor) {// check for an existing descriptionTypeDescription desc = m_typeMap.get(dtor);if (desc == null) {// new description needed - must be array or classif (dtor.charAt(0) == '[') {desc = new ArrayClassDescriptor(dtor,getTypeInstance(dtor.substring(1)));} else {// parse binary class to build descriptionbyte[] byts = m_loader.getBytes(dtor);desc = new SimpleClassDescription(dtor, byts, this);}}return desc;}/*** Get description for generic class with specific type substitutions.** @param sig field signature with type substitutions* @param types actual types used for instance (values may be* <code>null</code> if no substitution defined)* @return type description*/public TypeDescription getSignatureInstance(String sig,TypeDescription[] types) {// first check for direct match on substituted signatureTypeDescription desc = (TypeDescription)m_typeMap.get(sig);if (desc == null) {// no direct match, first handle arrayif (sig.charAt(0) == '[') {desc = new ArrayClassDescriptor(sig,getSignatureInstance(sig.substring(1), types));} else {...}}return desc;}/*** Get description for signature with type mapping.** @param sig field signature for type variables* @param tmap type mapping for variables* @return type description*/public TypeDescription getMappedSignatureInstance(String sig,HashMap<String,TypeDescription> tmap) {...}.../*** Descriptor for primitive "class." There's really nothing to record for a * primitive type except the name, so that's all this does. Because instances * only need to be created and added to the directory at initialization, this * is an inner class.*/private static class PrimitiveTypeDescription extends TypeDescription{private final String m_externalName;private PrimitiveTypeDescription(String iname, String xname) {super(iname);m_externalName = xname;}public boolean isPrimitive() {return true;}public String toString() {return m_externalName;}}/*** Descriptor for array class. This is just a wrapper around the descriptor* for the item type, with the same field list used for all arrays.*/private class ArrayClassDescriptor extends TypeDescription{private final TypeDescription m_itemType;protected ArrayClassDescriptor(String name, TypeDescription item) {super(name);m_itemType = item;}public boolean isArray() {return true;}public TypeDescription getArrayItemType() {return m_itemType;}public FieldDescription[] getFields() {return m_arrayFields;}public String toString() {return m_itemType + "[]";}}}清单 2 的代码使用内部的 PrimitiveTypeDescription 和 ArrayTypeDescription 类直接处理原生类型和数组类型。