手把手教你用Abp vnext構建API介面服務

2020 年 3 月 17 日
筆記

ABP是一個開源應用程式框架,該項目是ASP.NET Boilerplate Web應用程式框架的下一代，專註於基於ASP.NET Core的Web應用程式開發,也支援開發控制台應用程式。

官方網站：https://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<Guid>      {          /// <summary>          /// 帳號          /// </summary>          /// <value>The account.</value>          public string Account { get; set; }            /// <summary>          /// 昵稱          /// </summary>          /// <value>The name of the nike.</value>          public string NickName { get; set; } = "";            /// <summary>          /// 頭像          /// </summary>          /// <value>The head icon.</value>          public string HeadIcon { get; set; } = "";            /// <summary>          /// 手機號碼          /// </summary>          /// <value>The mobile.</value>          public string Mobile { get; set; } = "";            /// <summary>          /// 電子郵箱          /// </summary>          /// <value>The email.</value>          public string Email { get; set; } = "";            /// <summary>          /// 刪除註記          /// </summary>          /// <value><c>true</c> if deleted; otherwise, <c>false</c>.</value>          public bool Deleted { get; set; }      }  }

5. 創建數據層

數據層添加引用：

dotnet add Lemon.UserCenter.EntityFrameworkCore/Lemon.UserCenter.EntityFrameworkCore.csproj package Volo.Abp.EntityFrameworkCore  dotnet add Lemon.UserCenter.EntityFrameworkCore/Lemon.UserCenter.EntityFrameworkCore.csproj package Volo.Abp.EntityFrameworkCore.PostgreSQL  dotnet add Lemon.UserCenter.EntityFrameworkCore/Lemon.UserCenter.EntityFrameworkCore.csproj package Microsoft.EntityFrameworkCore.Design  dotnet add Lemon.UserCenter.EntityFrameworkCore/Lemon.UserCenter.EntityFrameworkCore.csproj package Microsoft.EntityFrameworkCore  dotnet add Lemon.UserCenter.EntityFrameworkCore/Lemon.UserCenter.EntityFrameworkCore.csproj package Microsoft.EntityFrameworkCore.Relational

在這裡我們使用的是PostgreSQL資料庫，所以引用了Volo.Abp.EntityFrameworkCore.PostgreSQL，如果使用的是MySQL，就要引用Volo.Abp.EntityFrameworkCore.MySQL，如果使用的是sqlserver，就要引用Volo.Abp.EntityFrameworkCore.SQLServer。

加入UserCenterDbContext類：

using Lemon.UserCenter.Domain;  using Microsoft.EntityFrameworkCore;  using Volo.Abp.Data;  using Volo.Abp.EntityFrameworkCore;    namespace Lemon.UserCenter.EntityFrameworkCore  {      [ConnectionStringName("Default")]      public class UserCenterDbContext : AbpDbContext<UserCenterDbContext>      {          public DbSet<UserData> UserData { get; set; }            public UserCenterDbContext(DbContextOptions<UserCenterDbContext> 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<UserCenterDbContext>      {          public UserCenterDbContext CreateDbContext(string[] args)          {              var configuration = BuildConfiguration();                var builder = new DbContextOptionsBuilder<UserCenterDbContext>()                  .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<UserCenterDbContext>(options => {                  options.AddDefaultRepositories(includeAllEntities: true);              });                Configure<AbpDbContextOptions>(options =>              {                  options.Configure(ctx =>                  {                      if (ctx.ExistingConnection != null)                      {                          ctx.DbContextOptions.UseNpgsql(ctx.ExistingConnection);                      }                      else                      {                          ctx.DbContextOptions.UseNpgsql(ctx.ConnectionString);                      }                  });              });                #region 自動遷移資料庫                context.Services.BuildServiceProvider().GetService<UserCenterDbContext>().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<UserData> 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<UserData, Guid> _repository;          public UserService(IRepository<UserData, Guid> repository)          {              this._repository = repository;          }            public async Task<UserData> 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<IActionResult> 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<Startup>();                  }).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<UserCenterHttpApiHostingModule>();          }            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、快取、微服務等。