如何确保 java-maven 构建的所有源文件都附有版权声明？

Question

人们是否有一种标准方法可以强制在其 java/maven 构建中包含版权声明？我意识到这不是必要的，因为产品本身是抄写的，如果有人有我的源代码，我就会遇到更大的问题，但我被要求检查，并且想知道 checkstyle、PMD 或其他东西是否自动处理这个问题。

有没有一个工具可以处理版权检查？

Answer 1

是，Checkstyle（以及 maven-checkstyle-plugin< /a>) 可以做到这一点，它可以检查每个源文件是否包含许可证头。将该标头放入文本文件中并使用 headerLocation 指向它（默认使用 LICENSE.txt）。

假设您想使用 checkstyle.license 作为版权声明。对于多模块构建，标准方法是创建一个专用模块来托管 Checkstyle 资源（请参阅 多模块配置)：

whizbang
|-- pom.xml
|-- build-tools
|   |-- src
|   |   `-- main
|   |       `-- resources
|   |           `-- whizbang
|   |               |-- checkstyle.xml
|   |               `-- checkstyle.license
|   `-- pom.xml
|-- core
|-- gui
|-- jmx
`-- src

然后，包含 Checkstyle 配置位于顶级 pom.xml 中。

<pluginManagement>
  <plugins>
    <!-- Apply checkstyle rules and fail the build in case of errors. The
         checkstyle config files are taken from the build-tools JAR module.-->
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-checkstyle-plugin</artifactId>
      <!-- Lock down plugin version for build reproducibility -->
      <version>2.4</version>
      <dependencies>
        <dependency>
          <groupId>com.example.whizbang</groupId>
          <artifactId>build-tools</artifactId>
          <version>1.0</version>
        </dependency>
      </dependencies>
      <configuration>
        <consoleOutput>true</consoleOutput>
        <configLocation>whizbang/checkstyle.xml</configLocation>
        <headerLocation>whizbang/checkstyle.license</headerLocation>
      </configuration>
      <executions>
        <execution>
          <goals>
            <goal>check</goal>
          </goals>
        </execution>
      </executions>
    </plugin>
    ...
  </plugins>
</pluginManagement>

此设置将确保源文件中存在版权标头（并应用其他 Checkstyle 规则，但这是另一个故事）。对其进行调整以满足您的需求。

Answer 2

我刚刚发现
http://code.google.com/p/maven-license-plugin/< /a>
似乎也有道理

Answer 3

如果您的项目位于 Git 存储库中，您可以遵循欧洲自由软件基金会的 REUSE 标准。使用reuse-tool，您可以通过执行reuse lint。对于持续集成 (CI)，您可以使用 fsfe/reuse Docker 映像。