给自己做了一个简单的SpringBoot微服务开发脚手架

最新推荐文章于 2025-09-25 11:16:57 发布

原创最新推荐文章于 2025-09-25 11:16:57 发布 · 1.1k 阅读

17 ·

CC 4.0 BY-SA版权

文章标签：

#spring boot #微服务 #后端

本文介绍了作者开发通用脚手架的过程，包括选择技术栈（如SpringBoot、SpringCloud、MyBatis-Plus等），实现登录认证、日志管理等功能，以及计划中的代码生成器和支付模块。分享了项目的结构和使用方法，源码可在GitHub上获取并参与贡献。

如您不吝赐教，可以提PR或Issues，我会认真拜读。 ^_^

什么是脚手架

百度百科搜索脚手架词条显示，脚手架是为了保证各施工过程顺利进行而搭设的工作平台。

软件的脚手架的作用，维基百科显示

Scaffolding is a meta-programming method of building database-backed software applications. It is a technique supported by some model-view-controller frameworks, in which the programmer may write a specification that describes how the application database may be used. The compiler uses this specification to generate code that the application can use to create, read, update and delete database entries, effectively treating the template as a "scaffold" on which to build a more powerful application.

*译：脚手架是一种构建数据库支持的软件应用程序的元编程方法。它是一些模型-视图-控制器框架支持的一种技术，程序员可以在其中编写描述如何使用应用程序数据库的规范。编译器使用该规范生成应用程序可以用来创建、读取、更新和删除数据库条目的代码，有效地将模板视为构建更强大应用程序的“脚手架”

为什么做

起初是接了一些私活的单子，每次接到不同类型的项目的时候都需要新建一个项目，为了节省时间，我为毕业设计的单子做了同类型的基础框架，在不同的类型上创建新分支进行开发。

后续做的不完全是毕业设计的项目，基础框架自然不能覆盖了，某些项目需要更加完备的功能，因此闲来无事，开始研究是否能做一个属于日常开发的通用脚手架。

开始

编写脚手架的步骤大致为编写或者现找一个可用合适的SpringBoot微服务项目，再开发模板引擎，将原有的项目内容替换成自己的。

准备

首先是技术选型，开发对应类型的项目脚手架。根据我个人的开发需求，开发微服务和单体版本，符合不同体量项目的需求，开发小项目时不需要微服务。并且由于学习的需要，则集成技术选用较新的版本。

环境

	版本
Java	17+
Lombok	/
Maven	3.5+
SpringBoot	3.0.7
SpringCloud-Alibaba	2022.0.0.0

集成

	版本
mybatis-Plus	17+
redisson	/
openfeign	3.5+
elastic-search	3.0.7
ok-http	3.0.7
spring-security	6.0.3
mysql	8+
jjwt	0.9.1
log4j	2.20.0
freeMarker	2.3.31
jakarta.validation	3.0.2
nacos-config	2022.0.0.0
nacos-discovery	2022.0.0.0

分支

Git管理参考 A successful Git branching model

分支一览

复制代码

master # 源分支 ├─ feature/freemarker-1.0.0 # 生成器功能开发分支 ├─ feature/standalone1.0.0 # 单体功能分支 ├─ feature/microservice1.0.0 # 微服务功能分支 # 目前仅一人开发，故没有开启devlop，直接在功能分支上开发

spring-cloud-security-cli ├─nacos-example | └config.yml # nacos参考配置文件 ├─ cloud-cli-service # 服务层模块 ├─ cloud-cli-security # 安全认证模块 ├─ cloud-cli-generate # 代码生成器模块（开发中） ├─ cloud-cli-common # 通用模块（工具、配置） ├─ cloud-cli-bean # 实体类模块 ├─ cloud-cli-api # Web api服务 ├─ (待定) cloud-cli-pay # 支付SDK分支

完成的功能

基于Spring Security + JJWT 的登录认证和安全拦截

aspect log4j的全局控制层日志打印

common模块下的其他配置、工具类…

正在开发的功能

生成器模块通过控制台交互、http调用生成自定义项目。

想要加入的功能

包装支付宝、微信支付功能的支付模块

使用配置

代码生成器模块还在开发，目前使用IDE替换项目、包名

替换后将Application的包扫描路径换成需要的路径

standalone分支使用

启动redis服务。

修改api模块下application.yml文件里的redis、mysql链接信息为你的地址。

microservice分支使用

参考配置文件为nacos-example文件夹下的config.yml

启动nacos、redis服务。

修改api模块下bootstrap.yml的配置信息。

源码下载

项目仍在开发维护，感兴趣可以参与贡献。

GitHub地址：github.com/IsNott/spri…