1. 程式人生 > >ABP原始碼分析三十六:ABP.Web.Api

ABP原始碼分析三十六:ABP.Web.Api

這裡的內容和ABP 動態webapi沒有關係。除了動態webapi,ABP必然是支援使用傳統的webApi。ABP.Web.Api模組中實現了一些同意的基礎功能,以方便我們建立和使用asp.net webApi。

AbpApiController:這是一個抽象基類,繼承自ApiController,是AB WebApi系統中所有controller的基類。如下圖中,其封裝了ABP核心模組中提供的大多數的功能物件。同時實現了一些公共的方法。它有四個派生類:DynamicApiController<T>,TypeScriptController,AbpCacheController,AbpServiceProxiesController。

ApiControllerConventionalRegistrar:所有AbpApiController的派生類都被register到ABP系統的容器中

HttpParameterBindingExtensions:HttpParameterBinding類的擴充套件方法,用於判斷方法引數是否從URI取值。

AbpApiAuthorizeAttribute:實現了IAbpAuthorizeAttribute,繼承ASP.NET 的AuthorizeAttribute。其封裝了Permissions和RequireAllPermissions用於配置許可權,其重寫了IsAuthorized的方法用於實現ABP的授權校驗邏輯。

AbpRemoteCallException:繼承AbpException。用於封裝ABP webapi返回給客戶端(C#)的Exception.

IAbpWebApiClient:定義了訪問ABP webAPI的介面。

AbpWebApiClient:實現了IAbpWebApiClient中定義的訪問ABP webapi的方法。其內部通過封裝HttpClient來訪問webapi,然後根據遠端API的response返回相應的結果給客戶端。

以下兩個方法用於將CLR物件轉換為json物件,或者將Json物件轉換為CLR物件。這邊定義的將CLR物件轉換為Json物件方法似乎多餘了,因為作者已經在ABP核心框架中定義了一個object的擴充套件方法將CLR物件轉換為Json物件。

AbpCacheController : 繼承自AbpApiController,用於清理快取(clear 和 ClearAll)。

ClearAllCacheModel : 只有一個password 屬性。

ClearCacheModel:有一個password 屬性和一個待清空的cache's name陣列

ClearCacheSettingProvider:注意清理快取的方法會先檢驗密碼,清除快取的密碼是以setting配置到ABP中的。ClearCacheSettingProvider為該設定提供了一個初始密碼,密碼是硬編碼到程式碼中的,如下圖:

也就是你可以用這個密碼清空任何套用ABP模板開發的站點(沒有重新設定這個密碼)的快取。這裡建議你到web.config中重置這個密碼。

WrapResultAttribute:該特性用於標註webApi如何封裝response.比如WrapOnError表示將錯誤資訊封裝到response返回到客戶端。LogError標識將錯誤資訊log到日誌中。

HttpActionDescriptorHelper:通過action的HttpActionDescriptor來獲取controller或action的WrapResultAttribute。

AbpExceptionFilterAttribute:繼承自ExceptionFilterAttribute,重寫OnException,以實現自定義的ExceptionFilter:根據action上標註的wrapResult來判斷是否要log或通過eventbus觸發事件

DynamicApiClientBuilder,IApiClientBuilder<TService>,ApiClientBuilder<TService>,DynamicApiClientBuilder:未實現,暫時忽略。

HttpVerbExtensions:HttpVerb的擴充套件方法,用於和httpmethod的比較。

相關推薦

ABP原始碼分析ABP.Web.Api

這裡的內容和ABP 動態webapi沒有關係。除了動態webapi,ABP必然是支援使用傳統的webApi。ABP.Web.Api模組中實現了一些同意的基礎功能,以方便我們建立和使用asp.net webApi。 AbpApiController:這是一個抽象基類,繼承自ApiController,是AB

ABP原始碼分析ABP.AutoMapper

這個模組封裝了Automapper,使其更易於使用。 下圖描述了改模組涉及的所有類之間的關係。 AutoMapAttribute,AutoMapFromAttribute和AutoMapToAttribute:這三個attribute用於標註一個類到另外一個類的map方向。 Auto

ABP原始碼分析ABP.Web.Mvc

ABP.Web.Mvc模組主要完成兩個任務: 第一,通過自定義的AbpController抽象基類封裝ABP核心模組中的功能,以便利的方式提供給我們建立controller使用。 第二,一些常見的基礎功能的實現。 AbpController:這是一個抽象基類,繼承自MVC Controller,是A

ABP原始碼分析ABP中動態WebAPI原理解析

動態WebAPI應該算是ABP中最Magic的功能之一了吧。開發人員無須定義繼承自ApiController的類,只須重用Application Service中的類就可以對外提供WebAPI的功能,這應該算是對DRY的最佳詮釋了. 如下圖所示,一行程式碼就為所有實現了IApplicationService的

ABP原始碼分析ABP.SignalR

Realtime Realtime是ABP底層模組提供的功能,用於管理線上使用者。它是使用SignalR實現給線上使用者傳送通知的功能的前提 IOnlineClient/OnlineClient: 封裝線上使用者的資訊 OnlineClientManager/IOnlineClientManager:

ABP原始碼分析ABP.Hangfire

ABP對HangFire的整合主要是通過實現IBackgroundJobManager介面的HangfireBackgroundJobManager類完成的。 HangfireBackgroundJobManager:實現了介面IBackgroundJobManager中的方法EnqueueAsync,通過

ABP原始碼分析ABP.Web.Api Script Proxy API

ABP提供Script Proxy WebApi為所有的Dynamic WebApi生成訪問這些WebApi的JQuery代理,AngularJs代理以及TypeScriptor代理。這些個代理就是javascript指令碼,通過這些代理可以簡單的訪問Dynamic webApi。 如下例項演示一個最基本的

ABP原始碼分析核心框架中的一些其他功能

本文是ABP核心專案原始碼分析的最後一篇,介紹一些前面遺漏的功能 AbpSession AbpSession: 目前這個和CLR的Session沒有什麼直接的聯絡。當然可以自定義的去實現IAbpSession使之與CLR的Session關聯 IAbpSession:定義如下圖中的四個屬性。 NullA

ABP原始碼分析ABP.MongoDb

這個Module通過建立一個MongoDbRepositoryBase<TEntity> 基類,封裝了對MongoDb資料庫的操作。 這個module通過引用MongoDB.Driver,MongoDB.Bson,MongoDB.Driver.Core,MongoDB.Driver.Legacy類

ABP原始碼分析ABP.Entity Framework

IRepository:介面定義了Repository常見的方法 AbpRepositoryBase:實現了IRepository介面的常見方法 EfRepositoryBase:實現了AbpRepositoryBase中定義的抽象方法:GetAll,Insert,Delete,Update。在實

ABP原始碼分析ABP.MemoryDB

這個模組簡單,且無實際作用。一般實際專案中都有用資料庫做持久化,用了資料庫就無法用這個MemoryDB 模組了。原因在於ABP限制了UnitOfWork的型別只能有一個(前文以作介紹),一般用了資料庫的必然要注入efUnitOfWork. 而注入了efUnitOfWork就不能在注入MemoryDbUnitO

ABP原始碼分析ABP中的異常處理

ABP 中異常處理的思路是很清晰的。一共五種型別的異常類。 AbpInitializationException用於封裝ABP初始化過程中出現的異常,只要丟擲AbpInitializationException異常就可以,無須做額外處理。這類異常往往是需要維護人員介入分析的。 其他四個異常都在AbpCon

ABP原始碼分析ZERO的身份認證

ABP Zero模組通過自定義實現Asp.Net Identity完成身份認證功能, 對Asp.Net Identity做了較大幅度的擴充套件。同時重寫了ABP核心模組中的permission功能,以實現授權。注意:ABP僅僅使用了Asp.Net Identity的身份認證功能,但沒有使用Asp.Net Id

ABP原始碼分析ZERO的Audit,Setting,Background Job

AuditLog: 繼承自Entity<long>的實體類。封裝AuditLog的資訊。 AuditingStore: 實現了IAuditingStore介面,實現了將AuditLog的資訊儲存到資料庫的功能。其通過IRepository<AuditLog, long>例項完成對資料

ABP原始碼分析EventBus

IEventData/EventData: 封裝了EventData資訊,觸發event的源物件和時間 IEventBus/EventBus: 定義和實現了了一系列註冊,登出和觸發事件處理函式的方法。EventBus定義了一個Dictionary容器來存放事件和處理該事件的物件(其實不是物件而是Factor

ABP原始碼分析八: ABP.Web.Api.OData

如果對OData不熟悉的話可參考OData的初步認識一文以獲取OData的一些初步知識。 API.Odata 模組唯一用處就是提供了一個泛型版本的ODataController,實現了Controller程式碼的常用。 AbpODataEntityController<TEntity, TPrima

ABP原始碼分析Navigation

MenuDefinition:封裝了導航欄上的主選單的屬性。 MenuItemDefinition:封裝了主選單的子選單的屬性。子選單可以引用其他子選單構成一個選單樹 UserMenu/UserMenuItem:封裝了用於顯示給使用者的選單/以及子選單集合。 ABP通過MenuDefinition/M

ABP原始碼分析Feature

Feature是什麼?Feature就是對function的分類方法,其與function的關係就比如Role和User的關係一樣。 ABP中Feature具有以下屬性: 其中最重要的屬性是name,用以表示feature的Identity,一個feature一個name. 一個Feature可以有一組子F

ABP原始碼分析ZERO的配置

ABP Zero模組中需要配置的地方主要集中在三塊:配置靜態的role,配置外部認證源,以及配置本地化語言和資源。 UserManagementConfig/IUserManagementConfig:定義了一個配置項,用於配置外部認證源。預設情況下,ABP Zero使用AbpUser表作為身份

ABP原始碼分析Notification

NotificationDefinition: 用於封裝Notification Definnition 的資訊。注意和Notification 的區別,如果把Notification看成是具體的訊息內容,NotificationDefinition則是對這個訊息自身的定義(可理解為訊息的型別)。