Maven打包生成源码包和Javadoc包

当我们开发了一个公共模块,将它deploy到Maven仓库时,最好同时提供源码包和Javadoc包,这样使用者可以在IDE中直接进入该依赖的源码查看其实现的细节。

由于生成源码包和Javadoc包是极其常见的需求,因此Maven官方提供了插件来帮助用户完成这个任务
,配置如下:

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.5.1</version>
            <configuration>
                <source>${java.version}</source>
                <target>${java.version}</target>
                <testSource>${java.version}</testSource>
                <testTarget>${java.version}</testTarget>
            </configuration>
        </plugin>
        <!--配置生成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>
                </execution>
            </executions>
        </plugin>
        <!--配置生成源码包-->
        <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>
    </plugins>
</build>


在使用IDEA生成Java Doc的过程中,可能会出现IDEA控制台输出中文乱码,即使我们在maven-javadoc-plugin插件中指定字符集为UTF-8,依然是乱码,这是因为Maven的默认平台编码是GBK。

解决办法:
在IDEA中,打开File | Settings | Build, Execution, Deployment | Build Tools | Maven | Runner在VM Options中添加-Dfile.encoding=GBK,切记一定是GBK。

参考

Maven实战(九)——打包的技巧:http://www.infoq.com/cn/news/2011/06/xxb-maven-9-package

  • 1
    点赞
  • 14
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
Maven是一个功能强大的项目管理工具,可以帮助我们自动化构建、编译和打包项目。Maven提供了一种称为插件(plugins)的机制,可以扩展其功能。下面是一些常用的Maven编译打包插件: 1. Maven Compiler Plugin:该插件用于编译Java源代码。它默认使用Java编译器进行编译,但也支持其他编译器,如Groovy等。可以通过配置插件的参数来指定编译的源码路径、目标版本等。 2. Maven Surefire Plugin:该插件用于运行项目中的单元测试。它会自动搜索项目中的测试类,并执行这些测试类中的测试方法。可以通过配置插件的参数来指定测试类的匹配规则、报告输出等。 3. Maven Javadoc Plugin:该插件用于生成项目的API文档。它会根据项目中的源代码和Javadoc注释生成HTML格式的文档,并可以通过配置插件参数来指定输出路径、是否含私有成员等。 4. Maven Source Plugin:该插件用于生成项目的源代码。它会将项目中的源代码打包成一个压缩文件,供其他开发人员使用。可以通过配置插件参数来指定输出路径、是否含测试代码等。 5. Maven Jar Plugin:该插件用于将项目打包成一个可执行的JAR文件。它会将项目中的编译后的类文件、资源文件等打包到JAR文件中,并可以通过配置插件参数来指定JAR文件的名称、含的内容等。 这些插件可以通过在项目的pom.xml文件中配置来启用和使用。例如,可以在`<build>`标签下的`<plugins>`标签中添加相应的插件配置。具体的插件配置和参数可以参考Maven官方文档或插件的官方文档。
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值