系列文章
- 基于 abp vNext 和 .NET Core 開發博客專案 - 使用 abp cli 搭建專案
- 基于 abp vNext 和 .NET Core 開發博客專案 - 給專案瘦身，讓它跑起來
- 基于 abp vNext 和 .NET Core 開發博客專案 - 完善與美化，Swagger登場
- 基于 abp vNext 和 .NET Core 開發博客專案 - 資料訪問和代碼優先
- 基于 abp vNext 和 .NET Core 開發博客專案 - 自定義倉儲之增刪改查
- 基于 abp vNext 和 .NET Core 開發博客專案 - 統一規范API，包裝回傳模型
- 基于 abp vNext 和 .NET Core 開發博客專案 - 再說Swagger，分組、描述、小綠鎖
- 基于 abp vNext 和 .NET Core 開發博客專案 - 接入GitHub，用JWT保護你的API
- 基于 abp vNext 和 .NET Core 開發博客專案 - 例外處理和日志記錄
- 基于 abp vNext 和 .NET Core 開發博客專案 - 使用Redis快取資料
- 基于 abp vNext 和 .NET Core 開發博客專案 - 集成Hangfire實作定時任務處理
- 基于 abp vNext 和 .NET Core 開發博客專案 - 用AutoMapper搞定物件映射
- 基于 abp vNext 和 .NET Core 開發博客專案 - 定時任務最佳實戰（一）
- 基于 abp vNext 和 .NET Core 開發博客專案 - 定時任務最佳實戰（二）
- 基于 abp vNext 和 .NET Core 開發博客專案 - 定時任務最佳實戰（三）
- 基于 abp vNext 和 .NET Core 開發博客專案 - 博客介面實戰篇（一）
- 基于 abp vNext 和 .NET Core 開發博客專案 - 博客介面實戰篇（二）
- 基于 abp vNext 和 .NET Core 開發博客專案 - 博客介面實戰篇（三）
- 基于 abp vNext 和 .NET Core 開發博客專案 - 博客介面實戰篇（四）
- 基于 abp vNext 和 .NET Core 開發博客專案 - 博客介面實戰篇（五）
- 基于 abp vNext 和 .NET Core 開發博客專案 - Blazor 實戰系列（一）
- 基于 abp vNext 和 .NET Core 開發博客專案 - Blazor 實戰系列（二）
- 基于 abp vNext 和 .NET Core 開發博客專案 - Blazor 實戰系列（三）
- 基于 abp vNext 和 .NET Core 開發博客專案 - Blazor 實戰系列（四）
- 基于 abp vNext 和 .NET Core 開發博客專案 - Blazor 實戰系列（五）
- 基于 abp vNext 和 .NET Core 開發博客專案 - Blazor 實戰系列（六）
- 基于 abp vNext 和 .NET Core 開發博客專案 - Blazor 實戰系列（七）
- 基于 abp vNext 和 .NET Core 開發博客專案 - Blazor 實戰系列（八）
- 基于 abp vNext 和 .NET Core 開發博客專案 - Blazor 實戰系列（九）
- 基于 abp vNext 和 .NET Core 開發博客專案 - 終結篇之發布專案
上一篇文章(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三個專案，
//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即可，
棒！預期已經達到了，Swagger之所以想單獨創建一個專案是因為還涉及到很多內容，如介面分組、JWT授權、還有Swagger檔案描述資訊的Filter等，
專案中還剩下.BackgroundJobs層沒有處理，此層準備集成Hangfire做一個定時任務處理的，后面會慢慢用起來的，
現在再回頭看看，專案是不是很清爽? 沒有亂七八糟的東西，有的只是我們需要的，
此時的層級目錄，以供參考，
專案中可能有許多不是很合理的地方，請酌情參考，因為大佬們都不愿意出來分享，所以我們渣渣只能做到這種程度，如果有錯誤歡迎指正，謝謝，
開源地址：https://github.com/Meowv/Blog/tree/blog_tutorial
轉載請註明出處，本文鏈接：https://www.uj5u.com/net/30454.html
標籤：.NET Core
下一篇：ABP框架——集成Mysql