From 32ac7fc7e97de23a34599ed3d3aa3b15e41f79dd Mon Sep 17 00:00:00 2001 From: wangjun Date: Tue, 19 Sep 2023 15:33:10 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E5=AE=8C=E5=96=84=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/content/user-guide/zh/deploy/github.md | 7 +- .../user-guide/zh/infrastructure/log.md | 26 +++++++ docs/content/user-guide/zh/modules/dic.md | 70 ++++++++++--------- docs/content/user-guide/zh/modules/file.md | 2 +- docs/content/user-guide/zh/modules/signalr.md | 4 +- docs/content/user-guide/zh/problem/ef.md | 13 ++++ docs/mkdocs.yml | 3 - 7 files changed, 81 insertions(+), 44 deletions(-) diff --git a/docs/content/user-guide/zh/deploy/github.md b/docs/content/user-guide/zh/deploy/github.md index 0289494e..292fe5c2 100644 --- a/docs/content/user-guide/zh/deploy/github.md +++ b/docs/content/user-guide/zh/deploy/github.md @@ -1,5 +1,4 @@ -# Github自动化部署 - +# Github 自动化部署 ## 添加部署 yaml @@ -97,7 +96,7 @@ password=1q2w3E*. ; # 管理web端登录密码 ``` - 查看是否能访问 http://ip:9001 - ![](https://blog-resouce.oss-cn-shenzhen.aliyuncs.com/images/abp/supervisor.png) + ![](https://blog-resouce.oss-cn-shenzhen.aliyuncs.com/images/abp/supervisor.png){: .zoom} - 添加 Lion.AbpPro.HttpApi.Host.ini @@ -153,7 +152,7 @@ systemctl enable nginx # 启用开机启动 Nginx ``` - 访问 http://ip:80 - ![](https://ask.qcloudimg.com/http-save/yehe-4727679/f0shutgsl8.png?imageView2/2/w/1620) + ![](https://ask.qcloudimg.com/http-save/yehe-4727679/f0shutgsl8.png?imageView2/2/w/1620){: .zoom} -- 配置 Yml diff --git a/docs/content/user-guide/zh/infrastructure/log.md b/docs/content/user-guide/zh/infrastructure/log.md index 6cbb55bd..ae4ca6f6 100644 --- a/docs/content/user-guide/zh/infrastructure/log.md +++ b/docs/content/user-guide/zh/infrastructure/log.md @@ -126,3 +126,29 @@ public class SampleAppService : AbpProAppService,ISampleAppService } } ``` + +## 日志追加字段 + +```csharp +/// +/// 自定义追加日志内容 +/// +/// +/// 日志内容 +/// 日志级别 +/// 追加内容 +public static void Custom(this ILogger logger, string message, LogLevel level = LogLevel.Information, Dictionary dictionary = null) +{ + if (dictionary == null || dictionary.Count == 0) + { + logger.Log(level, message); + } + else + { + using (logger.BeginScope(dictionary)) + { + logger.Log(level, message); + } + } +} +``` diff --git a/docs/content/user-guide/zh/modules/dic.md b/docs/content/user-guide/zh/modules/dic.md index ceaef713..9dd78c0f 100644 --- a/docs/content/user-guide/zh/modules/dic.md +++ b/docs/content/user-guide/zh/modules/dic.md @@ -1,6 +1,7 @@ # 数据字典模块 -Abp自带的Setting模块可能满足不了需求,特意提供数据字典模块。 -![](../../../img/dic.png) + +Abp 自带的 Setting 模块可能满足不了需求,特意提供数据字典模块。 +![](../../../img/dic.png){: .zoom} ## 安装 @@ -16,42 +17,43 @@ Abp自带的Setting模块可能满足不了需求,特意提供数据字典模 - 添加 DependsOn(typeof(DataDictionaryManagementXxxModule)) 特性到对应模块。 -- 在EntityFrameworkCore层添加数据库配置在AbpProDbContext.cs的OnModelCreating()方法中添加builder.ConfigureDataDictionaryManagement(); +- 在 EntityFrameworkCore 层添加数据库配置在 AbpProDbContext.cs 的 OnModelCreating()方法中添加 builder.ConfigureDataDictionaryManagement(); ## 实体 + **DataDictionary** 表结构: -字段名 | 描述 | 类型 -:---|:---|:--- -Id | Id | Guid -TenantId | 租户id | Guid? -Code | 字典编码 | string -DisplayText | 显示名 | string -Description | 描述 | DateTime -Details | 字典明细 | List -IsDeleted | 是否删除 | bool -DeleterId | 删除人 | Guid? -DeletionTime | 删除时间 | DateTime -LastModifierId | 最后修改人 | Guid? -LastModificationTime | 最后修改时间 | DateTime -CreatorId | 创建人 | Guid? -CreationTime | 创建时间 | DateTime +| 字段名 | 描述 | 类型 | +| :------------------- | :----------- | :------------------------- | +| Id | Id | Guid | +| TenantId | 租户 id | Guid? | +| Code | 字典编码 | string | +| DisplayText | 显示名 | string | +| Description | 描述 | DateTime | +| Details | 字典明细 | List | +| IsDeleted | 是否删除 | bool | +| DeleterId | 删除人 | Guid? | +| DeletionTime | 删除时间 | DateTime | +| LastModifierId | 最后修改人 | Guid? | +| LastModificationTime | 最后修改时间 | DateTime | +| CreatorId | 创建人 | Guid? | +| CreationTime | 创建时间 | DateTime | **DataDictionaryDetail** 表结构: -字段名 | 描述 | 类型 -:---|:---|:--- -Id | Id | Guid -DataDictionaryId | 所属字典Id | Guid -Order | 排序 | Int -Code | 字典编码 | string -IsEnabled | 启/停用(默认启用) | bool -DisplayText | 显示名 | string -Description | 描述 | DateTime -IsDeleted | 是否删除 | bool -DeleterId | 删除人 | Guid? -DeletionTime | 删除时间 | DateTime -LastModifierId | 最后修改人 | Guid? -LastModificationTime | 最后修改时间 | DateTime -CreatorId | 创建人 | Guid? -CreationTime | 创建时间 | DateTime \ No newline at end of file +| 字段名 | 描述 | 类型 | +| :------------------- | :---------------- | :------- | +| Id | Id | Guid | +| DataDictionaryId | 所属字典 Id | Guid | +| Order | 排序 | Int | +| Code | 字典编码 | string | +| IsEnabled | 启/停用(默认启用) | bool | +| DisplayText | 显示名 | string | +| Description | 描述 | DateTime | +| IsDeleted | 是否删除 | bool | +| DeleterId | 删除人 | Guid? | +| DeletionTime | 删除时间 | DateTime | +| LastModifierId | 最后修改人 | Guid? | +| LastModificationTime | 最后修改时间 | DateTime | +| CreatorId | 创建人 | Guid? | +| CreationTime | 创建时间 | DateTime | diff --git a/docs/content/user-guide/zh/modules/file.md b/docs/content/user-guide/zh/modules/file.md index 80ceff59..6dbc7aa1 100644 --- a/docs/content/user-guide/zh/modules/file.md +++ b/docs/content/user-guide/zh/modules/file.md @@ -3,7 +3,7 @@ - 与 abp 自带的文件模块不一样,此模块接入阿里云 oss 作为云存储。 - 前端上传文件到 OSS,文件模块保存相对路径。 -![](../../../img/file.png) +![](../../../img/file.png){: .zoom} ## 安装 diff --git a/docs/content/user-guide/zh/modules/signalr.md b/docs/content/user-guide/zh/modules/signalr.md index d8e2eb99..9ccd8dae 100644 --- a/docs/content/user-guide/zh/modules/signalr.md +++ b/docs/content/user-guide/zh/modules/signalr.md @@ -4,11 +4,11 @@ - 发送消息会在前端右上角,根据不同消息等级有不同的窗体提示。 -![](../../../img/send.png) +![](../../../img/send.png){: .zoom} - 在右上角灯泡按钮可以看到接受的消息。 -![](../../../img/send1.png) +![](../../../img/send1.png){: .zoom} ## 安装 diff --git a/docs/content/user-guide/zh/problem/ef.md b/docs/content/user-guide/zh/problem/ef.md index 7165d2d1..5375a287 100644 --- a/docs/content/user-guide/zh/problem/ef.md +++ b/docs/content/user-guide/zh/problem/ef.md @@ -132,3 +132,16 @@ namespace Lion.AbpPro.EntityFrameworkCore } } ``` + +## 如何设置 Abp 表前缀 + +- 在 host 层的 Module 下修改 + +```csharp +public override void OnPreApplicationInitializatio(ApplicationInitializationContext context) + { + // 比如修改为带下划线 + AbpCommonDbProperties.DbTablePrefix = "Abp_"; + base.OnPreApplicationInitialization(context); + } +``` diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index d145294e..c6776f48 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -143,9 +143,6 @@ nav: # - 扩展: # - 统一返回值格式: user-guide/zh/extension/统一返回值格式.md # - Magicodes.IE: user-guide/zh/extension/MagicodesIE.md - - 常见问题: - - 编译: user-guide/zh/problem/problem.md - - EFCore: user-guide/zh/problem/ef.md - 部署: - Docker: user-guide/zh/deploy/docker.md # - Github自动化部署: user-guide/zh/deploy/github.md