ABP框架中基于BLOB存储系统的文件上传下载实现指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00038/article/details/148392057

ABP框架中基于BLOB存储系统的文件上传下载实现指南

abp Open-source web application framework for ASP.NET Core! Offers an opinionated architecture to build enterprise software solutions with best practices on top of the .NET. Provides the fundamental infrastructure, cross-cutting-concern implementations, startup templates, application modules, UI themes, tooling and documentation. 项目地址: https://gitcode.com/gh_mirrors/abp1/abp

前言

在现代Web应用开发中，文件上传下载是常见需求。本文将详细介绍如何在ABP框架中利用其内置的BLOB存储系统实现文件上传下载功能。通过本教程，您将掌握从项目搭建到功能实现的完整流程。

BLOB存储系统概述

BLOB（Binary Large Object）即二进制大对象，指存储二进制数据的容器。在ABP框架中，BLOB存储系统提供了统一的抽象接口，具有以下优势：

存储无关性：支持多种后端存储（数据库、文件系统、Azure等）
模块化设计：可轻松替换存储实现而不影响业务代码
多租户支持：天然适配ABP的多租户架构
简化开发：提供简洁的API接口

项目准备

初始化项目

首先创建基础项目结构，使用ABP CLI工具生成项目模板。创建完成后，执行数据库迁移工具初始化数据库。

添加BLOB存储模块

ABP框架支持多种BLOB存储提供程序，本教程以数据库存储为例：

安装数据库存储模块
执行数据库迁移更新表结构

配置BLOB容器

BLOB存储以容器为单位管理文件，创建自定义容器类：

[BlobContainerName("my-file-container")]
public class MyFileContainer { }

BlobContainerName特性指定容器名称，后续操作都基于此容器进行。

应用层实现

数据传输对象(DTO)设计

定义以下DTO用于前后端交互：

BlobDto：包含文件内容和名称
GetBlobRequestDto：文件下载请求参数
SaveBlobInputDto：文件上传参数

应用服务接口

定义文件操作接口：

public interface IFileAppService : IApplicationService
{
    Task SaveBlobAsync(SaveBlobInputDto input);
    Task<BlobDto> GetBlobAsync(GetBlobRequestDto input);
}

应用服务实现

注入IBlobContainer<MyFileContainer>服务实现文件操作：

public class FileAppService : ApplicationService, IFileAppService
{
    private readonly IBlobContainer<MyFileContainer> _fileContainer;

    public FileAppService(IBlobContainer<MyFileContainer> fileContainer)
    {
        _fileContainer = fileContainer;
    }

    public async Task SaveBlobAsync(SaveBlobInputDto input)
    {
        await _fileContainer.SaveAsync(input.Name, input.Content, true);
    }

    public async Task<BlobDto> GetBlobAsync(GetBlobRequestDto input)
    {
        var blob = await _fileContainer.GetAllBytesAsync(input.Name);
        return new BlobDto { Name = input.Name, Content = blob };
    }
}

关键方法说明：

SaveAsync：保存文件，可设置是否覆盖
GetAllBytesAsync：获取文件字节数组

Web API实现

创建控制器提供下载接口：

[HttpGet]
[Route("download/{fileName}")]
public async Task<IActionResult> DownloadAsync(string fileName)
{
    var fileDto = await _fileAppService.GetBlobAsync(new GetBlobRequestDto{ Name = fileName });
    return File(fileDto.Content, "application/octet-stream", fileDto.Name);
}

此接口返回FileResult触发浏览器下载行为。

用户界面实现

Razor页面设计

创建包含两个功能区域的页面：

左侧：文件上传表单
右侧：文件下载表单

使用ABP Tag Helpers简化表单构建：

<abp-input asp-for="UploadFileDto.Name"></abp-input>
<abp-input asp-for="UploadFileDto.File"></abp-input>

页面模型

处理文件上传逻辑：

public async Task<IActionResult> OnPostAsync()
{
    using (var memoryStream = new MemoryStream())
    {
        await UploadFileDto.File.CopyToAsync(memoryStream);
        await _fileAppService.SaveBlobAsync(
            new SaveBlobInputDto
            {
                Name = UploadFileDto.Name,
                Content = memoryStream.ToArray()
            }
        );
    }
    return Page();
}

客户端脚本

实现下载功能和文件名自动填充：

downloadForm.submit(function (event) {
    event.preventDefault();
    var fileName = $("#fileName").val().trim();
    window.open(DOWNLOAD_ENDPOINT + "/" + fileName, "_blank");
});

$("#UploadFileDto_File").change(function () {
    var fileName = $(this)[0].files[0].name;
    $("#UploadFileDto_Name").val(fileName);
});