【亲测可用】Spring Boot + H2 + MyBatis-Plus + Swagger 使用示例
【亲测可用】Spring Boot + H2 + MyBatis-Plus + Swagger 使用示例
这是一个把 Spring Boot、H2、MyBatis-Plus 和 Swagger 整合在一起的完整示例。它用 H2 作为嵌入在 JVM 里的数据库,免去先装 MySQL 或配置连接串这一步,应用一启动就能查库、调接口。适合想快速搭一套后端脚手架,或需要一份可运行演示、测试环境的开发者。
🔧 它好在哪
- 零外部依赖:H2 是嵌入式数据库,数据放在内存里(
jdbc:h2:mem:mybatis),不用先装 MySQL 或维护连接串,克隆下来就能跑。 - 启动即建表:
application.yml指向db/schema.sql和db/data.sql,应用启动时自动建表并灌入两条测试数据,重启即重置,天然适合测试。 - CRUD 不用手写 SQL:MyBatis-Plus 的
BaseMapper和IService直接给出增删改查,示例里StudentMapper、StudentService都是空接口就能工作。 - 接口文档自带:配好 Swagger 后,
/doc.html就是一个能直接点着调的接口页,前后端联调不用翻文档。
核心组件拆解
Spring Boot —— 把整套服务跑起来
Spring Boot 负责内嵌 Tomcat 并管理所有 Bean 的生命周期。本项目基于 2.5.2(Java 8),H2TestApplication 上加的 @MapperScan 和 @EnableSwagger2 两个注解,分别激活 MyBatis-Plus 的 Mapper 扫描和 Swagger 文档生成。
H2 —— 内存里的一整个数据库
H2 是一个用 Java 写的嵌入式数据库引擎,本例用内存模式 jdbc:h2:mem:mybatis,随应用启动、随应用销毁。开启 spring.h2.console.enabled=true 后,浏览器访问 /h2-console 就能在线查表,不用装数据库客户端。
MyBatis-Plus —— 省掉增删改查的样板代码
它是 MyBatis 的增强版,StudentMapper extends BaseMapper<Student>、StudentService extends IService<Student> 两个空接口就自带 list()、getById() 等方法。配合 map-underscore-to-camel-case: true,下划线列名会自动映射到驼峰字段。
Swagger —— 自动生成可点击的接口页
本项目用 springfox 2.9.2 搭配 swagger-bootstrap-ui,SwaggerConfig 里配一个 Docket Bean 并指定 basePackage。访问 /doc.html 就能看到按 Controller 分组、可直接调用的接口文档。
什么时候用它
- 开发联调:后端一起就能在
/doc.html里直接调接口,前端不必等真实数据库就绪。 - 单元测试与集成测试:内存库每次启动都是全新状态,配合
data.sql灌入固定数据,测试可重复执行。 - 演示与培训:交付一个可运行的 demo 时,H2 免安装、跨平台,拿到就能跑。
- 学习 MyBatis-Plus / Swagger:想看清
BaseMapper、IService、Docket到底怎么串起来,这是个最小可运行的参照。
⚡ 从零跑起来
- 克隆仓库:
git clone https://gitcode.com/Premium-Resources/a4f29 - 解压 h2-test.zip,得到标准 Maven 工程
h2-test/ - 用 IDE 导入
h2-test/目录,确认pom.xml依赖能正常下载(Spring Boot 2.5.2、Java 8) - 直接运行
H2TestApplication——默认内存 H2,无需外部配置,启动时自动执行schema.sql建表、data.sql灌数 - 打开 Swagger 文档页
http://localhost:8888/doc.html(或/swagger-ui.html),调用GET /test/list验证返回 - 要查数据就访问 H2 控制台
http://localhost:8888/h2-console,JDBC URL 填jdbc:h2:mem:mybatis、用户名root、密码123456
进阶提示 / 常见坑
- 版本别乱升:springfox 2.9.2 只兼容到 Spring Boot 2.5.x;升到 2.6+ 要加
spring.mvc.pathmatch.matching-strategy=ant_path_matcher,而 Spring Boot 3 基本没法用(Springfox 已停止维护,需换 springdoc-openapi)。 - 内存库不持久:
mem:mybatis重启即清空,要落盘就把application.yml的url换成文件模式,注释里留有jdbc:h2:文件路径;MODE=MYSQL的写法可参考。 - 控制台别暴露到生产:
spring.h2.console.enabled=true方便调试,上线前应关掉,避免被人直接连库。
这套组合把「搭库、建表、写 CRUD、看接口」压进一次启动里,适合作为 Spring Boot 后端脚手架的起点。完整工程在 h2-test.zip 里,说明见 README.md。