基於 abp vNext 和 .NET Core 開發部落格專案 - 完善與美化，Swagger登場

阿星Plus發表於2020-05-18
Swagger

上一篇文章(https://www.cnblogs.com/meowv/p/12896898.html)已經成功將部落格專案跑起來了，那麼本篇主要是將之前遺留的問題解決，現在的程式碼看起來可能還是比較混亂，有大量與之無關的程式碼存在裡面，對於強迫症患者來說真的是零容忍。

在程式設計師界，總有一批強迫症患者，他們希望自己寫的程式碼看起來儘量的完美無瑕疵。

完善與美化

直奔主題，首先將各專案層的專案檔案(.csproj)開啟，格式化一下，沒有引用<Import Project="..\..\common.props" />這句程式碼的也加一下，這裡其實就是將公共屬性拿出來，沒什麼特殊的。

common.props中的程式碼也非常簡單，主要是禁用當開啟輸出XML的時候沒有給程式碼進行summary註釋產生的警告，其實這些大可不必為之折騰，不影響專案的成功執行。如果您覺得沒啥必要，完全可以跳過此小節看最後。

.Application

.Application層現在只引用Volo.Abp.Identity.Application包，和依賴.Application.Caching、.Application.Contracts、.Domain.Shared三個專案。

//Meowv.Blog.Application.csproj
<Project Sdk="Microsoft.NET.Sdk">

  <Import Project="..\..\common.props" />

  <PropertyGroup>
    <TargetFramework>netcoreapp3.1</TargetFramework>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="Volo.Abp.Identity.Application" Version="2.7.0" />
    
    <ProjectReference Include="..\Meowv.Blog.Application.Caching\Meowv.Blog.Application.Caching.csproj" />
    <ProjectReference Include="..\Meowv.Blog.Application.Contracts\Meowv.Blog.Application.Contracts.csproj" />
    <ProjectReference Include="..\Meowv.Blog.Domain.Shared\Meowv.Blog.Domain.Shared.csproj" />
  </ItemGroup>

</Project>

.Application.Caching

.Application.Caching層看名字就知道，我準備用它來處理快取，這裡會用到兩個包，Volo.Abp.Caching、Microsoft.Extensions.Caching.Redis。

不管三七二十一，新建一個模組類MeowvBlogApplicationCachingModule.cs，依賴於AbpCachingModule和我們的MeowvBlogDomainModule模組(此時還沒新增)

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);
        }
    }
}

//Meowv.Blog.Application.Caching.csproj
<Project Sdk="Microsoft.NET.Sdk">

  <Import Project="..\..\common.props" />

  <PropertyGroup>
    <TargetFramework>netcoreapp3.1</TargetFramework>
  </PropertyGroup>
  
  <ItemGroup>
    <PackageReference Include="Microsoft.Extensions.Caching.Redis" Version="2.2.0" />
    <PackageReference Include="Volo.Abp.Caching" Version="2.7.0" />
    
    <ProjectReference Include="..\Meowv.Blog.Application.Contracts\Meowv.Blog.Application.Contracts.csproj" />
    <ProjectReference Include="..\Meowv.Blog.Domain.Shared\Meowv.Blog.Domain.Shared.csproj" />
    <ProjectReference Include="..\Meowv.Blog.ToolKits\Meowv.Blog.ToolKits.csproj" />
  </ItemGroup>

</Project>

.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層。

也可以直接修改專案檔案實現，如下

//Meowv.Blog.Application.Contracts.csproj
<Project Sdk="Microsoft.NET.Sdk">

  <Import Project="..\..\common.props" />

  <PropertyGroup>
    <TargetFramework>netcoreapp3.1</TargetFramework>
  </PropertyGroup>

  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
    <DocumentationFile>..\Meowv.Blog.HttpApi.Hosting\Meowv.Blog.Application.Contracts.xml</DocumentationFile>
  </PropertyGroup>

  <ItemGroup>
    <ProjectReference Include="..\Meowv.Blog.Domain.Shared\Meowv.Blog.Domain.Shared.csproj" />
  </ItemGroup>

</Project>

.Domain

.Domain層為我們的實體領域模型，不需要引用其它層，只新增包Volo.Abp.Identity.Domain，同時也輸出一下XML檔案，XML檔案的作用後續Swagger會用的。

//Meowv.Blog.Domain.csproj
<Project Sdk="Microsoft.NET.Sdk">

  <Import Project="..\..\common.props" />

  <PropertyGroup>
    <TargetFramework>netcoreapp3.1</TargetFramework>
  </PropertyGroup>

  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
    <DocumentationFile>..\Meowv.Blog.HttpApi.Hosting\Meowv.Blog.Domain.xml</DocumentationFile>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="Volo.Abp.Identity.Domain" Version="2.7.0" />

    <ProjectReference Include="..\Meowv.Blog.Domain.Shared\Meowv.Blog.Domain.Shared.csproj" />
  </ItemGroup>

</Project>

刪掉此層所有檔案，不要忘了新增模組類，MeowvBlogDomainModule.cs，它依賴AbpIdentityDomainModule模組

using Volo.Abp.Identity;
using Volo.Abp.Modularity;

namespace Meowv.Blog.Domain
{
    [DependsOn(typeof(AbpIdentityDomainModule))]
    public class MeowvBlogDomainModule : AbpModule
    {

    }
}

此時上面.Application.Caching中可以將MeowvBlogDomainModule加上了。

//MeowvBlogApplicationCachingModule.cs
...
    [DependsOn(
        typeof(AbpCachingModule),
        typeof(MeowvBlogDomainModule)
    )]
    public class MeowvBlogApplicationCachingModule : AbpModule
    {
        ...
    }
...

.Domain.Shared

.Domain.Shared層相當於.Domain的一個擴充套件一樣，這裡放一下專案用到的列舉、公共常量等內容，需要引用我們的.Domain專案

<Project Sdk="Microsoft.NET.Sdk">

  <Import Project="..\..\common.props" />

  <PropertyGroup>
    <TargetFramework>netcoreapp3.1</TargetFramework>
  </PropertyGroup>

  <ItemGroup>
    <ProjectReference Include="..\Meowv.Blog.Domain\Meowv.Blog.Domain.csproj" />
  </ItemGroup>

</Project>

還是要新增一個模組類MeowvBlogDomainSharedModule.cs，它依賴AbpIdentityDomainSharedModule模組

//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專案

//Meowv.Blog.EntityFrameworkCore.csproj
<Project Sdk="Microsoft.NET.Sdk">

  <Import Project="..\..\common.props" />

  <PropertyGroup>
    <TargetFramework>netcoreapp3.1</TargetFramework>
  </PropertyGroup>
  
  <ItemGroup>
    <PackageReference Include="Volo.Abp.EntityFrameworkCore.MySQL" Version="2.7.0" />
    <PackageReference Include="Volo.Abp.EntityFrameworkCore.PostgreSql" Version="2.7.0" />
    <PackageReference Include="Volo.Abp.EntityFrameworkCore.Sqlite" Version="2.7.0" />
    <PackageReference Include="Volo.Abp.EntityFrameworkCore.SqlServer" Version="2.7.0" />

    <ProjectReference Include="..\Meowv.Blog.Domain.Shared\Meowv.Blog.Domain.Shared.csproj" />
  </ItemGroup>

</Project>

新建一個模組類MeowvBlogFrameworkCoreModule.cs，依賴MeowvBlogDomainModule和資料庫模組

//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。

//Meowv.Blog.Swagger.csproj
<Project Sdk="Microsoft.NET.Sdk">

  <Import Project="..\..\common.props" />

  <PropertyGroup>
    <TargetFramework>netcoreapp3.1</TargetFramework>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="Volo.Abp.AspNetCore" Version="2.7.0" />
    <PackageReference Include="Swashbuckle.AspNetCore" Version="5.4.1" />

    <ProjectReference Include="..\Meowv.Blog.Domain\Meowv.Blog.Domain.csproj" />
  </ItemGroup>

</Project>

新增模組類MeowvBlogSwaggerModule.cs，依賴MeowvBlogDomainModule模組，並且重寫ConfigureServices和OnApplicationInitialization方法，不知道這是什麼的，可以看文件：https://docs.abp.io/zh-Hans/abp/latest/Module-Development-Basics

然後新建一個擴充套件類MeowvBlogSwaggerExtensions.cs，編寫兩個擴充套件方法AddSwagger和UseSwaggerUI。

在AddSwagger方法中引用我們的XML檔案，配置介面的名稱版本以及描述資訊，在UseSwaggerUI方法中使用SwaggerUI，程式碼如下：

//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中引用了

//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即可。

1

棒！預期已經達到了。Swagger之所以想單獨建立一個專案是因為還涉及到很多內容，如介面分組、JWT授權、還有Swagger文件描述資訊的Filter等。

專案中還剩下.BackgroundJobs層沒有處理，此層準備整合Hangfire做一個定時任務處理的，後面會慢慢用起來的。

現在再回頭看看，專案是不是很清爽? 沒有亂七八糟的東西，有的只是我們需要的。

此時的層級目錄，以供參考。

2

專案中可能有許多不是很合理的地方，請酌情參考。因為大佬們都不願意出來分享，所以我們渣渣只能做到這種程度，如果有錯誤歡迎指正，謝謝。

開源地址：https://github.com/Meowv/Blog/tree/blog_tutorial

相關文章