tencentcloud-webar 1.0.29-2 → 1.0.29-3

package/doc/EventBus /345/256/236/344/276/213/347/272/247/346/224/271/351/200/240/346/214/207/345/215/227.md"

@@ -0,0 +1,177 @@
+# EventBus 实例级改造指南
+
+## 核心思路
+
+每个SDK实例创建自己的EventBus实例，通过构造函数参数传递给需要的模块。
+
+## 已完成的改造
+
+### 1. SDK主文件 (`src/h5/index.ts`)
+
+```typescript
+export class ArSdk extends AuthedWrap implements ARSdkInterface {
+  // 实例级EventBus
+  private instanceEventBus: EventObj;
+  
+  constructor(config: Config) {
+    super(auth, domain, initReport, reportRegion, language);
+    
+    // 创建实例级EventBus
+    this.instanceEventBus = new EventObj();
+    
+    // 传递给ArMainImpl
+    this.core = new ArMainImpl(this.input_type, resizeCallback, this.instanceEventBus);
+  }
+  
+  private _bindEvent() {
+    // 使用实例级EventBus
+    const EventBus = this.instanceEventBus;
+    EventBus.on("error", (data) => { ... });
+    // ... 其他事件监听
+  }
+}
+```
+
+### 2. ArMainImpl (`src/h5/impls/MainImpl.ts`)
+
+```typescript
+export class ArMainImpl extends ArBase {
+  // 实例级EventBus
+  private eventBus: EventObj;
+  
+  constructor(
+    type: EntryType, 
+    resizeCallback: (...args: any) => any,
+    eventBus?: EventObj  // 接收实例级EventBus
+  ) {
+    super();
+    // 保存实例级EventBus，如果没传则使用全局EventBus（向后兼容）
+    this.eventBus = eventBus || EventBus;
+    
+    // 使用实例EventBus
+    this.eventBus.trigger("error", { ... });
+  }
+}
+```
+
+## 待改造的文件
+
+以下文件需要接收EventBus参数并使用实例级EventBus：
+
+### 高优先级（核心模块）
+
+1. **`src/h5/input/Camera.ts`** - CameraInput类
+   - 构造函数添加 `eventBus?: EventObj` 参数
+   - 替换所有 `EventBus.trigger(...)` 为 `this.eventBus.trigger(...)`
+   - 约15+处需要修改
+
+2. **`src/h5/detector/DetectorWorker.ts`** - DetectorWorker类
+   - 构造函数添加 `eventBus?: EventObj` 参数
+   - 替换约4处EventBus调用
+
+3. **`src/h5/detector/DetectorBase.ts`** - DetectorBase类
+   - 构造函数添加 `eventBus?: EventObj` 参数
+   - 替换EventBus调用
+
+4. **`src/h5/utils.ts`** - 工具函数
+   - 需要将eventBus作为参数传入相关函数
+   - 约5处需要修改
+
+### 中优先级
+
+5. **`src/auth/index.ts`** - Auth类
+   - 约6处EventBus调用
+
+6. **`src/core/renderer/Effect.ts`** - Effect类
+   - 渲染相关事件触发
+
+7. **`src/core/loaders/EncLoader.ts`** - 加载器
+   - 加载事件触发
+
+## 改造步骤（针对每个文件）
+
+### 步骤1: 添加eventBus属性
+
+```typescript
+export class YourClass {
+  private eventBus: EventObj;
+  
+  constructor(...existingParams, eventBus?: EventObj) {
+    // 保存实例级EventBus，如果没传则使用全局EventBus（向后兼容）
+    this.eventBus = eventBus || EventBus;
+  }
+}
+```
+
+### 步骤2: 替换EventBus调用
+
+**查找：**
+```typescript
+EventBus.trigger("eventName", data);
+EventBus.on("eventName", callback);
+```
+
+**替换为：**
+```typescript
+this.eventBus.trigger("eventName", data);
+this.eventBus.on("eventName", callback);
+```
+
+### 步骤3: 传递eventBus给子模块
+
+如果该类创建了其他需要EventBus的子模块：
+
+```typescript
+// 创建子模块时传递eventBus
+this.subModule = new SubModule(...params, this.eventBus);
+```
+
+## 注意事项
+
+1. **向后兼容**：所有eventBus参数都设为可选 `eventBus?: EventObj`，默认使用全局EventBus
+2. **不要删除全局EventBus**：保留 `import { EventBus } from "src/utils/event"` 作为fallback
+3. **逐步迁移**：可以一个文件一个文件地改，不影响其他模块
+4. **测试验证**：每改完一个模块，测试该模块功能是否正常
+
+## 示例：改造Camera.ts
+
+```typescript
+// 改造前
+export class CameraInput {
+  constructor(config: CameraConfig) {
+    // ...
+    EventBus.trigger("cameraReady", this.camera);
+  }
+}
+
+// 改造后
+export class CameraInput {
+  private eventBus: EventObj;
+  
+  constructor(config: CameraConfig, eventBus?: EventObj) {
+    this.eventBus = eventBus || EventBus;
+    // ...
+    this.eventBus.trigger("cameraReady", this.camera);
+  }
+}
+
+// 调用处（在ArMainImpl中）
+this.inputNode = new CameraInput(config, this.eventBus);
+```
+
+## 验证方法
+
+1. 创建多个SDK实例
+2. 每个实例监听相同的事件
+3. 触发其中一个实例的事件
+4. 验证只有对应实例的监听器被触发，其他实例不受影响
+
+```typescript
+const sdk1 = new ArSdk(config1);
+const sdk2 = new ArSdk(config2);
+
+sdk1.on("error", (data) => console.log("SDK1 error:", data));
+sdk2.on("error", (data) => console.log("SDK2 error:", data));
+
+// 只应该触发sdk1的error监听器
+```