From 7faec69c4313eca0d6b2cdf0c3115790b4e079b0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BC=80=E6=BA=90=E6=B5=B7=E5=93=A5?= Date: Sat, 17 Jun 2023 10:44:33 +0800 Subject: [PATCH] update comments --- docs/zh/core/column.md | 2 +- docs/zh/core/columns-permission.md | 2 +- docs/zh/core/fill.md | 2 +- docs/zh/core/id.md | 4 ++-- docs/zh/core/multi-tenancy.md | 2 +- .../src/main/java/com/mybatisflex/annotation/KeyType.java | 2 +- 6 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/zh/core/column.md b/docs/zh/core/column.md index bcc5238c..5982f2e0 100644 --- a/docs/zh/core/column.md +++ b/docs/zh/core/column.md @@ -139,7 +139,7 @@ WHERE `id` = ? ## isLarge -用于标识这个字段是否是大字段，比如说存放文章的文章字段，在一般的场景中是没必要对这个字段进行查询的， 若字段被表示为 `isLarge`，那么 APT 生成 "ARTICLE" 类时，默认不会存放在 DEFAULT_COLUMNS 中，以下 +用于标识这个字段是否是大字段，比如存放文章的文章字段，在一般的场景中是没必要对这个字段进行查询的， 若字段被表示为 `isLarge`，那么 APT 生成 "ARTICLE" 类时，默认不会存放在 DEFAULT_COLUMNS 中，以下 是 Article.java 以及 APT 生成的类： ```java diff --git a/docs/zh/core/columns-permission.md b/docs/zh/core/columns-permission.md index 83263fd6..56c219fb 100644 --- a/docs/zh/core/columns-permission.md +++ b/docs/zh/core/columns-permission.md @@ -1,7 +1,7 @@ # 字段权限 字段权限，指的是在一张表中设计了许多字段，但是不同的用户（或者角色）查询，返回的字段结果是不一致的。 -比如说：tb_account 表中，有 user_name 和 password 字段，但是 password 字段只允许用户本人查询， +比如：tb_account 表中，有 user_name 和 password 字段，但是 password 字段只允许用户本人查询， 或者超级管理员查询，这种场景下，我们会用到 字段权限 的功能。 在 `@Table()` 注解中，有一个配置名为 `onSet`，用于设置这张表的 `设置` 监听，这里的 `设置` 监听指的是： diff --git a/docs/zh/core/fill.md b/docs/zh/core/fill.md index 93c14619..371a6236 100644 --- a/docs/zh/core/fill.md +++ b/docs/zh/core/fill.md @@ -1,6 +1,6 @@ # 数据填充 -数据填充指的是，当 Entity 数据被插入 或者 更新的时候，会为字段进行一些默认的数据设置。这个非常有用，比如说当某个 entity 被插入时候 +数据填充指的是，当 Entity 数据被插入 或者 更新的时候，会为字段进行一些默认的数据设置。这个非常有用，比如当某个 entity 被插入时候 会设置一些数据插入的时间、数据插入的用户 id，多租户的场景下设置当前租户信息等等。 MyBatis-Flex 提供了两种方式，帮助开发者进行数据填充。 diff --git a/docs/zh/core/id.md b/docs/zh/core/id.md index f4e638d5..30316daf 100644 --- a/docs/zh/core/id.md +++ b/docs/zh/core/id.md @@ -69,7 +69,7 @@ public enum KeyType { Generator, /** - * 其他方式，比如说在代码层用户手动设置 + * 其他方式，比如在代码层用户手动设置 */ None, } @@ -163,7 +163,7 @@ public class Account { ## 全局配置 -一般的项目中，通常是许多的 Entity 使用同一个数据库，同时使用一种主键生成方式，比如说都使用 自增， +一般的项目中，通常是许多的 Entity 使用同一个数据库，同时使用一种主键生成方式，比如都使用 自增， 或者都使用通过序列（Sequence）生成，此时，我们是没有必要为每个 Entity 单独配置一样内容的。 MyBatis-Flex 提供了一种全局配置的方式，代码如下： diff --git a/docs/zh/core/multi-tenancy.md b/docs/zh/core/multi-tenancy.md index be1513d9..72732bc9 100644 --- a/docs/zh/core/multi-tenancy.md +++ b/docs/zh/core/multi-tenancy.md @@ -56,7 +56,7 @@ public interface TenantFactory { `getTenantIds` 要求返回一个数组，原因有如下场景： - **场景1**：租户对自己的数据进行增删改查，返回的 `Object[]` 数组只有租户自己的 ID 就可以了。 -- **场景2**：租户可以对自己，以及其他租户（比如说下级租户）的数据进行增删改查，那么要求返回的 `Object[]` 必须包含其他租户的 ID。比如某个数据列表， +- **场景2**：租户可以对自己，以及其他租户（比如下级租户）的数据进行增删改查，那么要求返回的 `Object[]` 必须包含其他租户的 ID。比如某个数据列表， 除了显示租户自己的数据以外，还包含下级租户的数据，这种场景则要求 `getTenantIds` 返回多个值。 - **场景3**：忽略租户条件，由代码自定义条件查询，此项要求 `getTenantIds` 返回 null 或者 空数组。 diff --git a/mybatis-flex-annotation/src/main/java/com/mybatisflex/annotation/KeyType.java b/mybatis-flex-annotation/src/main/java/com/mybatisflex/annotation/KeyType.java index d26fa7b2..0a7b7d03 100644 --- a/mybatis-flex-annotation/src/main/java/com/mybatisflex/annotation/KeyType.java +++ b/mybatis-flex-annotation/src/main/java/com/mybatisflex/annotation/KeyType.java @@ -37,7 +37,7 @@ public enum KeyType { Generator, /** - * 其他方式，比如说在代码层用户手动设置 + * 其他方式，比如在代码层用户手动设置 */ None, }