Cocos Creator MVVM 工具集使用教程

1. 项目目录结构及介绍

cocos_creator_mvvm_tools/
├── assets/
│   └── Script/
│       └── modelView/
│           ├── JsonOb.ts
│           ├── ViewModel.ts
│           ├── VMBase.ts
│           └── VMParent.ts
├── docs/
│   ├── README.md
│   └── VMState.md
├── settings/
│   ├── gitignore
│   ├── LICENSE
│   ├── README.md
│   ├── creator.d.ts
│   ├── jsconfig.json
│   └── project.json
└── README.md

目录结构说明

• assets/Script/modelView/: 核心脚本文件存放路径，包含实现 MVVM 模式的关键组件。

  • JsonOb.ts: 实现基础的观察者模式，改变绑定的数据会自动调用回调函数。
  • ViewModel.ts: VM 的核心模块，动态管理 ViewModel，使用 cc.director.emit 通知游戏内的节点组件改变状态。
  • VMBase.ts: VM 监听核心组件，用于接收 ViewModel 的数值变动消息，衍生组件如 VMCustom 和 VMEvent 继承自此组件。
  • VMParent.ts: VM 父组件，适合 prefab 弹窗使用，将数据绑定在继承 VMParent 的组件上。

• docs/: 项目文档存放路径，包含项目的使用说明和详细文档。

  • README.md: 项目的基本介绍和使用说明。
  • VMState.md: 关于 VM 状态的详细说明文档。

• settings/: 项目配置文件存放路径。

  • gitignore: Git 忽略文件配置。
  • LICENSE: 项目许可证文件。
  • README.md: 项目的 README 文件。
  • creator.d.ts: Cocos Creator 的 TypeScript 定义文件。
  • jsconfig.json: JavaScript 配置文件。
  • project.json: Cocos Creator 项目配置文件。

2. 项目启动文件介绍

项目的启动文件主要是 assets/Script/modelView/ 目录下的核心脚本文件。这些文件实现了 MVVM 模式的关键功能，包括数据绑定、视图更新等。

关键启动文件

• JsonOb.ts: 实现基础的观察者模式，用于监听数据变化并自动调用回调函数。
• ViewModel.ts: VM 的核心模块，负责管理 ViewModel 并通知节点组件更新状态。
• VMBase.ts: VM 监听核心组件，用于接收 ViewModel 的数值变动消息。
• VMParent.ts: VM 父组件，适合 prefab 弹窗使用，将数据绑定在继承 VMParent 的组件上。

3. 项目配置文件介绍

项目的配置文件主要存放在 settings/ 目录下，这些文件用于配置项目的各种设置。

关键配置文件

• gitignore: Git 忽略文件配置，指定哪些文件或目录不需要被 Git 管理。
• LICENSE: 项目许可证文件，说明项目的开源许可证类型。
• README.md: 项目的 README 文件，包含项目的基本介绍和使用说明。
• creator.d.ts: Cocos Creator 的 TypeScript 定义文件，用于 TypeScript 类型检查。
• jsconfig.json: JavaScript 配置文件，用于配置 JavaScript 项目的编译选项。
• project.json: Cocos Creator 项目配置文件，包含项目的各种设置，如场景、资源路径等。

通过以上配置文件和启动文件，开发者可以快速了解和使用 cocos_creator_mvvm_tools 项目，实现高效的 MVVM 模式开发。