MyFramework 用法说明（二）：工程目录和启动流程

上一篇完成安装和初始化以后工程中会生成一套默认模板。这一篇主要说明这些目录分别放什么代码以及框架启动时从哪里开始执行。一、初始化后的主要目录初始化完成后重点关注Assets/Scripts下的几个目录Assets/Scripts ├── AutoGenerated │ ├── HybridCLRGenerate │ └── Obfuz ├── Game │ ├── Common │ ├── Game │ ├── GameScene │ └── UI └── HotFix ├── Common ├── Game ├── GameScene └── UI其中AutoGenerated 自动生成代码目录不建议手动改 Game 非热更业务层 HotFix 热更业务层Game和HotFix是最重要的两个目录。Game里的代码会直接参与主工程编译一般放启动流程、热更前资源更新、平台初始化等不能随便热更的逻辑。HotFix里的代码属于热更业务层项目主要玩法逻辑、主场景流程、热更 UI 注册等后续都应该优先放这里。二、几个程序集的关系模板里默认会生成Assets/Scripts/Game/Game.asmdef Assets/Scripts/HotFix/HotFix.asmdef Assets/Scripts/AutoGenerated/AutoGenerated.asmdef框架包内部还有Frame_Base Frame_Game Frame_HotFix可以简单理解成Frame_Base 框架最底层非热更 Frame_Game 框架非热更层 Game 项目非热更层 Frame_HotFix 框架热更层 HotFix 项目热更层 AutoGenerated 自动生成代码实际项目里建议遵守一个原则能放 HotFix 的业务逻辑就不要放 Game。Game层只保留启动、热更前资源更新、平台接入、热更入口等必要代码。三、启动入口GameEntry初始化时框架会把GameEntry脚本挂到启动场景的GameEntry节点上。默认代码很简单public class GameEntry : GameEntryBase { public override void Awake() { base.Awake(); Game framework new(); framework.init(); setFrameworkAOT(framework); } }这里做了三件事1. 调用 GameEntryBase.Awake() 2. 创建非热更框架 Game 3. 初始化 Game并设置为 AOT 框架实例GameEntryBase负责 Unity 生命周期转发比如Update FixedUpdate LateUpdate OnApplicationQuit也就是说真正每帧驱动框架的入口在GameEntryBase中。四、非热更入口GameGame是非热更部分的项目框架入口。默认代码核心是public class Game : GameFramework { public override void init() { mOnInitFrameSystem gameInitFrameSystem; mOnRegisteStuff gameRegiste; mOnPackageName () { return ANDROID_PLUGIN_BUNDLE_NAME; }; base.init(); if (!isEnableHotFix() || isEditor()) { mAssetVersionSystem.setAssetReadPath(ASSET_READ_PATH.STREAMING_ASSETS_ONLY); } else { mAssetVersionSystem.setAssetReadPath(ASSET_READ_PATH.SAME_TO_REMOTE); } mGameSceneManager.enterSceneLaunchScene(); } protected void gameInitFrameSystem(){} protected void gameRegiste() { LayoutRegister.registeAllLayout(); } }这里重点看几个位置。gameInitFrameSystem用来注册非热更层自己的框架系统。比如以后需要在热更前使用某些管理器可以放这里protected void gameInitFrameSystem() { // registeFrameSystemXXXManager((com) { mXXXManager com; }); }gameRegiste用来注册非热更层资源、布局等内容。默认会调用LayoutRegister.registeAllLayout();最后进入mGameSceneManager.enterSceneLaunchScene();也就是说非热更启动后第一个进入的是LaunchScene。五、LaunchScene热更前流程LaunchScene是非热更层的启动场景流程。默认代码public class LaunchScene : GameScene { public override void assignStartExitProcedure() { mStartProcedure typeof(LaunchSceneVersion); mExitProcedure typeof(LaunchSceneExit); } public override void createSceneProcedure() { addProcedureLaunchSceneVersion(); addProcedureLaunchSceneExit(); } }它有两个流程LaunchSceneVersion 启动热更流程 LaunchSceneExit 退出启动场景流程LaunchSceneVersion里默认调用public class LaunchSceneVersion : SceneProcedure { public override void init() { base.init(); HybridCLRSystem.launchHotFix(null, null, null); } }这里就是热更启动入口。编辑器下会直接从当前 AppDomain 中查找HotFix程序集。真机热更版则会加载热更 DLL然后启动GameHotFix。六、热更入口GameHotFix热更启动后框架会查找GameHotFix类型并创建热更实例。默认代码public class GameHotFix : GameHotFixBaseGameHotFix { protected override void registerAll() { LayoutRegisterHotFix.registeAll(); } protected override void initFrameSystem() { //registeFrameSystemNetManager((com) { mNetManager com; }); } protected override string getAndroidPluginBundleName() { return ANDROID_PLUGIN_BUNDLE_NAME; } protected override Type getStartGameSceneType() { return typeof(MainScene); } }这里有三个重点。registerAll用来注册热更层内容比如热更 UIprotected override void registerAll() { LayoutRegisterHotFix.registeAll(); }initFrameSystem用来注册热更层框架系统protected override void initFrameSystem() { // registeFrameSystemNetManager((com) { mNetManager com; }); }getStartGameSceneType决定热更启动完成后进入哪个场景protected override Type getStartGameSceneType() { return typeof(MainScene); }所以真正的业务主场景默认从MainScene开始。七、MainScene热更业务主场景模板中的MainScene结构如下public class MainScene : GameScene { public override void assignStartExitProcedure() { mStartProcedure typeof(MainSceneLoading); mExitProcedure typeof(MainSceneExit); } public override void createSceneProcedure() { addProcedure(typeof(MainSceneLoading)); addProcedure(typeof(MainSceneExit)); } }默认有两个流程MainSceneLoading 主场景加载流程 MainSceneExit 主场景退出流程MainSceneLoading目前是空实现public class MainSceneLoading : SceneProcedure { protected override void onInit(SceneProcedure lastProcedure) { } protected override void onExit(SceneProcedure nextProcedure) { } }实际项目可以从这里开始写主业务初始化比如public class MainSceneLoading : SceneProcedure { protected override void onInit(SceneProcedure lastProcedure) { base.onInit(lastProcedure); // 加载主界面 // 初始化玩家数据 // 进入主城流程 } }MainSceneExit中默认调用genericExit(0);一般用于卸载当前场景的布局和资源避免离开场景后还有资源残留。八、UI 注册入口非热更 UI 注册在Assets/Scripts/Game/UI/LayoutRegister.cs默认结构public class LayoutRegister { public static void registeAllLayout() { //registeLayoutUIDemo((script) { mUIDemo script; }); } }热更 UI 注册在Assets/Scripts/HotFix/UI/LayoutRegisterHotFix.cs默认结构public class LayoutRegisterHotFix { public static void registeAll() { // auto generate start // auto generate end } }后续使用 UI 代码生成器时热更 UI 的注册代码通常会写入auto generate区域。九、推荐修改位置刚接入框架时建议先只改这些文件Assets/Scripts/Game/Common/GameDefine.cs Assets/Scripts/Game/Game/Game.cs Assets/Scripts/HotFix/Game/GameHotFix.cs Assets/Scripts/HotFix/GameScene/MainScene/MainSceneLoading.cs Assets/Scripts/HotFix/UI/LayoutRegisterHotFix.cs大致分工如下GameDefine.cs 项目常量比如安卓插件包名 Game.cs 非热更层初始化 GameHotFix.cs 热更层初始化 MainSceneLoading.cs 主业务入口 LayoutRegisterHotFix.cs 热更 UI 注册不要一开始就去改框架包里的Runtime/Frame_*代码。如果只是正常开发项目优先在Game和HotFix目录中扩展。十、启动流程总结完整启动流程可以理解为start.unity ↓ GameEntry.Awake ↓ Game.init ↓ 进入 LaunchScene ↓ LaunchSceneVersion ↓ HybridCLRSystem.launchHotFix ↓ 创建 GameHotFix ↓ GameHotFix.start ↓ 进入 MainScene ↓ MainSceneLoading ↓ 项目主业务开始如果不启用热更编辑器下也会尽量走同一套入口只是不会从外部加载 DLL而是直接从当前工程中的程序集启动热更逻辑。这样做的好处是编辑器开发和真机运行的业务入口基本一致后续调试热更层代码会更方便。