从 0 到 1 搭建自己的脚手架（java 后端）

2023-06-06 10:13 由京东云开发者发表于 #后端开发

一、脚手架是什么

脚手架是一种基础设施工具，用于快速生成项目的框架代码和文件结构。它是一种标准化的开发工具，使开发人员能够在项目的早期阶段快速搭建出一个具备基本功能和结构的系统。

二、脚手架的意义

主流的微服务架构体系下很多公司会将原有的单体架构或者繁重的微服务进行拆分。这个时候按照模块(商品、订单、用户、库存、优惠、搜索、管理后台..)、按照领域驱动设计(投保、理赔、支付、保单管理)等进行拆分就需要很多的微服务项目，如果一个一个的去创建微服务其实是在做重复的工作容易出错而且没有意义，浪费人力物力。这个时候基础性的持久层、日志、异常处理、权限控制等在项目创建时一起生成不仅减少了重新创建或部分复制带来的风险而且高效。

三、脚手架的创建

3.1 编写项目模版

首先我们要有一个基础项目的模板，这个模板中集成了开发时所需要的常用配置，你可以自己搭建，或者找一个基础项目如：SpringBoot 项目中已经引入了 MyBatis-Plus, Redis, Logback, Hutool, Swagger-UI 等。或者将公司的架构沉淀出一个基础项目的模板。

springboot模版项目：

3.2 生成脚手架

3.2.1 使用 idea 打开项目模板

使用 IDEA 打开基础项目，查看一下 maven 的配置路径，搭建过程中要保证 maven 路径始终一致，我的 maven 路径如下。

D:/Program Files/apache-maven-3.2.5
D:\Program Files\apache-maven-3.2.5\conf\settings.xml
D:\Program Files\apache-maven-3.2.5\repository

然后运行一下项目，要确保基础项目是正常的。

3.2.2 注意版本号

然后留意一下 pom.xml 文件中的项目 gvn，这是项目的版本号，也与下文生成模板的版本号有关。

org.springframework.boot.demo
spring‐boot‐stage‐demo
0.0.1‐SNAPSHOT

3.2.3 构建脚手架

方式一：打开命令行窗口 Terminal ，正常情况指向的是本项目的目录，如果不是则 cd 到本项目，然后输入：

mvn archetype:create-from-project #从已有的项目中生成archetype.

方式二：当前项目所在文件夹下执行

eg: 项目的跟路径为 D:\spring-staggingcmd下执行
d:
cd D:\spring-stagging
mvn archetype:create-from-project

执行完成后脚手架项目也就创建完成,生成如下所示的结构

注：这里如果生成的是如下所示的结构

解决办法1.调整如图所示的artifactId与module前缀一致

将产生的target目录移动到新的目录，打开gitbash进行如下操作

删除idea的相关文件
rm -rf .idea
find . -name " .iml" -type f -print -exec rm -rf {} ;
删除不需要的实例代码find . -name "xxxMain" -type f -print -exec rm -rf {} ;
eg:将脚手架放到D:\spring-stagging-archetype 目录下,目录下主要存放src和pom文件即可

3.2.4发布脚手架

用idea打开后配置maven

在创建项目的时候也要保证maven的一致否则不能找到对应的脚手架pom

配置distributionManagement后deploy到artifactId仓库
否则创建的时候：Could not find artifact org.springframework.boot.demo:spring-boot-stage-demo-archetype:pom:0.0.1-SNAPSHOT

      
        
          xxx-central
          libs-releases-local
          http://artifactory.66.com/libs-releases-local
        
        
          xxx-snapshots
          libs-snapshot-local
          http://artifactory.66.com/libs-snapshots-local

pom里的 gav就是以后创建项目时用到的脚手架的gav

org.springframework.boot.demo
  spring-boot-stage-demo-archetype
  0.0.1-SNAPSHOT
  maven-archetype

上传脚手架项目到git代码仓库保存便于以后更新和沉淀。

四、使用脚手架创建新的项目

4.1配置脚手架的gav

4.2填写要创建的目标项目的gav

4.3配置maven

4.4根据新的artifactId生成新的工程

五、参考文档

https://maven.apache.org/archetype/maven-archetype-plugin/

作者：京东健康马仁喜

来源：京东云开发者社区

热门相关：骑士归来梦回大明春夫人，你马甲又掉了！朕夫人，你马甲又掉了！