手把手教你用Abp vnext構建API介面服務
阿新 • • 發佈：2020-03-17
ABP是一個開源應用程式框架,該專案是ASP.NET Boilerplate Web應用程式框架的下一代，專注於基於ASP.NET Core的Web應用程式開發,也支援開發控制檯應用程式。
官方網站：[https://abp.io/](https://abp.io/)
官方文件：[https://docs.abp.io/](https://docs.abp.io/)
### 一、使用ABP框架可以快速的搭建一個應用程式，僅需要幾步即可完成：
#### 1. 安裝ABP CLI
ABP CLI是使用ABP框架啟動新解決方案的最快方法。如果沒有安裝ABP CLI，使用命令列視窗安裝ABP CLI：
```
dotnet tool install -g Volo.Abp.Cli
```
#### 2. 在一個空資料夾中使用abp new命令建立您的專案：
```
abp new Acme.BookStore
```
您可以使用不同級別的名稱空間。例如BookStore，Acme.BookStore或Acme.Retail.BookStore。
這樣，就已經完成了一個應用程式的搭建。
然後我們只需要修改一下其他的配置即可執行應用程式，開發人員在這個架構的基礎上就可以愉快的擼程式碼了。
然而，ABP的學習才剛剛開始。ABP放棄了原有MVC的架構，使用了模組化架構，支援微服務，根據DDD模式和原則設計和開發，為應用程式提供分層模型。對於沒有微服務開發經驗的程式設計師來說，學習ABP難度比較大。下面我們開始從一個空的web解決方案，一步步搭建API介面服務。
### 二、用APB基礎架構搭建一個使用者中心API介面服務
開發環境：Mac Visual Studio Code
SDK：dotnet core 3.1
#### 1. 首先我們建立一個資料夾Lemon.UserCenter，並在終端中開啟該資料夾。
使用命令建立一個空的web方案：
```
dotnet new web -o Lemon.UserCenter.HttpApi.Hosting
```
#### 2. 再使用命令建立其他類庫方案：
```
建立api層
dotnet new classlib -o Lemon.UserCenter.HttpApi
建立應用層
dotnet new classlib -o Lemon.UserCenter.Application
建立領域層
dotnet new classlib -o Lemon.UserCenter.Domain
建立基於EntityFrameworkCore的資料層
dotnet new classlib -o Lemon.UserCenter.EntityFrameworkCore
```
#### 3. 把所有類庫加入解決方案，然後類庫間互相引用：
```
建立解決方案
dotnet new sln
所有類庫加入解決方案
dotnet sln Lemon.UserCenter.sln add Lemon.UserCenter.HttpApi.Hosting/Lemon.UserCenter.HttpApi.Hosting.csproj
dotnet sln Lemon.UserCenter.sln add Lemon.UserCenter.HttpApi/Lemon.UserCenter.HttpApi.csproj
dotnet sln Lemon.UserCenter.sln add Lemon.UserCenter.Application/Lemon.UserCenter.Application.csproj
dotnet sln Lemon.UserCenter.sln add Lemon.UserCenter.Domain/Lemon.UserCenter.Domain.csproj
dotnet sln Lemon.UserCenter.sln add Lemon.UserCenter.EntityFrameworkCore/Lemon.UserCenter.EntityFrameworkCore.csproj
新增專案引用
dotnet add Lemon.UserCenter.HttpApi.Hosting/Lemon.UserCenter.HttpApi.Hosting.csproj reference Lemon.UserCenter.HttpApi/Lemon.UserCenter.HttpApi.csproj
dotnet add Lemon.UserCenter.HttpApi.Hosting/Lemon.UserCenter.HttpApi.Hosting.csproj reference Lemon.UserCenter.EntityFrameworkCore/Lemon.UserCenter.EntityFrameworkCore.csproj
dotnet add Lemon.UserCenter.HttpApi/Lemon.UserCenter.HttpApi.csproj reference Lemon.UserCenter.Application/Lemon.UserCenter.Application.csproj
dotnet add Lemon.UserCenter.Application/Lemon.UserCenter.Application.csproj reference Lemon.UserCenter.Domain/Lemon.UserCenter.Domain.csproj
dotnet add Lemon.UserCenter.EntityFrameworkCore/Lemon.UserCenter.EntityFrameworkCore.csproj reference Lemon.UserCenter.Domain/Lemon.UserCenter.Domain.csproj
```
#### 4. 在領域層新增實體。
領域層新增Volo.Abp.Identity.Domain包引用：
```
dotnet add Lemon.UserCenter.Domain/Lemon.UserCenter.Domain.csproj package Volo.Abp.Identity.Domain
```
建立領域層模組類：
```
using Volo.Abp.Identity;
using Volo.Abp.Modularity;
namespace Lemon.UserCenter.Domain
{
[DependsOn(typeof(AbpIdentityDomainModule))]
public class UserCenterDomainModule : AbpModule
{
}
}
```
建立實體類：
```
using System;
using Volo.Abp.Domain.Entities;
namespace Lemon.UserCenter.Domain
{
public class UserData : Entity
{
///
/// 賬號
///
/// The account.
public string Account { get; set; }
///
/// 暱稱
///
/// The name of the nike.
public string NickName { get; set; } = "";
///
/// 頭像
///
/// The head icon.
public string HeadIcon { get; set; } = "";
///
/// 手機號碼
/// The mobile.
public string Mobile { get; set; } = "";
///
/// 電子郵箱
///
/// The email.
public string Email { get; set; } = "";
///
/// 刪除註記
///
/// true if deleted; otherwise, false .
{
public DbSet UserData { get; set; }
public UserCenterDbContext(DbContextOptions options)
: base(options)
{
}
protected override void OnModelCreating(ModelBuilder builder)
{
base.OnModelCreating(builder);
}
}
}
```
加入UserCenterDbContextFactory類：
```
using System.IO;
using Microsoft.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore.Design;
using Microsoft.Extensions.Configuration;
namespace Lemon.UserCenter.EntityFrameworkCore
{
public class UserCenterDbContextFactory: IDesignTimeDbContextFactory
{
public UserCenterDbContext CreateDbContext(string[] args)
{
var configuration = BuildConfiguration();
var builder = new DbContextOptionsBuilder()
.UseNpgsql(configuration.GetConnectionString("Default"));
return new UserCenterDbContext(builder.Options);
}
private static IConfigurationRoot BuildConfiguration()
{
var builder = new ConfigurationBuilder()
.SetBasePath(Directory.GetCurrentDirectory())
.AddJsonFile("appsettings.json", optional: false);
return builder.Build();
}
}
}
```
加入appsettings.json配置，用於生成資料遷移程式碼：
```
{
"ConnectionStrings": {
"Default": "server=127.0.0.1;port=5432;Database=abp-samples-user-center;uid=postgres;pwd=123456"
}
}
```
建立資料層模組類：
```
using Lemon.UserCenter.Domain;
using Microsoft.EntityFrameworkCore;
using Microsoft.Extensions.DependencyInjection;
using Volo.Abp.EntityFrameworkCore;
using Volo.Abp.EntityFrameworkCore.PostgreSql;
using Volo.Abp.Modularity;
namespace Lemon.UserCenter.EntityFrameworkCore
{
[DependsOn(typeof(UserCenterDomainModule),
typeof(AbpEntityFrameworkCoreModule),
typeof(AbpEntityFrameworkCorePostgreSqlModule))]
public class UserCenterentityFrameworkCoreModule : AbpModule
{
public override void ConfigureServices(ServiceConfigurationContext context)
{
context.Services.AddAbpDbContext(options => {
options.AddDefaultRepositories(includeAllEntities: true);
});
Configure(options =>
{
options.Configure(ctx =>
{
if (ctx.ExistingConnection != null)
{
ctx.DbContextOptions.UseNpgsql(ctx.ExistingConnection);
}
else
{
ctx.DbContextOptions.UseNpgsql(ctx.ConnectionString);
}
});
});
#region 自動遷移資料庫
context.Services.BuildServiceProvider().GetService().Database.Migrate();
#endregion 自動遷移資料庫
}
}
}
```
生成資料遷移程式碼：
```
dotnet ef migrations add InitialCreate --project Lemon.UserCenter.EntityFrameworkCore/Lemon.UserCenter.EntityFrameworkCore.csproj
```
在資料層下生成一個Migrations資料夾，裡面的程式碼就是資料遷移程式碼，執行以下命令即可在資料庫中自動生成資料庫表：
```
dotnet ef database update --project Lemon.UserCenter.EntityFrameworkCore/Lemon.UserCenter.EntityFrameworkCore.csproj
```
#### 6. 在應用層實現具體業務邏輯
應用層新增Volo.Abp.Identity.Application應用：
```
dotnet add Lemon.UserCenter.Application/Lemon.UserCenter.Application.csproj package Volo.Abp.Identity.Application
```
建立應用層模組類：
```
using Volo.Abp.Modularity;
using Volo.Abp.Identity;
namespace Lemon.UserCenter.Application
{
[DependsOn(typeof(AbpIdentityApplicationModule))]
public class UserCenterApplicationModule : AbpModule
{
}
}
```
建立使用者介面：
```
using System.Threading.Tasks;
using Lemon.UserCenter.Domain;
namespace Lemon.UserCenter.Application
{
public interface IUserService
{
Task Create(UserData data);
}
}
```
實現使用者服務：
```
using System;
using System.Threading.Tasks;
using Lemon.UserCenter.Domain;
using Volo.Abp.Application.Services;
using Volo.Abp.Domain.Repositories;
namespace Lemon.UserCenter.Application
{
public class UserService : ApplicationService, IUserService
{
private readonly IRepository _repository;
public UserService(IRepository repository)
{
this._repository = repository;
}
public async Task Create(UserData data)
{
return await _repository.InsertAsync(data);
}
}
}
```
#### 7. 在api層實現webapi控制器
api層新增Volo.Abp.Identity.HttpApi引用:
```
dotnet add Lemon.UserCenter.HttpApi/Lemon.UserCenter.HttpApi.csproj package Volo.Abp.Identity.HttpApi
```
建立模組類：
```
using Lemon.UserCenter.Application;
using Volo.Abp.Identity;
using Volo.Abp.Modularity;
namespace Lemon.UserCenter.HttpApi
{
[DependsOn(typeof(AbpIdentityHttpApiModule),
typeof(UserCenterApplicationModule))]
public class UserCenterHttpApiModule : AbpModule
{
}
}
```
建立controller：
```
using System.Threading.Tasks;
using Lemon.UserCenter.Application;
using Lemon.UserCenter.Domain;
using Microsoft.AspNetCore.Mvc;
using Volo.Abp.AspNetCore.Mvc;
namespace Lemon.UserCenter.HttpApi.Controllers
{
[Route("api/user")]
public class UserController : AbpController
{
private readonly IUserService _userService;
public UserController(IUserService userService)
{
this._userService = userService;
}
[HttpPost("create")]
public async Task Create(UserData data)
{
var result = await _userService.Create(data);
return Json(result);
}
}
}
```
#### 7. 在api hosting實現專案啟動項
新增Volo.Abp.Autofac引用：
```
dotnet add Lemon.UserCenter.HttpApi.Hosting/Lemon.UserCenter.HttpApi.Hosting.csproj package Volo.Abp.Autofac
```
建立模組類
```
using Lemon.UserCenter.Domain;
using Lemon.UserCenter.EntityFrameworkCore;
using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.Hosting;
using Volo.Abp;
using Volo.Abp.AspNetCore.Mvc;
using Volo.Abp.Autofac;
using Volo.Abp.Modularity;
namespace Lemon.UserCenter.HttpApi.Hosting
{
[DependsOn(typeof(UserCenterHttpApiModule),
typeof(UserCenterDomainModule),
typeof(UserCenterentityFrameworkCoreModule),
typeof(AbpAspNetCoreMvcModule),
typeof(AbpAutofacModule))]
public class UserCenterHttpApiHostingModule: AbpModule
{
public override void OnApplicationInitialization(
ApplicationInitializationContext context)
{
var app = context.GetApplicationBuilder();
var env = context.GetEnvironment();
if (env.IsDevelopment())
{
app.UseDeveloperExceptionPage();
}
else
{
app.UseExceptionHandler("/Error");
}
app.UseStaticFiles();
app.UseRouting();
app.UseMvcWithDefaultRouteAndArea();
}
}
}
```
修改Program類,新增UseAutofac：
```
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Hosting;
namespace Lemon.UserCenter.HttpApi.Hosting
{
public class Program
{
public static void Main(string[] args)
{
CreateHostBuilder(args).Build().Run();
}
public static IHostBuilder CreateHostBuilder(string[] args) =>
Host.CreateDefaultBuilder(args)
.ConfigureWebHostDefaults(webBuilder =>
{
webBuilder.UseStartup();
}).UseAutofac();
}
}
```
修改Startup類：
```
using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.DependencyInjection;
namespace Lemon.UserCenter.HttpApi.Hosting
{
public class Startup
{
public void ConfigureServices(IServiceCollection services)
{
services.AddApplication();
}
public void Configure(IApplicationBuilder app)
{
app.InitializeApplication();
}
}
}
```
#### 8. 執行服務
```
cd Lemon.UserCenter.HttpApi.Hosting
dotnet watch run
```
#### 9. 最後我們用postman來測試api介面服務是否可以正常使用。
操作如下圖：
資料庫結果如下：
### 總結
以上就是介面服務的構建過程，主要參考了ABP CLI生成的專案結構，但是又有所不同。整個分層架構還可以繼續優化，這個就見仁見智吧。後續還會繼續分享ABP的相關知識，例如identity server 4、快取、微服務等。
#### GitHub: [https://github.com/huangbenq/abp-samples](https://github.com/huangbenq/abp-