diff --git a/README.md b/README.md index 3df542a9..c2d282df 100644 --- a/README.md +++ b/README.md @@ -1,43 +1,79 @@ -

Yi意框架-一个紧跟时代的开源框架

-

Yi.Framework-基于.NET5+Vue快速开发框架

+ + +

Yi框架-一个紧跟时代的.NetCore开源框架

+

基于.NET5+Vue快速开发框架

意义为了开发更简易

-#### 简介 +[English](README-en.md) | 简体中文 + +[![sdk](https://img.shields.io/badge/sdk-5.0.1-d.svg)](#) [![License MIT](https://img.shields.io/badge/license-Apache-blue.svg?style=flat-square)](https://github.com/ccnetcore/Yi/master/LICENSE) [![star this repo](https://githubbadges.com/star.svg?user=ccnetcore&repo=Yi&style=flat-square)](https://github.com/ccnetcore/Yi)[![fork this repo](https://githubbadges.com/fork.svg?user=ccnetcore&repo=Yi&style=flat-square)](https://github.com/ccnetcore/Yi/fork) +**** +#### 简介: +**中文：意框架** **CC.Yi.Old**：.Net5早期三层单体架构（已被CC.Yi取代） **CC.Yi**:.Net5经典三层WebApi单体应用架构 -**CC.Yi.Framework**:.Net5DDD领域驱动设计分层微服务架构（正在更新） +**Yi.Framework**:.Net5DDD领域驱动设计分层微服务架构（正在更新） -**CC.Yi.Vue**：Vue2.0配合CC.Yi.Framework使用前端项目（正在更新） +**Yi.Vue**：Vue2.0配合CC.Yi.Framework使用前端项目（正在更新） -#### 支持 +**** +#### 支持: -- 完全支持单体应用架构 -- 完全支持分布式应用架构 -- 完全支持微服务架构 +- [x] 完全支持单体应用架构 +- [x] 完全支持分布式应用架构 +- [x] 完全支持微服务架构 -#### 软件架构 -架构：后端.NET5(.NetCore 5)、前端Vue（2.0） +**** +#### 软件架构: -支持的关系型数据库：mysql、sql server、sqlite、oracle +**架构**：后端.NET5(.NetCore 5)、前端Vue（2.0） -操作系统：Windows、Linux +**关系型数据库**：mysql、sql server、sqlite、oracle -身份验证：Identity、JWT、IdentityServer +**操作系统**：Windows、Linux -组件：EFcore、Autofac、Castle、Swagger、Log4Net、Redis、RabbitMq、ES、Quartz.net +**身份验证**：Identity、JWT、IdentityServer4 -微服务：Consul、Ocelot、IdentityService、Apollo、Docker、Jenkins、Nginx、K8s、ELK、Polly +**组件**：EFcore、Autofac、Castle、Swagger、Log4Net、Redis、RabbitMq、ES、Quartz.net、T4 -封装：Json处理模块，滑动验证码模块，base64图片处理模块，异常捕捉模块、邮件处理模块、linq封装模块、随机数模块、统一接口模块、基于策略的jwt验证、过滤器、数据库连接、跨域、初始化种子数据、Base32、Console输出、日期处理、文件传输、html筛选、http请求、ip过滤、md5加密、Rsa加密、序列化、雪花算法、字符串处理、编码处理、地址处理、xml处理、心跳检查 +**微服务**：Consul、Ocelot、IdentityService、Apollo、Docker、Jenkins、Nginx、K8s、ELK、Polly -#### 功能模块 +**封装**：Json处理模块，滑动验证码模块，base64图片处理模块，异常捕捉模块、邮件处理模块、linq封装模块、随机数模块、统一接口模块、基于策略的jwt验证、过滤器、数据库连接、跨域、初始化种子数据、Base32、Console输出、日期处理、文件传输、html筛选、http请求、ip过滤、md5加密、Rsa加密、序列化、雪花算法、字符串处理、编码处理、地址处理、xml处理、心跳检查 -太多了等待更新 +**** +#### 支持模块: -#### 目录结构 +- [x] 支持`DDD领域驱动设计`进行分层，支持微服务扩展 +- [x] 支持采用`异步`开发awit/async +- [x] 支持数据库主从`读写分离` +- [x] 支持功能替换，无需改动代码，只需配置`json文件`进行装配即可 +- [x] 支持采用DbFirst开发方式，使用`T4模板代码生成器`，自动映射模型一键生成Service及IService所有代码 +- [x] 支持`用户-角色-菜单-接口`以及vue2.0前端全部逻辑代码，下载无需修改直接使用 +- [x] 支持`Aop封装`，FilterAop、IocAop、LogAop +- [x] 支持`Log4Net日志`记录，自动生成至bin目录下的logs文件夹 +- [x] 支持`DbSeed数据库种子数据`接入，默认创建admin用户，密码123 +- [x] 支持主流`数据库随意切换`，Mysql/Sqlite/Sqlserver/Oracle +- [x] 支持微软官方`EFcore ORM` +- [x] 支持`SwaggerWebAPI`，jwt身份认证接入 +- [x] 支持`Cors`跨域 +- [x] 支持`AutoFac`自动映射依赖注入 +- [x] 支持`consul`健康检查 +- [x] 支持`RabbitMQ`消息队列 +- [x] 支持`Redis`多级缓存 +- [x] 支持Ocelot`网关，路由、服务聚合、服务发现、认证、鉴权、限流、熔断、缓存、Header头传递 +- [x] 支持`Apollo`全局配置中心; +- [x] 支持`docker`镜像制作 +- [x] 支持页面`静态化处理`，将动态页面生成静态页面 +- [ ] 支持ELK +- [ ] 支持IdentityService4` +- [ ] 支持Es分词查询 +- [ ] 支持微信支付 +- [ ] 支持Quartz.net任务调度，实现任意接口被调度 +**** +#### 目录结构: ![图片](https://user-images.githubusercontent.com/68722157/138565689-ac6e2489-4b8f-47fd-93c1-47f26d453779.png) @@ -49,24 +85,52 @@ - Infrastructure：实例层 - MicroServiceInstance：服务层 -#### 安装教程 +**** +#### 安装教程: 我们将在之后更新教程手册！ 1. 下载全部源码，默认使用sqlite数据库，已经生成 2. 使用Visual Studio 2019在windows环境中打开CC.Yi.sln文件即可 -#### 使用说明 +**** +#### 使用说明: -我们将在之后更新教程手册！ +我们将使用说明转移至我们的官方论坛中，正在制作中，尽情期待！ +**** +#### 感谢人员： + +**国内.Net行业领头人中鼎鼎有名的微软MVP**： Eleven神、哲学的老张 + +**核心开发人员**： + +[橙子]https://github.com/ccnetcore + +[lzw]https://github.com/yeslode + +[其他]https://github.com + +**** #### 联系我们： QQ：454313500 -#### FQA +**** +#### FQA: -问：你好 +问1：为何不采用经典的三层架构？ -答：你好 +答1：EFcoreORM已经非常强大，已经完全可以充当数据处理层，另一个原因，在简单与复杂，我们选择了简单 +问2：这个框架的一切都是原创的吗？ + +答2：并不是，我们在初期是参考过非常非常多的其他框架，但我们可以保证，基本上绝大部分都是原创。 + +问3：以后会持续更新下去吗？ + +答3：一定会的，我们的标题是 一个紧跟时代的.Netcore开源框架 ，如果有我们比较感兴趣的技术，我们一定会加入进来，例如：.Net6 。 + +问4：这个框架的针对人群是哪些人？适合所有人吗？ + +答4：并不是适合所有人，应该算适合需要有一定基础的开发人员，当然，如果你是大神，你完全可以将这个框架改进！