更新日志

7.1.2（2024年6月8日）

• 添加了通过CLI（以"/EA:<class.name>"的形式）和插件（以"actionPreprocessorExtension"的形式）定义预处理器扩展类的方法。该类应在类路径中提供。#48
• 更新了一些依赖项

7.1.1（2024年1月13日）

• 修复了Maven和Gradle中空或null全局变量值导致的NPE问题 #47
• 更新了依赖项

完整更新日志

简介

这个预处理器工具最初开发于2002年，源于高效管理J2ME设备多样化源代码的需求。它旨在简化不同设备间特定调用位置的更改过程，从而优化开发流程。以Java作为主要技术，该工具针对C/Java语言家族进行了微调，充分利用了它们的导入部分和C风格注释。

最初作为一个闭源项目，它于2011年转变为开源项目。如今，它已成为一个强大的两步式Java预处理器，能够理解文档结构（前缀、主体和后缀），包含循环，并将XML文件作为数据源。它的功能还扩展到生成静态网站。

预处理器现在作为一个综合的uber-jar存在，捆绑了Maven、ANT和Gradle的接口代码，与这些工具无缝集成。它需要至少1.8版本的JDK。

此外，各种Linux仓库都提供了名为libcomment-preprocessor-java的预处理器包，简化了用户的使用过程。

所有选项的思维导图

如何使用

预处理器可以作为以下方式使用：

• CLI工具
• Java JAR库
• Maven目标
• ANT任务
• Gradle任务

预处理器已发布在Maven中央仓库。

    <build>
        <plugins>
...
           <plugin>
                <groupId>com.igormaznitsa</groupId>
                <artifactId>jcp</artifactId>
                <version>7.1.2</version>
                <executions>
                    <execution>
                        <id>preprocessSources</id>
                        <phase>generate-sources</phase>
                        <goals>
                            <goal>preprocess</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
...
        </plugins>
    </build>    

如何在命令行中使用

uber-jar可以通过CLI接口直接在Java下启动。让我们看一个在Linux命令行下启动它的简短示例：

java -jar jcp-7.1.2.jar  --i:./test --o:./result

上面的例子只是预处理./test文件夹中的文件（默认允许预处理的扩展名），并将结果文件放入./result文件夹。请记住，预处理器不会处理所有文件，例如默认情况下不会预处理XML文件。未标记为预处理的扩展名的文件将只会被复制（当然，如果该扩展名不在排除列表中）。

更复杂的例子：

java -jar jcp-7.1.2.jar  --c --r --v --f:java,xml --ef:none --i:./test --o:./result  '--p:HelloWorld=$Hello world$'

• --c 在工作前清空目标文件夹
• --r 从预处理后的结果文件中删除所有Java风格的注释
• --v 显示预处理过程的详细日志
• --f 将.java和.xml文件包含在预处理中（默认情况下，预处理器不预处理XML文件，必须明确定义扩展名）
• --ef 不从预处理中排除任何扩展名
• --i 使用./test作为源文件夹
• --o 使用./result作为目标文件夹
• --p 定义名为HelloWorld的全局变量，内容为'Hello world'
• --z 在替换前开启文件内容检查，如果内容相同，预处理器将不会替换文件
• --es 允许注释和指令之间有空白（默认情况下是关闭的）

一些示例

• 为Javassist准备源代码
• 为JEP-238制作多版本JAR
• 从XML源生成静态文件
• 简单的基于Gradle的Android项目

带有指令的Java源代码示例

在Java中，注入指令而不破坏工具和编译器工作的唯一允许方式是使用注释空间，因此预处理器使用它。

//#local TESTVAR="TEST LOCAL VARIABLE"
//#echo TESTVAR=/*$TESTVAR$*/
//#include "./test/_MainProcedure.java"

public static final void testproc()
{
 System.out.println(/*$VARHELLO$*/);
 System.out.println("// Hello commentaries");
 //#local counter=10
        //#while counter!=0
        System.out.println("Number /*$counter$*/");
        //#local counter=counter-1
        //#end
 System.out.println("Current file name is /*$SRV_CUR_FILE$*/");
 System.out.println("Output dir is /*$SRV_OUT_DIR$*/");
 //#if issubstr("Hello","Hello world")
 System.out.println("Substring found");
 //#endif
}

多部分文档

与普通文档相比，Java文档至少有两个部分 - 前缀（存放导入和特殊信息）和主体。为了访问这些部分，有特殊的预处理指令//#prefix[-|+]、//#postfix[-|+]。它们允许打开或关闭前缀和后缀部分的输出。

//#prefix+
 import java.lang.*;
 //#prefix-
 public class Main {
  //#prefix+
  import java.util.*;
  //#prefix-
  public static void main(String ... args){}
 }

如何从源代码中删除所有注释

有时从源代码中完全删除所有注释是非常有用的，JCP包含了这种可能性，可以通过特殊标志或命令行开关激活。下面的例子展示了如何使用CLI删除所有注释：

java -jar ./jcp-7.1.2.jar --i:/sourceFolder --o:/resultFolder -ef:none --r