目录— 个文件
⌕
目录加载中…
…/core/base/EditorConfigScript.ts
1import { _decorator, Component, CCInteger } from 'cc';
2import { FrameworkEntry } from "../../FrameworkEntry";
3import { Framework } from "../../Framework";
4import { PackageFrameData } from "../../module/package/PackageFrameConfig";
5import { applyAyApiRuntimeFromPackage } from '../../module/sdk/AyApi/AyApiDefine';
6import { ProjectEnv, SdkChannel } from '../../module/sdk/SdkChannel';
7import { SdkConfig } from '../../module/sdk/SdkConfig';
8import { applyZsApiRuntimeFromPackage } from '../../module/sdk/zsApi/ZsApiDefine';
9import { LogManager } from "../log/LogManager";
10import { ResourceMode } from '../resource/ResourceFrameConfig';
11
12const { ccclass, property, executeInEditMode } = _decorator;
13
14/**
15 * 编辑器配置脚本 - 可在Canvas上挂载,用于修改全局配置
16 * 支持在编辑器模式下实时修改配置参数
17 */
18@ccclass('EditorConfigScript')
19@executeInEditMode // 允许在编辑器模式下执行
20class EditorConfigScript extends Component {
21 // SdkConfig.Channel配置
22 @property({
23 type: SdkChannel,
24 displayName: 'SDK渠道',
25 tooltip: '修改SdkConfig的Channel值'
26 })
27 // 组件构造早于入口注入;保留原 Inspector 初始选项,旧场景序列化值仍覆盖它。
28 private sdkChannel: SdkChannel = SdkChannel.Try;
29
30 // Framework.Res.Config.ResourceMode配置
31 @property({
32 type: ResourceMode,
33 displayName: '资源加载模式',
34 tooltip: '修改ResourceConfig的ResourceMode值'
35 })
36 // 组件构造早于入口注入;现有场景仍由序列化值覆盖。
37 private resourceMode: ResourceMode = ResourceMode.Remote;
38
39 // Framework.Res.Config.BundleVersion配置
40 // 字符串默认值已提供属性类型。
41 @property({
42 displayName: 'Bundle版本号',
43 tooltip: '修改ResourceConfig的BundleVersion值'
44 })
45 // 不在组件构造时读取运行态配置,显式空版本也不做兜底。
46 private bundleVersion: string = "";
47
48 // SdkConfig.Env 环境配置(测试/线上,影响 Config 与远程资源路径)
49 @property({
50 type: ProjectEnv,
51 displayName: '环境',
52 tooltip: '测试环境(Test) / 线上环境(Online),资源框架与 Config 按此选择远程路径'
53 })
54 // 仅为 Inspector 初始选项,不在组件构造时读取运行态 SDK 配置。
55 private projectEnv: ProjectEnv = ProjectEnv.Test;
56
57 // 当前选择的马甲包类型
58 @property({
59 type: CCInteger,
60 displayName: '马甲包类型',
61 tooltip: '选择要打包的马甲包,对应不同的 OSS 根路径与项目名'
62 })
63 // -1 表示新组件尚未选择,默认包由项目入口注入;旧场景数字值原样保留。
64 private packageType: number = -1;
65
66 onLoad() {
67 }
68
69 private GetEnableLogByProjectEnv(projectEnv: ProjectEnv): boolean {
70 if (projectEnv === ProjectEnv.Test) {
71 return true;
72 }
73 if (projectEnv === ProjectEnv.Online) {
74 return false;
75 }
76 throw new Error(`[EditorConfigScript] Unknown projectEnv: ${projectEnv}`);
77 }
78
79 // 同步配置到实际的Config对象
80 public SyncConfig() {
81 // 同步SDK渠道配置
82 SdkConfig.Channel = this.sdkChannel;
83 Framework.Log.Log(`SdkConfig.Channel已修改为: ${this.sdkChannel}`);
84
85 // 同步资源加载模式配置
86 Framework.Res.Config.ResourceMode = this.resourceMode;
87 Framework.Log.Log(`Framework.Res.Config.ResourceMode已修改为: ${this.resourceMode}`);
88
89 // 同步Bundle版本号配置
90 Framework.Res.Config.BundleVersion = this.bundleVersion;
91 Framework.Log.Log(`Framework.Res.Config.BundleVersion已修改为: ${this.bundleVersion}`);
92
93 // 同步环境配置
94 SdkConfig.Env = this.projectEnv;
95 Framework.Log.Log(`SdkConfig.Env已修改为: ${this.projectEnv === ProjectEnv.Online ? 'Online' : 'Test'}`);
96
97 // 日志开关由环境决定:Test 开启,Online 关闭。
98 const enableLog: boolean = this.GetEnableLogByProjectEnv(this.projectEnv);
99 LogManager.EnableLog = enableLog;
100 Framework.Log.Log(`LogManager.EnableLog已根据环境修改为: ${enableLog}`);
101
102 // 同步马甲包配置
103 if (this.packageType !== -1) {
104 Framework.Package.SetCurrentPackageType(this.packageType);
105 }
106 const pkg: PackageFrameData = Framework.Package.GetCurrentPackageData();
107 Framework.Log.Log(`马甲包切换为: ${this.packageType}`);
108 Framework.Res.Config.RemoteUrl = pkg.OSSRoot;
109 FrameworkEntry.ProjectName = pkg.ProjectName;
110
111 // 根据当前马甲包配置注入抖音 SDK / 广告位信息
112 const adCfg = Framework.Package.GetCurrentAdConfig();
113 SdkConfig.AppId = adCfg.appId;
114 SdkConfig.InterstitialId = adCfg.interstitialId || "";
115 SdkConfig.RewardVideoId = adCfg.rewardVideoId || "";
116 SdkConfig.HksXtAppId = pkg.hksXtAppId || "";
117 SdkConfig.GravityAppId = pkg.gravity?.appId || "";
118 SdkConfig.GravityPackageName = pkg.gravity?.packageName || "";
119 SdkConfig.GravityAppKey = pkg.gravity?.appKey || "";
120 SdkConfig.GravityAccessToken = pkg.gravity?.accessToken || "";
121 SdkConfig.UmengAppKey = pkg.umeng?.appKey || "";
122 for (const timerId of adCfg.jdrewardVideoAdTimerIds || []) {
123 SdkConfig.JDRewardVideoAdUnits.push({ advTimerId: timerId, linkId: adCfg.jdrewardVideoLinkId || "" });
124 }
125
126 Framework.Log.Log(
127 `SdkConfig 已根据马甲包注入广告配置: appId=${SdkConfig.AppId}, inter=${SdkConfig.InterstitialId}, reward=${SdkConfig.RewardVideoId}`
128 );
129
130 // 根据当前马甲包配置注入 dn sdk 接入参数
131 const dnSdkParam = adCfg.wx_sdk_dn;
132 if (dnSdkParam) {
133 SdkConfig.DnSdkConfig = dnSdkParam;
134 }
135
136 applyZsApiRuntimeFromPackage(pkg, SdkConfig.AppId);
137 applyAyApiRuntimeFromPackage(pkg, SdkConfig.AppId);
138
139 }
140}
141
142export default EditorConfigScript;
讲解143 行
编辑器配置注入脚本人工通读
EditorConfigScript.ts
挂在场景节点上,把 Inspector 选定的 SDK 渠道、资源模式、Bundle 版本、环境和马甲包写进运行时全局配置。它不在 onLoad 里同步,写入发生在入口调用 SyncConfig 那一刻,是编辑器配置覆盖运行配置的唯一入口。
先看五个 property 字段与默认值注释,再按顺序读 SyncConfig 的五段:渠道、资源、环境与日志、马甲包、三方 SDK 参数,最后看 GetEnableLogByProjectEnv 的抛错分支。
特殊处理与易错点
- 单例/静态状态字段默认值只是 Inspector 的初始选项,组件构造早于入口注入,旧场景的序列化值会覆盖默认值;不能靠默认值反推实际生效的配置。L28
- 初始化顺序依赖onLoad 是空实现,不参与同步;配置覆盖完全依赖外部调用 SyncConfig,漏调会静默沿用旧配置。L66
- 特殊处理日志开关由环境字段推导,Test 强制开启、Online 强制关闭,出现其它值直接抛错阻断启动。L98
- 特殊处理packageType 为 -1 时不调用 SetCurrentPackageType,沿用入口已经注入的默认马甲包,只继续读取当前包数据。L103
- 易错点京东激励视频广告位用 push 往 SdkConfig.JDRewardVideoAdUnits 追加,同步前没有清空数组,SyncConfig 被重复调用会累积出重复广告位。L122
- 设计ZsApi 与 AyApi 的运行参数不在脚本里硬编码,而是由当前马甲包数据和已确定的 AppId 现场推导。L136
1注释EditorConfigScript:编辑器配置脚本 - 可在Canvas上挂载,用于修改全局配置 支持在编辑器模式下实时修改配置
18注释编辑器配置脚本 - 可在Canvas上挂载,用于修改全局配置 支持在编辑器模式下实时修改配置参数
22注释SdkConfig.Channel配置
28属性Inspector 选择的 SDK 渠道,SyncConfig 时写入 SdkConfig.Channel。
31注释Framework.Res.Config.ResourceMode配置
37属性资源加载模式,SyncConfig 时写入 Framework.Res.Config.ResourceMode,
41注释Framework.Res.Config.BundleVersion配置 字符串默认值已提供属性类型。
46属性Bundle 版本号,默认空串且不做兜底,原样写入 ResourceConfig.BundleVersion。
49注释SdkConfig.Env 环境配置(测试/线上,影响 Config 与远程资源路径)
55属性测试或线上环境,同时决定 SdkConfig.Env 与 LogManager.EnableLog。
58注释当前选择的马甲包类型
64属性马甲包序号,-1 表示新组件尚未选择,此时不切换只沿用当前包。
66方法空方法,不读取字段也不同步配置,真正写入全局配置要等外部显式调用 SyncConfig。
69方法按环境枚举返回日志开关,Test 返回 true,Online 返回 false,其它值抛异常阻断。
80方法把五个字段写入渠道、资源、环境、日志开关和马甲包,再按当前包注入广告与三方 SDK 参数。
82注释同步SDK渠道配置
86注释同步资源加载模式配置
90注释同步Bundle版本号配置
94注释同步环境配置
98注释日志开关由环境决定:Test 开启,Online 关闭。
103注释同步马甲包配置
112注释根据当前马甲包配置注入抖音 SDK / 广告位信息
131注释根据当前马甲包配置注入 dn sdk 接入参数