打包Maven公共模块项目的JavaDoc和源码

Posted 2022-12-03 Neo Yang

抽取公共模块是为了将其编译成jar包提给其他人使用，相同的逻辑不用每个人实现一遍。公共模块代码可读性要求很高，为了方便用户使用，我们可以将公共模块的javadoc注释以及源码打包一并发布。

一、打包JavaDoc注解

在pom文件中增加打包javadoc的插件配置：

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-javadoc-plugin</artifactId>
                <version>2.10.4</version>
                <configuration>
                    <encoding>UTF-8</encoding>
                    <aggregate>true</aggregate>
                    <charset>UTF-8</charset>
                    <docencoding>UTF-8</docencoding>
                </configuration>
                <executions>
                    <execution>
                        <id>attach-javadocs</id>
                        <goals>
                            <goal>jar</goal>
                        </goals>
                        <configuration>
                            <additionalparam>-Xdoclint:none</additionalparam>
                        </configuration>
                    </execution>
                </executions>
            </plugin>

增加 -Xdoclint:none配置是因为有一部老代码不符合javadoc规范，打包时忽略。

二、打包源码文件

在pom文件中增加打包源码文件的插件：

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-source-plugin</artifactId>
                <version>3.0.1</version>
                <executions>
                    <execution>
                        <id>attach-sources</id>
                        <goals>
                            <goal>jar</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>

配置完后用mvn命令打包可以看到生成的jar包：

三、用户下载javadoc和源码

在客户端程序的pom文件中增加如下配置，就可以将javadoc和source的包下到本地：

        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <classifier>javadoc</classifier>
            <version>1.2.31</version>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <classifier>sources</classifier>
            <version>1.2.31</version>
        </dependency>