Util后端概述

Util应用框架 .Net 功能概述

本节列出了Util应用框架集成封装了哪些有用的.Net功能,以及为此功能引入或参考的第三方技术框架.

框架核心

• 启动器

Util应用框架在项目启动时,会扫描全部程序集,并自动执行服务注册器,执行相关依赖配置.

启动器核心代码参考自 NopCommerce .

• 服务注册器

项目启动扫描时,会加载所有的服务注册器,并按顺序执行.

服务注册器类似其它应用框架的模块概念,但功能有限.

只能用于配置依赖注入关系,无法获取服务提供程序,所以不能执行复杂的操作.

• 依赖服务注册器

扫描 ISingletonDependency, IScopeDependency, ITransientDependency 接口,并自动配置依赖.

框架基础

• 对象到对象映射

技术选型: AutoMapper.

对象到对象映射主要用于分层对象之间的转换,比如从实体映射到DTO.

Util 在所有对象上添加 MapTo 扩展方法,自动完成基础配置,如果映射的两端对象属性名相同,则无需配置,直接使用即可.

• AOP( 面向切面编程 )

技术选型: AspectCore.

AOP用于在调用方法时进行拦截,在执行前后添加自定义逻辑.

Util 主要使用AOP拦截器进行验证.

• 对象验证

Util 使用 DataAnnotation 注解作为基础验证方式,并提供 验证规则 和 验证处理器 等构造块进行自定义验证和处理.

Util 在实体,DTO等对象上添加了 Validate 方法, 以标准化的方式进行对象验证.

• 异常处理

Util 提供了 Warning 类型,表示业务异常,并封装相关异常操作.

• 身份认证和授权

技术选型: Identity, Identity Server 4

Identity 是Asp.Net Core自带的身份认证框架,提供用户管理,登录认证等功能.

Identity Server 4 是一个身份认证服务器,用于颁发令牌和验证令牌等操作.

Identity Server 4 已经停止更新,它的新版本是收费的,Util 仅使用 Identity Server 4 的基础功能,由于它的基础功能已经十分稳定,暂时不需要迁移到其它框架.

Util 除了集成 Identity 和 Identity Server 4,还扩展了Asp.Net Core自定义授权策略,提供简单易行的Api访问控制方法.

Util Platform提供了基于角色和资源的权限管理功能,可以轻松设置前端UI菜单和按钮等权限,同时对后端API进行访问控制.

• 本地化

技术选型: My.Extensions.Localization.Json

Util 本地化支持Json文件或自定义数据存储方式.

My.Extensions.Localization.Json 提供了Json本地化功能.

由于无法满足项目需求, 以源码方式引入, 对健壮性和性能进行了提升.

• 日志

技术选型: Serilog, Seq, Exceptionless

Serilog是.Net目前最流行的日志框架,支持结构化日志.

Seq 和 Exceptionless 是日志管理系统,提供了操作日志的界面,可以使用Serilog写入.

Util 对它们进行了轻度封装,集成了常用配置,并提供日志上下文等扩展.

• 缓存

技术选型: EasyCaching

Util 集成了内存缓存和Redis缓存两种提供程序.

• 事件总线

技术选型: MediatR, Dapr

事件总线分为本地事件总线和集成事件总线.

Util 本地事件总线提供两种实现,默认使用Ioc方式实现,无需外部依赖. 另外引入了 MediatR 框架,它是流行的进程内事件处理框架.

集成事件总线用于微服务之间消息通信,Util 集成了 Dapr 微服务框架,基于 Dapr 的发布订阅实现集成事件总线.

• 模板引擎

技术选型: RazorEngineCore , Handlebars.Net

Util 以源码方式引入 RazorEngineCore ,并进行大量修改.

Razor 模板引擎目前主要用在 Util 代码生成器.

• 图像处理

技术选型: ImageSharp

ImageSharp 是一个图像处理库.

Util 使用 ImageSharp 实现动态文本头像生成.

• 文件存储

技术选型: Minio

Minio 是流行的对象存储系统,适合部署到内部服务器.

Util 集成封装了 Minio SDK, 提供 存储桶名称处理策略, 文件名处理策略等构造块进行扩展处理.

• 后台任务

技术选型: Quartz , HangFire

Util 封装了 Quartz 和 HangFire, 用于处理后台任务.

• 数据访问

技术选型: EntityFrameworkCore , Dapper

Util数据访问主要使用 EntityFrameworkCore ,它是.Net官方提供的ORM框架,属于重量级数据访问框架.

EntityFrameworkCore 支持工作单元模式,对复杂的业务处理非常有效,但对复杂的查询操作无能为力.

可以直接使用 EntityFrameworkCore 执行Sql语句, 但此操作非常原始,效率低下.

Dapper是轻量级数据访问框架, Util引入它并进行封装,用于解决查询问题.

目前 Util Dapper 封装尚不可用,它还缺乏分页,Lambda表达式支持等高级功能,现在仅用于代码生成读取元数据,后续会进行扩展.

由于使用国产数据库的需求逐渐增多,后续将考虑引入 FreeSql 数据访问框架.

• 工具类

Util包含大量工具类,用于处理常用操作.

• 类型转换操作
• Lambda操作
• 命令行操作
• 配置操作
• 枚举操作
• Ioc操作
• Json操作
• 字符串操作
• 时间操作
• IP操作
• Web操作
• 加密操作
• …

架构支持

多租户架构支持

Saas系统支持多家客户使用同一系统,客户数据彼此隔离.

Util 参考了 ABP 应用框架的多租户架构设计的租户解析和数据过滤部分.

Util 多租户架构在独立部署租户数据库方面基于 EntityFrameworkCore 的官方建议,有一些限制.

DDD分层架构支持

Util 分层架构基于领域驱动设计(DDD) 和 企业应用架构模式(POEAA) 的基础构造块.

.Net 早期流行的分层架构是三层架构, 对于不熟悉 DDD 的开发人员,可以把它当成三层架构使用,不过术语的变化而已.

但是对于有一定领域模型使用经验的开发人员,该架构在处理更复杂的业务时可以有效管控复杂性.

对于复杂模块的开发,该架构与三层架构的主要区别在于,实体是作为简单数据容器,还是作为业务处理的场所.

对于很多业务领域,将实体对应的业务操作封装到实体本身,可以提升业务表达能力和封装性.

Util 分层架构分为四层.

领域层

领域层是Util分层架构的核心.

领域层非常纯净, 没有对数据访问和UI的依赖,很容易对该层进行单元测试.

• 聚合根
• 作为并发单元的最外层实体.
• 实体
• 由唯一标识决定的业务对象.
• 值对象
• 表示实体属性值的对象.
• 仓储
• 表示聚合根的集合,用于进行数据访问.
• 领域服务
• 用于封装多个聚合根的操作.
• 领域事件
• 表示实体数据发生变化.
• 使用Util本地事件总线发布领域事件.
• 有几个标准领域事件:
• EntityChangedEvent - 实体变更事件
• EntityCreatedEvent - 实体创建事件
• EntityUpdatedEvent - 实体修改事件
• EntityDeletedEvent - 实体删除事件

基础设施层

对于大多项目,基础设施层主要包含数据访问的实现.

应用层

集成了领域层和基础设施层,为UI提供服务.

• 应用服务
• 应用服务接收UI请求,并将调用委托给实体,领域服务等构造块完成业务功能.
• 对于普通项目,业务逻辑直接在应用服务中实现即可,这与三层架构相似.
• 数据传输对象(DTO)
• 数据传输对象是一种用来传递参数的对象.
• 查询参数对象
• 查询参数对象是一种专门用来传递查询参数的对象.

表现层

微服务架构支持

Util 集成了 Dapr ,它是微软主推的微服务框架.

Util 封装了 Dapr Http同步调用,异步事件发布订阅,状态存储等功能.

并对身份认证,事件日志,事件重发等重要功能进行扩展.

常见业务功能支持

树形结构支持

有些数据包含层次结构.

Util 分层架构包含对树形结构的支持.

如果使用 Util UI,无论加载树形表格还是树形,继承基类即可实现功能.

审计支持

大多操作需要记录创建人,创建时间,修改人,修改时间等审计信息.

Util支持保存时自动设置审计信息.

Util 审计设计参考自 ABP 应用框架.

逻辑删除支持

Util 支持逻辑删除,删除时更新为已删除状态,查询时自动过滤已删除记录.

Util 逻辑删除设计参考自 ABP 应用框架.

对象变更值支持

修改时可能需要获取对象哪些数据发生了变化.

Util 提供多种方式获取对象变更值记录.

代码生成

由于 Util 采用 DDD分层架构,导致简单需求也需要创建大量的类型.

手工创建这些类型效率低下,通过代码生成迅速创建它们,可以大幅提升开发效率和质量.

Util 配套代码生成器, 简单易用, 可解决大部分机械工作.

在生成的代码基础上进行修改,比从头开始工作要好得多.