liangxiegame /QFramework

Godot/Unity3D System Design Architecture

★ 5,610⑂ 871👁 155⑃ 33● 126▤ 71
C#MITCreated 2016-02-05qframework.cn
Download: v1.0.187 Unity2018Compatiblev1.0.246-Unity2018Compatible ↓v1.0.246-Unity2018Compatible2026-05-27
+7
Daily
5,610
stars
871
forks
155
watchers
33
prs
126
issues
71
releases

README

!LOGO





 QFramework 简介 Intro

中文|English

QFramework 是提供一套简单、强大、易上手、符合 SOLID 原则、支持领域驱动设计(DDD)、事件驱动、数据驱动、分层、MVC 、CQRS、模块化、易扩展的架构,她的源码只有不到 1000 行,你可以完全把她放在你的笔记应用里保存。

 提供的架构图

!image.png

 举个例子(一图胜千言😂)

!

 各种情况的示意图

!image-20260124142617406

 架构使用规范

QFramework系统设计架构分为四层及其规则:

 表现层:ViewController层。IController接口,负责接收输入和状态变化时的表现,一般情况下,MonoBehaviour 均为表现层
     可以获取System
     可以获取Model
     可以发送Command
     可以监听Event
 系统层:System层。ISystem接口,帮助IController承担一部分逻辑,在多个表现层共享的逻辑,比如计时系统、商城系统、成就系统等
     可以获取System
     可以获取Model
     可以监听Event
     可以发送Event
 数据层:Model层。IModel接口,负责数据的定义、数据的增删查改方法的提供
     可以获取Utility
     可以发送Event
 工具层:Utility层。IUtility接口,负责提供基础设施,比如存储方法、序列化方法、网络连接方法、蓝牙方法、SDK、框架继承等。啥都干不了,可以集成第三方库,或者封装API
 除了四个层级,还有一个核心概念——Command
     可以获取System
     可以获取Model
     可以发送Event
     可以发送Command
 层级规则:
     IController 更改 ISystem、IModel 的状态必须用Command
     ISystem、IModel状态发生变更后通知IController必须用事件或BindableProperty
     IController可以获取ISystem、IModel对象来进行数据查询
     ICommand不能有状态
     上层可以直接获取下层,下层不能获取上层对象
     下层向上层通信用事件
     上层向下层通信用方法调用(只是做查询,状态变更用Command),IController的交互逻辑为特别情况,只能用Command

(照抄自:学生课堂笔记1)

 运行环境

 Unity 2018.4.x ~ Unity 6.x

 安装

 QFramework.cs 
     直接复制此代码到自己项目中的任意脚本中
 QFramework.cs 与 官方示例
     点此下载 unitypackage

 QFramework.ToolKits
     点此下载 unitypackage
 QFramework.ToolKitsPro
     从 AssetStore 安装



 资源

| 版本 |                                      |                                                          |
| ----------------------  | ---------------------------------------- | ------------------------------------------------------------ |
| QFramework.cs | QFramework 本体架构的实现 | 文件 |
| QFramework.cs  示例 | QFramework.cs 与官方示例: CounterApp、《点点点》、FlappyBird、CubeMaster、ShootingEditor2D、贪吃蛇等 | 点此下载 unitypackage |
| QFramework.Toolkits | QFramework  集成 CoreKit/UIKit/ActionKit/ResKit/PackageKit/AudioKit 等全部官方工具(已包含 QFramework.cs 和 示例) | 点此下载 unitypackage |
| QFramework.Toolkits.Demo.WuZiQi | 使用 QFramework.Toolkits 开发的五子棋 Demo(需要安装好  QFramework.Toolkits) | 点此下载 unitypackage |
| QFramework.Toolkits.Demo.Saolei | 使用 QFramework.Toolkits 开发的扫雷 Demo(需要安装好  QFramework.Toolkits) | 点此下载 unitypackage |
| QFramework.ToolKitsPro | 在 ToolKits 基础上集成更多好用的工具的版本(已包含 QFramework.Toolkits) | AssetStore |
| 群友案例 |  |  |
| 赛车游戏《Crazy Car》 | 群友 TastSong 使用 QF 进行重构的开源赛车游戏 | 游戏主页(Github) |
| 社区 |  |  |
| QQ 群:623597263 | 交流群 | 点击加群 |
| 腾讯频道 | 中文社区 | 点击加入频道 |
| Discord | 英文社区 | 点击加入频道 |
| 教程 |  |  |
| 《框架搭建 决定版》    | 教程 QFramework  的核心架构是怎么演化过来的? | 课程主页\|学生课堂笔记1\|学生课堂笔记2 |
| 产品案例 | 如果用了 qf 并且想要在如下列表中登记,可以在 github/gitee 的 issue 里发帖子,也可以加 qq 群,也可以用邮箱联系凉鞋 [email protected],当然如果看到使用 qf 的项目,我也会先去尝试征得同意再放到如下列表。 |  |
| 精选置顶 |  | |
| ! | 独立游戏《盒子面包坊》 | TapTap \| Steam |
| !img | 独立游戏《观鸟笔记》 | Steam |
| ! | 独立游戏《乌合之众》 | Steam |
| 按登记时间 |  | |
| ! | 独立游戏《三国掷:崛起》 | Steam |
| ! | 独立游戏《银河摸鱼人》 | Steam |
| ! | 独立游戏《ScaleBox》 | Steam |
| ! | 独立游戏《我的玫瑰》 | Steam |
| ! | 独立游戏《蚀界档案》 | TapTap \|Steam |
| ! | 独立游戏《X-teriods》 | Steam |
| ! | 独立游戏《你好茄子:精灵的诞生》 | Steam |
| ! | 独立游戏《当火车鸣

Top issues

Latest release

v1.0.187 Unity2018Compatible v1.0.246-Unity2018Compatible 2026-05-27
【CN】变更日志
 修复(Unity):打开包工具面板时避免DX12崩溃(感谢 SoGameStudio 的 PR)
 内置文档: 引入 System.md 使用新版概念交互图&错别字修复
 内置文档:引入 Utility.md 删掉没用的代码
 内置文档:04. 引入 Event 错别字修复
 内置文档:Roadmap 部分更新 
 内置文档:引入 Command.md 错别字修复
 修复文件名在 windows 不合法的问题
 内置文档: 新增 架构篇 21. 什么是需要共享的数据?
 内置文档: 01. 架构简介 使用新版概念交互参考图
 文档: QFramework 架构简介修改,补充新增特性描述
 文档:01.简介 删除掉失效的链接&增加年会员链接
 BuildKit: 打包 Windows 包帮助函数增加 zipFileBaseName 参数
 BuildKit: 帮助函数增加 BuildWebGL 的 API
 BuildKit: 默认构建 Windows 的帮助函数改进
 AudioKit: 增加 PlaySoundByClip 示例
 AudioKit: 增加 PlayMusicByClip 示例
 AudioKit:增加 PlayResKitABSound 示例 
 AudioKit:代码审核全部完成 
 AudioKit:

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON