JAVA代码添加License_代码中注释 怎么加license

在开源代码的时候，我们经常会在代码顶部添加License信息，每个文件复制粘贴显然是比较麻烦的，我们可以在工具中进行配置，在创建新的类的时候自动为我们添加相关信息，以eclipse为例。

进入Preference->Java->Code Style->Code Template

在中间的面板中选择Comments->Files，然后单击Edit...按钮，在弹出的对话框中填写我们的License信息。

最后在我们创建新的JAVA类的时候需要勾选Generate comments。

这样，我们新创建的文件就会自动添加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));
      StringBuilder builder = new StringBuilder("/**\r\n");
      String line = null;
      while ((line = reader.readLine()) != null) {
         builder.append(" * ");
         builder.append(line);
         builder.append("\r\n");
      }
      builder.append(" */");
      return builder.toString();
   }

   /**
    * 处理license头部信息
    * 
    * @param root
    * @param in
    * @param charset
    * @throws IOException
    */
   public void processLicenseHeader(File root, InputStream in, String charset) throws IOException {
      System.out.println("开始读取并格式化license...");
      String headerBody = readLicenseHeader(in, charset);
      System.out.println(headerBody);
      System.out.println("读取并格式化license完成...");
      if (root.isDirectory() || root.getName().endsWith(".java")) {
         System.out.println("开始处理：" + root.getAbsolutePath());
         processLicenseHeader(root, charset, headerBody);
      }
   }

   private void processLicenseHeader(File root, String charset, String headerBody) throws IOException {
      if (root.isFile()) {
         System.out.println("开始读取并处理：" + root.getAbsolutePath());
         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 = reader.readLine()) != 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("读取并处理[" + root.getAbsolutePath() + "]完成");
      } 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() || file.getName().endsWith(".java");
   }

   @Test
   public void test() throws IOException {
      processLicenseHeader(new File("src/main/java"), new FileInputStream("license.txt"), "UTF-8");
   }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104