Project
版本
语言
Contributors 编辑 (2023/10/5)
Avatar

文件存储管理

文件管理是基于 ABP BlobStoring 构建的应用程序模块，它为文件上传提供了文件类型验证和文件大小验证的功能。此外，开发人员还可以添加更多的自定义处理逻辑。

在深入学习本模块的使用方法之前，请务必详细阅读 ABP BlobStoring 文档。

安装

以下是安装文件管理模块的步骤：

  1. 将 Dignite.Abp.Files.Domain.Shared NuGet 包安装到 Domain.Shared 项目中。

  2. 在 模块类 的 [DependsOn(...)] 属性列表中添加 DigniteAbpFilesDomainSharedModule。

  3. 将 Dignite.Abp.Files.Domain NuGet 包安装到 Domain 项目中。

  4. 在 模块类 的 [DependsOn(...)] 属性列表中添加 DigniteAbpFilesDomainModule。

  5. 将 Dignite.Abp.Files.EntityFrameworkCore NuGet 包安装到 EntityFrameworkCore 项目中。

  6. 在 模块类 的 [DependsOn(...)] 属性列表中添加 DigniteAbpFilesEntityFrameworkCoreModule。

文件存储处理器

除了 ABP BlobStoring 的配置之外，本模块还引入了两个文件处理器配置：

  • 文件上传类型配置

    在 ConfigureServices 方法中配置允许上传的文件类型：

    Configure<AbpBlobStoringOptions>(options =>
{
    options.Containers.Configure<ProfilePictureContainer>(container =>
    {
        container.AddFileTypeCheckHandler(config =>
            config.AllowedFileTypeNames = new string[] { ".jpeg",".jpg",".png" }
        );
    });
});

  • 文件上传大小配置

    在 ConfigureServices 方法中配置上传文件大小限制：

    Configure<AbpBlobStoringOptions>(options =>
{
    options.Containers.Configure<ProfilePictureContainer>(container =>
    {
        container.AddFileSizeLimitHandler(config =>
            config.MaxFileSize = 1024    // 限制文件大小（KB）
        );
    });
});

创建文件处理器

  1. 创建一个配置类，用于存储处理器的配置项：

    using Volo.Abp.BlobStoring;

namespace Dignite.Abp.BlobStoring
{
    public class MyCustomFileHandlerConfiguration
    {
        public string Option1
        {
            get => _containerConfiguration.GetConfigurationOrDefault<string>("MyCustomFileHandlerOption", null);
            set => _containerConfiguration.SetConfiguration("MyCustomFileHandlerOption", value);
        }

        private readonly BlobContainerConfiguration _containerConfiguration;

        public MyCustomFileHandlerConfiguration(BlobContainerConfiguration containerConfiguration)
        {
            _containerConfiguration = containerConfiguration;
        }
    }
}

    然后，在 MyCustomHandlerBlobContainerConfigurationExtensions 类中添加以下扩展方法：

    public static MyCustomFileHandlerConfiguration GetMyCustomFileHandlerConfiguration(
    this BlobContainerConfiguration containerConfiguration)
{
    return new MyCustomFileHandlerConfiguration(containerConfiguration);
}

  2. 创建 BlobContainerConfiguration 的扩展方法：

    using System;
using Volo.Abp.BlobStoring;
using Volo.Abp.Collections;

namespace Dignite.Demo
{
    public static class MyCustomHandlerBlobContainerConfigurationExtensions
    {
        public static void AddMyCustomHandler(
            this BlobContainerConfiguration containerConfiguration,
            Action<MyCustomFileHandlerConfiguration> configureAction)
        {
            var fileProcessHandlers = containerConfiguration.GetConfigurationOrDefault(
                BlobContainerConfigurationNames.FileHandlers,
                new TypeList<IFileHandler>());

            if (fileProcessHandlers.TryAdd<MyCustomFileHandler>())
            {
                configureAction(new MyCustomFileHandlerConfiguration(containerConfiguration));

                containerConfiguration.SetConfiguration(
                    BlobContainerConfigurationNames.FileHandlers,
                    fileProcessHandlers);
            }
        }
    }
}

  3. 创建一个实现 IFileHandler 接口的类：

    通过实现 IFileHandler 接口，您可以构建符合您业务需求的自定义处理器：

    using System.Threading.Tasks;
using Volo.Abp;
using Volo.Abp.DependencyInjection;

namespace Dignite.Demo
{
    public class MyCustomFileHandler : IFileHandler, ITransientDependency
    {
        public Task ExecuteAsync(FileHandlerContext context)
        {
            var configuration = context.ContainerConfiguration.GetMyCustomFileHandlerConfiguration();

            // 在这里处理文件流
            return Task.CompletedTask;
        }
    }
}

  4. 在 ConfigureServices 方法中配置：

    Configure<AbpBlobStoringOptions>(options =>
{
    options.Containers.Configure<MyCustomFileHandlerConfiguration>(container =>
    {
        container.AddMyCustomHandler(config =>
            config.Option1 = "abc"
        );
    });
});

文件信息持久化

文件存储管理提供了一些接口，规范了文件信息的持久化开发。

IFile 接口

IFile 是文件信息的接口类，提供以下基础字段：

  • ContainerName 存储文件的容器名称。 参见 Typed IBlobContainer

  • BlobName 对应 BLOB 存储中的 BlobName。

  • Size 文件二进制大小。

  • Name 文件的名称。

  • MimeType 文件的 Mime 类型。 例如，图片的 Mime 类型可能是 .jpeg、.jpg、.png 中的一个。

  • Md5 文件的 Md5 值。 用于验证用户上传的文件在容器中是否已存在。

  • ReferBlobName 在同一容器中，当上传了相同的文件时，系统不会再次存储文件，而是引用已存在文件的 BlobName，这种机制能够节省重复文件的存储空间。

FileBase 抽象类

FileBase 是 IFile 接口的实现，开发者可使用 FileBase 作为文件信息的基类。

IFileStore 接口

IFileStore 是一个泛型接口，提供了一系列方法用于 IFile 的 CURD 操作。

FileManager<TFile, TFileStore> 抽象类

FileManager 是一个泛型抽象类，包装了 IFileStore 的系列方法。

在文件管理器模块中有一个完整的实现。

配置 EF Core 实体

Dignite.Abp.Files.EntityFrameworkCore 提供了一个实用的扩展方法，配置从 IFile 接口继承的属性。

使用 ConfigureAbpFiles<TFile> 配置 IFile 中的字段。在 DbContext 的 OnModelCreating 方法中配置如下：

protected override void OnModelCreating(ModelBuilder builder)
{
    // 总是调用基本方法
    base.OnModelCreating(builder);

    builder.Entity<FileDescriptor>(b =>
    {
        // 配置表
        b.ToTable("FileDescriptors");

        b.ConfigureByConvention();

        //
        b.ConfigureAbpFiles();
    });
}

有关 FileDescriptor 对象信息，请参阅文件管理器模块源代码。

继续阅读

  • 文件管理器模块 提供了一套完整的文件管理模块，包括文件目录管理和文件管理功能。
InThisDocument