update docs

This commit is contained in:
开源海哥 2023-05-14 09:47:59 +08:00
parent e33fca582a
commit 3a08a5f399
3 changed files with 15 additions and 15 deletions

View File

@ -24,19 +24,19 @@ Mybaits-Flex 消息包含了如下内容:
- **platform**:平台,或者是运行的应用
- **module**:应用模块
- **url**:执行这个 Sql 涉及的 URL 地址
- **user**:执行这个 Sql 涉及的 平台用户
- **userIp**:执行这个 sql 的平台用户 IP 地址
- **hostIp**:执行这个 sql 的服务器 IP 地址
- **query**sql 内容
- **queryParams**sql 参数
- **queryTime**sql 执行的时间
- **elapsedTime**sql 执行消耗的时间
- **url**:执行这个 SQL 涉及的 URL 地址
- **user**:执行这个 SQL 涉及的 平台用户
- **userIp**:执行这个 SQL 的平台用户 IP 地址
- **hostIp**:执行这个 SQL 的服务器 IP 地址
- **query**SQL 内容
- **queryParams**SQL 参数
- **queryTime**SQL 执行的时间点(当前时间)
- **elapsedTime**SQL 执行的消耗时间(毫秒)
- **metas**:其他扩展元信息
::: tip 提示
> 通过以上的消息内容可知:每个 SQL 的执行,都包含了:哪个访问用户、哪个 IP 地址访问,访问的是哪个 URL 地址,这个 SQL 的参数是什么,执行的时间是什么,执行
> 花费了多少时间等等。这样,通过 Mybatis-flex 的 SQL 审计功能,我们能全盘了解到每个 SQL 的执行情况。
通过以上的消息内容可知:每个 SQL 的执行,都包含了:哪个访问用户、哪个 IP 地址访问,访问的是哪个 URL 地址,这个 SQL 的参数是什么,执行的时间是什么,执行
花费了多少时间等等。这样,通过 Mybatis-flex 的 SQL 审计功能,我们能全盘了解到每个 SQL 的执行情况。
:::

View File

@ -24,12 +24,12 @@ public class Account {
以上的示例中,使用了 `CHINESE_NAME` 的脱敏规则,其主要用于处理 "中文名字" 的场景。当我们查询到 userName 为 `张三丰` 的时候,其内容自动被处理成 `张**`
除此之外Mybatis-Flex 还提供了如下的 8 中脱敏规则,方便开发者直接使用:
除此之外Mybatis-Flex 还提供了如下的 8 中脱敏规则共9种,方便开发者直接使用:
- 手机号脱敏
- 固定电话脱敏
- 身份证号脱敏
- 身份证号脱敏
- 车牌号脱敏
- 地址脱敏
- 邮件脱敏
- 密码脱敏

View File

@ -14,7 +14,7 @@ AuditManager.setMessageCollector(collector);
```
通过以上代码,配置 `AuditManager``MessageCollector``ConsoleMessageCollector` 后,
每次执行 sql 请求,控制台将输入内容如下:
每次执行 SQL 请求,控制台将输入内容如下:
```
Flex exec sql taked 2 ms >>> SELECT * FROM `tb_account` WHERE `id` = 1
@ -23,7 +23,7 @@ Flex exec sql taked 3 ms >>> INSERT INTO `tb_account`(`user_name`, `age`, `birt
控制台输出了完整的 SQL以及 SQL 执行消耗时间,方便我们在开发的时候,对慢 SQL 进行排查和快速定位。
或者在spring工程里将sql打印到日志中可以通过配置日志级别控制是否输出sql通过配置日志Appender控制sql输出目的地。
或者在 Spring 工程里,将 SQL 打印到日志中,可以通过配置日志级别控制是否输出 SQL ,通过配置日志 Appender 控制 SQL 输出目的地。
```java
import com.mybatisflex.core.audit.AuditManager;
import org.slf4j.Logger;
@ -48,7 +48,7 @@ public class MyBatisFlexConfiguration {
```
## 注意
在执行以下语句之后执行的sql才会被打印。如果你发现你有些sql没有打印则需要自行检查sql执行与以下语句执行的先后顺序。
在执行以下语句之后执行的 SQL 才会被打印。如果你发现你有些 SQL 没有打印,则需要自行检查 SQL 执行与以下语句执行的先后顺序。
```
AuditManager.setAuditEnable(true);
AuditManager.setMessageCollector(collector);