OSharp Framework with .NETStandard2.0

OSharpNS简介
OSharpNS特性
快速开始
项目进度

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等上进行构建的快速开发框架。

框架组件组织

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.SqlServer【EFCore SqlServer 数据组件】：EFCore SqlServer数据访问组件，封装SqlServer的EntityFrameworkCore数据访问功能的实现
OSharp.Permissions【权限组件】：使用AspNetCore的Identity为基础实现身份认证的封装，以Security为基础实现以角色-功能、用户-功能的功能权限实现，以角色-数据，用户-数据的数据权限的封装

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一一对应，是功能权限的最小验证单位，基于功能点，可以配置：
- 功能访问类型（匿名访问、登录访问、限定角色访问）
- 功能的数据缓存时间及缓存过期方式（绝对过期、相对过期）
- 是否开启操作审计（XXX人员XXX时间做了XXX操作）
- 是否开启数据审计（操作引起的数据变化详情（新增、更新、删除））
数据实体EntityInfo与数据库中的各个数据实体一一对应，基于数据实体，可以配置：
- 是否开启数据审计，与Function上的同配置级别不同，如果指定实体未开放审计，则不审计当前实体。
- [未实现] 数据权限，基于角色 - 实体的数据权限设计，通过配置实现 XXX角色是否有权访问XXX实体数据（的XX属性）
设计了一个树形结构的业务模块体系（Module），对应着后端向前端开放的操作点（菜单/按钮），一个模块可由一个或多个功能点构成，模块是对外开放的特殊功能点，是进行角色/用户功能授权的单位。把一个模块授权给角色，角色即拥有了一个或多个功能点的操作权限。
功能权限授权流程
- [自动] 创建MVC的各个Area/Controller/Action的功能点Function信息，存储到数据库
- [自动] 创建树形模块Module信息，并创建模块与功能点（一个或多个）的分配关系，存储到数据库
- 将模块Module分配给角色Role
- 将角色Role分配给用户User
- 可将模块Module分配给用户User，解决特权问题
- 这样用户即可根据拥有的角色，自动拥有模块对应着的所有功能点的功能权限
功能权限验证流程
- 系统初始化时，根据每个角色Role分配到的模块Module，自动初始化每个 角色 Role - Function[] 的权限对应关系并缓存
- 游客进入系统时，自动请求所有可匿名访问FunctionAccessType.Anonymouse的模块信息并缓存到浏览器，浏览器根据这个缓存的模块集合，对前端页面的各个操作点（菜单/按钮）进行是否隐藏/禁用的状态控制
- 注册用户登录系统时，自动请求所有可执行（包括匿名的FunctionAccessType.Anonymouse、登录的FunctionAccessType.Logined、指定角色的FunctionAccessType.RoleLimit）的模块信息并缓存到浏览器，浏览器根据这个缓存的模块集合，对前端页面的各个操作点（菜单/按钮）进行是否隐藏/禁用的状态控制
- 用户User执行一个功能点Function时，验证流程如下：
  - 功能点不存在时，返回404
  - 功能点被锁定时，返回423
  - 功能点可访问性为匿名FunctionAccessType.Anonymouse验证通过
  - 功能点可访问性为需要登录FunctionAccessType.Logined时，用户未登录，返回401，已登录则验证通过
  - 功能点可访问性为需要登录FunctionAccessType.RoleLimit时，流程如下：
    - 用户未登录，返回401
    - 逐个验证用户拥有的角色Role，根据角色从缓存中取出Role-Function[]缓存项，Function[]包含要验证的功能点时，验证通过
    - 由分配给用户的模块Module对应的功能点，获取到User-Function[]（并缓存），Function[]包含要验证的功能点时，验证通过
    - 验证未通过，返回403
[未实现] 数据权限授权流程
[未实现] 数据权限验证流程

快速启动

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命令行窗口，执行命令

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

下载安装 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
    }
}

至此，项目启动完成，最终效果如下图所示：

## 项目开发进度

kimiburg/osharp-ns20