基于 abp vNext 和 .NET Core 开发博客项目 - 完善与美化,Swagger登场
1|0系列文章
- 基于 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)已经成功将博客项目跑起来了,那么本篇主要是将之前遗留的问题解决,现在的代码看起来可能还是比较混乱,有大量与之无关的代码存在里面,对于强迫症患者来说真的是零容忍。
在程序员界,总有一批强迫症患者,他们希望自己写的代码看起来尽量的完美无瑕疵。
2|0完善与美化
直奔主题,首先将各项目层的项目文件(.csproj
)打开,格式化一下,没有引用<Import Project="..\..\common.props" />
这句代码的也加一下,这里其实就是将公共属性拿出来,没什么特殊的。
common.props
中的代码也非常简单,主要是禁用当开启输出XML的时候没有给代码进行summary注释产生的警告,其实这些大可不必为之折腾,不影响项目的成功运行。如果您觉得没啥必要,完全可以跳过此小节看最后。
2|1.Application
.Application
层现在只引用Volo.Abp.Identity.Application
包,和依赖.Application.Caching
、.Application.Contracts
、.Domain
三个项目。
2|2.Application.Caching
.Application.Caching
层看名字就知道,我准备用它来处理缓存,这里会用到两个包,Volo.Abp.Caching
、Microsoft.Extensions.Caching.Redis
。
不管三七二十一,新建一个模块类MeowvBlogApplicationCachingModule.cs
,依赖于AbpCachingModule
和我们的MeowvBlogDomainModule
模块(此时还没添加)
2|3.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
层。
也可以直接修改项目文件实现,如下
2|4.Domain
.Domain
层为我们的实体领域模型,不需要引用其它层,只添加包Volo.Abp.Identity.Domain
,同时也输出一下XML文件,XML文件的作用后续Swagger会用的。
删掉此层所有文件,不要忘了添加模块类,MeowvBlogDomainModule.cs
,它依赖AbpIdentityDomainModule
模块
此时上面.Application.Caching
中可以将MeowvBlogDomainModule
加上了。
2|5.Domain.Shared
.Domain.Shared
层相当于.Domain
的一个扩展一样,这里放一下项目用到的枚举、公共常量等内容,需要引用我们的.Domain
项目
还是要新增一个模块类MeowvBlogDomainSharedModule.cs
,它依赖AbpIdentityDomainSharedModule
模块
2|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
项目
新建一个模块类MeowvBlogFrameworkCoreModule.cs
,依赖MeowvBlogDomainModule
和数据库模块
2|7.EntityFrameworkCore.DbMigrations
.EntityFrameworkCore.DbMigrations
层主要做数据库迁移,用code-first方式创建数据库表,先删掉默认生成的文件,目前还用不上,后面讲。
2|8.ToolKits
.ToolKits
层是我们手动创建的项目,我主要用它来包装一些扩展方法,公共的工具类。
3|0Swagger登场
做.net core开发的,相信Swagger的使用大家应该都很熟悉了,不做过多的介绍,今天只先将其用上看看效果。
我单独为Swagger新建了一个项目Meowv.Blog.Swagger
,其实大可不必,直接写在.HttpApi.Hosting
中也是一样的。
添加Volo.Abp.AspNetCore
和Swashbuckle.AspNetCore
包,引用实体层.Domain
。
添加模块类MeowvBlogSwaggerModule.cs
,依赖MeowvBlogDomainModule
模块,并且重写ConfigureServices
和OnApplicationInitialization
方法,不知道这是什么的,可以看文档:https://docs.abp.io/zh-Hans/abp/latest/Module-Development-Basics
然后新建一个扩展类MeowvBlogSwaggerExtensions.cs
,编写两个扩展方法AddSwagger
和UseSwaggerUI
。
在AddSwagger
方法中引用我们的XML文件,配置接口的名称版本以及描述信息,在UseSwaggerUI
方法中使用SwaggerUI,代码如下:
随后便可以在模块MeowvBlogDomainModule
中引用了
最后在.HttpApi.Hosting
层的的启动模块中引用一下。
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__

本文链接:https://www.cnblogs.com/meowv/p/12909558.html
关于博主:评论和私信会在第一时间回复。或者直接私信我。
版权声明:本博客所有文章除特别声明外,均采用 BY-NC-SA 许可协议。转载请注明出处!
声援博主:如果您觉得文章对您有帮助,可以点击文章右下角【推荐】一下。您的鼓励是博主的最大动力!
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】凌霞软件回馈社区,博客园 & 1Panel & Halo 联合会员上线
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】博客园社区专享云产品让利特惠,阿里云新客6.5折上折
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步
· 没有源码,如何修改代码逻辑?
· 一个奇形怪状的面试题:Bean中的CHM要不要加volatile?
· [.NET]调用本地 Deepseek 模型
· 一个费力不讨好的项目,让我损失了近一半的绩效!
· .NET Core 托管堆内存泄露/CPU异常的常见思路
· 微软正式发布.NET 10 Preview 1:开启下一代开发框架新篇章
· 没有源码,如何修改代码逻辑?
· NetPad:一个.NET开源、跨平台的C#编辑器
· PowerShell开发游戏 · 打蜜蜂
· 在鹅厂做java开发是什么体验