APB vNext 框架入門
快速入門案例
.NET Core 控制台應用
1. 安裝 ABP 框架核心依賴
Install-Package Volo.Abp.Core -Version 3.3.2
2. 新建 ABP 應用的啟動模塊
HelloAbpModule.cs
using Volo.Abp.Modularity;
namespace HelloAbp
{
/// <summary>
/// 啟動模塊
/// </summary>
public class HelloAbpModule : AbpModule
{
}
}
3. 新建服務，並注冊到啟動模塊中
HelloWorldService.cs
using System;
using Volo.Abp.DependencyInjection;
namespace HelloAbp
{
/// <summary>
/// TODO: ABP 注冊服務方式一： 繼承接口
/// ISingletonDependency、IScopedDependency、ITransientDependency
/// </summary>
public class HelloWorldService : ITransientDependency
{
public void Run()
{
Console.WriteLine($"{nameof(HelloAbpModule)}-{nameof(HelloWorldService)}: Hello World!");
}
}
}
4. 根據啟動模塊創建 ABP應用，調用應用中注冊的服務方法
Program.cs
using System;
using Microsoft.Extensions.DependencyInjection;
using Volo.Abp;
namespace HelloAbp
{
class Program
{
static void Main(string[] args)
{
// 根據啟動模塊創建 abp 應用
var application = AbpApplicationFactory.Create<HelloAbpModule>();
// 初始化 abp 應用
application.Initialize();
// 獲取應用中注冊的服務
var service = application.ServiceProvider.GetService<HelloWorldService>();
// 調用應用中的服務方法
service.Run();
Console.ReadKey();
}
}
}
ASP.NET Core Web 應用程序
1. 安裝 ABP 框架核心依賴
Install-Package Volo.Abp.Core -Version 3.3.2
Install-Package Volo.Abp.AspNetCore.Mvc -Version 3.3.2
2.新建 ABP 應用的啟動模塊
AppModule.cs
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.Hosting;
using Volo.Abp;
using Volo.Abp.AspNetCore.Mvc;
using Volo.Abp.Modularity;
namespace HelloWebAbp
{
/// <summary>
/// 啟動模塊
/// TODO: 1.在啟動模塊中配置 ASP.NET Core Web 程序的管道，就需要定義對 ASP.NET Core Mvc模塊的依賴
/// </summary>
[DependsOn(typeof(AbpAspNetCoreMvcModule))]
public class AppModule : AbpModule
{
/// <summary>
/// 應用初始化方法
/// TODO: 2.重寫 ABP 應用的初始化方法，用來構建 ASP.NET Core 應用程序的中間件管道
/// </summary>
/// <param name="context"></param>
public override void OnApplicationInitialization(ApplicationInitializationContext context)
{
// base.OnApplicationInitialization(context);
var app = context.GetApplicationBuilder();
var env = context.GetEnvironment();
if (env.IsDevelopment())
{
app.UseDeveloperExceptionPage();
}
app.UseRouting();
// TODO: 5.將 程序應用的端點配置 修改為 ABP 應用的端點配置
app.UseConfiguredEndpoints();
}
}
}
3. 注冊 ABP 啟動模塊，並初始化 ABP 應用
Startup.cs
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
namespace HelloWebAbp
{
/// <summary>
/// 程序啟動類
/// TODO: 3. 在 Startup 類中，完成對 ABP 應用的初始化
/// </summary>
public class Startup
{
// This method gets called by the runtime. Use this method to add services to the container.
// For more information on how to configure your application, visit https://go.microsoft.com/fwlink/?LinkID=398940
public void ConfigureServices(IServiceCollection services)
{
services.AddApplication<AppModule>();
}
// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
app.InitializeApplication();
}
}
}
4. 新建控制器，測試 ABP 應用運行狀態
HomeController.cs
using Microsoft.AspNetCore.Mvc;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Volo.Abp.AspNetCore.Mvc;
namespace HelloWebAbp.Controllers
{
/// <summary>
/// 控制器
/// TODO: 4. 繼承 Abp 框架中的基類控制器（提供了一些便捷的服務和方法）
/// </summary>
public class HomeController : AbpController
{
public IActionResult Index()
{
return Content("Hello world!");
}
}
}
各個擊破案例
ABP應用中的模塊可以有很多個，但是啟動模塊只能有一個；
ABP應用中的每個模塊之間沒有必然的聯系；
ABP應用中每個模塊注冊的服務，都注冊到了ABP應用的全局容器中;
ABP應用中的模塊也分為兩種類型：應用程序模塊(業務實現)和框架模塊(技術實現)；
ABP應用中最頂層的模塊是啟動模塊，最后被加載的也是啟動模塊。
在模塊中注冊自定義服務
HelloAbpModule.cs
using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.Extensions.DependencyInjection;
using Volo.Abp;
using Volo.Abp.Modularity;
namespace HelloAbp
{
/// <summary>
/// 啟動模塊
/// </summary>
public class HelloAbpModule : AbpModule
{
// TODO: 重寫 ABP 模塊的服務配置方法，向模塊中注冊自定義的服務
public override void ConfigureServices(ServiceConfigurationContext context)
{
base.ConfigureServices(context);
// TODO: ABP 注冊服務方式二： 模塊注冊
context.Services.AddTransient<HelloWorldService>();
}
}
}
小結
初始化ABP模塊
- 1.注冊ABP基礎設施與核心服務（模塊系統相關）
- 2.加載整個應用的所有模塊，按照依賴性排序
- 3.按順序遍歷所有模塊，執行每一個模塊的配置方法
- 4.按順序遍歷所有模塊，執行每一個模塊的初始化方法
使用標簽屬性注冊自定義服務
HelloWorldService.cs
using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.Extensions.DependencyInjection;
using Volo.Abp.DependencyInjection;
namespace HelloAbp
{
/// <summary>
/// TODO: ABP 注冊服務方式三： 特性標簽
/// ServiceLifetime.Singleton、ServiceLifetime.Scoped、ServiceLifetime.Transient
/// </summary>
[Dependency(ServiceLifetime.Transient)]
public class HelloWorldService
{
public void Run()
{
Console.WriteLine($"{nameof(HelloAbpModule)}-{nameof(HelloWorldService)}: Hello World!");
}
}
}
ABP 項目中使用 Autofac
1. 安裝 Autofac 模塊
Install-Package Volo.Abp.Autofac -Version 3.3.2
2. 在模塊中創建對 Autofac 模塊的依賴
HelloAbpModule.cs
using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.Extensions.DependencyInjection;
using Volo.Abp;
using Volo.Abp.Autofac;
using Volo.Abp.Modularity;
namespace HelloAbp
{
/// <summary>
/// 啟動模塊
/// </summary>
// TODO: 使用 Autofac 第三方依賴注入框架（提供了更多的高級特性）
[DependsOn(typeof(AbpAutofacModule))]
public class HelloAbpModule : AbpModule
{
public override void ConfigureServices(ServiceConfigurationContext context)
{
base.ConfigureServices(context);
context.Services.AddTransient<HelloWorldService>();
}
}
}
3. 在ABP應用創建時集成 Autofac
Program.cs
using System;
using Microsoft.Extensions.DependencyInjection;
using Volo.Abp;
namespace HelloAbp
{
class Program
{
static void Main(string[] args)
{
{
// 根據啟動模塊創建 abp 應用
var application = AbpApplicationFactory.Create<HelloAbpModule>(options =>
{
// 集成 Autofac
options.UseAutofac();
});
// 初始化 abp 應用
application.Initialize();
// 獲取應用中注冊的服務
var service = application.ServiceProvider.GetService<HelloWorldService>();
// 調用應用中的服務方法
service.Run();
}
Console.WriteLine("Hello World!");
Console.ReadKey();
}
}
}