1 Star 0 Fork 0

帶頭二哥/springboot-project

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MulanPSL-2.0

Java基于SpringBoot封装的脚手架技术文档


📌 一、项目概述

本项目是基于 Spring Boot 3.0 的企业级后台管理系统,采用模块化架构设计,包含通用工具模块、数据模型模块及前后端分离的WEB服务模块。系统集成JWT认证、MyBatis-Plus快速开发、Redis缓存及Knife4j接口文档,适用于中大型企业级应用的后台管理场景。


🛠️ 二、技术栈详情

技术组件 版本 说明
Spring Boot 3.0.5 核心框架,提供自动配置、依赖管理及快速开发支持
MyBatis-Plus 3.5.3 持久层增强工具,简化CRUD操作,支持逻辑删除、自动填充等特性
Spring Security 6.1.0 安全框架,结合JWT实现接口权限控制
Knife4j 4.1.0 Swagger增强工具,提供可视化API文档及测试功能
Redis 6.2 内存数据库,用于缓存用户会话、令牌黑名单及高频访问数据
Maven 3.8.6 依赖管理工具,父工程统一管理所有子模块依赖版本
Flyway 9.11.0 数据库迁移工具,确保环境数据库结构一致性

📦 三、模块详细说明

3.1 通用模块(common)

职责:提供全局通用功能,包括工具类、统一响应封装、第三方组件配置等。

核心目录结构

common/
├── src/main/java/
│   ├── com.example.common.util/       # 工具类(JwtUtil/RedisUtil/SmsUtil)
│   ├── com.example.common.config/     # 配置类(RedisConfiguration/MyBatisPlusConfig)
│   └── com.example.common.domain/     # 领域模型(Result/ResultCodeEnum)
└── src/main/resources/
    ├── application-common.yml         # 通用配置文件
    └── logback-spring.xml             # 日志配置文件

3.2 数据模型模块(model)

职责:定义数据库实体类及MyBatis映射关系。

核心功能点

  • com.example.model.entity:数据库实体类(如User/Role/Menu),使用@TableName/@TableField注解映射表结构
  • com.example.model.mapper:继承BaseMapper的接口类(如UserMapper),自动生成CRUD方法
  • src/main/resources/mapper:XML格式自定义SQL(复杂查询场景)

3.3 WEB模块(web)

3.3.1 后台管理系统(admin)

职责:提供后台管理端接口(用户管理/角色权限/日志监控)。

关键组件

包路径 功能说明
com.example.admin.controller 用户/角色/日志等功能的HTTP接口层
com.example.admin.service 业务逻辑实现层(密码加密/权限分配)
src/main/resources/mapper/admin 后台管理相关自定义SQL文件
application-admin.yml 服务端口(8555)、JWT密钥、Redis连接配置

3.3.2 前端接口服务(api)

职责:提供前端应用调用的业务接口(商品查询/订单提交)。

特色实现

  • GoodsController:商品列表查询(带Redis缓存)、详情接口
  • OrderController:订单提交(事务控制)、支付回调处理
  • application-api.yml:接口限流(Sentinel)、短信服务AK/SK配置

🚀 四、核心功能实现细节

4.1 MyBatis-Plus增强配置

// MyBatisPlusConfig.java
@Configuration
public class MyBatisPlusConfig {
    // 分页插件配置
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
        return interceptor;
    }

    // 自动填充配置(创建时间自动赋值)
    @Bean
    public MetaObjectHandler metaObjectHandler() {
        return new MyMetaObjectHandler() {
            @Override
            public void insertFill(MetaObject metaObject) {
                this.strictInsertFill(metaObject, "createTime", LocalDateTime::now, LocalDateTime.class);
            }
        };
    }
}

4.2 JWT认证流程详解

  1. 登录验证:用户提交账号密码 → UserDetailsService查询用户信息 → 密码匹配后生成双token
  2. token生成
    • access_token(15分钟有效期):用于接口访问
    • refresh_token(7天有效期):用于刷新access_token
  3. 拦截校验JwtAuthenticationFilter从请求头提取token → JwtUtil校验签名和过期时间 → 解析用户信息存入SecurityContext
  4. 登出处理:将token加入Redis黑名单(与token剩余有效期同步过期)

⚡ 五、快速启动指南

5.1 环境准备

环境组件 版本要求 说明
JDK 17+(推荐OpenJDK) 必须安装17及以上版本
MySQL 8.0+ 提前创建数据库api_db(utf8mb4)
Redis 6.2+ 默认端口6379(无密码)
Maven 3.8+ 配置阿里云镜像加速下载依赖

5.2 初始化数据库

# 在父工程目录执行,自动执行flyway迁移
mvn flyway:migrate -Dflyway.url=jdbc:mysql://localhost:3306/api_db -Dflyway.user=root -Dflyway.password=123456

5.3 启动服务

# 启动后台管理系统(端口8555)
cd web/admin && mvn spring-boot:run

# 启动前端接口服务(端口8666)
cd ../api && mvn spring-boot:run

5.4 验证服务

  • 后台API文档:http://localhost:8555/doc.html 🌟
  • 前端接口文档:http://localhost:8666/doc.html 🌟

📝 六、接口规范

6.1 统一响应格式

{
  "code": 200,          // 业务状态码(200成功,400参数错误,401未认证,500服务器错误)
  "message": "操作成功", // 提示信息
  "data": {
    "id": 1,
    "username": "admin"
  },
  "timestamp": 1712345678900 // 响应时间戳
}

6.2 错误码说明

错误码 说明 示例场景
200 ✅ 成功 正常接口调用
400 ⚠️ 参数校验失败 手机号格式错误
401 🔒 token无效/过期 access_token过期未刷新
403 ❌ 无访问权限 普通用户尝试访问管理员接口
500 🛑 服务器内部错误 数据库连接失败

⚠️ 七、注意事项

7.1 配置管理

生产环境需在application-prod.yml中补充:

  • mybatis-plus.configuration.log-impl: null(关闭SQL日志)
  • spring.redis.password: your_redis_password(配置Redis密码)
  • jwt.secret: your_32bit_random_string(设置高强度JWT密钥)

7.2 性能优化

  • 高频查询接口(如商品列表)添加Redis缓存(设置合理过期时间)
  • 批量操作(如用户导入)使用MyBatis-Plus.saveBatch(默认100条/批)

7.3 安全加固

  • 接口权限控制:@PreAuthorize("hasRole('ADMIN')")(限制管理员访问)
  • 敏感信息存储:用户密码使用BCrypt加密(盐值自动生成)

7.4 监控报警

  • 集成Spring Boot Actuator,暴露/health//metrics监控端点
  • 配置Prometheus+Grafana监控QPS、数据库连接数等核心指标
木兰宽松许可证,第2版 木兰宽松许可证,第2版 2020年1月 http://license.coscl.org.cn/MulanPSL2 您对“软件”的复制、使用、修改及分发受木兰宽松许可证,第2版(“本许可证”)的如下条款的约束: 0. 定义 “软件” 是指由“贡献”构成的许可在“本许可证”下的程序和相关文档的集合。 “贡献” 是指由任一“贡献者”许可在“本许可证”下的受版权法保护的作品。 “贡献者” 是指将受版权法保护的作品许可在“本许可证”下的自然人或“法人实体”。 “法人实体” 是指提交贡献的机构及其“关联实体”。 “关联实体” 是指,对“本许可证”下的行为方而言,控制、受控制或与其共同受控制的机构,此处的控制是 指有受控方或共同受控方至少50%直接或间接的投票权、资金或其他有价证券。 1. 授予版权许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的版权许可,您可 以复制、使用、修改、分发其“贡献”,不论修改与否。 2. 授予专利许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的(根据本条规定 撤销除外)专利许可,供您制造、委托制造、使用、许诺销售、销售、进口其“贡献”或以其他方式转移其“贡 献”。前述专利许可仅限于“贡献者”现在或将来拥有或控制的其“贡献”本身或其“贡献”与许可“贡献”时的“软 件”结合而将必然会侵犯的专利权利要求,不包括对“贡献”的修改或包含“贡献”的其他结合。如果您或您的“ 关联实体”直接或间接地,就“软件”或其中的“贡献”对任何人发起专利侵权诉讼(包括反诉或交叉诉讼)或 其他专利维权行动,指控其侵犯专利权,则“本许可证”授予您对“软件”的专利许可自您提起诉讼或发起维权 行动之日终止。 3. 无商标许可 “本许可证”不提供对“贡献者”的商品名称、商标、服务标志或产品名称的商标许可,但您为满足第4条规定 的声明义务而必须使用除外。 4. 分发限制 您可以在任何媒介中将“软件”以源程序形式或可执行形式重新分发,不论修改与否,但您必须向接收者提供“ 本许可证”的副本,并保留“软件”中的版权、商标、专利及免责声明。 5. 免责声明与责任限制 “软件”及其中的“贡献”在提供时不带任何明示或默示的担保。在任何情况下,“贡献者”或版权所有者不对 任何人因使用“软件”或其中的“贡献”而引发的任何直接或间接损失承担责任,不论因何种原因导致或者基于 何种法律理论,即使其曾被建议有此种损失的可能性。 6. 语言 “本许可证”以中英文双语表述,中英文版本具有同等法律效力。如果中英文版本存在任何冲突不一致,以中文 版为准。 条款结束 如何将木兰宽松许可证,第2版,应用到您的软件 如果您希望将木兰宽松许可证,第2版,应用到您的新软件,为了方便接收者查阅,建议您完成如下三步: 1, 请您补充如下声明中的空白,包括软件名、软件的首次发表年份以及您作为版权人的名字; 2, 请您在软件包的一级目录下创建以“LICENSE”为名的文件,将整个许可证文本放入该文件中; 3, 请将如下声明文本放入每个源文件的头部注释中。 Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details. Mulan Permissive Software License,Version 2 Mulan Permissive Software License,Version 2 (Mulan PSL v2) January 2020 http://license.coscl.org.cn/MulanPSL2 Your reproduction, use, modification and distribution of the Software shall be subject to Mulan PSL v2 (this License) with the following terms and conditions: 0. Definition Software means the program and related documents which are licensed under this License and comprise all Contribution(s). Contribution means the copyrightable work licensed by a particular Contributor under this License. Contributor means the Individual or Legal Entity who licenses its copyrightable work under this License. Legal Entity means the entity making a Contribution and all its Affiliates. Affiliates means entities that control, are controlled by, or are under common control with the acting entity under this License, ‘control’ means direct or indirect ownership of at least fifty percent (50%) of the voting power, capital or other securities of controlled or commonly controlled entity. 1. Grant of Copyright License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable copyright license to reproduce, use, modify, or distribute its Contribution, with modification or not. 2. Grant of Patent License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable (except for revocation under this Section) patent license to make, have made, use, offer for sale, sell, import or otherwise transfer its Contribution, where such patent license is only limited to the patent claims owned or controlled by such Contributor now or in future which will be necessarily infringed by its Contribution alone, or by combination of the Contribution with the Software to which the Contribution was contributed. The patent license shall not apply to any modification of the Contribution, and any other combination which includes the Contribution. If you or your Affiliates directly or indirectly institute patent litigation (including a cross claim or counterclaim in a litigation) or other patent enforcement activities against any individual or entity by alleging that the Software or any Contribution in it infringes patents, then any patent license granted to you under this License for the Software shall terminate as of the date such litigation or activity is filed or taken. 3. No Trademark License No trademark license is granted to use the trade names, trademarks, service marks, or product names of Contributor, except as required to fulfill notice requirements in section 4. 4. Distribution Restriction You may distribute the Software in any medium with or without modification, whether in source or executable forms, provided that you provide recipients with a copy of this License and retain copyright, patent, trademark and disclaimer statements in the Software. 5. Disclaimer of Warranty and Limitation of Liability THE SOFTWARE AND CONTRIBUTION IN IT ARE PROVIDED WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED. IN NO EVENT SHALL ANY CONTRIBUTOR OR COPYRIGHT HOLDER BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO ANY DIRECT, OR INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING FROM YOUR USE OR INABILITY TO USE THE SOFTWARE OR THE CONTRIBUTION IN IT, NO MATTER HOW IT’S CAUSED OR BASED ON WHICH LEGAL THEORY, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 6. Language THIS LICENSE IS WRITTEN IN BOTH CHINESE AND ENGLISH, AND THE CHINESE VERSION AND ENGLISH VERSION SHALL HAVE THE SAME LEGAL EFFECT. IN THE CASE OF DIVERGENCE BETWEEN THE CHINESE AND ENGLISH VERSIONS, THE CHINESE VERSION SHALL PREVAIL. END OF THE TERMS AND CONDITIONS How to Apply the Mulan Permissive Software License,Version 2 (Mulan PSL v2) to Your Software To apply the Mulan PSL v2 to your work, for easy identification by recipients, you are suggested to complete following three steps: i. Fill in the blanks in following statement, including insert your software name, the year of the first publication of your software, and your name identified as the copyright owner; ii. Create a file named "LICENSE" which contains the whole context of this License in the first directory of your software package; iii. Attach the statement to the appropriate annotated syntax at the beginning of each source file. Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details.

简介

脚手架开箱即用 展开 收起
README
MulanPSL-2.0
取消

发行版

暂无发行版

贡献者

全部

语言

近期动态

不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/nacker/springboot-project.git
git@gitee.com:nacker/springboot-project.git
nacker
springboot-project
springboot-project
master

搜索帮助