第一章 Net 5.0 快速开发框架 YC.Boilerplate--框架介绍
YC.Boilerplate 框架介绍
YC.Boilerplate 是一套快速开发框架,采用当下流行的前后端分离开发模式,前端 采用VUE、后端采用Net 5.0;框架实现了 多租户、动态webApi、多种ORM、IOC、数据库表和业务代码生成等等一系列模块,并开发了用户管理、角色权限、组织机构、 数据字典、审计日志等常规功能,前后端代码一键生成。
框架的宗旨:构建一套松耦合、灵活组合、功能齐全、开发便捷、减少开发工作量的样板化开发框架。
在线文档:http://doc.yc-l.com/#/README
在线演示地址:http://yc.yc-l.com/#/login
源码github:https://github.com/yc-l/yc.boilerplate
源码gitee:https://gitee.com/yc-power/yc.boilerplate
元磁之力框架技术群QQ:1060819005
视频教程:
元磁之力框架开源初心和框架设计介绍(上): https://www.bilibili.com/video/BV1VM4y1G7hC/
元磁之力框架开源初心和框架设计介绍(下): https://www.bilibili.com/video/BV15h411s7w6/
元磁之力框架数据库表和代码生成使用教程实战: https://www.bilibili.com/video/BV1oM4y137D5/
后续:关于框架demo和细节技巧,会在QQ群中发布,就不撰文说明。
框架技术栈和开发模式
- 开发模式:当下流行的前后端分离。
- 前端:vue、elementUI等技术栈,为单页面应用程序提供了项目模板。
- 后端采用NET 5.0。
框架特点
- 模块化开发,灵活组合,将解耦进行到底,按需注入使用。
- 当下流行的开发模式,分层明确。
- 配合框架自带代码生成器快速完成CRUD和树形等复杂功能逻辑实现,不敲一行代码,节省60%工作量。
框架分层介绍
- 核心层:
YC.Core
主要实现顶层设计类接口规范和一些类的封装,比如:租户接口、AopInterceptor AOP 拦截注入、TokenContext token逻辑、公共特性等等。 - 数据层:
YC.DapperFrameWork
、YC.FreeSqlFrameWork
多项ORM 封装,主要存在仓储、工作单元等。 - 公共层:
YC.Common
主要是各种公共类的使用。 - 业务服务层:
YC.ApplicationService
业务逻辑实现,默认实现动态webapi。 - 实体层:
YC..Model
常规的数据表实体,枚举等,以及常规的model需要用的基础方法。 - 业务Api层:
YC.ServiceWebApi
提供对外接口服务启动项目。
模块层(按需使用)
- 数据库表和代码生成模块:
YC.CodeGenerate
- Redis 缓存模块:
YC.Cache.Redis
- 动态WebApi模块:
YC.Core.DynamicApi
- 日志模块:
YC.Log.Serilog
- 定时服务
Quartz.net YC.QuartzService
- Mongodb 模块
YC.MongoDB
- 图数据库Neo4j
YC.Neo4j
单元测试
微软自带单元测试:UnitTestProject
数据库表和代码生成测试:YC.CodeGenerateTest
其他各个模块配套的单元测试:YC.QuartzTest
、YC.MongoDbXUnitTest
、YC.Neo4jXUnitTest
框架功能模块
框架特性
- 基于最新的.NET技术 NET 5.0。
- 实现领域驱动设计(实体、仓储、领域服务、领域事件、应用服务、数据传输对象,工作单元等等)。
- 实现分层体系结构(领域层,应用层,展现层和基础设施层)。
- 提供了一个基础架构来开发可重用可配置的模块。
- 集成一些最流行的开源框架/库,也许有些是你正在使用的。
- 提供了一个基础架构让我们很方便地使用依赖注入(使用Autofac作为依赖注入的容器)。
- 提供Repository仓储模式支持不同的ORM(已实现dapperFramework 、freesqlFrameWork、Redis等)。
- 支持并实现数据库迁移(采用自由映射Table )。
- 模块化开发(每个模块有独立的采用autofac模块注入形式,根据不同业务可以动态切换指定数据库)。
- 统一的异常处理(应用层几乎不需要处理自己写异常处理代码)。
- 通过Application Services自动创建Web Api层(不需要写ApiController层了)。
- 提供基类和帮助类让我们方便地实现一些常见的任务。
- 使用“约定优于配置原则”。
- 实现多租户,按照不同的租户分库服务端。
- 实现了基于表模型生成对应的全流程代码,包括:model、DTO、Service、前端展示界面(常规CRUD和树形功能)、路由规则、Mapper model和Dto映射等代码。
- 框架已经实现常规基础功能,如:身份验证用户&角色管理、系统设置、存取管理(系统级、租户级、用户级,作用范围自动管理)、审计日志(自动记录每一次接口的调用者和参数)、组织机构等,实现框架开箱即用。
- 框架采用redis 作为cache和session 存储,脱离cookie 使用,解决非web的等也可以使用框架进行多样的场景需求改造。