前言

Hello,今天来教大家:如何搭建基于 SpringBoot 的Java项目脚手架,以及运用脚手架构建新项目。

在任何一家公司工作,软件项目的架构都是经过了长期的深淀,一般是不会变的,尤其是对于新项目。而在每一次构建项目时都需要做重复的操作:新建项目、配置持久层、配置日志、配置异常处理、配置权限控制等等。

SO,为了帮助大家一劳永逸,我们一起来瞧一瞧!

一、编写基础项目模板

首先我们要有一个基础的模板,这个模板中集成了开发时所需要的常用配置,你可以自己搭建,或者在这里我提供给大家一个基础项目:SpringBoot 项目中已经引入了 MyBatis-Plus, Redis, Logback, Hutool, Swagger-UI 等,项目描述中有详细的架构描述

Gitee:https://gitee.com/guaidonggua/plus

第一步下载项目模板:

git clone https://gitee.com/guaidonggua/plus.git

二、生成脚手架

2.1 使用 idea 打开项目模板

使用 IDEA 打开基础项目,查看一下 maven 的配置路径,搭建过程中要保证 maven 路径始终一致,我的 maven 路径如下。然后运行一下项目,要确保基础项目是正常的。

java 脚手架 框架 文档 java脚手架搭建_maven

2.2 注意版本号

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

java 脚手架 框架 文档 java脚手架搭建_java 脚手架 框架 文档_02

2.3 构建脚手架

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

mvn archetype:create-from-project

脚手架项目编译成功后,install 到本地,继续输入两条 maven 命令:

cd target/generated-sources/archetype
mvn install

然后会在 maven 仓库(repository)中生成脚手架的配置文件:

java 脚手架 框架 文档 java脚手架搭建_java 脚手架 框架 文档_03

三、使用脚手架创建项目

3.1 创建项目

操作步骤与下图序号一一对应:
创建 maven 项目
选择自己的 jdk 版本,与基础项目版本的 jdk 一致
允许使用脚手架
添加自己的脚手架
填刚才创建的脚手架版本号,即上文maven 仓库(repository)中生成脚手架的配置文件图中的内容

groupId : com.plus
artifactId : plus-template-archetype
version : 0.0.1-SNAPSHOT

序号 5 中点击 OK 列表中就添加进了自己的脚手架,选中它

next 向下创建完成项目

java 脚手架 框架 文档 java脚手架搭建_java 脚手架 框架 文档_04

3.2 来杯拿铁,等待一会…

java 脚手架 框架 文档 java脚手架搭建_版本号_05

3.3 修改新项目配置

  1. 观察新项目的目录结构与基础项目是一致的
  2. 基本配置修改,数据库还是要换一下滴

java 脚手架 框架 文档 java脚手架搭建_maven_06

3.4 运行新项目

运行项目,访问 swagger 接口文档::http://localhost:8899//swagger-ui.html

java 脚手架 框架 文档 java脚手架搭建_java 脚手架 框架 文档_07

附:删除脚手架

如果某些脚手架不需要了,也不想在创建时脚手架列表中看到它,可以在 下面路径下中删除,删除个别时打开配置进行删除,删除所有时直接删除文件即可。

C:\Users\ASUS\.IntelliJIdea2019.3\system\Maven\Indices\UserArchetypes.xml

java 脚手架 框架 文档 java脚手架搭建_java 脚手架 框架 文档_08