【开源】OSharpNS，轻量级.net core快速开发框架发布

2022-10-12 21:36:58

OSharpNS简介

OSharp Framework with .NetStandard2.0（OSharpNS）是OSharp的以.NetStandard2.0为目标框架，在AspNetCore的现有组件 Microsoft.Extensions.DependencyInjection，Microsoft.Extensions.Configuration，

Microsoft.Extensions.Logging，Microsoft.Extensions.Caching，Microsoft.EntityFrameworkCore等上进行构建的快速开发框架。

框架目标人群

本框架适用于中小型项目，一（两）年以上开发经验，对依赖注入，ORM，缓存，日志，发布订阅模式有一定理解的开发人员

框架组件组织

OSharp【框架核心组件】：框架的核心组件，包含一系列快速开发中经常用到的Utility辅助工具功能，框架各个组件的核心接口定义，部分核心功能的实现
OSharp.AspNetCore【AspNetCore组件】：AspNetCore组件，提供AspNetCore的服务端功能的封装
OSharp.AutoMapper【对象映射组件】：AutoMapper 对象映射组件，封装基于AutoMapper的对象映射实现
OSharp.EntityFrameworkCore【EFCore 数据组件】：EFCore数据访问组件，封装EntityFrameworkCore数据访问功能的实现
OSharp.EntityFrameworkCore.MySql【EFCore MySql 数据组件】：EFCore MySql数据访问组件，封装MySql的EntityFrameworkCore数据访问功能的实现
OSharp.EntityFrameworkCore.PostgreSql【EFCore PostgreSql 数据组】：EFCore PostgreSql数据访问组件，封装PostgreSql的EntityFrameworkCore数据访问功能的实现
OSharp.EntityFrameworkCore.Sqlite【EFCore Sqlite 数据组】：EFCore Sqlite数据访问组件，封装Sqlite的EntityFrameworkCore数据访问功能的实现
OSharp.EntityFrameworkCore.SqlServer【EFCore SqlServer 数据组件】：EFCore SqlServer数据访问组件，封装SqlServer的EntityFrameworkCore数据访问功能的实现
OSharp.EntityFrameworkCore.Sqlite【EFCore Sqlite 数据组件】：EFCore Sqlite数据访问组件，封闭Sqlite的EntityFrameworkCore数据访问功能的实现
OSharp.Exceptionless【Exceptionless 分布式日志组件】：Exceptionless 分布式日志组件，封装基于Exceptionless 分布式日志记录实现
OSharp.Hangfire【Hangfire后台任务组件】：Hangfire 后台任务组件，封装基于Hangfire后台任务的服务端实现
OSharp.Log4Net【Log4Net组件】：Log4Net组件，封装使用log4net组件来实现框架的日志输出功能
OSharp.MiniProfiler【MiniProfiler 性能监测组件】：MiniProfiler 性能监测组件，基于MiniProfiler实现的性能监测组件
OSharp.Permissions【权限组件】：使用AspNetCore的Identity为基础实现身份认证的封装，以Security为基础实现以角色-功能、用户-功能的功能权限实现，以角色-数据，用户-数据的数据权限的封装
OSharp.Redis【Redis 缓存组件】：Redis 缓存组件，封装基于Redis客户端的缓存实现
OSharp.Swagger【Swagger 客户端组件】：Swagger 客户端组件，封装基于Redis客户端实现

OSharpNS特性

1. 模块化的组件设计

框架设计了一个模块（Pack）的系统，所有实现了模块基类（OsharpPack）的类都视为一个独立的模块，一个模块可以独立添加服务（AddServices），并可在初始化时应用服务（UsePack）进行模块初始化。

2. 自动化的依赖注入机制

框架定义了ISingletonDependency，IScopeDependency，ITransientDependency三个空接口对应DependencyInjection中的三种服务生命周期，系统初始化时，通过反射检索程序集的方式，检索出所有服务类型(ServiceType)与服务实现(ImplementationType)及生命周期类型(ServiceLifetime)的相关数据，对依赖注入的ServiceCollection进行全自动初始化。

3. UnitOfWork-Repository模式，EFCore上下文动态构建

数据模块使用了UnitOfWork-Repository的模式来设计，设计了一个泛型的实体仓储接口IRepository<TEntity,TKey>，避免每个实体都需实现一个仓储的繁琐操作。设计了IUnitOfWork接口来管理事务，通过UnitOfWork模式管理DbContext的创建，使不同上下文类型同数据库连接字符串的上下文使用相同DbConnection对象来创建，达到多上下文的事务同步能力。
基于MVC的ActionFilter的UnitOfWorkAttribute AOP 事务自动提交，业务中不再需要关心事务的生命周期。
系统初始化时，通过反射检索程序集的方式，检索出各个实体与上下文的映射关系，向上下文中动态添加实体类来构建上下文类型，以达到上下文类型与业务实体解耦的目的。通过统一基类EntityTypeConfigurationBase<TEntity, TKey>的FluentAPI实体映射，*配置每个实体与数据库映射的每一个细节。

4. 基于AspNetCore的Identity的身份认证设计系统

使用AspNetCore原生的用户身份认证框架，身份认证相关操作统一使用UserManager<TUser>，RoleMamanger<TRole>两个入口，保持了原生Identity的体系强大性与功能完整性。
重新设计了用户存储UserStore和角色存储RoleStore，使用框架内设计的IRepository<TEntity,TKey>数据仓储接口来实现对数据的仓储操作，使Identity身份认证系统与框架完美结合，避免了使用官方的Microsoft.AspNetCore.Identity.EntityFrameworkCore造成多个上下文或者被强制使用Identity上下文作为系统数据上下文来实现业务造成的尴尬。

5. 设计了一个强大的功能权限与数据权限的授权体系

从底层开始，自动收集了系统的所有业务点（IFunction）和数据实体（IEntityInfo），用于对系统的功能权限、数据权限、数据缓存、操作审计等实用功能提供数据支持。
功能点Function与MVC的Area/Controller/Action一一对应，是功能权限的最小验证单位，基于功能点，可以配置：
1. 功能访问类型（匿名访问、登录访问、限定角色访问）
2. 功能的数据缓存时间及缓存过期方式（绝对过期、相对过期）
3. 是否开启操作审计（XXX人员XXX时间做了XXX操作）
4. 是否开启数据审计（操作引起的数据变化详情（新增、更新、删除））
数据实体EntityInfo与数据库中的各个数据实体一一对应，基于数据实体，可以配置：
1. 是否开启数据审计，与Function上的同配置级别不同，如果指定实体未开放审计，则不审计当前实体。
2. [部分实现] 数据权限，基于角色 - 实体的数据权限设计，通过配置实现 XXX角色是否有权访问XXX实体数据（的XX属性）
设计了一个树形结构的业务模块体系（Module），对应着后端向前端开放的操作点（菜单/按钮），一个模块可由一个或多个功能点构成，模块是对外开放的特殊功能点，是进行角色/用户功能授权的单位。把一个模块授权给角色，角色即拥有了一个或多个功能点的操作权限。
功能权限授权流程
1. [自动] 创建MVC的各个Area/Controller/Action的功能点Function信息，存储到数据库
2. [自动] 创建树形模块Module信息，并创建模块与功能点（一个或多个）的分配关系，存储到数据库
3. 将模块Module分配给角色Role
4. 将角色Role分配给用户User
5. 可将模块Module分配给用户User，解决特权问题
6. 这样用户即可根据拥有的角色，自动拥有模块对应着的所有功能点的功能权限
功能权限验证流程
1. 系统初始化时，根据每个角色Role分配到的模块Module，自动初始化每个 角色 Role - Function[] 的权限对应关系并缓存
2. 游客进入系统时，自动请求所有可匿名访问FunctionAccessType.Anonymouse的模块信息并缓存到浏览器，浏览器根据这个缓存的模块集合，对前端页面的各个操作点（菜单/按钮）进行是否隐藏/禁用的状态控制
3. 注册用户登录系统时，自动请求所有可执行（包括匿名的FunctionAccessType.Anonymouse、登录的FunctionAccessType.Logined、指定角色的FunctionAccessType.RoleLimit）的模块信息并缓存到浏览器，浏览器根据这个缓存的模块集合，对前端页面的各个操作点（菜单/按钮）进行是否隐藏/禁用的状态控制
4. 用户User执行一个功能点Function时，验证流程如下：
  1. 功能点不存在时，返回404
  2. 功能点被锁定时，返回423
  3. 功能点可访问性为匿名FunctionAccessType.Anonymouse验证通过
  4. 功能点可访问性为需要登录FunctionAccessType.Logined时，用户未登录，返回401，已登录则验证通过
  5. 功能点可访问性为需要登录FunctionAccessType.RoleLimit时，流程如下：
    1. 用户未登录，返回401
    2. 逐个验证用户拥有的角色Role，根据角色从缓存中取出Role-Function[]缓存项，Function[]包含要验证的功能点时，验证通过
    3. 由分配给用户的模块Module对应的功能点，获取到User-Function[]（并缓存），Function[]包含要验证的功能点时，验证通过
    4. 验证未通过，返回403
[部分实现] 数据权限授权流程
1. 基于角色Role-实体EntityInfo 的一一对应关系，配置指定角色对指定数据实体的数据查询筛选规则，并持久化到数据库中
2. 数据查询筛选规则组成为条件组FilterGroup和条件FilterRule，一个条件组 FilterGroup 包含一个或多个条件 FilterRule 和一个或多个条件组FilterGroup，这样就实现了条件组和条件的无限嵌套，能满足绝大多数数据筛选规则的组装需要，如下图：
[部分实现] 数据权限验证流程
1. 系统初始化时，将所有角色-实体的数据筛选规则缓存到内存中
2. 进行数据查询的时候，根据当前用户的所有角色 Role和要查询的实体 EntityInfo，查找出所有配置的数据筛选规则FilterGroup，转换为数据查询表达式Expression<Func<TEntity,bool>>，各个角色的表达式之间使用Or逻辑进行组合
3. 将以上生成的数据权限数据查询表达式，使用And逻辑组合到用户的提交的查询条件生成的表达式中，得到最终的数据查询表达式，提交到数据库中进行数据查询，从而获得数据权限限制下的合法数据

6. 集成 Swagger 后端API文档系统

OSharpNS 快速启动模板的开发模式，集成了Swagger API 文档生成组件，更方便了前后端分离的开发模式中前后端开发人员的数据接口对接工作。基于Swagger的工作原理，API的输入输出都需使用强类型的数据类型，Swagger才能发挥更好的作用，而OSharpNS框架通过AutoMapper的ProjectTo对业务实体到输出DTOIOutputDto提供了自动映射功能，能有效减轻后端开发中数据对象属性映射的工作量。

快速启动

OSharpNS框架制作了一个基于dotnet cli命令行工具的快速启动模板，下面演示如何来使用这个模板快速创建一个基于OSharpNS框架的初始化项目。

1. 安装最新版本 dotnetcore sdk

OSharpNS当前版本（0.2.1-beta05）使用了 dotnetcore 当前最新版本 2.1.1，所以对应的 dotnetcore sdk 需要安装到对应版本 >=v2.1.301。

2. 安装OSharpNS的 dotnet new 项目模板

在任意空白目录，打开cmd或者powershell命令行窗口，执行命令

dotnet new -i OSharpNS.Template.Mvc_Angular

执行后，将能看到osharp_xxx系列的命令已安装到列表中

3. 执行 osharp_cmd 命令，获取项目一键安装脚本

dotnet new osharp_cmd

执行后，将得到一个名为cmd_build.bat的批处理脚本文件

4. 运行脚本文件，生成项目初始化代码

直接执行cmd_build.bat脚本代码，将会提示 请输入项目名称，推荐形如 “公司.项目”的模式：，此名称将用作解决方案名称、工程名称起始部分、代码中的namespace起始部分。例如输入Liuliu.Demo，将生成如下代码结构：

5. 用VS打开解决方案

打开解决方案后，各个工程之间的引用关系已配置好，osharp框架的类库已引用 nuget.org 上的相应版本，并将自动还原好。项目结构如图所示：

项目代码结构说明：

Liuliu.Demo.Core：业务核心工程，顶层文件夹以业务模块内聚，每个文件夹按职责划分文件夹，通常可包含传输对象Dtos、实体类型Entities、事件处理Events等，业务接口IXxxContract与业务实现IXxxService放在外边，如果文件数量多的话也可以建文件夹存放。
Liuliu.Demo.EntityConfiguration： EFCore实体映射工程，用于配置各个业务实体映射到数据库的映射细节。文件夹也推荐按模块内聚。
Liuliu.Demo.Web：网站的Hosting项目，按常规方式使用即可

项目启动配置

按实际环境修改配置文件appsetting.Development.json中的OSharp:DbContexts:[SqlServer|MySql]中的配置信息，ConnectionString为数据库连接串，AutoMigrationEnabled为是否开启自动迁移
如未开启AutoMigrationEnabled的自动迁移功能，还需要在nuget 控制台手动执行迁移操作

Update-Database

配置好后，即可正常启动端口号为7001的项目，启动后开发模式将进入Swagger的后端Api接口的文档页。

6. Angular6的前端项目启动

前端项目使用了ng-alain和kendoui作为UI进行开发的，需要熟悉nodejs,angular6等技术。

安装 NodeJS ，搭建前端技术环境

安装最新版本 NodeJS：angular6需要最新版本的 NodeJS，请到 NodeJS官方网站下载最新版本的NodeJS进行安装。
设置npm的淘宝镜像仓库：由于npm的国外仓储会很慢，所以最好把npm仓库地址指定国内镜像，推荐淘宝镜像：

npm config set registry https://registry.npm.taobao.org

安装全局Angular/Cli：如果Angular/Cli没有安装，执行如下命令全局安装Angular

Angular的快速启动，请参考Angular官方文档

npm install -g @angular/cli

下载安装 Visual Studio Code：前端最好用的IDE，官方下载

使用 VS Code 打开 Angular 前端项目

定位到项目的目录src/ui/ng-alain，在空白处点右键，使用 VS Code 打开项目，可看到如下结构：

按Ctrl+Tab快捷键，调出VS Code的命令行控制台，输入NodeJS包安装命令：

npm install

包安装完成后，输入项目启动命令：

npm start

此命令将会执行如下命令：ng serve --port 4201 --proxy-config proxy.config.json --open，其中--proxy-config proxy.config.json对前端项目发起的API请求进行了代理，所有以 /api/开头的请求，都会转发到服务端项目中进行处理，代理的实际配置如下：

{

    "/api": {

        "target": "http://localhost:7001",

        "secure": false

    }

}

至此，项目启动完成，后续可以进行用户注册的工作，请注意：

系统的第一个注册用户，将自动拥有系统最高权限的超级管理员权限

最终效果如下图所示：

# 项目开发进度

截止到目前，OSharpNS 框架的完成程度已经很高了，计划中的功能点，除了数据权限未完成，其余均已得到较高水准的实现，具体功能点完成进度如下所示：

[ ] OSharpNS Framework
- [ ] OSharp
  - [x] 添加常用Utility辅助工具类
  - [x] 添加框架配置Options定义
  - [x] 定义Entity数据访问相关接口
  - [x] 定义依赖注入模块相关接口
  - [x] 定义并实现EventBus事件总线的设计
  - [x] 定义Mapper对象映射模块相关接口
  - [x] 定义实体信息EntityInfo及初始化，用于给各个实体进行数据日志审计配置及数据权限设计
  - [x] 定义功能点信息Function及初始化，用于收集各个业务功能点（如MVC的Action），用于对功能进行缓存配置、操作日志审计、功能权限设计
  - [x] 定义Permissions权限模块的相关接口
  - [x] 实现框架依赖注入服务启动入口，调用各个功能模块（Pack）添加各模块的服务映射
  - [x] 实现ServiceLocator服务定位模式的依赖注入对象的解析
- [x] OSharp.EntityFrameworkCore
  - [x] 实现运行时上下文类型初始化及自动加载相关实体类型的功能
  - [x] 实现Repository仓储的数据存储功能
  - [x] 实现UnitOfWork的多上下文管理及同DbConnection的上下文事务同步
- [x] OSharp.AutoMapper
  - [x] 不同的映射类型，通过实现Profile来实现映射注册
  - [x] 实现通过遍历程序集，查找实现了IMapTuple接口的Profile来自动注册映射策略
  - [x] 定义MapToAttribute，MapFromAttribute类型，用以标注Mapping的Source与Target类型，使用时在要映射的类型上标注如[MapTo(typeof(TTarget))]或[MapFrom(typeof(TSource))]特性，框架初始化时自动查找相应的类型进行CreateMap映射注册
- [x] OSharp.AspNetCore
  - [x] AspNet
    - [x] 实现框架启动入口app.UseOSharp()，调用Pack模块管理器OSharpPackManager启动各个功能模块（OSharpPack）
    - [x] 实现基于当前请求的ServiceLocator的Scoped对象的解析
    - [x] 实现JSON请求的404处理中间件
    - [x] 实现JSON请求的异常信息到JSON操作结果与异常日志记录中间件
  - [x] MVC
    - [x] 添加Api专用控制器基类ApiController,AreaApiController
    - [x] 实现MVC功能点处理器
    - [x] 实现MVC业务模块处理器
    - [x] 实现基于MVC的功能权限AOP拦截验证
    - [x] 实现基于MVC的事务提交AOP拦截提交
  - [x] SignalR
    - [x] 定义客户端连接与用户信息的对应关系ConnectionUser
    - [x] 实现客户端连接与用户信息的缓存IConnectionUserCache
- [ ] OSharp.Permissions
  - [x] 身份认证Identity
    - [x] 用户添加昵称NickName属性，并添加默认验证器
    - [x] 重写UserStore，RoleStore，使用现有IRepository进行数据存储
  - [ ] 权限授权Security
    - [x] 功能权限
      - [x] 实现功能权限各个业务实体的数据存储
      - [x] 实现在系统初始化时，遍历反射程序集，自动初始化功能点、数据实体、业务模块等信息并持久化到数据库
      - [x] 实现系统初始化时，将功能点，数据实体，角色功能权限等信息缓存到内存中
      - [x] 实现角色-功能点，用户-功能点的功能权限验证
    - [ ] 数据权限
      - [ ] 实现角色-实体，用户-实体的数据权限配置
      - [ ] 实现角色-实体，用户-实体的数据权限过滤
  - [x] 系统System
    - [x] 实现键值对数据字典功能

码农公寓