基于 abp vNext 和 .NET Core 开发博客项目 - 完善与美化,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.CachingMicrosoft.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.AspNetCoreSwashbuckle.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模块,并且重写ConfigureServicesOnApplicationInitialization方法,不知道这是什么的,可以看文档:https://docs.abp.io/zh-Hans/abp/latest/Module-Development-Basics

然后新建一个扩展类MeowvBlogSwaggerExtensions.cs,编写两个扩展方法AddSwaggerUseSwaggerUI

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

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/309826.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

[C++11]基于范围的for循环

C11提供了一种新型的for循环形式 - 基于范围的for循环 语法: for (declaration : expression) {//循环体 }在上面的语法格式中&#xff0c;declaration表示遍历声明&#xff0c;在遍历过程中&#xff0c;当前被遍历到的元素会被存储到声明的变量中&#xff0c;expression是要…

c语言画笔的使用方法,新手必看:Photoshop笔刷画笔工具基本使用教程

本文为Photoshop初学者提供基本的Photoshop笔刷画笔工具的基本使用方法,这可以说是Photoshop最重要的功能。希望初学PS朋友认真学习&#xff0c;有所帮助&#xff01;工具/原料Photoshop CC 2014或者其他较新版本的psPhotoshop笔刷画笔工具介绍&#xff1a;1、画笔工具在哪里呢…

基于 abp vNext 和 .NET Core 开发博客项目 - 给项目瘦身,让它跑起来

上一篇文章(https://www.cnblogs.com/meowv/p/12896177.html)已经成功创建了博客项目&#xff0c;但是abp默认给我们引用了许多项目中用不到的组件。本篇文章将给项目进行瘦身&#xff0c;删掉对我们来说暂时用不到的组件。讲解各个模块之间的关系&#xff0c;写一个Hello Worl…

计算机网络原理第一章习题3-24 3-25

计算机网络原理第一章习题 3-24假定站点A和B在同一个10Mb/s以太网网段上。这两个站点之间的传播时延为225比特时间。现假定A开始发送一帧&#xff0c;并且在A发送结束之前B也发送一帧。如果A发送的是以太网所容许的最短的帧&#xff0c;那么A在检测到和B发生碰撞之前能否把自己…

[C++11]可调用对象

在C中存在"可调用对象"这么一个概念&#xff0c;准确来说&#xff0c;可调用对象有如下几种定义: 1.是一个函数指针 代码如下: int print(int a, double b) {cout << a << b << endl;return 0; }int(*func)(int, double) &print;2.是一个具…

c语言加花指令,花指令的应用

原标题&#xff1a;花指令的应用对免杀的影响是非常大的&#xff0c;有效地利用花指令可以使免杀工作事半功倍&#xff0c;甚至单凭花指令就可以达到免杀的效果。一、花指令在免杀领域的应用1、花指令的应用技巧在使用之前&#xff0c;首先我们应该明白什么时候比较适合使用&am…

走向统一的 .NET 旅程

这是微软第一次完全线上举办的Build大会&#xff0c;也是第一次完全属于开发者的大会。几乎所有的新产品都是属于开发者&#xff0c;开发者成为了唯一的主角。现在的微软比以往任何时候都贴近开发者&#xff0c;重视开发者的作用&#xff0c;为他们打造平台和工具。因为没有开发…

[PAT乙级]1039 到底买不买

小红想买些珠子做一串自己喜欢的珠串。卖珠子的摊主有很多串五颜六色的珠串&#xff0c;但是不肯把任何一串拆散了卖。于是小红要你帮忙判断一下&#xff0c;某串珠子里是否包含了全部自己想要的珠子&#xff1f;如果是&#xff0c;那么告诉她有多少多余的珠子&#xff1b;如果…

Collecting Bugs POJ - 2096(基础概率dp+期望模板)

题意&#xff1a; 有s个系统&#xff0c;n种bug&#xff0c;小明每天找出一个bug&#xff0c;可能是任意一个系统的&#xff0c;可能是任意一种bug&#xff0c;即是某一系统的bug概率是1/s&#xff0c;是某一种bug概率是1/n。 求他找到s个系统的bug&#xff0c;n种bug&#xff…

Service Mesh 高可用在企业级生产中的实践

Service Mesh Virtual Meetup 是 ServiceMesher 社区和 CNCF 联合主办的线上系列直播。本期为 Service Mesh Virtual Meetup#1 &#xff0c;邀请了四位来自不同公司的嘉宾&#xff0c;从不同角度展开了 Service Mesh 的应用实践分享&#xff0c;分享涵盖来自陌陌和百度的 Servi…

sony android mp3播放器,入手一年,详细聊聊 索尼ZX505、艾利和SR15 两款安卓播放器的使用体验...

入手一年&#xff0c;详细聊聊 索尼ZX505、艾利和SR15 两款安卓播放器的使用体验2020-12-04 16:00:21113点赞179收藏28评论创作立场声明&#xff1a;本文所测商品为自费购入。如参加张大妈家的活动获得&#xff0c;我会在文中点明。坚持独立的评价观点是笔者创作的基本底线&…

研发协同平台持续交付2.0架构演进

源宝导读&#xff1a;为了打通CI/CD环节&#xff0c;实现持续的端到端的交付能力&#xff0c;RDC平台提供了在线化的更新服务&#xff0c;随着业务量增长与场景的需要&#xff0c;我们对更新服务架构重新设计&#xff0c;实现了2.0版本。本文将介绍更新服务2.0的架构演进过程与…

[C++11]可调用对象包装器function

可调用对象包装器 std::function是可调用对象的包装器。它是一个类模板&#xff0c;可以容纳除了类成员(函数)指针之外的所有可调用对象。通过指定它的模板参数&#xff0c;它可以用统一的方式处理函数&#xff0c;函数对象&#xff0c;函数指针&#xff0c;并允许保存和延迟执…

android应用窗口模式,[技巧]如何启用Android N开发者预览版中的“自由窗口”模式...

这里是Android N开发者预览版“自有窗口”模式的一些实际演示截图。对于已经参加了“Beta Program”的人们来说&#xff0c;通过OTA获取Android N Preview更新是最简单的。但如果你非要选择“困难模式”(命令行镜像刷新)&#xff0c;则可能让设备无法再通过OTA的方式来安装未来…

LOOPS HDU - 3853(概率dp,期望)

题意&#xff1a; 有一个R*C的方格。一个人想从&#xff08;1&#xff0c;1&#xff09;走到(r,c)。在每个格子都有三种选择&#xff0c;向下&#xff0c;向右&#xff0c;或者原地不动。每个格子里的每个选择都有一定的概率。而每次移动都需要消耗2点的能量&#xff0c;问期望…

Sql Server之旅——第四站 你必须知道的非聚集索引扫描

非聚集索引&#xff0c;这个是大家都非常熟悉的一个东西&#xff0c;有时候我们由于业务原因&#xff0c;sql写的非常复杂&#xff0c;需要join很多张表&#xff0c;然后就泪流满面了。。。这时候就有DBA或者资深的开发给你看这个猥琐的sql&#xff0c;通过执行计划一分析,或许…

[C++11]可调用对象绑定器

std::bind用来将可调用对象与其参数一起进行绑定。绑定后的结果可以使用std::function进行保存&#xff0c;并延迟调用到任何我们需要的时候。通俗来说&#xff0c;它主要有两个作用: 1.将可调用对象与其参数一起绑定成一个仿函数。 2.将多元(参数个数为n&#xff0c;n > …

电视android已停止运行是什么意思,智能电视提示应用停止运行怎么办?当贝市场三招解决...

智能电视提示应用停止运行怎么办&#xff1f;当贝市场三招解决2019年11月28日 17:53作者&#xff1a;网络编辑&#xff1a;王动分享智能电视使用久了之后,电视页面会提示我们应用停止运行,这是怎么回事?当贝小编针对这个问题,整理了一份解决教程,大家可以看看有没有什么帮助。…

重磅!2020年微软开发者大会落幕,.NET迎来新机遇!

两天前微软举行了首个线上Build大会&#xff0c;而开发者成为大会里唯一的主角。和所有技术公司一样&#xff0c;开发者对于微软来说&#xff0c;同样也越来越重要了。如同血肉相依的关系&#xff0c;谁也离不开谁。在这次大会上&#xff0c;开发者是最大的宠儿&#xff0c;成了…

番茄时间有感之关于在疫情期间我与ACM不得不说的故事

哼哼~首先声明&#xff0c;我不是来讲故事的&#xff0c;我来总结一下在疫情这段时间&#xff0c;在ACM训练过程中的自我情况的总结和反思&#xff0c;嘻嘻&#xff0c;我是一个标题党&#xff0c;如果是被标题骗进来哒&#xff0c;抱歉啦&#xff0c;有句话说的好&#xff0c;…