using Dpz.Core.Public.ViewModel.Request;
using Dpz.Core.Public.ViewModel.Response;

namespace Dpz.Core.Service.RepositoryService;

public interface IPictureRecordService
{
    /// <summary>
    /// 获取所有相册标签
    /// </summary>
    /// <param name="cancellationToken">传播通知操作应取消的通知令牌</param>
    /// <returns></returns>
    Task<List<string>> GetTagsAsync(CancellationToken cancellationToken = default);

    /// <summary>
    /// 获取所有Banner
    /// </summary>
    /// <returns></returns>
    Task<ICollection<PictureRecordResponse>> GetBannerAsync();

    /// <summary>
    /// 分页获取相册信息
    /// </summary>
    /// <param name="tags"></param>
    /// <param name="description"></param>
    /// <param name="pageIndex"></param>
    /// <param name="pageSize"></param>
    /// <param name="account">相册上传人</param>
    /// <param name="cancellationToken">传播通知操作应取消的通知令牌</param>
    /// <returns></returns>
    Task<IPagedList<PictureRecordResponse>> GetPagesAsync(
        List<string>? tags,
        string? description,
        int pageIndex = 1,
        int pageSize = 20,
        string? account = null,
        CancellationToken cancellationToken = default
    );

    /// <summary>
    /// 获取相册信息
    /// </summary>
    /// <param name="id"></param>
    /// <returns></returns>
    Task<PictureRecordResponse?> GetPictureRecordAsync(string id);

    /// <summary>
    /// 创建一个相册记录
    /// </summary>
    /// <param name="request"></param>
    /// <param name="cancellationToken"></param>
    /// <returns></returns>
    Task<PictureRecordResponse> CreateRecordAsync(
        CreatePictureRecordRequest request,
        CancellationToken cancellationToken = default
    );

    /// <summary>
    /// 修改相册信息
    /// </summary>
    /// <param name="request"></param>
    /// <param name="cancellationToken"></param>
    /// <returns></returns>
    Task<PictureRecordResponse?> ChangeInformationAsync(
        EditPictureRecordRequest request,
        CancellationToken cancellationToken = default
    );

    /// <summary>
    /// 删除
    /// </summary>
    /// <param name="id"></param>
    /// <returns></returns>
    Task DeleteAsync(string id);

    /// <summary>
    /// 清除缓存
    /// </summary>
    /// <returns></returns>
    Task ClearCacheAsync(CancellationToken cancellationToken = default);

    /// <summary>
    /// 清除发布照片相关缓存。
    /// </summary>
    /// <param name="tags">照片标签</param>
    /// <param name="cancellationToken">传播通知操作应取消的通知令牌</param>
    /// <returns></returns>
    Task ClearPublishCacheAsync(
        IReadOnlyCollection<string> tags,
        CancellationToken cancellationToken = default
    );
}
⚠⚠    以下内容为AI分析的结果,请根据实际情况进行判断。

这是一个C#的接口定义文件,定义了一个名为IPictureRecordService的服务接口,用于管理相册记录相关的业务操作。让我逐一解释每个方法的功能:

接口概述

这个接口封装了相册管理系统的核心业务逻辑,包括相册的增删改查、标签管理、缓存控制等功能。

方法详解

1. 查询相关方法

GetTagsAsync

  • 功能:获取系统中所有的相册标签
  • 返回:标签字符串列表
  • 支持异步操作和取消令牌

GetBannerAsync

  • 功能:获取所有Banner图片记录
  • 返回:PictureRecordResponse集合,通常用于首页轮播等展示

GetPagesAsync

  • 功能:分页查询相册信息,支持多条件筛选
  • 参数包括:
    • tags:标签过滤条件
    • description:描述关键词
    • pageIndex:页码(默认第1页)
    • pageSize:每页大小(默认20条)
    • account:上传用户账号
  • 返回:分页结果对象IPagedList<PictureRecordResponse>

GetPictureRecordAsync

  • 功能:根据ID获取单个相册详情
  • 返回:可能为null的PictureRecordResponse对象

2. 数据操作方法

CreateRecordAsync

  • 功能:创建新的相册记录
  • 参数:CreatePictureRecordRequest创建请求对象
  • 返回:创建成功后的响应对象

ChangeInformationAsync

  • 功能:修改现有相册信息
  • 参数:EditPictureRecordRequest编辑请求对象
  • 返回:修改后的响应对象(可能为null)

DeleteAsync

  • 功能:根据ID删除相册记录
  • 无返回值的异步操作

3. 缓存管理方法

ClearCacheAsync

  • 功能:清除所有相关缓存
  • 通常在数据发生变化时调用以保证数据一致性

ClearPublishCacheAsync

  • 功能:清除特定标签相关的发布缓存
  • 参数:只读的标签集合
  • 更精确的缓存清理,避免清除不必要的缓存

设计特点

  1. 异步设计:所有方法都是异步的,提高系统性能
  2. 取消支持:大部分方法支持CancellationToken,可以优雅地取消长时间运行的操作
  3. 分页支持:提供分页查询功能,适合大数据量场景
  4. 缓存管理:内置缓存清理机制,保证数据一致性
  5. 可选参数:查询方法使用可选参数,提供灵活的筛选条件

这个接口设计遵循了良好的软件工程实践,为相册管理系统提供了完整且灵活的服务层抽象。

评论加载中...