一、什么是ABP vNext?
ABP.Vnext是一個基於Asp.Net Core Web應用程序框架。主要目的是用來快速開發Web應用,
ABP.Vnext不僅提供完整Web應用程序開發模板,而且提供Web應用程序開發所需要的一些基礎設施功能。
二、什么是Module?
當然每個人看問題的角度不一樣,如何能讓自己快速理解就先用什么方式吧,從萬物皆對象的角度,也可以說萬物皆模塊,只是需要自己去平衡它的邊界。
我自己認為模塊就是對所有組件和業務模塊的抽象,取的一個名字,例如在OA系統中可以按照業務划分考勤模塊,請假模塊,員工模塊等,也可以按照自己理解的方式去拆分處模塊,最終各個不同的模塊拼湊在一起協作,形成一個完整的應用程序,方便維護和及快速開發。
三、在ABP中如何使用Module
環境vs2019和.NET5
1.控制台應用程序
1.創建一個控制台應用程序
2.然后Nuget安裝Abp vNext
Nuget Volo.Abp.Core
3.然后在控制台項目中創建模塊來使用ABP,每一個自定義模塊必須繼承AbpModule
public class ConsoleModule : AbpModule
{
public override void ConfigureServices(ServiceConfigurationContext context)
{
// 1、IOC注冊自定義類
System.Console.WriteLine("加載AbpModuleModule模塊");
//此處可以用於當前模塊注冊一些服務
//context.Services.AddSingleton<CustomService>();
//ConsoleHostedService主機服務,需要繼承自IHostedService
context.Services.AddHostedService<ConsoleHostedService>();
}
}
4.修改Progarm啟動類
static void Main(string[] args)
{
CreateHostBuilder(args).RunConsoleAsync().Wait();
}
internal static IHostBuilder CreateHostBuilder(string[] args) =>
Host.CreateDefaultBuilder(args)
.ConfigureAppConfiguration()
.ConfigureServices((hostContext, services) =>
{
//應用程序裝載自定義模塊作為啟動模塊
services.AddApplication<ConsoleModule>();
});
2.Web應用程序
1.創建一個Web應用程序
2.然后Nuget安裝Abp.Vnext
Nuget Volo.Abp.Core
3.然后在WEB項目中創建一個WebModule模塊來使用ABP,模塊必須繼承AbpModule
public class WebModule : AbpModule
{
public override void ConfigureServices(ServiceConfigurationContext context){}
public override void OnApplicationInitialization(ApplicationInitializationContext context){}
}
4.在原有Startup類中修改代碼
public class Startup
{
public void ConfigureServices(IServiceCollection services)
{
//在服務中心注冊WebModule為啟動項
services.AddApplication<WebModule>();
}
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
//框架初始化應用程序
app.InitializeApplication();
}
}
5.將原有Web中Startup類中的注冊服務和配置中間件的內容移到WebModule中
public class WebModule : AbpModule
{
//注冊服務
public override void ConfigureServices(ServiceConfigurationContext context)
{
context.Services.AddControllers();
}
//應用程序開始時注冊中間件
public override void OnApplicationInitialization(ApplicationInitializationContext context)
{
var app = context.GetApplicationBuilder();
var env = context.GetEnvironment();
if (env.IsDevelopment())
{
app.UseDeveloperExceptionPage();
}
app.UseStaticFiles();
app.UseRouting();
app.UseConfiguredEndpoints();
}
}
四、模塊依賴注冊
1.自定義模塊
除了項目啟動模塊的使用如控制台,web項目等,如果要自定義模塊其實也和上述2種使用方式相同,並且更為簡單,不需要其他的加載項配置,只需要引入Abp.Vnext繼承自AbpModule即可。
創建一個自定義的公共模塊
public class CommonModule : AbpModule
{
//模塊加載時配置一些操作或初始化服務
public override void ConfigureServices(ServiceConfigurationContext context)
{
System.Console.WriteLine("加載自定義CommonModule模塊");
}
}
2.模塊依賴
假設我在我的控制台項目想要依賴我的公共模塊,我應該怎么做呢,傳統沒有使用ABP的做法是直接引入對應類就可以完成依賴並且使用,但是使用了ABP框架之后,需要在傳統的做法上做一些事情,就是在模塊類上加入 [DependsOn()]特性即可。
例如我的A模塊需要依賴我的B模塊
[DependsOn(typeof(B))]
public class A : AbpModule
{
public override void ConfigureServices(ServiceConfigurationContext context)
{
System.Console.WriteLine("自定義A模塊");
}
}
public class B : AbpModule
{
public override void ConfigureServices(ServiceConfigurationContext context)
{
System.Console.WriteLine("自定義B模塊");
}
}
3.服務注冊
首先我們要知道服務和模塊是被包含的關系,“模塊”包含“服務”
在使用了ABP框架后在模塊中注冊服務有3
種方式
1.在模塊類中的ConfigureServices方法中手動注冊服務
,但是如果服務增多,ConfigureServices方法中將會產生大量的注冊代碼,需要維護
public class CommonModule : AbpModule
{
public override void ConfigureServices(ServiceConfigurationContext context)
{
context.Services.AddTransient<CommonService>();
}
}
2.繼承自約束接口例如ITransientDependency,ISingletonDependency
,接口約束
public class CommonService:ITransientDependency
{
public void Common()
{
System.Console.WriteLine("CommonService 執行");
}
}
3.在需要被注冊的服務商使用特性標記[Dependency(ServiceLifetime.Transient)]
,推薦使用職責分明
//注冊服務生命周期為瞬時
[Dependency(ServiceLifetime.Transient)]
public class CommonService
{
public void Common()
{
System.Console.WriteLine("CommonService 執行");
}
}
五、插件加載
有時候我們想實現某個標准功能的接口做一個插件模塊,按需要手動配置到項目中,需要的時候就給他配置,不需要就去掉配置,而不是像模塊依賴一樣需要強引用,那這種做法就可以使用abp的插件加載機制
其實原理並不難,知道怎么用后,完全可以自己寫一個,我們先給出在ABP中的實現步驟
1.使用vs創建插件項目Common.PlugIn模塊
2.然后創建插件目錄PlugIns
3.然后將Common.PlugIn.dll復制到PlugIns目錄中
4.然后在Console項目中Program加載PlugIns
5.在web項目中就是在Startup注冊服務中加入以下代碼
services.AddApplication<ConsoleModule>(options =>
{
options.PlugInSources.AddFolder(@"\Plugin");
});
});
六.ABP CLI使用
1.安裝CLI & 更新
dotnet tool install -g Volo.Abp.Cli
dotnet tool update -g Volo.Abp.Cli
2.創建項目
進入需要創建項目的文件夾位置,打開PowerSheel或者CMD
//創建默認mvc項目
abp new Project.Web -o
//創建基於sqlserver的webmvc項目
abp new Project.Web -o --dbms mssql -o
//創建基於mysql的api項目的4.4.3版本
abp new Project.WebApi --dbms mysql -u none -o -v 4.4.3
//創建控制台項目
abp new Project.Console -t console -o