msumshk/TakeoutSaaS.TenantApi
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix: 修复公告模块核心问题并完善功能

Browse Source 
主要修复内容：
1. 修复 RowVersion 并发控制
   - 配置 EF Core RowVersion 映射为 bytea 类型
   - 添加 PostgreSQL 触发器自动生成 RowVersion
   - 在更新/发布/撤销操作中添加 RowVersion 校验
   - 移除 Application 层对 EF Core 的直接依赖

2. 修复 API 路由和校验问题
   - 添加平台公告列表路由的版本化别名
   - 租户公告接口添加 X-Tenant-Id 必填校验，返回 400
   - 生效时间校验返回 422 而非 500
   - 修复 FluentValidation 异常命名冲突

3. 实现关键词搜索功能
   - 在查询参数中添加 keyword 字段
   - 使用 PostgreSQL ILIKE 实现大小写不敏感搜索
   - 支持标题和内容字段的模糊匹配

4. 数据库迁移
   - 新增 RowVersion 触发器迁移文件
   - 回填现有公告记录的 RowVersion
This commit is contained in:
MSuMshk
2025-12-26 09:08:30 +08:00
parent 857f776447
commit 755b61a044
15 changed files with 178 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
src/Api/TakeoutSaaS.AdminApi/Controllers/PlatformAnnouncementsController.cs
View File

@@ -20,6 +20,7 @@ namespace TakeoutSaaS.AdminApi.Controllers;
[ApiVersion("1.0")]
[Authorize]
[Route("api/platform/announcements")]
[Route("api/admin/v{version:apiVersion}/platform/announcements")]
public sealed class PlatformAnnouncementsController(IMediator mediator, ITenantContextAccessor tenantContextAccessor) : BaseApiController
{
/// <summary>

65
src/Api/TakeoutSaaS.AdminApi/Controllers/TenantAnnouncementsController.cs
View File

@@ -20,6 +20,8 @@ namespace TakeoutSaaS.AdminApi.Controllers;
[Route("api/admin/v{version:apiVersion}/tenants/{tenantId:long}/announcements")]
public sealed class TenantAnnouncementsController(IMediator mediator) : BaseApiController
{
private const string TenantIdHeaderName = "X-Tenant-Id";
/// <summary>
/// 分页查询公告。
/// </summary>
@@ -47,6 +49,12 @@ public sealed class TenantAnnouncementsController(IMediator mediator) : BaseApiC
[ProducesResponseType(typeof(ApiResponse<object>), StatusCodes.Status403Forbidden)]
public async Task<ApiResponse<PagedResult<TenantAnnouncementDto>>> Search(long tenantId, [FromQuery] GetTenantsAnnouncementsQuery query, CancellationToken cancellationToken)
{
var headerError = EnsureTenantHeader<PagedResult<TenantAnnouncementDto>>();
if (headerError != null)
{
return headerError;
}
query = query with { TenantId = tenantId };
var result = await mediator.Send(query, cancellationToken);
return ApiResponse<PagedResult<TenantAnnouncementDto>>.Ok(result);
@@ -80,6 +88,12 @@ public sealed class TenantAnnouncementsController(IMediator mediator) : BaseApiC
[ProducesResponseType(typeof(ApiResponse<object>), StatusCodes.Status403Forbidden)]
public async Task<ApiResponse<TenantAnnouncementDto>> Detail(long tenantId, long announcementId, CancellationToken cancellationToken)
{
var headerError = EnsureTenantHeader<TenantAnnouncementDto>();
if (headerError != null)
{
return headerError;
}
var result = await mediator.Send(new GetAnnouncementByIdQuery { TenantId = tenantId, AnnouncementId = announcementId }, cancellationToken);
return result is null
? ApiResponse<TenantAnnouncementDto>.Error(StatusCodes.Status404NotFound, "公告不存在")
@@ -124,6 +138,12 @@ public sealed class TenantAnnouncementsController(IMediator mediator) : BaseApiC
[ProducesResponseType(typeof(ApiResponse<object>), StatusCodes.Status403Forbidden)]
public async Task<ApiResponse<TenantAnnouncementDto>> Create(long tenantId, [FromBody, Required] CreateTenantAnnouncementCommand command, CancellationToken cancellationToken)
{
var headerError = EnsureTenantHeader<TenantAnnouncementDto>();
if (headerError != null)
{
return headerError;
}
command = command with { TenantId = tenantId };
var result = await mediator.Send(command, cancellationToken);
return ApiResponse<TenantAnnouncementDto>.Ok(result);
@@ -164,6 +184,12 @@ public sealed class TenantAnnouncementsController(IMediator mediator) : BaseApiC
[ProducesResponseType(typeof(ApiResponse<object>), StatusCodes.Status403Forbidden)]
public async Task<ApiResponse<TenantAnnouncementDto>> Update(long tenantId, long announcementId, [FromBody, Required] UpdateTenantAnnouncementCommand command, CancellationToken cancellationToken)
{
var headerError = EnsureTenantHeader<TenantAnnouncementDto>();
if (headerError != null)
{
return headerError;
}
command = command with { TenantId = tenantId, AnnouncementId = announcementId };
var result = await mediator.Send(command, cancellationToken);
return result is null
@@ -202,6 +228,12 @@ public sealed class TenantAnnouncementsController(IMediator mediator) : BaseApiC
[ProducesResponseType(typeof(ApiResponse<object>), StatusCodes.Status403Forbidden)]
public async Task<ApiResponse<TenantAnnouncementDto>> Publish(long tenantId, long announcementId, [FromBody, Required] PublishAnnouncementCommand command, CancellationToken cancellationToken)
{
var headerError = EnsureTenantHeader<TenantAnnouncementDto>();
if (headerError != null)
{
return headerError;
}
command = command with { AnnouncementId = announcementId };
var result = await mediator.Send(command, cancellationToken);
return result is null
@@ -240,6 +272,12 @@ public sealed class TenantAnnouncementsController(IMediator mediator) : BaseApiC
[ProducesResponseType(typeof(ApiResponse<object>), StatusCodes.Status403Forbidden)]
public async Task<ApiResponse<TenantAnnouncementDto>> Revoke(long tenantId, long announcementId, [FromBody, Required] RevokeAnnouncementCommand command, CancellationToken cancellationToken)
{
var headerError = EnsureTenantHeader<TenantAnnouncementDto>();
if (headerError != null)
{
return headerError;
}
command = command with { AnnouncementId = announcementId };
var result = await mediator.Send(command, cancellationToken);
return result is null
@@ -269,6 +307,12 @@ public sealed class TenantAnnouncementsController(IMediator mediator) : BaseApiC
[ProducesResponseType(typeof(ApiResponse<object>), StatusCodes.Status403Forbidden)]
public async Task<ApiResponse<bool>> Delete(long tenantId, long announcementId, CancellationToken cancellationToken)
{
var headerError = EnsureTenantHeader<bool>();
if (headerError != null)
{
return headerError;
}
var result = await mediator.Send(new DeleteTenantAnnouncementCommand { TenantId = tenantId, AnnouncementId = announcementId }, cancellationToken);
return ApiResponse<bool>.Ok(result);
}
@@ -299,9 +343,30 @@ public sealed class TenantAnnouncementsController(IMediator mediator) : BaseApiC
[ProducesResponseType(typeof(ApiResponse<object>), StatusCodes.Status403Forbidden)]
public async Task<ApiResponse<TenantAnnouncementDto>> MarkRead(long tenantId, long announcementId, CancellationToken cancellationToken)
{
var headerError = EnsureTenantHeader<TenantAnnouncementDto>();
if (headerError != null)
{
return headerError;
}
var result = await mediator.Send(new MarkAnnouncementAsReadCommand { TenantId = tenantId, AnnouncementId = announcementId }, cancellationToken);
return result is null
? ApiResponse<TenantAnnouncementDto>.Error(StatusCodes.Status404NotFound, "公告不存在")
: ApiResponse<TenantAnnouncementDto>.Ok(result);
}
private ApiResponse<T>? EnsureTenantHeader<T>()
{
if (!Request.Headers.TryGetValue(TenantIdHeaderName, out var tenantHeader) || string.IsNullOrWhiteSpace(tenantHeader))
{
return ApiResponse<T>.Error(StatusCodes.Status400BadRequest, $"缺少租户标识，请在请求头 {TenantIdHeaderName} 指定租户");
}
if (!long.TryParse(tenantHeader.FirstOrDefault(), out _))
{
return ApiResponse<T>.Error(StatusCodes.Status400BadRequest, $"租户标识无效，请在请求头 {TenantIdHeaderName} 指定正确的租户 ID");
}
return null;
}
}

12
src/Application/TakeoutSaaS.Application/App/Common/Behaviors/ValidationBehavior.cs
View File

@@ -1,5 +1,6 @@
using FluentValidation;
using MediatR;
using TakeoutSaaS.Shared.Abstractions.Exceptions;
namespace TakeoutSaaS.Application.App.Common.Behaviors;
@@ -26,7 +27,16 @@ public sealed class ValidationBehavior<TRequest, TResponse>(IEnumerable<IValidat
if (failures.Count > 0)
{
throw new ValidationException(failures);
var errors = failures
.GroupBy(f => string.IsNullOrWhiteSpace(f.PropertyName) ? "Request" : f.PropertyName)
.ToDictionary(
group => group.Key,
group => group
.Select(f => string.IsNullOrWhiteSpace(f.ErrorMessage) ? "Invalid" : f.ErrorMessage)
.Distinct()
.ToArray());
throw new TakeoutSaaS.Shared.Abstractions.Exceptions.ValidationException(errors);
}
}

1
src/Application/TakeoutSaaS.Application/App/Tenants/Handlers/GetTenantsAnnouncementsQueryHandler.cs
View File

@@ -44,6 +44,7 @@ public sealed class GetTenantsAnnouncementsQueryHandler(
// 1. 优化的数据库查询：应用排序和限制
var announcements = await announcementRepository.SearchAsync(
tenantId,
request.Keyword,
request.Status,
request.AnnouncementType,
request.IsActive,

5
src/Application/TakeoutSaaS.Application/App/Tenants/Handlers/PublishAnnouncementCommandHandler.cs
View File

@@ -23,6 +23,11 @@ public sealed class PublishAnnouncementCommandHandler(
/// <inheritdoc />
public async Task<TenantAnnouncementDto?> Handle(PublishAnnouncementCommand request, CancellationToken cancellationToken)
{
if (request.RowVersion == null || request.RowVersion.Length == 0)
{
throw new BusinessException(ErrorCodes.ValidationFailed, "RowVersion 不能为空");
}
// 1. 查询公告
var tenantId = tenantProvider.GetCurrentTenantId();
var announcement = await announcementRepository.FindByIdAsync(tenantId, request.AnnouncementId, cancellationToken);

5
src/Application/TakeoutSaaS.Application/App/Tenants/Handlers/RevokeAnnouncementCommandHandler.cs
View File

@@ -23,6 +23,11 @@ public sealed class RevokeAnnouncementCommandHandler(
/// <inheritdoc />
public async Task<TenantAnnouncementDto?> Handle(RevokeAnnouncementCommand request, CancellationToken cancellationToken)
{
if (request.RowVersion == null || request.RowVersion.Length == 0)
{
throw new BusinessException(ErrorCodes.ValidationFailed, "RowVersion 不能为空");
}
// 1. 查询公告
var tenantId = tenantProvider.GetCurrentTenantId();
var announcement = await announcementRepository.FindByIdAsync(tenantId, request.AnnouncementId, cancellationToken);

5
src/Application/TakeoutSaaS.Application/App/Tenants/Handlers/UpdateTenantAnnouncementCommandHandler.cs
View File

@@ -22,6 +22,11 @@ public sealed class UpdateTenantAnnouncementCommandHandler(ITenantAnnouncementRe
throw new BusinessException(ErrorCodes.ValidationFailed, "公告标题和内容不能为空");
}
if (request.RowVersion == null || request.RowVersion.Length == 0)
{
throw new BusinessException(ErrorCodes.ValidationFailed, "RowVersion 不能为空");
}
// 2. 查询公告
var announcement = await announcementRepository.FindByIdAsync(request.TenantId, request.AnnouncementId, cancellationToken);
if (announcement == null)

5
src/Application/TakeoutSaaS.Application/App/Tenants/Queries/GetTenantsAnnouncementsQuery.cs
View File

@@ -25,6 +25,11 @@ public sealed record GetTenantsAnnouncementsQuery : IRequest<PagedResult<TenantA
/// </summary>
public AnnouncementStatus? Status { get; init; }
/// <summary>
/// 关键词搜索（标题/内容）。
/// </summary>
public string? Keyword { get; init; }
/// <summary>
/// 是否筛选启用状态。
/// </summary>

4
src/Application/TakeoutSaaS.Application/App/Tenants/Targeting/TargetTypeFilter.cs
View File

@@ -37,6 +37,10 @@ public static class TargetTypeFilter
return normalized switch
{
"ALL" => announcement.TenantId == 0
? ApplyPayloadConstraints(payload, parsed, context, allowEmpty: true)
: announcement.TenantId == context.TenantId
&& ApplyPayloadConstraints(payload, parsed, context, allowEmpty: true),
"ALL_TENANTS" => ApplyPayloadConstraints(payload, parsed, context, allowEmpty: true),
"TENANT_ALL" => announcement.TenantId == context.TenantId
&& ApplyPayloadConstraints(payload, parsed, context, allowEmpty: true),

5
src/Application/TakeoutSaaS.Application/App/Tenants/Validators/CreateAnnouncementCommandValidator.cs
View File

@@ -28,8 +28,9 @@ public sealed class CreateAnnouncementCommandValidator : AbstractValidator<Creat
.Must(x => x.TenantId != 0 || x.PublisherScope == PublisherScope.Platform)
.WithMessage("TenantId=0 仅允许平台公告");
RuleFor(x => x.EffectiveTo)
.Must((command, effectiveTo) => !effectiveTo.HasValue || command.EffectiveFrom < effectiveTo.Value)
RuleFor(x => x.EffectiveFrom)
.LessThan(x => x.EffectiveTo!.Value)
.When(x => x.EffectiveTo.HasValue)
.WithMessage("生效开始时间必须早于结束时间");
}
}

2
src/Domain/TakeoutSaaS.Domain/Tenants/Repositories/ITenantAnnouncementRepository.cs
View File

@@ -12,6 +12,7 @@ public interface ITenantAnnouncementRepository
/// 查询公告列表（包含平台公告 TenantId=0），按类型、状态与生效时间筛选。
/// </summary>
/// <param name="tenantId">租户 ID。</param>
/// <param name="keyword">关键词（标题/内容）。</param>
/// <param name="status">公告状态。</param>
/// <param name="type">公告类型。</param>
/// <param name="isActive">启用状态。</param>
@@ -24,6 +25,7 @@ public interface ITenantAnnouncementRepository
/// <returns>公告集合。</returns>
Task<IReadOnlyList<TenantAnnouncement>> SearchAsync(
long tenantId,
string? keyword,
AnnouncementStatus? status,
TenantAnnouncementType? type,
bool? isActive,

13
src/Infrastructure/TakeoutSaaS.Infrastructure/App/Persistence/TakeoutAppDbContext.cs
View File

@@ -807,10 +807,13 @@ public sealed class TakeoutAppDbContext(
builder.Property(x => x.TenantId).IsRequired();
builder.Property(x => x.Title).HasMaxLength(128).IsRequired();
builder.Property(x => x.Content).HasColumnType("text").IsRequired();
builder.Property(x => x.AnnouncementType).HasConversion<int>();
builder.Property(x => x.PublisherScope).HasConversion<int>();
builder.Property(x => x.AnnouncementType)
.HasConversion<int>();
builder.Property(x => x.PublisherScope)
.HasConversion<int>();
builder.Property(x => x.PublisherUserId);
builder.Property(x => x.Status).HasConversion<int>();
builder.Property(x => x.Status)
.HasConversion<int>();
builder.Property(x => x.PublishedAt);
builder.Property(x => x.RevokedAt);
builder.Property(x => x.ScheduledPublishAt);
@@ -819,7 +822,9 @@ public sealed class TakeoutAppDbContext(
builder.Property(x => x.Priority).IsRequired();
builder.Property(x => x.IsActive).IsRequired();
builder.Property(x => x.RowVersion)
.IsConcurrencyToken();
.IsRowVersion()
.IsConcurrencyToken()
.HasColumnType("bytea");
ConfigureAuditableEntity(builder);
ConfigureSoftDeleteEntity(builder);
builder.HasIndex(x => new { x.TenantId, x.AnnouncementType, x.IsActive });

9
src/Infrastructure/TakeoutSaaS.Infrastructure/App/Repositories/EfTenantAnnouncementRepository.cs
View File

@@ -14,6 +14,7 @@ public sealed class EfTenantAnnouncementRepository(TakeoutAppDbContext context)
/// <inheritdoc />
public async Task<IReadOnlyList<TenantAnnouncement>> SearchAsync(
long tenantId,
string? keyword,
AnnouncementStatus? status,
TenantAnnouncementType? type,
bool? isActive,
@@ -29,6 +30,14 @@ public sealed class EfTenantAnnouncementRepository(TakeoutAppDbContext context)
.IgnoreQueryFilters()
.Where(x => tenantIds.Contains(x.TenantId));
if (!string.IsNullOrWhiteSpace(keyword))
{
var normalized = keyword.Trim();
query = query.Where(x =>
EF.Functions.ILike(x.Title, $"%{normalized}%")
|| EF.Functions.ILike(x.Content, $"%{normalized}%"));
}
if (status.HasValue)
{
query = query.Where(x => x.Status == status.Value);

50
src/Infrastructure/TakeoutSaaS.Infrastructure/Migrations/20251225090000_AddTenantAnnouncementRowVersionTrigger.cs Normal file
View File

@@ -0,0 +1,50 @@
using Microsoft.EntityFrameworkCore.Migrations;
#nullable disable
namespace TakeoutSaaS.Infrastructure.Migrations
{
/// <inheritdoc />
public partial class AddTenantAnnouncementRowVersionTrigger : Migration
{
/// <inheritdoc />
protected override void Up(MigrationBuilder migrationBuilder)
{
migrationBuilder.Sql(
"""
CREATE OR REPLACE FUNCTION public.set_tenant_announcement_row_version()
RETURNS trigger AS $$
BEGIN
NEW."RowVersion" = decode(md5(random()::text || clock_timestamp()::text), 'hex');
RETURN NEW;
END;
$$ LANGUAGE plpgsql;
""");
migrationBuilder.Sql(
"""
DROP TRIGGER IF EXISTS trg_tenant_announcements_row_version ON tenant_announcements;
CREATE TRIGGER trg_tenant_announcements_row_version
BEFORE INSERT OR UPDATE ON tenant_announcements
FOR EACH ROW EXECUTE FUNCTION public.set_tenant_announcement_row_version();
""");
migrationBuilder.Sql(
"""
UPDATE tenant_announcements
SET "RowVersion" = decode(md5(random()::text || clock_timestamp()::text), 'hex')
WHERE "RowVersion" IS NULL OR octet_length("RowVersion") = 0;
""");
}
/// <inheritdoc />
protected override void Down(MigrationBuilder migrationBuilder)
{
migrationBuilder.Sql(
"""
DROP TRIGGER IF EXISTS trg_tenant_announcements_row_version ON tenant_announcements;
DROP FUNCTION IF EXISTS public.set_tenant_announcement_row_version();
""");
}
}
}

5
tests/TakeoutSaaS.Integration.Tests/App/Tenants/AnnouncementWorkflowTests.cs
View File

@@ -164,7 +164,7 @@ public sealed class AnnouncementWorkflowTests
}
[Fact]
public async Task GivenStaleRowVersion_WhenUpdate_ThenThrowsConcurrencyException()
public async Task GivenStaleRowVersion_WhenUpdate_ThenReturnsConflict()
{
// Arrange
using var database = new SqliteTestDatabase();
@@ -197,7 +197,8 @@ public sealed class AnnouncementWorkflowTests
Func<Task> act = async () => await handler.Handle(command, CancellationToken.None);
// Assert
await act.Should().ThrowAsync<DbUpdateConcurrencyException>();
var exception = await act.Should().ThrowAsync<BusinessException>();
exception.Which.ErrorCode.Should().Be(ErrorCodes.Conflict);
}
private static TenantAnnouncement CreateDraftAnnouncement(long tenantId, long id)