ASP.NET Core Web API で multipart / form-data を使ってファイルをアップロードする

Azure Storage Blobs client library を使って Blob Storage にアクセスできますが、

• クライアントに Azure Storage の情報を公開したくない
• アプリケーション側でアクセスログを取りたい

といった要件があった場合、ASP.NET Core Web API を経由して Blob にアクセスさせることがあります。ファイルをアップロードする際には、Content-Type に multipart / form-data を使うことが多いです。
過去に ASP.NET の記事を書きましたが、その内容を ASP.NET Core にアップデートした内容となります。
gooner.hateblo.jp
gooner.hateblo.jp

Blob Storage へのアクセス

Azure Blob Storage SDK v12 を使用する方法をまとめたので、こちらの記事を参照してください。
gooner.hateblo.jp

Controller クラス

Controller クラスのコンストラクタでは、上記の記事で作成した Blob Storage にアクセスするクラスの FileRepository のインスタンスを DI で受け取ります。

[Route("api/[controller]")]
[Produces("application/json")]
[ApiController]
public class FilesController : ControllerBase
{
    private readonly IFileRepository _repository;

    public FilesController(IFileRepository repository)
    {
        _repository = repository;
    }
}

Blob にファイルをアップロードする

ASP.NET のときは、マルチパートのコンテンツを読み取るプロバイダークラスを使うなど面倒な実装が必要でした。
ASP.NET Core では、アップロードされたファイルが IFormFile に読み込まれるのでシンプルに実装できるようになりました。

public class UploadRequest
{
    public string FileName { get; set; }
    public IFormFile File { get; set; }
}

[HttpPost]
[ProducesResponseType(StatusCodes.Status200OK)]
public async Task<ActionResult> Upload([FromForm] UploadRequest upload)
{
    var fileName = upload.FileName;
    var file = upload.File;

    if (file.Length > 0)
    {
        using (var fileStream = file.OpenReadStream())
        {
            await _repository.UploadAsync(fileStream, fileName, file.ContentType);
        }
        return Ok();
    }
    return BadRequest();
}

Blob からファイルをダウンロードする

ダウンロードの API の場合は、FileContentResult の ActionResult を返します。

[HttpGet("{fileName}")]
[ProducesResponseType(StatusCodes.Status200OK)]
public async Task<ActionResult> DownloadAsync(string fileName)
{
    var fileContents = await _repository.DownloadAsync(fileName);
    return File(fileContents, "application/octet-stream", fileName);
}

Swagger ドキュメント

ASP.NET のときは、Swashbuckle の IOperationFilter インターフェイスを使うなど面倒な実装が必要でした。
gooner.hateblo.jp
ASP.NET Core では、IFormFile が引数に使われたアクションメソッドを判定して Swashbuckle 側で対応してくれるので、特別な実装は必要ありません。
Visual Studio でプロジェクトを作成する際に、Open API サポートを有効にする設定を行うだけで OK です。

ASP.NET Core アプリケーションで Azure Blob Storage SDK v12 を使用する

ASP.NET Core アプリケーションにおいて、Azure Blob Storage SDK v12 を使用する方法をまとめておきます。
公式ドキュメントに記載のある通りなので、個人的な備忘録です。
github.com

Azure Storage の接続情報管理

Azure Storage の接続情報は、Azure Key Vault および Secret Manager で管理することを前提とします。詳細は、こちらの記事を参照してください。
gooner.hateblo.jp

NuGet パッケージのインストール

現時点で最新の Azure Storage Blobs client library である v12 を使います。

Install-Package Azure.Storage.Blobs -Version 12.10.0

www.nuget.org

ASP.NET Core アプリケーションの初期化処理

BlobServiceClient クラスのインスタンスを DI コンテナーに登録します。

public void ConfigureServices(IServiceCollection services)
{
    // Blob Storage
    services.AddSingleton(new BlobServiceClient(Configuration["WebApi:StorageConnection"]));

    // Repository
    services.AddTransient<Infrastructure.IFileRepository, Infrastructure.FileRepository>();
}

FileRepository クラスは、Blob Storage にアクセスするためのクラスとして作ることにしました。コンテナーの名前は、sample としました。

public interface IFileRepository
{
    Task UploadAsync(Stream fileStream, string fileName, string contentType);
    Task<byte[]> DownloadAsync(string fileName);
    Task<IList<string>> GetAsync();
}

public class FileRepository : IFileRepository
{
    private readonly BlobContainerClient _container;
    private const string ContainerName = "sample";

    public FileRepository(BlobServiceClient blobServiceClient)
    {
        _container = blobServiceClient.GetBlobContainerClient(ContainerName);
    }
}

Blob にファイルをアップロードする

public async Task UploadAsync(Stream fileStream, string fileName, string contentType)
{
    var blockBlob = _container.GetBlobClient(fileName);
    await blockBlob.UploadAsync(fileStream, new BlobHttpHeaders { ContentType = contentType });
}

Blob からファイルをダウンロードする

public async Task<byte[]> DownloadAsync(string fileName)
{
    var blockBlob = _container.GetBlobClient(fileName);
    var response = await blockBlob.DownloadContentAsync();
    return response.Value.Content.ToArray();
}

Blob のリストを取得する

public async Task<IList<string>> GetAsync()
{
    var result = new List<string>();
    await foreach (var blobItem in _container.GetBlobsAsync())
    {
        result.Add(blobItem.Name);
    }
    return result;
}

ASP.NET Core Web API を経由して Blob にアクセスする

こちらの記事を参照してください。
gooner.hateblo.jp

ASP.NET Core アプリケーションで Azure Data Tables SDK を使用する

ASP.NET Core アプリケーションにおいて、Azure Data Tables SDK を使用する方法をまとめておきます。
公式ドキュメントに記載のある通りなので、個人的な備忘録です。
github.com

Azure Storage の接続情報管理

Azure Storage の接続情報は、Azure Key Vault および Secret Manager で管理することを前提とします。詳細は、こちらの記事を参照してください。
gooner.hateblo.jp

NuGet パッケージのインストール

現時点で最新の Azure Tables client library である v12 を使います。

Install-Package Azure.Data.Tables -Version 12.2.1

www.nuget.org

ASP.NET Core アプリケーションの初期化処理

TableServiceClient クラスのインスタンスを DI コンテナーに登録します。

public void ConfigureServices(IServiceCollection services)
{
    // Table Storage
    services.AddSingleton(new TableServiceClient(Configuration["WebApi:StorageConnection"]));

    // Repository
    services.AddTransient<Infrastructure.IProductRepository, Infrastructure.ProductRepository>();
}

ProductRepository クラスは、Table Storage にアクセスするためのクラスとして作ることにしました。
商品マスターを題材とするので、Table 名と PartitionKey は Product としました。

public interface IProductRepository
{
    Task<IList<Product>> GetAsync();
    Task<Product> GetByIdAsync(string id);
    Task InsertAsync(Product product);
    Task UpdateAsync(Product product);
    Task DeleteAsync(Product product);
}

public class ProductRepository : IProductRepository
{
    private readonly TableClient _tableClient;
    private const string TableName = "Product";
    private const string PartitionKey = TableName;

    public ProductRepository(TableServiceClient tableServiceClient)
    {
        _tableClient = tableServiceClient.GetTableClient(TableName);
    }
}

ITableEntity インターフェイスを継承したエンティティクラスを定義します。

public class Product : ITableEntity
{
    public string PartitionKey { get; set; }

    public string RowKey { get; set; }

    public string Desc { get; set; }

    public string Name { get; set; }

    public double Price { get; set; }

    public DateTimeOffset? Timestamp { get; set; }

    public ETag ETag { get; set; }
}

商品を追加する

public async Task InsertAsync(Product product)
{
    product.PartitionKey = PartitionKey;
    product.RowKey = Guid.NewGuid().ToString();
    await _tableClient.AddEntityAsync(product);
}

商品を修正する

public async Task UpdateAsync(Product product)
{
    await _tableClient.UpdateEntityAsync(product, product.ETag);
}

商品を削除する

public async Task DeleteAsync(Product product)
{
    await _tableClient.DeleteEntityAsync(product.PartitionKey, product.RowKey);
}

商品を ID で検索する

商品 ID には、RowKey を指定します。

public async Task<Product> GetByIdAsync(string id)
{
    return await _tableClient.GetEntityAsync<Product>(PartitionKey, id);
}

商品の一覧を取得する

Table へのクエリには OData フィルターを使うこともできますが、タイプセーフではないので LINQ を使うようにします。

public async Task<IList<Product>> GetAsync()
{
    var result = new List<Product>();
    var queryResults = _tableClient.QueryAsync<Product>(x => x.PartitionKey == PartitionKey);
    await foreach (var entity in queryResults)
    {
        result.Add(entity);
    }
    return result;
}