JAVA代码添加License
在开源代码的时候,我们经常会在代码顶部添加License信息,每个⽂件复制粘贴显然是⽐较⿇烦的,我们可以在⼯具中进⾏配置,在创建新的类的时候⾃动为我们添加相关信息,以eclipse为例。
进⼊Preference->Java->Code Style->Code Template
在中间的⾯板中选择Comments->Files,然后单击按钮,在弹出的对话框中填写我们的License信息。
最后在我们创建新的JAVA类的时候需要勾选Generate comments。
java stream
这样,我们新创建的⽂件就会⾃动添加License信息了。如果现存的⼀些历史⽂件,⽤上⾯的⽅法显然
就不太好了,所以写了⼀个⼯具类⽅便为源码添加License部分,供⼤家参考,可以按照实际情况进⾏修改。
import java.io.BufferedReader;
import java.io.BufferedWriter;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileFilter;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.OutputStreamWriter;
import org.junit.Test;
/**
* License复制⼯具
*
* @author jianggujin
*
*/
public class LicenseCopyUtils implements FileFilter {
/**
* 读取License⽂件
*
* @param in
* @param charset
* @return
* @throws IOException
*/
public String readLicenseHeader(InputStream in, String charset) throws IOException {
BufferedReader reader = new BufferedReader(new InputStreamReader(in, charset));
BufferedReader reader = new BufferedReader(new InputStreamReader(in, charset));
StringBuilder builder = new StringBuilder("/**\r\n");
String line = null;
while ((line = adLine()) != null) {
builder.append(" * ");
builder.append(line);
builder.append("\r\n");
}
builder.append(" */");
String();
}
/**
* 处理license头部信息
*
* @param root
* @param in
* @param charset
* @throws IOException
*/
public void processLicenseHeader(File root, InputStream in, String charset) throws IOException {
System.out.println("开始读取并格式化");
String headerBody = readLicenseHeader(in, charset);
System.out.println(headerBody);
System.out.println("读取并格式化license完成...");
if (root.isDirectory() || Name().endsWith(".java")) {
System.out.println("开始处理:" + AbsolutePath());
processLicenseHeader(root, charset, headerBody);
}
}
private void processLicenseHeader(File root, String charset, String headerBody) throws IOException {
if (root.isFile()) {
System.out.println("开始读取并处理:" + AbsolutePath());
BufferedReader reader = new BufferedReader(new InputStreamReader(new FileInputStream(root), charset));        ByteArrayOutputStream stream = new ByteArrayOutputStream();
BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(stream, charset));
writer.write(headerBody);
writer.write("\r\n");
String line = null;
boolean body = false;
while ((line = adLine()) != null) {
if (body || line.startsWith("package ") || line.startsWith("import ")) {
body = true;
writer.write(line);
writer.write("\r\n");
}
}
reader.close();
writer.close();
FileOutputStream out = new FileOutputStream(root);
stream.writeTo(out);
out.flush();
out.close();
System.out.println("读取并处理[" + AbsolutePath() + "]完成");
} else {
File[] list = root.listFiles(this);
if (list != null)
for (File file : list) {
processLicenseHeader(file, charset, headerBody);
}
}
}
@Override
public boolean accept(File file) {
return file.isDirectory() || Name().endsWith(".java");
}
@Test
public void test() throws IOException {
processLicenseHeader(new File("src/main/java"), new FileInputStream(""), "UTF-8");  }
}

版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。