Must have pro license to use this module.

Install

abp add-module Volo.FileManagement

Configure

private void ConfigureBlobStoring(IConfiguration configuration)
{
    Configure<AbpBlobStoringOptions>(options =>
    {
        options.Containers.Configure<FileManagementContainer>(c =>
        {
            c.UseFileSystem(fileSystem =>
            {
                fileSystem.BasePath = configuration["Path"];
            }); // You can use Database or Azure providers also.
        });
    });
}

Usage

private readonly IRepository<DirectoryDescriptor> _directoryDescriptorRepository;
private readonly FileManager _fileManager;

public TestFileManagementAppService(IRepository<DirectoryDescriptor> directoryDescriptorRepository,
    FileManager fileManager)
{
    _directoryDescriptorRepository = directoryDescriptorRepository;
    _fileManager = fileManager;
}

public async Task<Guid?> CreateBackupAsync(IRemoteStreamContent Content)
{
    var backup = await _directoryDescriptorRepository.FirstOrDefaultAsync(x =>
        x.Name == "Backup" && x.ParentId == null && x.TenantId == null);
    if (backup == null)
    {
        backup = await _directoryDescriptorRepository.InsertAsync(
            new DirectoryDescriptor(GuidGenerator.Create(), "Backup"),
            true);
    }

    var f = await _fileManager.CreateAsync(Content.FileName, Content.ContentType, Content, backup.Id, null, true);
    return f.DirectoryId;
}

代码解释

该代码定义了一个名为 TestFileManagementAppService 的类，它继承自 NbEdiAppService，并提供了一个方法用于创建备份文件夹并将文件存储到其中。以下是代码的详细解释：

构造函数

public TestFileManagementAppService(IRepository<DirectoryDescriptor> directoryDescriptorRepository,
    FileManager fileManager)

构造函数接收两个依赖项：IRepository<DirectoryDescriptor> 和 FileManager。

• IRepository<DirectoryDescriptor> 用于操作 DirectoryDescriptor 实体（目录描述符），例如查询或插入目录。
• FileManager 用于管理文件的创建和存储。

这些依赖项通过依赖注入传递给类，并存储在私有字段 _directoryDescriptorRepository 和 _fileManager 中。

CreateBackupAsync 方法

public async Task<Guid?> CreateBackupAsync(IRemoteStreamContent Content)

该方法的目的是在一个名为 "Backup" 的目录中创建备份文件。如果目录不存在，则会先创建该目录。

1. 查找或创建备份目录：

   var backup = await _directoryDescriptorRepository.FirstOrDefaultAsync(x =>
       x.Name == "Backup" && x.ParentId == null && x.TenantId == null);
   

   这里通过 FirstOrDefaultAsync 方法查询名为 "Backup" 的根目录（ParentId == null 且 TenantId == null）。如果目录不存在：

   backup = await _directoryDescriptorRepository.InsertAsync(
       new DirectoryDescriptor(GuidGenerator.Create(), "Backup"),
       true);
   

   使用 InsertAsync 方法创建一个新的 DirectoryDescriptor 实体，并将其插入到存储库中。

2. 创建文件：

   var f = await _fileManager.CreateAsync(Content.FileName, Content.ContentType, Content, backup.Id, null, true);
   

   使用 FileManager 的 CreateAsync 方法将文件存储到备份目录中。方法参数包括文件名、内容类型、文件内容、目标目录 ID 等。

3. 返回目录 ID：

   return f.DirectoryId;
   

   方法返回文件所属目录的 ID（即备份目录的 ID）。

总结

该类的主要功能是确保存在一个名为 "Backup" 的目录，并将传入的文件存储到该目录中。通过依赖注入的方式，代码实现了对目录和文件的解耦管理，便于扩展和测试。

Ref

file-management

Install

abp add-package Volo.Abp.BlobStoring.FileSystem

Configure

private void ConfigureBlobStoring(IConfiguration configuration)
{
    Configure<AbpBlobStoringOptions>(options =>
    {
        options.Containers.ConfigureDefault(container =>
        {
            container.UseFileSystem(fileSystem =>
            {
                fileSystem.BasePath = configuration["Path"];
            });
        });
        // temp is a container name
        options.Containers.Configure("temp", container =>
            {
                container.UseFileSystem(fileSystem =>
                {
                    fileSystem.BasePath = configuration["BlobOptions:BlobPath"];
                });
            });
    });
}

Usage

private readonly IBlobContainer _blobContainer;
private readonly IConfiguration _configuration;

public TestFileSystemAppService(IBlobContainerFactory blobContainerFactory, IConfiguration configuration)
{
    _configuration = configuration;
    _blobContainer = blobContainerFactory.Create("temp");
}

public async Task SaveBytesAsync(byte[] bytes)
{
    await _blobContainer.SaveAsync("my-blob-1", bytes, true);
}

public async Task<byte[]?> GetBytesAsync()
{
    return await _blobContainer.GetAllBytesOrNullAsync("my-blob-1");
}

public async Task SaveStreamAsync(IRemoteStreamContent Content)
{
    await _blobContainer.SaveAsync(Content.FileName ?? "my-blob-2", Content.GetStream(), true);
}

public async Task<IRemoteStreamContent?> GetStreamAsync(string? fileName = "my-blob-2")
{
    if (string.IsNullOrEmpty(fileName))
    {
        throw new ArgumentNullException(nameof(fileName));
    }

    var s = await _blobContainer.GetOrNullAsync(fileName);
    if (s == null)
    {
        throw new NotFoundException();
    }

    return new RemoteStreamContent(s, fileName,
        "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
}

public async Task SaveDirectoryAsync(IRemoteStreamContent Content)
{
    await _blobContainer.SaveAsync(Path.Combine("DirName", "SubDir", Content.FileName), Content.GetStream(), true);
}

public async Task GetEdisync(string name)
{
    var s = await _blobContainer.GetOrNullAsync(Path.Combine("DirName", "SubDir",name));
    if (s == null)
    {
        throw new NotFoundException();
    }
}

public async Task<IEnumerable<string>> GetDirectoryAsync()
{
    return _blobContainer.GetFileNameList(Path.Combine(_configuration["Path"], "host", "DirName", "SubDir"));
}

GetDirectoryFiles

Retrieve all file names in a folder using the GetFileNameList extension method, and then iterate through the list to access the file contents.

extension

Create a extension method to get file name list from directory.

public static class NbEdiExtensions

public static List<string> GetFileNameList(
    this IBlobContainer blobContainer,
    string blobPath,
    string? subPath = null)
{
    if (!string.IsNullOrWhiteSpace(subPath))
    {
        blobPath = Path.Combine(blobPath, subPath);
    }

    if (!Directory.Exists(blobPath))
    {
        return new List<string>();
    }

    var di = new DirectoryInfo(blobPath);

    return di.GetFiles().Select(x => x.Name).ToList();
}

P.S. You can also add checks for TenantId and UserId to retrieve file lists for different tenants and users.

该方法 GetFileNameList 是一个扩展方法，用于从指定的本地文件系统路径中获取文件名列表。它接受三个参数：IBlobContainer 接口实例（尽管未在方法中直接使用）、blobPath（文件夹路径）以及可选的子路径 subPath。

参数处理

首先，方法检查 subPath 是否为空或仅包含空白字符：

if (!string.IsNullOrWhiteSpace(subPath))
{
    blobPath = Path.Combine(blobPath, subPath);
}

如果 subPath 有效，则将其与 blobPath 合并，生成完整的路径。

路径验证

接下来，方法验证合并后的路径是否存在：

if (!Directory.Exists(blobPath))
{
    return new List<string>();
}

如果路径不存在，则返回一个空的字符串列表，表示没有可用的文件。

获取文件名列表

如果路径存在，方法会创建一个 DirectoryInfo 实例来表示该目录：

var di = new DirectoryInfo(blobPath);

然后通过调用 GetFiles 方法获取目录中的所有文件，并使用 LINQ 将每个文件的名称提取为字符串列表：

return di.GetFiles().Select(x => x.Name).ToList();

总结

该方法的主要功能是从指定的本地目录中获取文件名列表。它通过路径合并和验证确保了输入路径的有效性，并使用 DirectoryInfo 和 LINQ 提供了简洁的文件名提取逻辑。如果路径无效或不存在，则返回空列表。

Ref

file-system