透過 AsyncResultFilter 來處理 Entity Mapper 成 DTO

前言

一般來說，在 Controller 中透過 Repository 取回 Entity 的資料後，會再透過 Mapper 來將它轉成 DTO 傳給 Client 。例如，

[HttpGet]
public IActionResult GetBooks()
{
    var bookEntities =  _bookRepository.GetBooksAsync().Result;
    //這段從 Entity 轉成 DTO 經常寫在 Action 中
    var books = _mapper.Map<IEnumerable<Models.Book>>(bookEntities);
    return Ok(books);
}

上面的範例雖然只有一行，但卻都是相同的程式碼，這時可以將它抽到 ResultFilterAttribute 之中。

實作

建立 BooksResultFilterAttribute 來繼承 ResultFilterAttribute 實作 OnResultExecutionAsync Method。
因為會使用到 AutoMapper ，所以可以從 Constructor 中取得，或是透過 HttpContext.RequestServices.GetRequiredService ，
使用後者方式比較簡潔一些。

public class BooksResultFilterAttribute: ResultFilterAttribute
{
    public override async Task OnResultExecutionAsync(
        ResultExecutingContext context
        , ResultExecutionDelegate next)
    {
        var resultFromAction = context.Result as ObjectResult;
        if (resultFromAction?.Value == null
            || resultFromAction.StatusCode < 200
            || resultFromAction.StatusCode >= 300)
        {
            //如果錯誤或是沒資料則不處理
            await next();
            return;
        }
        //取得 AutoMapper
        var mapper = context.HttpContext.RequestServices.GetRequiredService<IMapper>();
        //將結果從 Entity 轉成 DTO
        resultFromAction.Value = mapper.Map<IEnumerable<Models.Book>>(resultFromAction.Value);
        await next();
    }
}

所以原本寫在 Action 之中的 Mapper 程式移到了 ResultFilterAttribute 後，只需在 Action 宣告使用該 Attribute 即可。

[HttpGet]
[BooksResultFilter()]
public IActionResult GetBooks()
{
    var bookEntities =  _bookRepository.GetBooksAsync().Result;
    return Ok(bookEntities);
}

如果整個 Controller 都是 Return 相同的 DTO ，則可以加在 Controller 上哦!

參考資料

Implementing Action Filters in ASP.NET Core