docs: 补全租户与字典模块注释

This commit is contained in:
2025-12-12 11:29:15 +08:00
parent 641598de86
commit 2da009c68a
17 changed files with 220 additions and 17 deletions

View File

@@ -20,6 +20,12 @@ public sealed class DictionaryAppService(
ITenantProvider tenantProvider,
ILogger<DictionaryAppService> logger) : IDictionaryAppService
{
/// <summary>
/// 创建字典分组。
/// </summary>
/// <param name="request">创建请求。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>分组 DTO。</returns>
public async Task<DictionaryGroupDto> CreateGroupAsync(CreateDictionaryGroupRequest request, CancellationToken cancellationToken = default)
{
// 1. 规范化编码并确定租户
@@ -52,6 +58,13 @@ public sealed class DictionaryAppService(
return MapGroup(group, includeItems: false);
}
/// <summary>
/// 更新字典分组。
/// </summary>
/// <param name="groupId">分组 ID。</param>
/// <param name="request">更新请求。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>分组 DTO。</returns>
public async Task<DictionaryGroupDto> UpdateGroupAsync(long groupId, UpdateDictionaryGroupRequest request, CancellationToken cancellationToken = default)
{
// 1. 读取分组并校验权限
@@ -70,6 +83,11 @@ public sealed class DictionaryAppService(
return MapGroup(group, includeItems: false);
}
/// <summary>
/// 删除字典分组。
/// </summary>
/// <param name="groupId">分组 ID。</param>
/// <param name="cancellationToken">取消标记。</param>
public async Task DeleteGroupAsync(long groupId, CancellationToken cancellationToken = default)
{
// 1. 读取分组并校验权限
@@ -83,6 +101,12 @@ public sealed class DictionaryAppService(
logger.LogInformation("删除字典分组:{GroupId}", group.Id);
}
/// <summary>
/// 搜索字典分组。
/// </summary>
/// <param name="request">查询条件。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>分组列表。</returns>
public async Task<IReadOnlyList<DictionaryGroupDto>> SearchGroupsAsync(DictionaryGroupQuery request, CancellationToken cancellationToken = default)
{
// 1. 确定查询范围并校验权限
@@ -111,6 +135,12 @@ public sealed class DictionaryAppService(
return result;
}
/// <summary>
/// 创建字典项。
/// </summary>
/// <param name="request">创建请求。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>字典项 DTO。</returns>
public async Task<DictionaryItemDto> CreateItemAsync(CreateDictionaryItemRequest request, CancellationToken cancellationToken = default)
{
// 1. 校验分组与权限
@@ -139,6 +169,13 @@ public sealed class DictionaryAppService(
return MapItem(item);
}
/// <summary>
/// 更新字典项。
/// </summary>
/// <param name="itemId">字典项 ID。</param>
/// <param name="request">更新请求。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>字典项 DTO。</returns>
public async Task<DictionaryItemDto> UpdateItemAsync(long itemId, UpdateDictionaryItemRequest request, CancellationToken cancellationToken = default)
{
// 1. 读取字典项与分组并校验权限
@@ -160,6 +197,11 @@ public sealed class DictionaryAppService(
return MapItem(item);
}
/// <summary>
/// 删除字典项。
/// </summary>
/// <param name="itemId">字典项 ID。</param>
/// <param name="cancellationToken">取消标记。</param>
public async Task DeleteItemAsync(long itemId, CancellationToken cancellationToken = default)
{
// 1. 读取字典项与分组并校验权限
@@ -174,6 +216,12 @@ public sealed class DictionaryAppService(
logger.LogInformation("删除字典项:{ItemId}", item.Id);
}
/// <summary>
/// 批量获取缓存中的字典项。
/// </summary>
/// <param name="request">批量查询请求。</param>
/// <param name="cancellationToken">取消标记。</param>
/// <returns>按编码分组的字典项集合。</returns>
public async Task<IReadOnlyDictionary<string, IReadOnlyList<DictionaryItemDto>>> GetCachedItemsAsync(DictionaryBatchQueryRequest request, CancellationToken cancellationToken = default)
{
// 1. 规范化编码