ABP入門系列目錄——學(xué)習(xí)Abp框架之實(shí)操演練
源碼路徑:Github-LearningMpaAbp
1. 引言
現(xiàn)在的互聯(lián)網(wǎng)已不在僅僅局限于網(wǎng)頁應(yīng)用熊赖,IOS浪听、Android钉蒲、平板浓利、智能家居等平臺正如火如荼的迅速發(fā)展宫仗,移動應(yīng)用的需求也空前旺盛够挂。所有的互聯(lián)網(wǎng)公司都不想錯過這一次移動浪潮,布局移動市場分一份移動紅利藕夫。
的確孽糖,智能手機(jī)作為我們?nèi)粘I钜驯夭豢缮俚囊徊糠郑ㄟ^手機(jī)app能夠獲得更好的體驗(yàn)毅贮,比如社交办悟、購物、娛樂滩褥、生活病蛉。
但這也引入了一個問題,如果布局移動市場瑰煎,就意味著要維護(hù)好幾條產(chǎn)品線铺然,比如網(wǎng)頁、Android酒甸、IOS魄健、微信公眾號等。這對公司來說無疑是一項(xiàng)大的投入插勤。
產(chǎn)品對于用戶來說诀艰,用戶只關(guān)心體驗(yàn)。
而對于開發(fā)者來說饮六,開發(fā)者更關(guān)心在保證業(yè)務(wù)流程及數(shù)據(jù)的正確流轉(zhuǎn)下其垄,如何對產(chǎn)品線進(jìn)行集成,來避免做重復(fù)工作卤橄。
而恰好ABP框架就已經(jīng)幫我們解決了這一問題绿满,Abp是基于【模塊化設(shè)計(jì)思想】構(gòu)建的,開發(fā)人員可以將自定義的功能以模塊(module)的形式集成到ABP中窟扑。
不同的模塊通過組裝就可以組成一個新的功能喇颁。
那你肯定很好奇如何玩轉(zhuǎn)Abp模塊,下面我們就以我們的Demo為例嚎货,來進(jìn)行微信公眾號模塊的開發(fā)橘霎。
2. 創(chuàng)建微信公眾號模塊
定義一個模塊很簡單,只需創(chuàng)建微信項(xiàng)目殖属,然后定義WeixinModule類繼承自AbpModule即可姐叁,再然后為WeixinModule定義[DependsOn]特性指定依賴的模塊即可。
2.1. 創(chuàng)建微信公眾號項(xiàng)目
新建mvc項(xiàng)目,命名項(xiàng)目名為LearningMpaAbp.Weixin。因?yàn)橐褂玫紸bp定義的模塊功能,首先要安裝Abp Nuget包坝锰,選擇后會提示需要以下Nuget包,點(diǎn)擊確定安裝即可嘱吗。
2.2. 定義微信公眾模塊
新建LearningMpaAbpWeixinModule繼承自AbpModule。代碼如下:
public class LearningMpaAbpWeixinModule:AbpModule
{
/// <summary>
/// 預(yù)初始化滔驾,通常是用來配置框架以及其它模塊
/// </summary>
public override void PreInitialize()
{
base.PreInitialize();
}
/// <summary>
/// 初始化谒麦,一般用來依賴注入的注冊
/// </summary>
public override void Initialize()
{
//把當(dāng)前程序集的特定類或接口注冊到依賴注入容器中
IocManager.RegisterAssemblyByConvention(Assembly.GetExecutingAssembly());
}
/// <summary>
/// 提交初始化,一般用來解析依賴關(guān)系
/// </summary>
public override void PostInitialize()
{
base.PostInitialize();
}
/// <summary>
/// 應(yīng)用關(guān)閉時調(diào)用
/// </summary>
public override void Shutdown()
{
base.Shutdown();
}
}
從代碼中可以看出主要包括四個重載方法哆致,每個重載方法負(fù)責(zé)不同的職責(zé)弄匕。
2.3. 指定依賴模塊
因?yàn)槲覀冃枰ㄟ^webapi與現(xiàn)有demo進(jìn)行交互,所以還需要安裝Abp.Web.Api Nuget包沽瞭。
那怎樣指定依賴呢迁匠,只需要通過[DependsOn]特性指定即可。
[DependsOn(typeof(AbpWebApiModule))]
public class LearningMpaAbpWeixinModule:AbpModule
{
//....
}
好了驹溃,一個微信公眾號模塊的基礎(chǔ)項(xiàng)目框架搭好了城丧,是不是很簡單!
到這一步豌鹤,你可能會問亡哄,你這只是簡單創(chuàng)建微信公眾號模塊,但如何與我們Demo進(jìn)行集成交互呢布疙?
對的蚊惯,是只簡單創(chuàng)建了微信模塊,但這一節(jié)我不打算講如何與Demo進(jìn)行集成交互灵临。因?yàn)樵诮榻B如何通過webapi與系統(tǒng)交互之前截型,梳理下Abp模塊化的設(shè)計(jì),更能幫助我們了解模塊化設(shè)計(jì)思想儒溉。
下面我們就簡單梳理下ABP模塊化的設(shè)計(jì)宦焦。
3. ABP模塊化設(shè)計(jì)
說到模塊,突然想到幾個單詞考考大家顿涣,model波闹、modal、module分別是什么意思涛碑?
不知道的就自行查詞典吧精堕。
下面回歸正題。
3.1. 模塊化相關(guān)類型
先來看看模塊相關(guān)類型依賴圖:
從類型依賴圖中可以看出設(shè)計(jì)的并不復(fù)雜:
- AbpModule:所有定義的模塊均需繼承此抽象類蒲障。
- AbpModuleInfo:可以理解為AbpModule的元數(shù)據(jù)歹篓,封裝AbpModule的基本信息瘫证,主要包括Assembly(所屬程序集)、Type(類型)滋捶、Dependencies(依賴的模塊)、IsLoadedAsPlugIn(是否插件模塊)余黎。
- AbpModuleCollection:從類的申明:
class AbpModuleCollection : List
可知它是一個AbpModuleInfo的集合重窟。 - AbpModuleManager:模塊管理類,主要用來進(jìn)行模塊管理惧财,比如啟動關(guān)閉模塊巡扇。
- DependsOnAttribute:依賴特性,用來標(biāo)明模塊的依賴項(xiàng)垮衷。
3.2. Abp如何發(fā)現(xiàn)并加載模塊
Abp中定義了一個啟動類AbpBootstraper
厅翔,該類的職責(zé)是啟動整個Abp系統(tǒng),主要負(fù)責(zé)依賴注入和注冊模塊以供啟動搀突。而該類必須在應(yīng)用程序啟動時最先被實(shí)例化刀闷。
而作為Abp生成的模板項(xiàng)目,啟動項(xiàng)目自然是web應(yīng)用仰迁,所以AbpBootstrapper
肯定在Web項(xiàng)目中被初始化甸昏。眾所周知,web項(xiàng)目的啟動是從Global.asax文件的Application_Start
項(xiàng)目開始的徐许。
public class MvcApplication : AbpWebApplication<LearningMpaAbpWebModule>
{
protected override void Application_Start(object sender, EventArgs e)
{
AbpBootstrapper.IocManager.IocContainer.AddFacility<LoggingFacility>(
f => f.UseAbpLog4Net().WithConfig("log4net.config")
);
base.Application_Start(sender, e);
}
}
我們先來觀察下類的申明施蜜,有沒有發(fā)現(xiàn)什么特別之處?
繼承的是泛型基類且指定的泛型為LearningMpaAbpWebModule
雌隅,指定了一個Module翻默,當(dāng)前web項(xiàng)目的Moduel。
對MVC比較熟悉的同學(xué)應(yīng)該知道恰起,MVC應(yīng)用程序啟動類默認(rèn)是繼承自HttpApplication
的修械。從該段代碼可以看出,Abp修改了MvcApplication
的默認(rèn)繼承類检盼。那自然AbpWebApplication<T>
是繼承自HttpApplication
了祠肥。廢話不多說,來看一看具體的定義:
public abstract class AbpWebApplication<TStartupModule>
: HttpApplication where TStartupModule : AbpModule
{
/// <summary>
/// Gets a reference to the <see cref="P:Abp.Web.AbpWebApplication`1.AbpBootstrapper" /> instance.
/// </summary>
public static AbpBootstrapper AbpBootstrapper { get; } = AbpBootstrapper.Create<TStartupModule>();
/// <summary>
/// This method is called by ASP.NET system on web application's startup.
/// </summary>
protected virtual void Application_Start(object sender, EventArgs e)
{
ThreadCultureSanitizer.Sanitize();
AbpWebApplication<TStartupModule>.AbpBootstrapper.Initialize();
}
/// <summary>
/// This method is called by ASP.NET system on web application shutdown.
/// </summary>
protected virtual void Application_End(object sender, EventArgs e)
{
AbpWebApplication<TStartupModule>.AbpBootstrapper.Dispose();
}
//省略了部分代碼
}
首先映入眼簾的是基類中定義的AbpBootstraper
屬性梯皿,然后看到的是Application_Start
和Application_End
虛方法仇箱。
Application_Start
方法中調(diào)用了AbpBootstrapper.Initialize()
方法。相當(dāng)于AbpBootstrapper.Create<TStartupModule>().Initialize();
代碼是不是看累了东羹,上圖剂桥,咱們直接來看web項(xiàng)目啟動時Module動態(tài)加載的調(diào)用堆棧。
是不是一目了然属提,總結(jié)以下:
Abp在啟動項(xiàng)目時根據(jù)指定的啟動模塊(StartupModule)首先加載該模塊权逗,然后再去檢查該模塊的自定義特性是否定義有[DependsOn]特性美尸,若有則按序加載所有依賴的模塊,也就是鏈?zhǔn)絼討B(tài)依賴加載斟薇。然后再依次調(diào)用Module的PreInitialize师坎,Initialize和PostInitialize以完成初始化。
好了模塊的啟動加載就講到這里堪滨,感興趣的還是建議大家直接看看源碼胯陋。
這里推薦一篇文章ABP源碼分析三:ABP Module,來幫助大家理解Abp的模塊化思想袱箱。
4. 總結(jié)
這一節(jié)有點(diǎn)標(biāo)題黨的味道遏乔,但內(nèi)容也算點(diǎn)題了。下一篇我將介紹微信公眾號模塊如何通過WebApi與系統(tǒng)進(jìn)行交互发笔,盡情期待盟萨。