【问题标题】:Java template classes using generator or similar?使用生成器或类似的 Java 模板类?
【发布时间】:2012-10-03 21:27:13
【问题描述】:

是否有一些库或生成器可用于从单个模板生成多个模板化 java 类?

显然,Java 本身确实有一个泛型实现,但由于它使用类型擦除,在很多情况下它还不够。

例如,如果我想制作一个这样的自增长数组:

 class EasyArray {
      T[] backingarray;
 }

(其中 T 是原始类型),那么这是不可能的。

这适用于任何需要数组的东西,例如高性能模板化矩阵和向量类。

应该可以编写一个代码生成器,它接受一个模板类并为不同的类型生成多个实例化,例如“double”和“float”以及“int”和“String”。有没有已经存在的东西可以做到这一点?

编辑:请注意,使用 Object 数组不是我想要的,因为它不再是原语数组。基元数组非常快,并且只使用 sizeof(primitive) * length-of-array 的空间。对象数组是指向 Double 对象或类似对象的指针/引用数组,它们可能分散在内存中的各处,需要垃圾收集、分配,并暗示访问的双重间接。

编辑3:

下面是显示原始数组和盒装数组之间性能差异的代码:

int N = 10*1000*1000;
double[]primArray = new double[N];
for( int i = 0; i < N; i++ ) {
    primArray[i] = 123.0;
}
Object[] objArray = new Double[N];
for( int i = 0; i < N; i++ ) {
    objArray[i] = 123.0;
}
tic();
primArray = new double[N];
for( int i = 0; i < N; i++ ) {
    primArray[i] = 123.0;
}
toc();
tic();
objArray = new Double[N];
for( int i = 0; i < N; i++ ) {
    objArray[i] = 123.0;
}
toc();

结果:

double[] array: 148 ms
Double[] array: 4614 ms

甚至没有接近!

【问题讨论】:

  • 为什么你的例子不可能?见Java how to: Generic Array creation
  • 众所周知,数组和泛型不能很好地混合。但是您通常可以只使用 Object[] 和一些类型转换:(T) array[i]。您要克服的限制是什么?
  • 话虽如此,您应该查看 Array 类,它具有用于操作数组的静态方法(如 Richard 的链接所建议的那样)。您可以实例化数组并反射地访问特定的数组元素。
  • 我认为投反对票是因为你提出的“解决方案”比你试图绕过的“限制”要糟糕得多。
  • 我可以给出的另一个建议是尝试将数组本身设为通用:new Example&lt;double[]&gt;()

标签: java templates generics code-generation


【解决方案1】:

提出了以下草案方式:

我们创建一个类,使用占位符类型TemplateArgOne,并添加一个用于方便解析的注解:

@GenerateFrom(EndlessArray.class)
public class EndlessArray {
    TemplateArgOne[] values;
    int size = 0;
    int capacity;
    public EndlessArray() {
        capacity = 10;
        values = new TemplateArgOne[capacity];
    }
    public void reserve(int newcapacity ) {
        if( newcapacity > capacity ) {
            TemplateArgOne[] newvalues = new TemplateArgOne[newcapacity];
            for( int i = 0; i < size; i++ ) {
                newvalues[i] = values[i];
            }
            values = newvalues;
            capacity = newcapacity;
        }
    }
    public void add( TemplateArgOne value ) {
        if( size >= capacity - 1 ) {
            reserve( capacity * 2);
        }
        values[size] = value;
    }
    public void set( int i, TemplateArgOne value ) {
        values[i] = value;
    }
    public TemplateArgOne get( int i ) {
        return values[i];
    }
}

我们将 TemplateArgOne 定义为一个空类,所以上面的代码编译得很好,可以在 Eclipse 中毫无问题地编辑它:

public class TemplateArgOne {
}

现在,我们创建一个新类来实例化模板类,并添加几个注解来告诉生成器我们想要实例化哪个类,以及我们想要TemplateArgOne 的类型:

@GenerateFrom(root.javalanguage.realtemplates.EndlessArray.class)
@GenerateArg(from=TemplateArgOne.class,to=double.class)
public class EndlessArrayDouble {

}

然后我们运行生成器,传入我们源代码的目录,以及实例化类的名称,即EndlessArrayDouble:

public static void main(String[] args ) throws Exception {
    new RealTemplateGenerator().go("/data/dev/machinelearning/MlPrototyping", EndlessArrayDouble.class);
}

然后转眼!当我们转到 EndlessArrayDouble 类时,它已经被我们的代码填充了! :

package root.javalanguage.realtemplates;

import root.javalanguage.realtemplates.RealTemplateGenerator.*;

@GenerateArg(from=TemplateArgOne.class,to=double.class)
@GenerateFrom(root.javalanguage.realtemplates.EndlessArray.class)
public class EndlessArrayDouble {
    double[] values;
    int size = 0;
    int capacity;
    public EndlessArrayDouble() {
        capacity = 10;
        values = new double[capacity];
    }
    public void reserve(int newcapacity ) {
        if( newcapacity > capacity ) {
            double[] newvalues = new double[newcapacity];
            for( int i = 0; i < size; i++ ) {
                newvalues[i] = values[i];
            }
            values = newvalues;
            capacity = newcapacity;
        }
    }
    public void add( double value ) {
        if( size >= capacity - 1 ) {
            reserve( capacity * 2);
        }
        values[size] = value;
    }
    public void set( int i, double value ) {
        values[i] = value;
    }
    public double get( int i ) {
        return values[i];
    }
}

注意,如果多次运行,不修改模板类,则实例化类java文件不会被修改,即不会触发Eclipse中的冗余文件重载。

生成器代码:

//Copyright Hugh Perkins 2012, hughperkins -at- gmail
//
//This Source Code Form is subject to the terms of the Mozilla Public License, 
//v. 2.0. If a copy of the MPL was not distributed with this file, You can 
//obtain one at http://mozilla.org/MPL/2.0/.

package root.javalanguage.realtemplates;

import java.lang.annotation.*;
import java.util.*;

public class RealTemplateGenerator {
    @Target(ElementType.TYPE)
    @Retention(RetentionPolicy.SOURCE)
    public @interface GenerateFrom {
        Class<?> value();
    }
    @Target(ElementType.TYPE)
    @Retention(RetentionPolicy.SOURCE)
    public @interface GenerateArg {
        Class<?> from();
        Class<?> to();
    }
public final static BufferedReader newBufferedReader(String filepath ) throws Exception {
    FileInputStream fileInputStream = new FileInputStream( filepath );
    InputStreamReader inputStreamReader = new InputStreamReader(fileInputStream);
    BufferedReader bufferedReader = new BufferedReader(inputStreamReader);
    return bufferedReader;
}

public final static BufferedWriter newBufferedWriter( String filepath ) throws Exception {
    FileOutputStream fileOutputStream = new FileOutputStream(filepath);
    OutputStreamWriter outputStreamWriter = new OutputStreamWriter(fileOutputStream);
    BufferedWriter bufferedWriter = new BufferedWriter(outputStreamWriter);
    return bufferedWriter;
}

public final static ArrayList<String> readFileAsLines(String filepath ) throws Exception {
    ArrayList<String> lines = new ArrayList<String>(40000);

    BufferedReader bufferedReader = newBufferedReader(filepath);

    String line = bufferedReader.readLine();
    int numlines = 0;
    while( line != null ) {
        lines.add(line.substring(0, line.length() ));
        line = bufferedReader.readLine();
        numlines++;
    }
    bufferedReader.close();
    return lines;
}

public final static void writeFileFromLines( String filepath, ArrayList<String> lines ) throws Exception {
    BufferedWriter bufferedWriter = newBufferedWriter(filepath);
    for( String line : lines ) {
        bufferedWriter.write(line + "\n");
    }
    bufferedWriter.close();
}

    void go( String sourcedirectory, Class<?> targetclass ) throws Exception {
        String targetclassfilepath = sourcedirectory + "/" + targetclass.getCanonicalName().replace(".","/") + ".java";
        ArrayList<String> initialLines = FileHelper.readFileAsLines(targetclassfilepath);
        String fromclassname = "";
        HashMap<String,String> argOldToNew = new HashMap<String, String>();
        ArrayList<String> generatelines = new ArrayList<String>();
        for( String line : initialLines ) {
            if( line.startsWith("@GenerateFrom")){
                fromclassname = line.split("\\(")[1].split("\\.class")[0];
            }
            if( line.startsWith("@GenerateArg")) {
                String fromclass= line.split("from=")[1].split("\\.")[0];
                String toclass = line.split("to=")[1].split("\\.")[0];
                argOldToNew.put(fromclass,toclass);
                generatelines.add(line);
            }   
        }
        Class<?> targettype = this.getClass().forName(fromclassname); 
        String fromclassfilepath = sourcedirectory + "/" + targettype.getCanonicalName().replace(".","/") + ".java";
        ArrayList<String> templateLines = FileHelper.readFileAsLines(fromclassfilepath );
        ArrayList<String> generatedLines = new ArrayList<String>();
        for( int i = 0; i < templateLines.size(); i++ ){
            String line = templateLines.get(i);
            if( !line.startsWith("@GenerateFrom") && !line.startsWith("@GenerateArg")) {
                for( String oldarg : argOldToNew.keySet() ) {
                    line = line.replace(oldarg, argOldToNew.get(oldarg));
                }
                line = line.replace(targettype.getSimpleName(), targetclass.getSimpleName());
            } else if( line.startsWith("@GenerateFrom") ) {
                for( String generateline : generatelines ) {
                    generatedLines.add(generateline);
                }
            }
            generatedLines.add(line);
        }
        boolean isModified = false;
        if( initialLines.size() != generatedLines.size() ) {
            isModified = true;
        } else {
            for(int i = 0; i < initialLines.size(); i++ ) {
                if( !initialLines.get(i).equals(generatedLines.get(i))) {
                    isModified = true;
                    break;
                }
            }
        }
        if( isModified ) {
            FileHelper.writeFileFromLines(targetclassfilepath, generatedLines);
            System.out.println("Generated " + targetclassfilepath );
        } else {
            System.out.println("No change to " + targetclassfilepath );         
        }
    }
    public static void main(String[] args ) throws Exception {
        new RealTemplateGenerator().go("/data/dev/machinelearning/MlPrototyping", EndlessArrayDouble.class);
    }
}

【讨论】:

  • 干得好。几个想法:我会让TemplateArgOne 成为一个真正的类型参数而不是一个类。这样您就可以在现有的泛型类(如ArrayList)上使用代码生成器。这也将是更多的自我记录。而不是自己解析 Java 文件,您可以让 javac 为您解析它并为您提供完整的带注释的源代码树。因此,如果您的源代码中有一个包含 TemplateArgOne 的字符串,您的生成器就不会中断。有关此类工作代码生成器,请参阅项目 Lombok。另请参阅javax.annotation.processing API 文档。
  • @Saintali,当您说“真实类型参数”时,我假设您的意思是“标准 Java 泛型类型参数”?不幸的是,据我所知,java 泛型类型参数不能是原始类。
  • @Santali,Project Lombok 看起来很酷。看起来它可能成为更易于使用的 java 未来的一部分。据我所知,它不能处理原始模板类型吗?如果您在答案中添加指向项目 lombok 的链接,我会投票赞成。
猜你喜欢
  • 2014-03-12
  • 1970-01-01
  • 1970-01-01
  • 2015-09-16
  • 1970-01-01
  • 1970-01-01
  • 2021-07-25
  • 1970-01-01
  • 2020-03-15
相关资源
最近更新 更多