在Maven项目开发中,尤其是开源项目,需要在pom.xml中配置licenses相关信息,明确项目的开源协议,让使用者清楚项目的授权范围和约束条件。正确的配置不仅能符合开源社区的规范,也能避免后续产生授权相关的纠纷。

pom.xml中licenses标签的基本结构
Maven的pom.xml通过<licenses>父标签来包裹所有的开源协议配置,每个单独的协议使用<license>子标签定义,一个项目可以配置多个开源协议,具体的结构如下:
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.example</groupId>
<artifactId>demo-project</artifactId>
<version>1.0.0</version>
<licenses>
<license>
<!-- 协议名称 -->
<name>协议名称</name>
<!-- 协议官方地址 -->
<url>协议地址</url>
<!-- 协议分发方式,一般填repo -->
<distribution>repo</distribution>
<!-- 可选,协议的补充说明 -->
<comments>补充说明内容</comments>
</license>
</licenses>
</project>
常见开源协议的配置示例
不同的开源协议有不同的配置内容,以下是几种常用开源协议的配置示例:
Apache License 2.0配置
<licenses>
<license>
<name>Apache License, Version 2.0</name>
<url>https://www.apache.org/licenses/LICENSE-2.0.txt</url>
<distribution>repo</distribution>
</license>
</licenses>
MIT License配置
<licenses>
<license>
<name>MIT License</name>
<url>https://opensource.org/licenses/MIT</url>
<distribution>repo</distribution>
</license>
</licenses>
GNU General Public License v3.0配置
<licenses>
<license>
<name>GNU General Public License v3.0</name>
<url>https://www.gnu.org/licenses/gpl-3.0.txt</url>
<distribution>repo</distribution>
</license>
</licenses>
配置注意事项
- name标签必须填写准确的协议全称,不要使用简写,避免使用者产生误解。
- url标签需要填写协议官方的正式地址,不要填写第三方转载的地址,保证信息的权威性。
- distribution标签一般统一填写repo,表示该协议适用于仓库分发的场景。
- 如果项目同时采用多个开源协议,只需要在<licenses>标签下添加多个<license>子标签即可,不需要额外修改结构。
- 配置完成后可以通过
mvn help:effective-pom命令查看生效的pom配置,确认licenses信息已经正确生效。
多协议配置示例
如果项目同时采用Apache 2.0和MIT两个协议,配置示例如下:
<licenses>
<license>
<name>Apache License, Version 2.0</name>
<url>https://www.apache.org/licenses/LICENSE-2.0.txt</url>
<distribution>repo</distribution>
</license>
<license>
<name>MIT License</name>
<url>https://opensource.org/licenses/MIT</url>
<distribution>repo</distribution>
</license>
</licenses>