IDEA打包自己的工具类,并通过maven使用



一、简介

当我们多个项目都重复使用一些工具类的时候,打包并通过依赖来使用会方便很多

普通项目直接通过添加 Project Structure - Artifacts,再build就能打包,使用的时候在 Project Structure - Modules 添加依赖就能使用

当我们使用 maven 管理项目时,再这样操作显得多此一举,本文介绍如何通过 maven 打包到本地仓库,含注释,并通过依赖使用



二、maven 打包到本地仓库

首先工具类所在的项目必须是普通的 maven 项目,不能是 spring...否则使用时会出现能找到但又不完全能找到你工具类的情况(滑稽)

这里说一下注释问题,我们使用 JavaSE 的 api 时,是能点进去看源码和注释的,但是使用第三方库我们大概率只能看代码看不了注释

那我们自己的工具类能不能把注释打进 jar 包呢 ?当然能

pom.xml <dependencies> 中引入依赖

<!-- https://mvnrepository.com/artifact/org.apache.maven.plugins/maven-javadoc-plugin -->
<dependency>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>3.3.0</version>
</dependency>
<!-- https://mvnrepository.com/artifact/org.apache.maven.plugins/maven-source-plugin -->
<dependency>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-source-plugin</artifactId>
    <version>3.2.1</version>
</dependency>

再添加配置

    <build>
        <plugins>
            <!--把注释打进工具包 start-->
            <!--生成doc jar包-->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-javadoc-plugin</artifactId>
                <executions>
                    <execution>
                        <id>attach-javadocs</id>
                        <goals>
                            <goal>jar</goal>
                        </goals>
                        <!-- 不让像@Param 这种后面没写值的东西 报错。
                        <configuration>
                            <additionalJOption>-Xdoclint:none</additionalJOption>
                        </configuration>-->

                    </execution>

                </executions>
            </plugin>

            <!--生成源码jar包-->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-source-plugin</artifactId>
                <executions>
                    <execution>
                        <id>attach-sources</id>
                        <goals>
                            <goal>jar</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
            <!--end-->

        </plugins>
    </build>

现在一切准备就绪,我们点开 IDEA 右侧的 Maven ,点击 install,maven 会进行打包并存入本地仓库

关于 maven package,install,deploy 的区别参考



三、maven 依赖本地仓库

怎么引入依赖呢,我们要获得工具类的坐标,在新建工具类的项目时我们可以编辑其 groupId、artifactId、version

后续也能通过工具类的 pom 文件编辑,所以我们在 pom 文件中找就好了



posted @ 2021-08-19 15:42  云牧青  阅读(1146)  评论(0编辑  收藏  举报