基於 abp vNext 和 .NET Core 開發部落格專案 - 完善與美化，Swagger登場
阿新 • • 發佈：2020-05-18
上一篇文章(https://www.cnblogs.com/meowv/p/12896898.html)已經成功將部落格專案跑起來了，那麼本篇主要是將之前遺留的問題解決，現在的程式碼看起來可能還是比較混亂，有大量與之無關的程式碼存在裡面，對於強迫症患者來說真的是零容忍。
在程式設計師界，總有一批強迫症患者，他們希望自己寫的程式碼看起來儘量的完美無瑕疵。
## 完善與美化
直奔主題，首先將各專案層的專案檔案(`.csproj`)開啟，格式化一下，沒有引用`
netcoreapp3.1
```
### .Application.Caching
`.Application.Caching`層看名字就知道，我準備用它來處理快取，這裡會用到兩個包，`Volo.Abp.Caching`、`Microsoft.Extensions.Caching.Redis`。
不管三七二十一，新建一個模組類`MeowvBlogApplicationCachingModule.cs`，依賴於`AbpCachingModule`和我們的`MeowvBlogDomainModule`模組(此時還沒新增)
```CSharp
using Volo.Abp.Caching;
using Volo.Abp.Modularity;
namespace Meowv.Blog.Application.Caching
{
[DependsOn(
typeof(AbpCachingModule)
// ...
)]
public class MeowvBlogApplicationCachingModule : AbpModule
{
public override void ConfigureServices(ServiceConfigurationContext context)
{
base.ConfigureServices(context);
}
}
}
```
```xml
//Meowv.Blog.Application.Caching.csproj
netcoreapp3.1
```
### .Application.Contracts
刪掉裡面所有檔案，`.Application.Contracts`層我不準備按照abp那樣來做，此層我只想用來放我們的傳輸物件(DTO)，新增專案引用`Domain.Shared`，同時開啟輸出XML檔案到我們`.HttpApi.Hosting`
輸出XML很簡單，在 Visual Studio 中對著專案 右鍵=>屬性=>生成=>輸出，然後選擇XML文件檔案，預設為一個物理路徑，我們將其改為相對路徑`..\Meowv.Blog.HttpApi.Hosting\Meowv.Blog.Application.Contracts.xml`，XML輸出到`.HttpApi.Hosting`層。
也可以直接修改專案檔案實現，如下
```xml
//Meowv.Blog.Application.Contracts.csproj
netcoreapp3.1
..\Meowv.Blog.HttpApi.Hosting\Meowv.Blog.Application.Contracts.xml
```
### .Domain
`.Domain`層為我們的實體領域模型，不需要引用其它層，只新增包`Volo.Abp.Identity.Domain`，同時也輸出一下XML檔案，XML檔案的作用後續Swagger會用的。
```xml
//Meowv.Blog.Domain.csproj
netcoreapp3.1
..\Meowv.Blog.HttpApi.Hosting\Meowv.Blog.Domain.xml
```
刪掉此層所有檔案，不要忘了新增模組類，`MeowvBlogDomainModule.cs`，它依賴`AbpIdentityDomainModule`模組
```CSharp
using Volo.Abp.Identity;
using Volo.Abp.Modularity;
namespace Meowv.Blog.Domain
{
[DependsOn(typeof(AbpIdentityDomainModule))]
public class MeowvBlogDomainModule : AbpModule
{
}
}
```
此時上面`.Application.Caching`中可以將`MeowvBlogDomainModule`加上了。
```CSharp
//MeowvBlogApplicationCachingModule.cs
...
[DependsOn(
typeof(AbpCachingModule),
typeof(MeowvBlogDomainModule)
)]
public class MeowvBlogApplicationCachingModule : AbpModule
{
...
}
...
```
### .Domain.Shared
`.Domain.Shared`層相當於`.Domain`的一個擴充套件一樣，這裡放一下專案用到的列舉、公共常量等內容，需要引用我們的`.Domain`專案
```xml
netcoreapp3.1
```
還是要新增一個模組類`MeowvBlogDomainSharedModule.cs`，它依賴`AbpIdentityDomainSharedModule`模組
```CSharp
//MeowvBlogDomainSharedModule.cs
using Volo.Abp.Identity;
using Volo.Abp.Modularity;
namespace Meowv.Blog.Domain
{
[DependsOn(typeof(AbpIdentityDomainModule))]
public class MeowvBlogDomainModule : AbpModule
{
}
}
```
### .EntityFrameworkCore
`.EntityFrameworkCore`層同樣的，先刪掉預設生成的檔案。它主要是集成了EF Core，自定義倉儲。詳細可以看看abp文件：https://docs.abp.io/zh-Hans/abp/latest/Repositories
它支援多種資料庫 MySQL、SqlServer、PostgreSql、Sqlite等，如果你有用到MongoDB，則需要新建一個專案，單獨實現。可以看官方文件，有時間可以分享具體方法，本專案用不到。https://docs.abp.io/zh-Hans/abp/latest/MongoDB
為了方便大家，我把以上4種主流資料庫都整合到專案中，新增包`Volo.Abp.EntityFrameworkCore.MySQL`，`.PostgreSql`、`.Sqlite`、`.SqlServer`，同時引用`.Domain.Shared`專案
```xml
//Meowv.Blog.EntityFrameworkCore.csproj
netcoreapp3.1
```
新建一個模組類`MeowvBlogFrameworkCoreModule.cs`，依賴`MeowvBlogDomainModule`和資料庫模組
```CSharp
//MeowvBlogFrameworkCoreModule.cs
using Meowv.Blog.Domain;
using Volo.Abp.EntityFrameworkCore;
using Volo.Abp.EntityFrameworkCore.MySQL;
using Volo.Abp.EntityFrameworkCore.PostgreSql;
using Volo.Abp.EntityFrameworkCore.Sqlite;
using Volo.Abp.EntityFrameworkCore.SqlServer;
using Volo.Abp.Modularity;
namespace Meowv.Blog.EntityFrameworkCore
{
[DependsOn(
typeof(MeowvBlogDomainModule),
typeof(AbpEntityFrameworkCoreModule),
typeof(AbpEntityFrameworkCoreMySQLModule),
typeof(AbpEntityFrameworkCoreSqlServerModule),
typeof(AbpEntityFrameworkCorePostgreSqlModule),
typeof(AbpEntityFrameworkCoreSqliteModule)
)]
public class MeowvBlogFrameworkCoreModule : AbpModule
{
public override void ConfigureServices(ServiceConfigurationContext context)
{
}
}
}
```
### .EntityFrameworkCore.DbMigrations
`.EntityFrameworkCore.DbMigrations`層主要做資料庫遷移，用code-first方式建立資料庫表，先刪掉預設生成的檔案，目前還用不上，後面講。
### .ToolKits
`.ToolKits`層是我們手動建立的專案，我主要用它來包裝一些擴充套件方法，公共的工具類。
## Swagger登場
做.net core開發的，相信Swagger的使用大家應該都很熟悉了，不做過多的介紹，今天只先將其用上看看效果。
我單獨為Swagger新建了一個專案`Meowv.Blog.Swagger`，其實大可不必，直接寫在`.HttpApi.Hosting`中也是一樣的。
新增`Volo.Abp.AspNetCore`和`Swashbuckle.AspNetCore`包，引用實體層`.Domain`。
```xml
//Meowv.Blog.Swagger.csproj
netcoreapp3.1
```
新增模組類`MeowvBlogSwaggerModule.cs`，依賴`MeowvBlogDomainModule`模組，並且重寫`ConfigureServices`和`OnApplicationInitialization`方法，不知道這是什麼的，可以看文件：https://docs.abp.io/zh-Hans/abp/latest/Module-Development-Basics
然後新建一個擴充套件類`MeowvBlogSwaggerExtensions.cs`，編寫兩個擴充套件方法`AddSwagger`和`UseSwaggerUI`。
在`AddSwagger`方法中引用我們的XML檔案，配置介面的名稱版本以及描述資訊，在`UseSwaggerUI`方法中使用SwaggerUI，程式碼如下：
```CSharp
//MeowvBlogSwaggerExtensions.cs
using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.OpenApi.Models;
using System;
using System.IO;
namespace Meowv.Blog.Swagger
{
public static class MeowvBlogSwaggerExtensions
{
public static IServiceCollection AddSwagger(this IServiceCollection services)
{
return services.AddSwaggerGen(options =>
{
options.SwaggerDoc("v1", new OpenApiInfo
{
Version = "1.0.0",
Title = "我的介面啊",
Description = "介面描述"
});
options.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, "Meowv.Blog.HttpApi.xml"));
options.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, "Meowv.Blog.Domain.xml"));
options.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, "Meowv.Blog.Application.Contracts.xml"));
});
}
public static void UseSwaggerUI(this IApplicationBuilder app)
{
app.UseSwaggerUI(options =>
{
options.SwaggerEndpoint($"/swagger/v1/swagger.json", "預設介面");
});
}
}
}
```
隨後便可以在模組`MeowvBlogDomainModule`中引用了
```CSharp
//MeowvBlogSwaggerModule.cs
using Meowv.Blog.Domain;
using Microsoft.AspNetCore.Builder;
using Volo.Abp;
using Volo.Abp.Modularity;
namespace Meowv.Blog.Swagger
{
[DependsOn(typeof(MeowvBlogDomainModule))]
public class MeowvBlogSwaggerModule : AbpModule
{
public override void ConfigureServices(ServiceConfigurationContext context)
{
context.Services.AddSwagger();
}
public override void OnApplicationInitialization(ApplicationInitializationContext context)
{
context.GetApplicationBuilder().UseSwagger().UseSwaggerUI();
}
}
}
```
最後在`.HttpApi.Hosting`層的的啟動模組中引用一下。
```
//MeowvBlogHttpApiHostingModule.cs
...
[DependsOn(
typeof(AbpAspNetCoreMvcModule),
typeof(AbpAutofacModule),
typeof(MeowvBlogHttpApiModule),
typeof(MeowvBlogSwaggerModule),
typeof(MeowvBlogFrameworkCoreModule)
)]
public class MeowvBlogHttpApiHostingModule : AbpModule
{
...
}
...
```
`Ctrl + Shift + B`生成解決方案，`Ctrl+F5`開啟 .../swagger/index.html 看看效果，上面有一個坑沒有填，不知道大家發現了沒有，`Meowv.Blog.HttpApi.xml`沒有生成，啟動是是會報錯的，大家按照之前的方法自行生成XML即可。
棒！預期已經達到了。Swagger之所以想單獨建立一個專案是因為還涉及到很多內容，如介面分組、JWT授權、還有Swagger文件描述資訊的Filter等。
專案中還剩下`.BackgroundJobs`層沒有處理，此層準備整合`Hangfire`做一個定時任務處理的，後面會慢慢用起來的。
現在再回頭看看，專案是不是很清爽? 沒有亂七八糟的東西，有的只是我們需要的。
此時的層級目錄，以供參考。
專案中可能有許多不是很合理的地方，請酌情參考。因為大佬們都不願意出來分享，所以我們渣渣只能做到這種程度，如果有錯誤歡迎指正，謝謝。
開源地址：https://github.com/Meowv/Blog/tree/blog_tutorial