基于现有REST API封装CSV导出API的实现方案及设计模式咨询

嘿，这个需求我之前也帮朋友处理过，其实核心就是把分页接口的所有数据拉取全，再转成CSV返回，同时还要兼顾扩展性和代码优雅性，我给你拆解下具体实现和要遵循的设计模式：

一、核心实现步骤 #

要做这个Wrapper，你需要搞定分页数据拉取、CSV格式转换和响应输出这三个核心环节，具体步骤如下：

• 接收导出请求：和原API的请求参数保持一致（比如你的MeasureCalculationRequest），这样用户可以带着筛选条件导出指定数据
• 循环拉取分页数据：
  • 初始化分页参数（比如page=1，pageSize设为原API允许的最大值，减少请求次数）
  • 循环调用原API，把每一页的数据累加到集合中
  • 当返回的数据为空，或者当前页是最后一页时停止循环
• 转换为CSV格式：把累加的数据集转换成符合规范的CSV文本（注意处理特殊字符、引号等格式问题）
• 设置响应头并返回：指定Content-Type为text/csv，通过Content-Disposition设置下载文件名，确保浏览器能识别为下载文件

二、推荐遵循的设计模式 #

为了让代码更易维护、可扩展，建议用到这几个设计模式：

1. 装饰器模式 #

这个模式完美适配你的场景——不修改原API的核心逻辑，只扩展导出功能，符合开闭原则。比如原API负责计算和分页返回，Wrapper在其之上包装了“拉取全量数据+导出CSV”的逻辑，后续要加Excel导出，只需要再写一个装饰器即可，不用动原代码。

2. 迭代器模式 #

把分页拉取数据的逻辑封装成一个迭代器（比如IEnumerable<MeasureCalculationResult>），这样导出方法里只需要foreach遍历迭代器，不用关心分页的细节，代码会更简洁易读。

3. 策略模式 #

如果后续可能支持多种导出格式（CSV/Excel/JSON），可以把格式转换逻辑抽成策略接口。比如定义IDataExporter接口，实现CsvExporter、ExcelExporter等策略类，导出时根据参数选择对应的策略，扩展性拉满。

三、代码示例（结合你的Web API场景） #

假设你已经有调用原分页API的客户端，下面是导出Wrapper的具体实现：

首先定义原API的客户端接口和分页结果模型：

public interface IMeasureCalculationApiClient
{
    Task<PagedResult<MeasureCalculationResult>> GetCalculationResultsAsync(
        MeasureCalculationRequest request, 
        int page, 
        int pageSize);
}

public class PagedResult<T>
{
    public List<T> Data { get; set; } = new List<T>();
    public int TotalPages { get; set; }
    public int CurrentPage { get; set; }
    public int PageSize { get; set; }
    public int TotalCount { get; set; }
}

然后是导出CSV的API接口：

[HttpPost]
public async Task<IHttpActionResult> ExportCalculationResultsToCsv(MeasureCalculationRequest exportRequest)
{
    const int MaxPageSize = 1000; // 按原API的最大允许值调整，减少请求次数
    int currentPage = 1;
    List<MeasureCalculationResult> allResults = new List<MeasureCalculationResult>();

    try
    {
        while (true)
        {
            var pagedResult = await _apiClient.GetCalculationResultsAsync(exportRequest, currentPage, MaxPageSize);
            
            if (!pagedResult.Data.Any())
                break;

            allResults.AddRange(pagedResult.Data);

            // 已拉取完所有数据，终止循环
            if (currentPage >= pagedResult.TotalPages)
                break;

            currentPage++;
        }

        // 转换为CSV格式
        string csvContent = ConvertToCsv(allResults);

        // 构建下载响应
        var response = new HttpResponseMessage(HttpStatusCode.OK)
        {
            Content = new StringContent(csvContent, Encoding.UTF8, "text/csv")
        };
        response.Content.Headers.ContentDisposition = new ContentDispositionHeaderValue("attachment")
        {
            FileName = $"CalculationResults_{DateTime.UtcNow:yyyyMMddHHmmss}.csv"
        };

        return ResponseMessage(response);
    }
    catch (Exception ex)
    {
        // 异常处理：返回友好错误，可根据实际情况调整
        return InternalServerError(ex);
    }
}

// 简易CSV转换方法（生产环境建议用成熟库如CsvHelper）
private string ConvertToCsv(List<MeasureCalculationResult> results)
{
    if (!results.Any())
        return string.Empty;

    // 获取属性名作为表头
    var properties = typeof(MeasureCalculationResult)
        .GetProperties(BindingFlags.Public | BindingFlags.Instance);
    var header = string.Join(",", properties.Select(p => p.Name));

    // 生成数据行，处理引号避免格式错误
    var rows = results.Select(result => 
        string.Join(",", properties.Select(p => 
            $"\"{p.GetValue(result)?.ToString().Replace("\"", "\"\"")}\""
        )));

    return string.Join(Environment.NewLine, header, string.Join(Environment.NewLine, rows));
}

四、额外注意事项 #

• 内存优化：如果数据量极大，不要一次性把所有数据加载到内存，应该边拉取边写入CSV流，减少内存占用
• 超时与重试：网络波动或数据量大时容易超时，建议给HttpClient设置合理超时，并用Polly等库添加重试机制
• 权限验证：Wrapper要和原API保持一致的权限校验，避免越权导出敏感数据
• 异步导出：如果导出时间很长，可考虑做成异步任务——用户提交请求后返回任务ID，完成后邮件发送下载链接

内容的提问来源于stack exchange，提问作者Codex