5.1 ABP分散式服務 ASP.NET Web API Controllers

5.1.1 簡介

ABP已經把 ASP.NET Web API Controllers 整合到了 Abp.Web.Api，你只要通過Nuget安裝它。正如你一直那樣做得，你可以建立常規的ASP.NET Web API Controllers，
依賴注入可以解析常規的ApiControllers。

為了能夠享受使用ABP.Web.Api帶來的便利，應該使你的controllers派生自 AbpApiController。

5.1.2 AbpApiController 基類

下面是一個簡單的派生自AbpApiController的示例程式碼：

public class UsersController : AbpApiController
{

}

1. 本地化

為了使本地化更容易，在AbpApiController中定義了一個方法：L；
如下所示：

public class UsersController : AbpApiController
{
    public UsersController()
    {
        LocalizationSourceName = "MySourceName";
    }

    public UserDto Get(long id)
    {
        var
 
 helloWorldText = L("HelloWorld");

        //...
    }
}

為了能夠使用 L 方法，首先我們應該初始化 LocalizationSourceName。當然，為了不重複初始化該變數，我們可以定義一個繼承自AbpApiController的基類，在該類中初始化它，以後所有的Controller類都繼承自該基類。

2. 其他

你也可以(pre-inijected)預先注入 AbpSession, EventBus, PermissionManager, PermissionChecker, SettingManager, FeatureManager, FeatureChecker, LocalizationManager, Logger, CurrentUnitOfWork 等基礎屬性。

3. 過濾器

ABP為ASP.NET Web API定義了一些預先構建的過濾器。預設它們被新增到了所有控制器的所有Action。

4. 審計日誌

對於審計日誌我們可以使用過濾器：AbpApiAuditFilter。它預設記錄請求到所有Actions的日誌(如果審計沒有禁用)。你可以使用特性 Audited 和 DisableAuditing 來控制控制器的Action是否記錄日誌。

你可以用AbpApiAuthorize特性來阻止未授權的使用者來訪問你的Controllers和Actions。
示例如下：

public class UsersController : AbpApiController
{
    [AbpApiAuthorize("MyPermissionName")]
    public UserDto Get(long id)
    {
        //...
    }
}

你可以對Action或者控制器來使用 AllowAnonymous 特性來禁用身份認證/授權。
AbpApiController也定義了一個快速檢測許可權的方法 IsGranted。
詳情請參照authorization。

6. 反偽造過濾器

對於POST,PUT以及DELETE的CSRF/XSRF攻擊請求，我們可以使用 AbpAntiForgeryApiFilter 來保護ASP.NET WEB API Actions(包括動態Web Api)。詳細瞭解請參考CSRF文件。

7. 工作單元

對於工作單元，我們可以使用 AbpApiUowFilter 過濾器。它會在Action執行之前自動的開啟一個新的工作單元，在Action執行之後完成該工作單元(如果沒有異常丟擲)。

你可以使用 UnitOfWork 特性來控制某個Action的UOW行為。你也可以在啟動配置中對所有的Action改變其預設的工作單元特性。

8. 包裝返回結果&異常處理

如果action執行成功，ABP 預設 沒有對Web API的actions的返回結果進行包裝。但是，它對 異常進行了處理和包裝。如果需要，你可以新增 WrapResult/DontWrapResult 到actions和控制器上。你可以從啟動配置中改變這個預設行為(使用： Configuration.Modules.AbpWebApi()…)。關於對結果包裝的瞭解請參考AJAX文件。

9. 快取結果

對於Web API請求，ABP添加了 Cache-Control 頭(no-cache, no-store)的響應。因此，它阻止瀏覽器對響應的快取，即使該請求是GET請求。該行為可以在配置中被禁用。

10. 驗證

AbpApiValidationFilter 過濾器自動的檢查 ModelState.IsValid 並且阻止action的執行，如果該action沒有通過驗證。同時，實現了input DTO 的驗證，詳細瞭解請閱讀資料傳輸物件驗證。

11. 模型繫結

AbpApiDateTimeBinder 過濾器被用來標準化DateTime(以及Nullable\