自定义archetype项目模板并发布到远程仓库

文章目录

• • 背景
  • 实现方式
  • 实现细节
  • 小结

概要

公司要做一个后端的通用项目，统一技术版本、技术架构，能够实现快速搭建项目。

目前分为两个版本，单体架构版和微服务版

所以记录一下过程，项目使用的若依的前后端分离版本作为基础框架，（感谢若依）

废话不多说了，上骨架。。。。。。

实现方式

采用自定义archetype的方式，生成骨架，并上传到maven私服

实现步骤

前提：创建好自己的项目

第一步 项目pom.xml中首先引入archetype插件，用于构建生成archetype项目

<build>
        <plugins>
            <!--mavan archetype 原型骨架插件-->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-archetype-plugin</artifactId>
                <version>3.1.1</version>
            </plugin>

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.1</version>
                <configuration>
                    <source>${java.version}</source>
                    <target>${java.version}</target>
                    <encoding>${project.build.sourceEncoding}</encoding>
                </configuration>
            </plugin>
        </plugins>
    </build>

第二步 新建archetype.properties文件和pom.xml同级目录

这个文件的作用就是定义哪些文件需要构建到骨架模版中

# 添加不需要放到模板的正则匹配
excludePatterns=.idea/**,README.md,.mvn/wrapper/*,.gitignore
# 需要替换处理的文件后缀，默认没有yml、yaml
archetype.filteredExtensions=java,yml,yaml,xml,txt,groovy,cs,mdo,aj,jsp,gsp,vm,html,xhtml,properties,classpath,project,doc,docx,bat,sh,sql,vm

第三步 生成archetype 

在pom.xml所在目录执行命令

1、执行  create-from-project 命令生成骨架 

 mvn clean archetype:create-from-project

执行成功后会生成target文件夹,结构如下

2、执行install 安装到本地

cmd 切换路径到 \target\generated-sources\archetype目录下，执行如下命令

cd target\generated-sources\archetype

mvn install

执行成功后会在你的maven仓库中生成骨架的pom和jar

2、生成坐标信息

mvn archetype:crawl 

成功后，会在你的maven本地仓库根目录生成一个archetype-catalog.xml文件

文件包含你安装骨架的坐标信息

到目前为止，你可以使用本地的archetype创建模板项目了

   使用idea >> IDEA >> File >> New >> Project

点击Finish下载构建项目，这里有一个下载的过程需要等一会儿

完成后就可看到整个项目了

如果是要从远程仓库安装

第一步 配置你的Maven的setting.xml文件，配置有上传权限的用户名和密码，以及仓库地址

配置完成，需要修改\target\generated-sources\archetype\的pom.xml文件

  <distributionManagement>
    <repository>
      <id>central</id>
      <name>artifactory-releases</name>
      <url>你的maven远程仓库地址</url>
    </repository>
  </distributionManagement>

后依然在\target\generated-sources\archetype\目录下执行：

mvn deploy

这样，骨架就上传到了你的maven私仓了

使用方法和本地使用是一样的！！

小结

提示：1、上传到私仓需要配置账号密码

    2、mvn 命令需要在生成的\target\generated-sources\archetype\目录下执行