ABP vnext模块化架构的最佳实践的实现

最新推荐文章于 2024-04-09 13:56:20 发布
最新推荐文章于 2024-04-09 13:56:20 发布
阅读量800 收藏 2
点赞数
文章标签： java 数据库 编程语言 spring 设计模式
原文链接：https://www.cnblogs.com/229015504/p/13812191.html
版权

在上一篇文章《手把手教你用Abp vnext构建API接口服务》中，我们用ABP vnext实现了WebAPI接口服务，但是并非ABP模块化架构的最佳实践。我本身也在学习ABP，我认为ABP新手应该从最佳实践开始学习，可以少走很多弯路，所以写了这篇最佳实践来做个总结，同时给其他朋友们提供一点参考。

一、什么是模块化架构的最佳实践

ABP是一个包含许多nuget包的模块化框架。它提供了一个完整的基础架构来开发你自己的具有实体、服务、数据库集成、API、 UI组件等等功能的应用程序模块。
模块化架构的最佳实践就是按功能的划分创建相应的模块实现的服务，必要时可以把模块发布到nuget，由其他模块安装组合成新的服务或单体应用。这样就可以复用现有的模块功能，快速的交付产品，告别996。

二、模块化架构的最佳实践说明

这部分内容全部来自于模块化架构最佳实践 & 约定，有兴趣的朋友可以去官方文档查看。如果已经很熟悉ABP分层了，可以直接阅读第三部分。

1、解决方案结构：

  1. 为每个模块创建一个单独的解决方案。将解决方案命名为CompanyName.ModuleName。

  2. 一个模块做为分层项目开发，因为它有几个包(项目)是相互关联的。每个包都有自己的模块定义文件,并显式声明所依赖的包/模块的依赖关系。

2、模块分层和包之间的关系
下面展示了一个分层良好的模块中的包以及它们之间的依赖关系:

领域层

将领域层划分为两个项目：

  1. Domain.Shared 包(项目) 命名为CompanyName.ModuleName.Domain.Shared,包含常量,枚举和其他类型，它不能包含实体、存储库、域服务或任何其他业务对象。可以安全地与模块中的所有层使用。此包也可以与第三方客户端使用。

  2. Domain 包(项目) 命名为CompanyName.ModuleName.Domain，包含实体、仓储接口、领域服务接口及其实现和其他领域对象。Domain 包依赖于 Domain.Shared 包。

应用服务层

将应用服务层划分为两个项目:

  1. Application.Contracts 包(项目) 命名为CompanyName.ModuleName.Application.Contracts,包含应用服务接口和相关的数据传输对象(DTO)。Application contract 包依赖于 Domain.Shared 包。

  2. Application 包(项目)命名为CompanyName.ModuleName.Application,包含应用服务实现。Application 包依赖于 Domain 包和 Application.Contracts 包。

基础设施层

  1. 为每个orm/数据库集成创建一个独立的集成包，比如Entity Framework Core 和 MongoDB。例如，创建一个抽象Entity Framework Core集成的CompanyName.ModuleName.EntityFrameworkCore 包。ORM 集成包依赖于 Domain 包。不推荐依赖于orm/数据库集成包中的其他层.

  2. 为每个主要的库创建一个独立的集成包, 在不影响其他包的情况下可以被另一个库替换.

HTTP 层

  1. 创建命名为CompanyName.ModuleName.HttpApi的HTTP API包，为模块开发REST风格的HTTP API。

  • HTTP API 包只依赖于 Application.Contracts 包。不要依赖 Application 包。

  • 为每个应用服务创建一个Controller (通常通过实现其接口)。这些控制器使用应用服务接口来委托操作。它根据需要配置路由，HTTP方法和其他与Web相关的东西。

  • 创建一个为HTTP API包提供客户端服务的HTTP API Client包，它的命名为Companyname.ModuleName.HttpApi.Client。这些客户端服务将应用服务接口实现远程端点的客户端。

    • HTTP API Client包仅依赖于 Application.Contracts包。

    • 推荐使用ABP框架提供的动态代理HTTP C＃客户端的功能。

    Web 层

    创建命名为CompanyName.ModuleName.Web的Web包。包含页面、视图、脚本、样式、图像和其他UI组件。Web包仅依赖于HttpApi包。

    三、实现模块化架构的最佳实践

    开发环境：Mac Visual Studio Code
    SDK：dotnet core 3.1
    数据库：PostgreSQL

    创建项目文件夹，然后进入改文件夹的命令目录执行以下命令创建项目

    在上一篇文章中引入的是Volo.Abp.Identity的包，现在改用Volo.Abp.DDD的包，更简洁。

    /**创建解决方案**/
dotnet new sln
/**创建模块分层**/
dotnet new classlib -o src/Lemon.Account.Domain.Shared
dotnet new classlib -o src/Lemon.Account.Domain
dotnet new classlib -o src/Lemon.Account.EntityFrameworkCore
dotnet new classlib -o src/Lemon.Account.EntityFrameworkCore.DbMigrations
dotnet new classlib -o src/Lemon.Account.Application.Contracts
dotnet new classlib -o src/Lemon.Account.Application
dotnet new classlib -o src/Lemon.Account.HttpApi
dotnet new classlib -o src/Lemon.Account.HttpApi.Client
dotnet new web -o src/Lemon.Account.Host

/**加入解决方案**/
dotnet sln Lemon.Account.sln add src/Lemon.Account.Domain.Shared
dotnet sln Lemon.Account.sln add src/Lemon.Account.Domain
dotnet sln Lemon.Account.sln add src/Lemon.Account.EntityFrameworkCore
dotnet sln Lemon.Account.sln add src/Lemon.Account.EntityFrameworkCore.DbMigrations
dotnet sln Lemon.Account.sln add src/Lemon.Account.Application.Contracts
dotnet sln Lemon.Account.sln add src/Lemon.Account.Application
dotnet sln Lemon.Account.sln add src/Lemon.Account.HttpApi
dotnet sln Lemon.Account.sln add src/Lemon.Account.HttpApi.Client
dotnet sln Lemon.Account.sln add src/Lemon.Account.Host

/**分层间互相引用**/
dotnet add src/Lemon.Account.Domain/Lemon.Account.Domain.csproj reference src/Lemon.Account.Domain.Shared/Lemon.Account.Domain.Shared.csproj
dotnet add src/Lemon.Account.EntityFrameworkCore/Lemon.Account.EntityFrameworkCore.csproj reference src/Lemon.Account.Domain/Lemon.Account.Domain.csproj
dotnet add src/Lemon.Account.EntityFrameworkCore.DbMigrations/Lemon.Account.EntityFrameworkCore.DbMigrations.csproj reference src/Lemon.Account.EntityFrameworkCore/Lemon.Account.EntityFrameworkCore.csproj
dotnet add src/Lemon.Account.Application/Lemon.Account.Application.csproj reference src/Lemon.Account.Application.Contracts/Lemon.Account.Application.Contracts.csproj
dotnet add src/Lemon.Account.Application/Lemon.Account.Application.csproj reference src/Lemon.Account.Domain/Lemon.Account.Domain.csproj
dotnet add src/Lemon.Account.HttpApi/Lemon.Account.HttpApi.csproj reference src/Lemon.Account.Application.Contracts/Lemon.Account.Application.Contracts.csproj
dotnet add src/Lemon.Account.Host/Lemon.Account.Host.csproj reference src/Lemon.Account.EntityFrameworkCore.DbMigrations/Lemon.Account.EntityFrameworkCore.DbMigrations.csproj
dotnet add src/Lemon.Account.Host/Lemon.Account.Host.csproj reference src/Lemon.Account.Application/Lemon.Account.Application.csproj
dotnet add src/Lemon.Account.Host/Lemon.Account.Host.csproj reference src/Lemon.Account.HttpApi/Lemon.Account.HttpApi.csproj

/**添加nuget依赖包**/
dotnet add src/Lemon.Account.Domain.Shared/Lemon.Account.Domain.Shared.csproj package Volo.Abp.Validation
dotnet add src/Lemon.Account.Domain/Lemon.Account.Domain.csproj package Volo.Abp.Ddd.Domain
dotnet add src/Lemon.Account.Domain/Lemon.Account.Domain.csproj package Lemon.Common

dotnet add src/Lemon.Account.EntityFrameworkCore/Lemon.Account.EntityFrameworkCore.csproj package Volo.Abp.EntityFrameworkCore
dotnet add src/Lemon.Account.EntityFrameworkCore/Lemon.Account.EntityFrameworkCore.csproj package Volo.Abp.EntityFrameworkCore.PostgreSql

dotnet add src/Lemon.Account.EntityFrameworkCore.DbMigrations/Lemon.Account.EntityFrameworkCore.DbMigrations.csproj package Volo.Abp.EntityFrameworkCore
dotnet add src/Lemon.Account.EntityFrameworkCore.DbMigrations/Lemon.Account.EntityFrameworkCore.DbMigrations.csproj package Volo.Abp.EntityFrameworkCore.PostgreSql
dotnet add src/Lemon.Account.EntityFrameworkCore.DbMigrations/Lemon.Account.EntityFrameworkCore.DbMigrations.csproj package Microsoft.EntityFrameworkCore.Design

dotnet add src/Lemon.Account.Application.Contracts/Lemon.Account.Application.Contracts.csproj package IdentityModel
dotnet add src/Lemon.Account.Application.Contracts/Lemon.Account.Application.Contracts.csproj package Volo.Abp.Ddd.Application.Contracts

dotnet add src/Lemon.Account.Application/Lemon.Account.Application.csproj package Volo.Abp.Ddd.Application
dotnet add src/Lemon.Account.Application/Lemon.Account.Application.csproj package Volo.Abp.AutoMapper

dotnet add src/Lemon.Account.HttpApi/Lemon.Account.HttpApi.csproj package Volo.Abp.AspNetCore.Mvc

dotnet add src/Lemon.Account.Host/Lemon.Account.Host.csproj package Volo.Abp.AspNetCore.Mvc
dotnet add src/Lemon.Account.Host/Lemon.Account.Host.csproj package Swashbuckle.AspNetCore
dotnet add src/Lemon.Account.Host/Lemon.Account.Host.csproj package Microsoft.AspNetCore.DataProtection.StackExchangeRedis
dotnet add src/Lemon.Account.Host/Lemon.Account.Host.csproj package Microsoft.Extensions.Caching.StackExchangeRedis
dotnet add src/Lemon.Account.Host/Lemon.Account.Host.csproj package Serilog.AspNetCore
dotnet add src/Lemon.Account.Host/Lemon.Account.Host.csproj package Serilog.Settings.Configuration
dotnet add src/Lemon.Account.Host/Lemon.Account.Host.csproj package Serilog.Sinks.Async
dotnet add src/Lemon.Account.Host/Lemon.Account.Host.csproj package Serilog.Sinks.File
dotnet add src/Lemon.Account.Host/Lemon.Account.Host.csproj package Volo.Abp.AspNetCore.Serilog
dotnet add src/Lemon.Account.Host/Lemon.Account.Host.csproj package Volo.Abp.Autofac
dotnet add src/Lemon.Account.Host/Lemon.Account.Host.csproj package IdentityServer4.AccessTokenValidation
dotnet add src/Lemon.Account.Host/Lemon.Account.Host.csproj reference src/Lemon.Account.EntityFrameworkCore.DbMigrations/Lemon.Account.EntityFrameworkCore.DbMigrations.csproj
    实现领域层

    在Domain创建实体类及其约束关联，具体代码请看UserData类，此处不再详细说明。

    实现基础设施层

    在EntityFrameworkCore创建AccountDbContext类和LemonAccountDbContextModelCreatingExtensions类。请特别关注LemonAccountDbContextModelCreatingExtensions类，主要是用来定义实体在数据库表中的字段属性。

    实现应用服务层
    实现httpapi
    用swagger调试接口

    进入Host目录，执行命令

    dotnet watch run


    服务启动成功，在浏览器打开链接http://localhost:5000/swagger/index.html，开始调试账号注册和验证接口。结果如下：



    四、模块化架构的最佳实践的好处

    使用模块化架构的好处有几点：

    1. 可以方便的更换模块
      比如我现在用的数据库是PostgreSQL，如果想要更换成MySQL，只要以EntityFrameworkCore层为基础，新增一个MySQL连接库，就可以在不改变业务逻辑的前提下快速的切换数据库。

    dotnet new classlib -o src/Lemon.Account.EntityFrameworkCore.MySQL
dotnet new classlib -o src/Lemon.Account.EntityFrameworkCore.MySQL.DbMigrations
dotnet sln Lemon.Account.sln add src/Lemon.Account.EntityFrameworkCore.MySQL
dotnet sln Lemon.Account.sln add src/Lemon.Account.EntityFrameworkCore.MySQL.DbMigrations

dotnet add src/Lemon.Account.EntityFrameworkCore.MySQL/Lemon.Account.EntityFrameworkCore.MySQL.csproj reference src/Lemon.Account.Domain/Lemon.Account.Domain.csproj
dotnet add src/Lemon.Account.EntityFrameworkCore.MySQL.DbMigrations/Lemon.Account.EntityFrameworkCore.MySQL.DbMigrations.csproj reference src/Lemon.Account.EntityFrameworkCore.MySQL/Lemon.Account.EntityFrameworkCore.MySQL.csproj

dotnet add src/Lemon.Account.EntityFrameworkCore.MySQL/Lemon.Account.EntityFrameworkCore.MySQL.csproj package Volo.Abp.EntityFrameworkCore.MySQL

dotnet add src/Lemon.Account.EntityFrameworkCore.MySQL.DbMigrations/Lemon.Account.EntityFrameworkCore.MySQL.DbMigrations.csproj package Microsoft.EntityFrameworkCore.Design

    最后再修改ConnectionStrings default为mysql的连接，修改LemonAccountHostModule的依赖项LemonAccountEntityFrameworkCoreDbMigrationsModule为MySQL

    1. 单体应用和微服务无缝切换
      模块开发完成后，一般当作微服务来部署；或者把模块发布到nuget，在单体应用的各个分层中引入模块，多个模块在单体应用中的应用就构成了一个完整系统服务。

    2. 模块复用
      由于模块是发布到nuget的，所以如果有新的项目需要用到相同功能的，可以直接从nuget引入安装，无需重复开发或者复制代码。

    3. 自动API控制器

    4. 动态 C# API 客户端

    GiHub地址：https://github.com/huangbenq/abp-samples

    参考文档：

    1. 模块化：https://docs.abp.io/zh-Hans/abp/latest/Module-Development-Basics

    2. 最佳实践：https://docs.abp.io/zh-Hans/abp/latest/Best-Practices/Index

    3. 自动API控制器：https://docs.abp.io/zh-Hans/abp/latest/API/Auto-API-Controllers

dotNET跨平台
关注
  • 0
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
基于 abp vNext 和 .NET Core 开发博客项目 - Blazor 实战系列（三）
阿星Plus
06-11 576
系列文章 基于 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 和
ABP vNext 商业版
01-24
ABP Commercial 仅供学习参考
Abp vNext 基本使用
最新发布
qq_20382175的博客
04-09 117
https://www.cnblogs.com/zzy-tongzhi-cnblog/p/16545513.html
ABP详细教程——模块类
dotNET跨平台
08-05 1122
概述模块化是ABP vNext的最大亮点，也是ABP vNext框架的核心，而模块类是ABP vNext框架模块化的核心要素。这一章节，我就从模块类的用法、运行机制、源代码等层面，带大家详细了解ABP vNext的模块类。用法在ABP的约定中，每个项目（类库）都应该包含一个继承自AbpModule的模块类，命名规范为【项目名称+Module】在模块类中，我们可以重写...
1初步整合ABP模块化
qq_42799562的博客
06-18 669
这里我们先初步整合WebApi模块化，待程序运行起来，后续文章我们再对Abp进行深入。
什么是ABP？
beiye_的博客
07-01 2666
简要讲解什么是ABP框架，并对ABP框架中的重点部分进行论述
并行计算与分布式计算
Listron的专栏
08-24 1万+
并行计算、分布式计算以及网格计算和云计算都是属于高性能计算（HPC）的范畴，主要目的在于对大数据的分析与处理，但它们却存在很多差异。我们需要了解两者的原理、特点和运用的场合，对云计算的了解大有裨益。 之所以将两种计算技术放在一起，是因为这两种计算具有共同的特点，都是运用并行来获得更高性能计算，把大任务分为N个小任务。但两者还是有区别的，关于两者的区别在后面有介绍。 并行计算 1、并行计算概念 并行计算（Parallel Computing）又称平行计算是指一种能够让多条指令同时进行.
Abp.Aliyun:专门为 ABP vNext 框架开发的阿里云 SDK 模块
05-06
专门为 ABP vNext 框架开发的阿里云 SDK 模块。 一、简要介绍 EasyAbp.Abp.Aliyun 库是针对于阿里云 API 进行了二次封装模块，与 ABP vNext 框架深度集成。 二、基本配置 开发人员根据自身项目情况，选择需要使用的...
ABP VNext 集成JwtBearer（JWT）JwtDemo.Api
07-22
ABP VNext 集成JwtBearer DEMO 简单版本安装依赖包 Microsoft.AspNetCore.Authentication.JwtBearer，亲测可以使用。最后在对应控制器或者方法加上加特性Authorize，然后可以通过postman调用，401即验证成功
Abp.Captcha:基于ABP vNext的人机验证模块
03-27
验证码 第一阶段将提供基于ABP vNext的人机验证模块，滑杆验证和竖锯验证。 使用框架 下一个：4.0 类型：模块 演示 使用界面： API调试界面： 模块配置说明 去做
HelloAbp:ABP vNext + vue-element-admin入门级项目实战
04-13
HelloAbpABP vNext + vue-element-admin入门级项目实战运行环境：.netcore 3.1、sqlserver、nodejs、npm修改Xhznl.HelloAbp.HttpApi.Host、Xhznl.HelloAbp.DbMigrator项目的数据库连接字符串运行/run/db-migrator....
初识ABP vNext（9）：ABP模块化开发-文件管理
dotNET跨平台
09-12 599
点击上方蓝字"小黑在哪里"关注我吧创建模块模块开发应用服务运行模块单元测试模块使用前言在之前的章节中介绍过ABP扩展实体，当时在用户表扩展了用户头像字段，用户头像就涉及到...
abp学习日志六（模块化开发）
iml6yu的博客
03-16 788
文章目录模块化继承AbpModule总结abp的模块化分层 模块化 ABP本身是一个包含许多nuget包的模块化框架.它还提供了一个完整的基础架构来开发你自己的具有实体, 服务, 数据库集成, API, UI组件等等功能的应用程序模块. 模块化是根据项目进行划分的，具体怎么划分应该根据业务来定义，abp对模块化的项目做了一些包装。 继承AbpModule 比如EntityFramework模块吧，...
dll模块化设计与编程_浅谈Abp vNext的模块化设计
weixin_33736666的博客
01-19 392
作者:张飞洪[厦门]出处:https://www.cnblogs.com/jackyfei/p/13572733.htmlabp的模块化给我留下深刻的印象，模块化不是什么新概念，大家都习以为常，但是为什么要模块化，模块化的意义或者说目的是什么？也许我们思考得并不深入。难得的是abp不仅完美的阐述了模块化概念，而且把模块化落地得十分优雅，并且进行了开源。模块化内涵？模块分类根据粒度大小的不同，模块具...
ABP vNext微服务架构详细教程——基础服务层
dotNET跨平台
01-29 1762
1服务创建在除身份管理相关服务以外的其他业务服务中，我们不需要包含用户角色权限管理功能模块，ABP vNext框架为我们提供了模块模式，其默认模板不包含身份管理相关模块，更适合用于搭建普通...
Abp vNext 模块化
dawei.tu的博客
09-13 716
Abp vNext 在Abp vNext框架当中呢，模块化管理可以说是最基本的要求，他把程序按照模块进行切分，模块之间也存在相互依赖的关系，当然模块切分可以按照业务，也可以按照功能，最后一个一个组装拼接成整个项目 Abp vNext模块化生命周期 每一次建立一个新的模块各模块之间都是相互独立的，都会进行asp.net core 的服务注册等等操作。 在asp.net core 原有的项目中，我们知道程序的启动项是基于startup里面的三大件进行服务注册，初始化，以及中间件等等操作的 而在abp.vnext
ABPVNext学习系列(1)-模块化
qq_35719502的博客
12-30 437
一、控制台应用程序使用ABP （1）安装 Volo.Abp.Core （2）创建ABP模块类：ABP是一个模块化框架,它需要一个**启动 (根) 模块**继承自AbpModule: a、通过DependsOn引用第三方模块 c、获取注入服务有两种： （3）插件自动加载 ...
ABP框架的理解和总结
热门推荐
roadlord的专栏
09-30 2万+
1、使用automapper实现实体与DTO之间的映射。 2、ABP使用Castle Windsor为整个程序框架提供依赖注入的功能。 使用log4Net日志记录组件， 提供给其他各层调用以进行日志记录。 4、ABP的多租户模式是关闭的，我们可以在模块PreInitialize 方法中开启他。Configuration.Multitency.IsEnabled = true; 5、如果你使用了mo...
AbpZero后台模块化(1)
dbk22131的博客
06-08 216
AbpZero的精髓就在于多租户模块化加载，如果不做到这两种的话，就没必要使用这个框架。 1、首先，我们得新建一个类库，用于存放我们写的业务代码。 在类库下分别建立三个类文件：TestAppService ,ITestAppService ,TestModule，一下是对应代码： TestModule： 1 using Abp.Modules; ...
Abp VNext前后端分离项目实践
08-19
Abp VNext是一个开源的应用框架，它提供了一种快速构建现代化、模块化和可扩展的企业级应用程序的方式。在Abp VNext中，前后端的分离是一种常见的项目实践方式，它可以提供更好的团队协作、灵活性和可维护性。 下面...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值