基于 abp vNext 和 .NET Core 开发博客项目 - 完善与美化,Swagger登场

本文涉及的产品
云数据库 RDS MySQL,集群版 2核4GB 100GB
推荐场景:
搭建个人博客
云原生数据库 PolarDB PostgreSQL 版,企业版 4核16GB
推荐场景:
HTAP混合负载
RDS SQL Server Serverless,2-4RCU 50GB 3个月
推荐场景:
简介:

基于 abp vNext 和 .NET Core 开发博客项目 - 完善与美化,Swagger登场

1|0完善与美化
直奔主题,首先将各项目层的项目文件(.csproj)打开,格式化一下,没有引用这句代码的也加一下,这里其实就是将公共属性拿出来,没什么特殊的。

common.props中的代码也非常简单,主要是禁用当开启输出XML的时候没有给代码进行summary注释产生的警告,其实这些大可不必为之折腾,不影响项目的成功运行。如果您觉得没啥必要,完全可以跳过此小节看最后。

1|1.Application
.Application层现在只引用Volo.Abp.Identity.Application包,和依赖.Application.Caching、.Application.Contracts、.Domain.Shared三个项目。

//Meowv.Blog.Application.csproj netcoreapp3.1
1|2.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 netcoreapp3.1
1|3.Application.Contracts
删掉里面所有文件,.Application.Contracts层我不准备按照abp那样来做,此层我只想用来放我们的传输对象(DTO),添加项目引用Domain.Shared,同时开启输出XML文件到我们.HttpApi.Hosting

输出XML很简单,在 Visual Studio 中对着项目 右键=>属性=>生成=>输出,然后选择XML文档文件,默认为一个物理路径,我们将其改为相对路径..Meowv.Blog.HttpApi.HostingMeowv.Blog.Application.Contracts.xml,XML输出到.HttpApi.Hosting层。

也可以直接修改项目文件实现,如下

//Meowv.Blog.Application.Contracts.csproj netcoreapp3.1..Meowv.Blog.HttpApi.HostingMeowv.Blog.Application.Contracts.xml
1|4.Domain
.Domain层为我们的实体领域模型,不需要引用其它层,只添加包Volo.Abp.Identity.Domain,同时也输出一下XML文件,XML文件的作用后续Swagger会用的。

//Meowv.Blog.Domain.csproj netcoreapp3.1..Meowv.Blog.HttpApi.HostingMeowv.Blog.Domain.xml
删掉此层所有文件,不要忘了添加模块类,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 { ... } ...
1|5.Domain.Shared
.Domain.Shared层相当于.Domain的一个扩展一样,这里放一下项目用到的枚举、公共常量等内容,需要引用我们的.Domain项目

netcoreapp3.1
还是要新增一个模块类MeowvBlogDomainSharedModule.cs,它依赖AbpIdentityDomainSharedModule模块

//MeowvBlogDomainSharedModule.cs using Volo.Abp.Identity; using Volo.Abp.Modularity; namespace Meowv.Blog.Domain { [DependsOn(typeof(AbpIdentityDomainModule))] public class MeowvBlogDomainModule : AbpModule { } }
1|6.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 netcoreapp3.1
新建一个模块类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) { } } }
1|7.EntityFrameworkCore.DbMigrations
.EntityFrameworkCore.DbMigrations层主要做数据库迁移,用code-first方式创建数据库表,先删掉默认生成的文件,目前还用不上,后面讲。

1|8.ToolKits
.ToolKits层是我们手动创建的项目,我主要用它来包装一些扩展方法,公共的工具类。

2|0Swagger登场
做.net core开发的,相信Swagger的使用大家应该都很熟悉了,不做过多的介绍,今天只先将其用上看看效果。

我单独为Swagger新建了一个项目Meowv.Blog.Swagger,其实大可不必,直接写在.HttpApi.Hosting中也是一样的。

添加Volo.Abp.AspNetCore和Swashbuckle.AspNetCore包,引用实体层.Domain。

//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,代码如下:

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

EOF

本文作者:阿星Plus
本文链接:https://www.cnblogs.com/meowv/p/12909558.html

相关实践学习
基于CentOS快速搭建LAMP环境
本教程介绍如何搭建LAMP环境,其中LAMP分别代表Linux、Apache、MySQL和PHP。
全面了解阿里云能为你做什么
阿里云在全球各地部署高效节能的绿色数据中心,利用清洁计算为万物互联的新世界提供源源不断的能源动力,目前开服的区域包括中国(华北、华东、华南、香港)、新加坡、美国(美东、美西)、欧洲、中东、澳大利亚、日本。目前阿里云的产品涵盖弹性计算、数据库、存储与CDN、分析与搜索、云通信、网络、管理与监控、应用服务、互联网中间件、移动服务、视频服务等。通过本课程,来了解阿里云能够为你的业务带来哪些帮助     相关的阿里云产品:云服务器ECS 云服务器 ECS(Elastic Compute Service)是一种弹性可伸缩的计算服务,助您降低 IT 成本,提升运维效率,使您更专注于核心业务创新。产品详情: https://www.aliyun.com/product/ecs
相关文章
|
15天前
|
开发框架 算法 Java
.NET 开发:实现高效能的秘诀
【7月更文挑战第4天】探索.NET高效开发涉及理解运行时(如GC、JIT)、代码与算法优化及工具利用。关键点包括适应性垃圾回收、异步编程、明智的并发控制;编写高效代码(避免对象创建,选对数据结构和算法);使用性能分析工具,善用高性能框架如ASP.NET Core,并借助云服务和CI/CD流程持续优化。性能优化是持续学习与实践的过程。
25 1
|
15天前
|
人工智能 前端开发 Devops
NET技术在现代开发中的影响力日益增强,本文聚焦其核心价值,如多语言支持、强大的Visual Studio工具、丰富的类库和跨平台能力。
【7月更文挑战第4天】**.NET技术在现代开发中的影响力日益增强,本文聚焦其核心价值,如多语言支持、强大的Visual Studio工具、丰富的类库和跨平台能力。实际应用涵盖企业系统、Web、移动和游戏开发,以及云服务。面对性能挑战、容器化、AI集成及跨平台竞争,.NET持续创新,开发者应关注技术趋势,提升技能,并参与社区,共同推进技术发展。**
15 1
|
15天前
|
机器学习/深度学习 人工智能 开发者
.NET 技术:为开发带来新机遇
【7月更文挑战第4天】**.NET技术开启软件开发新篇章,通过跨平台革命(.NET Core, Xamarin, .NET MAUI)、云服务与微服务(Azure, DevOps, Docker)及AI集成(ML.NET, 认知服务, TensorFlow)为开发者创造新机遇。开源社区的繁荣与性能提升使.NET更具竞争力,推动智能应用的创新与发展。开发者需紧跟潮流,利用这些工具和框架构建高效、创新的解决方案。**
15 1
|
11天前
|
开发框架 .NET API
.NET Core 和 .NET 标准类库项目类型有什么区别?
在 Visual Studio 中,可创建三种类库:.NET Framework、.NET Standard 和 .NET Core。.NET Standard 是规范,确保跨.NET实现的API一致性,适用于代码共享。.NET Framework 用于特定技术,如旧版支持。.NET Core 库允许访问更多API但限制兼容性。选择取决于兼容性和所需API:需要广泛兼容性时用.NET Standard,需要更多API时用.NET Core。.NET Standard 替代了 PCL,促进多平台共享代码。
|
14天前
|
JSON 数据格式
MysbatisPlus-核心功能-IService开发基础业务接口,MysbatisPlus_Restful风格,新增@RequestBody指定是为了接收Json数据的,使用swagger必须注解
MysbatisPlus-核心功能-IService开发基础业务接口,MysbatisPlus_Restful风格,新增@RequestBody指定是为了接收Json数据的,使用swagger必须注解
支付系统----微信支付16----创建案例项目-引入Swagger
支付系统----微信支付16----创建案例项目-引入Swagger
支付系统---微信支付14----创建案例项目---介绍,第二步引入Swagger,接口文档和测试页面生成工具,定义统一结果的目的是让结果变得更加规范,以上就是谷粒项目的几个过程
支付系统---微信支付14----创建案例项目---介绍,第二步引入Swagger,接口文档和测试页面生成工具,定义统一结果的目的是让结果变得更加规范,以上就是谷粒项目的几个过程
|
17天前
|
开发框架 JSON .NET
|
21天前
|
开发框架 .NET Nacos
使用 Nacos 在 C# (.NET Core) 应用程序中实现高效配置管理和服务发现
使用 Nacos 在 C# (.NET Core) 应用程序中实现高效配置管理和服务发现
45 0
|
22天前
|
存储 JSON NoSQL
技术心得记录:在.NETCore中使用CSRedis
技术心得记录:在.NETCore中使用CSRedis
13 0