Util应用框架介绍

什么是Util应用框架?

Util是一个.Net平台下的应用框架，旨在提升中小团队的开发能力，由工具类、分层架构基类、Ui组件，配套代码生成模板，权限等组成。

Util应用框架的作者: 何镇汐

Util应用框架的主要作者为何镇汐。

Util应用框架的开源协议: MIT

这是最宽松的开源协议,意味着可以以任何方式使用该代码。

Util应用框架的主要贡献者

汪总 胡兴业

这里只列出了主要贡献者,还有很多开发人员以不同形式对Util做出了宝贵贡献。

Util应用框架的目标: 让开发更简单

Util应用框架让你的团队迅速进入业务开发状态,并在开发过程中持续提供帮助。

Util应用框架的特点: 简单易用

Util应用框架的设计理念是追求Api简单化,尽量少的配置,不用精确记忆Api,有个模糊印象即可使用。

Util应用框架的学习成本相对较低,对于有.Net基础的开发人员,进行常规业务开发,通常在3天内上手。

Util应用框架开发流程

搜集 - 整理 - 集成 - 封装

每当发现无法满足项目需求时，扩展框架的时刻来临。

从头造轮子是下策，所以总是先四处搜集相关资料。对于简单的需求，可能只需要找到一些代码片断即可。对于更专业的问题，需要寻求第三方技术框架的帮助。

找到解决方案并调试通过后，需要对代码进行整理，以符合我们的编程风格。

通常以Nuget包或Npm包的方式进行集成,为了降低学习成本，需要仔细考虑如何封装才能让调用者最省力。

任何有技术含量的工作，均由第三方技术框架完成，Util应用框架仅对技术框架选型并集成封装。

Util应用框架只是很薄的一层外观，为复杂的技术框架提供一个简易视图。

这导致更健壮的实现和更易用的API。

Util应用框架的使用方式

使用Util应用框架有几种不同的方式。

最灵活的方式是将Util应用框架的代码复制到你自己的应用框架中,然后可以随意修改它们来满足项目需求。

不过这种方式的代价也很大,很难合并Util的任何更新,你需要自行维护相当大的代码库。

由于Util应用框架的体积在不断增长,维护这些代码库可能给你带来不小的负担。

另一种可行的方式是将Util应用框架作为你的基础库,使用Nuget引入它们,基础的工作让Util应用框架帮你完成,你只需要扩展自己业务领域相关的功能。

这种方式的限制也很明显,Util提供的功能可能无法满足你的要求。

解决这个问题的关键是与Util开发团队保持沟通,将你的需求告诉我们。

对于通用功能,我们会尽量满足,这样会让更多的开发者受益,对于定制需求,我们也会为你提供扩展点,方便你能自行扩展。

框架核心

• 启动器

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提供服务.

• 应用服务