update docs

readme_zh.md

@@ -1,4 +1,3 @@
-
 # Mybatis-Flex 一个优雅的 Mybatis 增强框架
 
 ## 特征
@@ -19,18 +18,17 @@
 
 ![](./docs/assets/images/qq_group.png)
 
-
 ## 开始
 
 - [Maven 依赖](./docs/zh/maven.md)
 - [示例项目](./mybatis-flex-test)
 
-
 ## hello world
 
 **第一步：编写 Entity 实体类**
 
 ```java
+
 @Table("tb_account")
 public class Account {
 
@@ -55,6 +53,7 @@ public interface AccountMapper extends BaseMapper<Account> {
 **第三步：开始查询数据**
 
 示例 1：查询 1 条数据
+
 ```java
 class HelloWorld {
     public static void main(String... args) {
@@ -100,6 +99,7 @@ List<Account> accounts = MybatisFlexBootstrap.getInstance()
 ```
 
 示例3：分页查询
+
 ```java
 // 示例3：分页查询
 // 查询第 5 页，每页 10 条数据，通过 QueryWrapper 构建条件查询
@@ -254,6 +254,7 @@ QueryWrapper queryWrapper=QueryWrapper.create()
 ```
 
 ### join
+
 ```java
 QueryWrapper queryWrapper=QueryWrapper.create()
         .select()
@@ -277,8 +278,8 @@ QueryWrapper queryWrapper = QueryWrapper.create()
 
 **疑问 2：如何通过实体类 Account.java 生成 QueryWrapper 所需要的 "ACCOUNT" 类 ?**
 
-答：Mybatis-Flex 使用了 APT（Annotation Processing Tool）技术，在项目编译的时候，会自动根据 Entity 类定义的字段帮你生成 "ACCOUNT" 类，
-通过开发工具构建项目（如下图），或者执行 maven 编译命令: `mvn clean package` 都可以自动生成。这个原理和 lombok 一致。
+答：Mybatis-Flex 使用了 APT（Annotation Processing Tool）技术，在项目编译的时候，会自动根据 Entity 类定义的字段帮你生成 "ACCOUNT" 类， 通过开发工具构建项目（如下图），或者执行
+maven 编译命令: `mvn clean package` 都可以自动生成。这个原理和 lombok 一致。
 
 ![](./docs/assets/images/build_idea.png)
 
@@ -286,8 +287,8 @@ QueryWrapper queryWrapper = QueryWrapper.create()
 
 ## Db + Row 工具类
 
-Db + Row 工具类，提供了在 Entity 实体类之外的数据库操作能力。使用 Db + Row 时，无需对数据库表进行映射，
-Row 是一个 HashMap 的子类，相当于一个通用的 Entity。以下为 Db + Row 的一些示例：
+Db + Row 工具类，提供了在 Entity 实体类之外的数据库操作能力。使用 Db + Row 时，无需对数据库表进行映射， Row 是一个 HashMap 的子类，相当于一个通用的 Entity。以下为 Db + Row
+的一些示例：
 
 ```java
 //使用原生 SQL 插入数据
@@ -318,11 +319,12 @@ QueryWrapper query = QueryWrapper.create()
         .where(ACCOUNT.AGE.ge(18));
         Page<Row> rowPage=Db.paginate("tb_account",3,10,query);
 ```
+
 > Db 工具类还提供了更多 增、删、改、查和分页查询等方法。
 >
 > 具体参考： [Db.java](./mybatis-flex-core/src/main/java/com/mybatisflex/core/row/Db.java) 。
 >
-> 更多关于 Row 插入时的**主键生成机制**、以及Db 的**事务管理**等，请点击 [这里](./docs/zh/row_and_db.md) 。
+> 更多关于 Row 插入时的**主键生成机制**、以及Db 的**事务管理**等，请点击 [这里](./docs/zh/db_row.md) 。
 
 ## Entity 部分字段更新
 
@@ -331,6 +333,7 @@ Page<Row> rowPage = Db.paginate("tb_account",3,10,query);
 ```java
 update(T entity,boolean ignoreNulls)
 ```
+
 - 第一个参数是 entity 的对象。
 - 第二个参数是是否忽略 null 值。
 
@@ -344,14 +347,17 @@ account.setSex(1);
 
         accountMapper.update(account,false);
 ```
+
 以上的示例中，会把 id 为 1 这条数据中的 user_name 字段更新为 null，sex 字段更新为 1，其他字段不会被更新。也就是说，通过 `UpdateEntity`
 创建的对象，只会更新调用了 setter 方法的字段，若不调用 setter 方法，不管这个对象里的属性的值是什么，都不会更新到数据库。
 
 其生成的 sql 内容如下：
 
 ```sql
-update tb_account set user_name = ? ,sex = ? where id = ?
-#params: null,1,1
+update tb_account
+set user_name = ?,
+    sex       = ?
+where id = ? #params: null,1,1
 ```
 
 ## 多主键
@@ -359,6 +365,7 @@ update tb_account set user_name = ? ,sex = ? where id = ?
 Mybatis-Flex 多主键就是在 Entity 类里有多个 `@Id` 注解标识而已，比如：
 
 ```java
+
 @Table("tb_account")
 public class Account {
 
@@ -371,6 +378,7 @@ public class Account {
     //getter setter
 }
 ```
+
 当我们保存数据的时候，Account 的 id 主键为自增，而 otherId 主键则通过 uuid 生成。
 
 ### 自定义主键生成器
@@ -396,6 +404,7 @@ KeyGeneratorFactory.register("myUUID", new UUIDKeyGenerator());
 第 3 步：在 Entity 里使用 "myUUID" 生成器：
 
 ```java
+
 @Table("tb_account")
 public class Account {
 
@@ -409,6 +418,7 @@ public class Account {
 ### 使用数据库 Sequence 生成
 
 ```java
+
 @Table("tb_account")
 public class Account {
 
@@ -420,6 +430,15 @@ public class Account {
 
 > 更多关于主键的配置，请点击 [这里](./docs/zh/id.md)
 
+## 更多文档
+
+- [Maven依赖](./docs/zh/maven.md)
+- [主键设置](./docs/zh/id.md)
+- [列的设置](./docs/zh/column.md)
+- [逻辑删除](./docs/zh/logic_delete.md)
+- [乐观锁](./docs/zh/version.md)
+- [Db + Row](./docs/zh/db_row.md)
+- [APT](./docs/zh/apt.md)
 
 ## 更多示例