Skip to content

Commit 063b279

Browse files
wangshu-gwangshu-g
committed
intro.md
1 parent 3fc3c62 commit 063b279

File tree

1 file changed

+71
-56
lines changed

1 file changed

+71
-56
lines changed

‎docs/docs/intro.md‎

Lines changed: 71 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,45 @@
22
sidebar_position: 1
33
---
44

5-
# 项目简介
5+
# 📘 项目简介
66

7-
## 介绍
7+
mybatis-xml-fast-develop 是一个面向 Spring Boot + MyBatis 的快速开发框架插件，旨在通过编译期自动生成 MyBatis
8+
XML、Mapper、ServiceInterface、ServiceInstance、Controller 等模板代码，从而大幅减少使用 Mybatis 时繁琐的工作。其设计目标是零侵入、零学习成本，不引入神秘黑盒逻辑，尤其对喜爱Mybatis
9+
XML开发极其友好。
810

9-
一个 mybatis-xml、spring boot 快速开发集合、mybatis-xml 编译期类似 lombok 的插件。
11+
* 它完全基于 MyBatis XML 原生机制实现
12+
* 自动在编译期根据实体、注解生成对应的 XML 映射与 SQL；
13+
* 支持常见数据库（MySQL / PostgreSQL / Oracle / SQL Server / MariaDB / 达梦等）；
14+
* 支持多种命名风格（如驼峰、下划线、上划线等）；
15+
* 包括核心模块、自动建表、生成模块、编译期插件与示例工程等；
16+
* 可作为 “Lombok + MyBatis XML 生成器” 插件使用，让开发者免于手写冗长的 XML。
1017

11-
用法类似 lombok，通过编译期生成模板 xml。
18+
它完全基于 MyBatis 原生扩展机制实现，引入后：
1219

13-
其完全基于 mybatis xml 扩展功能，因此引入后不会为团队带来任何学习成本和心智负担，几乎为零的侵入性，不存在任何黑盒
20+
* 几乎 **零学习成本**、**零心智负担**；
21+
* 对现有项目 **无侵入性**；
22+
* **无黑盒逻辑**，可直接查看、调试、修改生成的 XML 文件。
1423

15-
## 文档网站
24+
---
25+
26+
## 🌐 官方文档
1627

17-
https://wangshu-g.github.io/mybatis-xml-fast-develop-docs/
28+
👉 [mybatis-xml-fast-develop-docs](https://wangshu-g.github.io/mybatis-xml-fast-develop-docs/)
29+
30+
---
1831

19-
## 如何使用
32+
## 🚀 快速使用
2033

21-
注意：请使用 maven 不再使用 github packages（后续将会清理掉）
34+
> ⚠️ 请使用 **Maven Central** 仓库，不再使用 GitHub Packages（后续将清理 GitHub Packages）。
2235
23-
maven 仓库链接:
36+
Maven 仓库地址：
37+
🔗 [https://central.sonatype.com/artifact/io.github.wangshu-g/mybatis-xml-fast-develop](https://central.sonatype.com/artifact/io.github.wangshu-g/mybatis-xml-fast-develop)
2438

25-
https://central.sonatype.com/artifact/io.github.wangshu-g/mybatis-xml-fast-develop
39+
### 📦 Maven 依赖示例
2640

2741
```xml
2842

29-
<dependencys>
43+
<dependencies>
3044

3145
<dependency>
3246
<groupId>io.github.wangshu-g</groupId>
@@ -40,74 +54,75 @@ https://central.sonatype.com/artifact/io.github.wangshu-g/mybatis-xml-fast-devel
4054
<version>1.6.1</version>
4155
</dependency>
4256

43-
<!--这个引入 mybatis-xml-fast-develop-generate-compile-time 就不需要自己手动调用生成了-->
57+
<!-- 引入后无需手动执行生成操作 -->
4458
<dependency>
4559
<groupId>io.github.wangshu-g</groupId>
4660
<artifactId>mybatis-xml-fast-develop-generate</artifactId>
4761
<version>1.6.1</version>
4862
</dependency>
4963

64+
<!-- 编译期生成插件（类似 Lombok） -->
5065
<dependency>
5166
<groupId>io.github.wangshu-g</groupId>
5267
<artifactId>mybatis-xml-fast-develop-generate-compile-time</artifactId>
5368
<version>1.6.1</version>
54-
<!--对于项目中存在某些动态编译场景，这里很重要哦！！！（编译不会引入该依赖）-->
55-
<scoppe>provided</scoppe>
69+
<!-- 对于存在动态编译场景的项目，该配置非常重要 -->
70+
<scope>provided</scope>
5671
</dependency>
5772

58-
</dependencys>
59-
73+
</dependencies>
6074
```
6175

62-
## 生成语法和自动建表数据库支持
76+
---
77+
78+
## 🗄️ 数据库支持与自动建表
6379

64-
受限于精力，一些数据库语法生成暂未支持，欢迎一起开发适配反馈
80+
> 当前版本已适配多种数据库类型（部分生成语法仍在完善中，欢迎参与适配与反馈）
6581
66-
| 枚举值 | 数据库类型说明 | 测试镜像版本 | 精确版本 |
67-
|-------------------------|----------------------|----------------------------------------------------|---------------------------------------------------------------------------------|
68-
| DataBaseType.oracle | Oracle | container-registry.oracle.com/database/free:latest | Oracle Database 23ai Free Release 23.0.0.0.0 - Develop, Learn, and Run for Free |
69-
| DataBaseType.mssql | Microsoft SQL Server | mcr.microsoft.com/mssql/server:2019-latest | Microsoft SQL Server 2019 (RTM-CU32-GDR) (KB5063757) - 15.0.4440.1 (X64) |
70-
| DataBaseType.postgresql | Postgresql | postgres:latest | PostgreSQL 17.6 (Debian 17.6-1.pgdg13+1) |
71-
| DataBaseType.mysql | MySQL（默认） | mysql:8 | 8.4.6 |
72-
| DataBaseType.mariadb | MariaDB | mariadb:latest | 12.0.2-MariaDB-ubu2404 |
73-
| DataBaseType.dameng | 达梦数据库（Dameng） | dm8_single:dm8_20240715_rev232765_x86_rh6_64 | 8 |
82+
| 枚举值 | 数据库类型 | 测试镜像版本 | 精确版本 |
83+
|---------------------------|----------------------|------------------------------------------------------|----------------------------------------------|
84+
| `DataBaseType.oracle` | Oracle | `container-registry.oracle.com/database/free:latest` | Oracle Database 23ai Free Release 23.0.0.0.0 |
85+
| `DataBaseType.mssql` | Microsoft SQL Server | `mcr.microsoft.com/mssql/server:2019-latest` | SQL Server 2019 (RTM-CU32-GDR, 15.0.4440.1) |
86+
| `DataBaseType.postgresql` | PostgreSQL | `postgres:latest` | PostgreSQL 17.6 |
87+
| `DataBaseType.mysql` | MySQL（默认） | `mysql:8` | MySQL 8.4.6 |
88+
| `DataBaseType.mariadb` | MariaDB | `mariadb:latest` | MariaDB 12.0.2 |
89+
| `DataBaseType.dameng` | 达梦数据库（Dameng） | `dm8_single:dm8_20240715_rev232765_x86_rh6_64` | DM8 v8 |
7490

75-
测试用例存在未覆盖情况，如有问题，请反馈
91+
> 测试用例部分数据库尚未完全覆盖，如发现问题，欢迎反馈。
7692
77-
## 常用sql语法风格
93+
---
94+
95+
## 🧾 SQL 命名风格
7896

79-
| 枚举值 | 命名风格 | 示例 |
80-
|--------------|-----------------------------|-----------|
81-
| SqlStyle.lcc | Lower Camel Case（默认，小写开头驼峰） | `userId` |
82-
| SqlStyle.sc | Snake Case（小写蛇形） | `user_id` |
83-
| SqlStyle.su | Snake Upper（大写蛇形） | `USER_ID` |
97+
| 枚举值 | 命名风格 | 示例 |
98+
|----------------|---------------------------|-----------|
99+
| `SqlStyle.lcc` | Lower Camel Case（默认，小写驼峰） | `userId` |
100+
| `SqlStyle.sc` | Snake Case（小写下划线） | `user_id` |
101+
| `SqlStyle.su` | Snake Upper（大写下划线） | `USER_ID` |
84102

85-
## 模块简介
103+
---
86104

87-
+ mybatis-xml-fast-develop-core
88-
+ 基本功能，基类、字段、注解关联关系标识
89-
+ mybatis-xml-fast-develop-starter
90-
+ 启动自动建表，异常控制
91-
+ mybatis-xml-fast-develop-generate
92-
+ 主要代码生成模块
93-
+ mybatis-xml-fast-develop-generate-compile-time
94-
+ 以上的是子弹，这个就是全自动步枪。
95-
+ 类似 lombok，编译期根据配置生成，一键启动支持，还会根据包名将生成的源代码自动拷贝至源代码处（不会覆盖原同名文件），方便开发修改
96-
+ 该组件解决使用 mybatis 及其相关组件进行开发时，sql、结构体映射等 xml 编写复杂耗时等问题，连表仅需在 model 基类字段添加注解即可
97-
+ 如果没有被触发，这是因为 IDEA 编辑器的编译变更策略导致，手动 Build --> Rebuild Module 'xxx'(Ctrl Shift F9)
98-
+ mybatis-xml-fast-develop-example
99-
+ 最佳实践案例
100-
+ mybatis-xml-fast-develop-single-example 单体应用案例
101-
+ mybatis-xml-fast-develop-multiple-module-example 多模块应用案例
105+
## 🧩 模块说明
102106

103-
## 视频使用演示
107+
| 模块 | 功能说明 |
108+
|----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------|
109+
| **mybatis-xml-fast-develop-core** | 基础功能：基类、字段定义、注解映射等核心逻辑 |
110+
| **mybatis-xml-fast-develop-starter** | 自动建表、异常控制、应用启动支持 |
111+
| **mybatis-xml-fast-develop-generate** | 主体代码生成模块 |
112+
| **mybatis-xml-fast-develop-generate-compile-time** | 编译期自动生成模块，类似 Lombok，可根据注解与配置在编译阶段自动生成 XML 与源代码（不会覆盖原文件）。若未触发生成，可执行 `Build → Rebuild Module (Ctrl+Shift+F9)` 重新编译。 |
113+
| **mybatis-xml-fast-develop-example** | 示例项目集合（包含单体与多模块示例） |
104114

105-
https://www.bilibili.com/video/BV17t5kzNEU2
115+
---
106116

107-
## 联系方式
117+
## 🎥 视频演示
118+
119+
📺 [点击查看使用演示（Bilibili）](https://www.bilibili.com/video/BV17t5kzNEU2)
120+
121+
---
108122

109-
2560334673@qq.com
123+
## 📬 联系方式
110124

111-
wangshu10086@gmail.com
125+
* 📧 [2560334673@qq.com](mailto:2560334673@qq.com)
126+
* 📧 [wangshu10086@gmail.com](mailto:wangshu10086@gmail.com)
112127

113-
表明来意哦，欢迎一起开发适配
128+
> 请在邮件中注明来意，欢迎开发者共同参与适配与功能扩展！

0 commit comments

Comments
 (0)