chore:banner添加种子数据

This commit is contained in:
橙子
2023-12-15 23:44:35 +08:00
parent 5a546cbbd0
commit a03a7162dd
50 changed files with 1104 additions and 9357 deletions

View File

@@ -1,6 +1,6 @@
## 它是什么?
YiFramework是一个基于.Net8+Abp.vNext+后端开源框架
YiFramework是一个基于.Net8+Abp.vNext+SqlSugar的DDD领域驱动设计后端开源框架
中文名称:意框架
@@ -9,6 +9,11 @@ YiFramework是一个基于.Net8+Abp.vNext+的后端开源框架
但是,不仅仅是如此
## 它的理念
谁说Abp复杂谁说DDD难打破常规化繁为简新人入门项目二开最佳方式之一
> 一百个人就有一百种DDDYi框架不一定是极度严格的DDD而是站在巨人的肩膀上经过极多项目的提炼摸索出一种最佳实践
优雅的进行快速开发通常简单程度与优雅程度不可兼得Yi框架并不一昧的追求极致的解耦会站在用户使用角度上在使用难易度进行考虑衡量
> 一个面向用户的快速开发后端框架
@@ -17,37 +22,21 @@ YiFramework是一个基于.Net8+Abp.vNext+的后端开源框架
## 特点
- 面向用户的后端框架,使用简单,适合小型、中型、企业级项目
- 项目内置源码,不打包,方便二开
- 项目直接内置源码,不打包,非常适合进行二开改造
- 内置包含大量通用场景模块
- 等等
## 基础设施简介
- Jwt鉴权
- 接口级别授权
- 对象映射
- O/RM
- 数据过滤
- 多租户
- 逻辑删除
- 审计日志
- 种子数据
- 工作单元
- 模块化
- 动态Api
- 属性注入
- 自动依赖注入
- 当前用户
- 仓储
- Crud
以下全部功能可直接使用:
- [Abp.vNext官网](https://docs.abp.io/zh-Hans/abp/latest/)
- [SqlSugar官网](https://www.donet5.com/home/doc)
## 内置模块简介
- Rbac权限管理系统
- Bbs论坛社区系统
## 业务项目
- RABC后台管理系统
- BBS社区系统
> 重复的东西,无需再写一遍,这也是优雅的体现之一

View File

@@ -0,0 +1,30 @@
# 后端
C# Asp.NetCore 8.0
- [x] 动态ApiAbp.vNext
- [x] 鉴权授权Jwt
- [x] 日志Serilog
- [x] 模块化Abp.vNext
- [x] 依赖注入Autofac
- [x] 对象映射Mapster
- [x] ORM: SqlsugarCore
- [x] 多租户Abp.vNext
- [x] 后台任务Quartz.Net
- [x] 本地缓存Abp.vNext
- [x] 分布式缓存Abp.vNext
- [x] 事件总线Abp.vNext
# 前端
js Vue3.2
- [x] 异步请求axios
- [x] 图表echarts
- [x] uielement-plus
- [x] 存储pinia
- [x] 路由vue-router
- [x] 打包vite
# 运维
- [x] 部署nginx
- [x] CICDgitlab+Jenkins
- [x] Dockerharbor

View File

@@ -0,0 +1,46 @@
本项目为前后端分离项目,后端需要.Net8环境启动前端需Node.js环境启动
推荐下载开发工具:
- Visual Studio 2022
- Visual Studio Core
## 后端
vs选中启动项目Yi.Abp.Web模板项目
![Alt text](../image/web.png)
直接启动即可,无任何其他环境依赖,数据库默认采用`Sqlsite`,缓存默认采用`本地缓存`
启动后浏览器将会弹出项目接口地址swagger
![Alt text](../image/swagger.png)
> 纳尼?怎么就看到一个测试接口?莫急,由于模块化方式,接口会越来越多,已自动分组至右上角,请点击分组
恭喜你,已经成功运行后端,是不是很简单?
> 等等表结构呢表数据呢为什么没有sql文件在这里统统不需要配置文件默认开启CodeFirst可自动建库及表结构默认开启DataSeed种子数据自动创建初始化数据
## 前端
对于前端默认提供两个项目分别对应后端的BBS与RBAC
- BBS -> Yi.BBS.Vue3
- RBAC -> Yi.RuoYi.Vue3
可根据需要选择进行启动
1:还原依赖
> npm install
2:启动项目
> npm run dev
## 配置启动地址:
前端:
![Alt text](../image/feStart.png)
后端:
![Alt text](../image/start.png)

View File

@@ -0,0 +1,104 @@
好了,相信当你非常容易的启动了项目之后,并看到了页面效果,也感受到它的简易
废话少说,直接上图:
![Alt text](../image/code.png)
***感觉和传统的不太一样,怎么这么多类库,感觉很难上手***
NONONONONO!
恰恰相反其实对于使用用户来说我们只关注src中的Yi.Abp即可如下图
项目模板结构:
> 懂Abp.vNext的大佬看到目录就会有一股熟悉的味道
Yi框架并没有直接采用Abp.vNext的模板生成而是从零进行搭建起来的但其中的分层结构与Abp.vNext是一致的只是EntityFramework更换成了SqlSugar
总体来看分为以下3个部分
- Framework Yi.Framework框架部分,基础设施)
- ModuleYi.Framework提供的内置模块部分例如Rbac、Bbs
- Src (真正业务进行开发的部分)
很好换句话来说只需要关注Src部分其他的都以`源代码`的方式并没有进行打成nuget包1是为了方便二开2是为了方便大家学习3是本来也不复杂
现在,我们来好好见识下为何如此分层吧~
说到分层,不得不提这个经典神图
![Alt text](../image/fenceng.png)
这张图就对应着我们的结构
![Alt text](../image/jiegou.png)
这个可能没接触过DDD的不能理解为什么要这样分层三层架构不好吗?这样感觉好难,不能理解!且慢,待你看完下面每层的概述,你就不会认为简单,这不比三层架构简单?
首先Yi框架的分层非常明确命名属于严格类型对于初学者一眼看破
简单分为6个类库
1. 应用层
2. 应用抽象层
3. 领域层
4. 共享层
5. 基础设施Sqlsugar层
6. Web层
我们从下至上讲解:
## Doman.Shared 共享层
最底层是Doman.Shared共享层这里存放各个常量、枚举、不依赖各个模块的通用类
![Alt text](../image/domanShared.png)
> Doman.Shared共享层 是一层很简单、不包含业务的模块让它尽可能简单有没有感觉像三层架构的Common
## Domain 领域层
只依赖Doman.Shared的`Domain领域层`
![Alt text](../image/domain.png)
你可以选择存放大部分业务到领域层中,我们称这种模式叫做:`重领域层模式`
你也可以选择存放大部分业务到它的上一层Application 应用层,叫做:`重应用层模式`
在领域层中,你的实体,以及跟实体相关的设施可在这里
同时你也可以创建领域服务(Managers文件夹中),管理当前子领域的聚合,例如:
> 在学校模块中,包含了学生、教师、教室,为了更加聚合,可在学校模块中创建领域服务
## Application 应用层
接下来,是应用层
![Alt text](../image/application.png)
熟悉的Crud、熟悉的Service这里可以存放简单的通用业务例如Crud
如果是重应用层开发你完全可以将业务写入到应用层当一个快乐的三层架构CrudBoy
另外关于上次的Job任务调度、事件处理也可以放在这里进行处理
> 简单而优雅~何乐而不为?
## Application.Contracrs 抽象层
Application.Contracrs应用抽象模块是对应用模块的抽象它的结构也非常的简单
![Alt text](../image/contracrs.png)
这里有Dtos的概念不出意外大部分人已经接触具体的可以在后续Crud中进行讲解
## SqlSugarCore 数据访问层
![Alt text](../image/sqlsugar.png)
这一层中,依赖领域层,但是不依赖应用层
用于使用Sqlsugar相关的操作比如`自定义仓储`
但是,其实大部分通用场景,框架内部已经封装,能用到这层的机会都比较少
对复杂的数据访问封装
> 由于Querable对象用起来并没有到达SugarQuerable的爽感且也不想让每个复杂查询都通过仓储进行扩展这会导致用户使用感较差所以经过各类平衡考虑YiFramework框架与Sqlsugar是有轻量的`耦合性`的框架提供Sqlsugar抽象层避免过重的耦合意味着你可以在大部分地方使用Sqlsugar的操作这在真正的业务项目来说使用非常的方便与Sqlsugar保持有一致的观念
## Web 层
最后一个同样非常简单的一层
Web模块它的目的只是利用Asp.NetCore host Web主机将应用层的业务通过Webapi形式暴露出去而已
![Alt text](../image/webPro.png)
可以看的出,结构很简单,甚至除了启动配置目录,连其他一个额外的目录都没有
> 综上所述,我们的业务,我的开发代码,大部分都在`领域层`与`应用层`
光说不练源代码直接提供rbac、bbs两大模块结构是一致的直接看看依葫芦画瓢不就清楚啦~

View File

@@ -1,60 +0,0 @@
## 简介
通常在Asp.NetCore中**容器组装**过程 与 **管道模型组装** 过程 会将启动类文件变的非常长,同时也需要明确各个模块的依赖关系
例如:
我们需要仓储的功能但是仓储的实现需要依赖Sqlsugar
老的引入写法:
``` cs
service.AddUow();
service.AddSqlsugar();
......
var app=service.Build();
app.UseSqlsugar();
......
```
这个文件会变得非常长,同时如果有顺序依赖关系的模块,还需按顺序组装
例如:
在Asp.NetCore,我们只有先鉴权才能进行授权操作
当模块越来越多,我们维护起来将越来越困难,所以引入了模块化功能
## 使用
每一个类库都可以有自己的模块化文件,我们通常命名为类库全名+Module
例如:`Yi.Template.Application`的模块类叫做`YiTemplateApplicationModule`
另外,该模块类实现`AbpModule`基类
ConfigureServices:用来配置容器服务
OnApplicationInitialization用来配置管道模型
Abp内置`DependsOn`特性标签,可进行维护各个模块之间的依赖关系
## 完整例子
创建模块化文件:
``` cs
using Volo.Abp.Modularity;
using Yi.Abp.Domain;
using Yi.Abp.SqlSugarCore;
using Yi.Framework.Bbs.SqlSugarCore;
using Yi.Framework.Mapster;
using Yi.Framework.Rbac.SqlSugarCore;
using Yi.Framework.SqlSugarCore;
namespace Yi.Abp.SqlsugarCore
{
[DependsOn(
typeof(YiAbpDomainModule),
typeof(YiFrameworkRbacSqlSugarCoreModule),
typeof(YiFrameworkBbsSqlSugarCoreModule),
typeof(YiFrameworkMapsterModule),
typeof(YiFrameworkSqlSugarCoreModule)
)]
public class YiAbpSqlSugarCoreModule : AbpModule
{
public override void ConfigureServices(ServiceConfigurationContext context)
{
context.Services.AddYiDbContext<YiDbContext>();
}
}
}
```
在启动管道模型组装文件使用入口模块: