[ohos]更新plugin注册逻辑

Author: 0xZOne

CHANGELOG.md

@@ -1,5 +1,6 @@
 ## NEXT
 1. [ohos]支持传入启动参数和dart入口参数
+2. [ohos]更新plugin注册逻辑
 
 ## 4.5.3
 1. [ohos]移除不必要的生命周期通知

example/ohos/dependencies/hvigor-4.2.0.tgz

@@ -79,11 +79,13 @@ export default class EntryAbility extends UIAbility implements FlutterBoostDeleg
     const optionsBuilder: FlutterBoostSetupOptionsBuilder = new FlutterBoostSetupOptionsBuilder()
       .setShellArgs(['--trace-systrace', '--user-authorization-code=QZvoUptODA+KDgeFUluhheYns7X7CnDu9YRv8YmU0GXQcKLzs4C2WgjblrAIhtkqqGg=='])
       .setDartEntrypointArgs(['I am from ohos!', '--for-test'])
-      .setPlugins(GeneratedPluginRegistrant.getPlugins())
 
-    FlutterBoost.getInstance().setup(this, this.context, () => {
+    FlutterBoost.getInstance().setup(this, this.context, (engine) => {
       hilog.info(0x0000, 'testTag', '%{public}s', '引擎初始化成功');
 
+      // register plugins
+      GeneratedPluginRegistrant.registerWith(engine)
+
       windowStage.loadContent('pages/EntryPage', (err, data) => {
         if (err.code) {
           hilog.error(0x0000, 'testTag', 'Failed to load the content. Cause: %{public}s', JSON.stringify(err) ?? '');

example/ohos/dependencies/hvigor-ohos-plugin-4.2.0.tgz

@@ -25,7 +25,6 @@ import AbilityConstant from '@ohos.app.ability.AbilityConstant';
 import hilog from '@ohos.hilog';
 import Want from '@ohos.app.ability.Want';
 import List from '@ohos.util.List';
-import { GeneratedPluginRegistrant } from '../plugins/GeneratedPluginRegistrant';
 import { FlutterPlugin } from '@ohos/flutter_ohos/src/main/ets/embedding/engine/plugins/FlutterPlugin';
 import { FlutterBoost, FlutterBoostDelegate, FlutterBoostRouteOptions, FlutterBoostAbility } from '@ohos/flutter_boost'
 
@@ -34,8 +33,4 @@ export default class FMFlutterAbility extends FlutterBoostAbility {
   async onCreate(want: Want, launchParam: AbilityConstant.LaunchParam) {
     await super.onCreate(want, launchParam)
   }
-
-  getPlugins():List<FlutterPlugin>{
-    return GeneratedPluginRegistrant.getPlugins()
-  }
 }

example/ohos/entry/src/main/ets/entryability/EntryAbility.ets

@@ -1,16 +1,27 @@
-import { FlutterPlugin } from '@ohos/flutter_ohos/src/main/ets/embedding/engine/plugins/FlutterPlugin';
-import List from '@ohos.util.List';
+import FlutterEngine from '@ohos/flutter_ohos/src/main/ets/embedding/engine/FlutterEngine';
+import Log from '@ohos/flutter_ohos/src/main/ets/util/Log';
 import FlutterBoostPlugin from '@ohos/flutter_boost'
 
 /**
  * Generated file. Do not edit.
  * This file is generated by the Flutter tool based on the
  * plugins that support the Ohos platform.
  */
+
+const TAG = "GeneratedPluginRegistrant";
+
 export class GeneratedPluginRegistrant {
-  static getPlugins(): List<FlutterPlugin> {
-    let pluginList : List<FlutterPlugin> = new List();
-    pluginList.add(new FlutterBoostPlugin());
-    return pluginList;
+
+  static registerWith(flutterEngine: FlutterEngine) {
+    try {
+      flutterEngine.getPlugins()?.add(new FlutterBoostPlugin());
+    } catch (e) {
+      Log.e(
+        TAG,
+        "Tried to register plugins with FlutterEngine ("
+          + flutterEngine
+          + ") failed.");
+      Log.e(TAG, "Received exception while registering", e);
+    }
   }
 }

example/ohos/entry/src/main/ets/fmflutterability/FMFlutterAbility.ets

@@ -29,16 +29,10 @@ import Want from '@ohos.app.ability.Want';
 import window from '@ohos.window';
 import { FlutterAbility } from '@ohos/flutter_ohos'
 import { FlutterPlugin } from '@ohos/flutter_ohos/src/main/ets/embedding/engine/plugins/FlutterPlugin';
-import { GeneratedPluginRegistrant } from '../plugins/GeneratedPluginRegistrant';
-import List from '@ohos.util.List';
 
 export default class PureFlutterAbility extends FlutterAbility {
   async onCreate(want: Want, launchParam: AbilityConstant.LaunchParam) {
     // want.uri
     await super.onCreate(want, launchParam)
   }
-
-  getPlugins(): List<FlutterPlugin> {
-    return GeneratedPluginRegistrant.getPlugins()
-  }
 }

example/ohos/entry/src/main/ets/plugins/GeneratedPluginRegistrant.ets

@@ -1,21 +1,6 @@
-/*
-* Copyright (c) 2023 Hunan OpenValley Digital Industry Development Co., Ltd.
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-*     http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*/
-
-{ 
-  "hvigorVersion": "4.0.2",
+{
+  "hvigorVersion": "file:../dependencies/hvigor-4.2.0.tgz",
   "dependencies": {
-    "@ohos/hvigor-ohos-plugin": "4.0.2"
+    "@ohos/hvigor-ohos-plugin": "file:../dependencies/hvigor-ohos-plugin-4.2.0.tgz"
   }
 }

example/ohos/entry/src/main/ets/pureflutterability/PureFlutterAbility.ets

@@ -61,42 +61,43 @@ export class FlutterBoost {
    * 设置FlutterBoost的配置信息
    * @param delegate FlutterBoost的委托对象
    * @param context 上下文对象
-   * @param callback 回调函数
+   * @param onEngineReady 回调函数
    * @param options FlutterBoost的配置选项
    */
   public async setup(delegate: FlutterBoostDelegate,
                      context: common.Context,
-                     callback: (engine: FlutterEngine) => void,
+                     onEngineReady: (engine: FlutterEngine) => void,
                      options: FlutterBoostSetupOptions | null) {
 
-    this.delegate = delegate
+    this.delegate = delegate;
 
-    // 0.如果为null，指定默认设置参数（初始路由为/,入口参数main）
     if (options == null) {
-      options = FlutterBoostSetupOptions.createDefault()
+      // 指定默认设置参数（初始路由为/,入口参数main）
+      options = FlutterBoostSetupOptions.createDefault();
     }
 
-    // 1.初始化engine
+    // 1. 初始化引擎
     let engine: FlutterEngine | null = this.getEngine()
     if (engine == null) {
-      const engineProvider = options.getFlutterEngineProvider()
+      const engineProvider = options.getFlutterEngineProvider();
       if (engineProvider) {
-        engine = engineProvider.provideFlutterEngine(context)
+        engine = engineProvider.provideFlutterEngine(context);
       }
       if (engine == null) {
-        engine = new FlutterEngine(context, null, null, new PlatformViewsController())
-        await engine.init(context, options.getShellArgs(), true, true, null, options.getPlugins())
+        engine = new FlutterEngine(context, null, null, new PlatformViewsController());
+        await engine.init(context, options.getShellArgs(), true);
       }
       FlutterEngineCache.getInstance().put(FlutterBoost.ENGINE_ID, engine);
     }
+    this.flutterEngine = engine;
 
-    this.flutterEngine = engine
-    //2. 设置代理
-    if (this.delegate) {
-      this.getPlugin()?.setDelegate(this.delegate)
-    }
+    // 2. 通知业务引擎就绪
+    onEngineReady(engine);
+
+    // 3. 设置message channel消息代理
+    this.getPlugin()!.setDelegate(this.delegate);
 
-    // 3.预热FlutterEngine
+    // 4. DartVM预热
     if (!engine.getDartExecutor().isExecutingDart()) {
       const navigationChannel = engine.getNavigationChannel()
       if (navigationChannel) {
@@ -110,13 +111,6 @@ export class FlutterBoost {
       );
       engine.getDartExecutor().executeDartEntrypoint(dartEntrypoint, options.getDartEntrypointArgs());
     }
-
-    if (callback) {
-      callback(engine)
-    }
-
-    // TODO:添加OHOS实现
-    // setupActivityLifecycleCallback(application, isBackForegroundEventOverridden);
   }
 
 
@@ -182,15 +176,13 @@ export class FlutterBoost {
       let engine = this.getEngine();
       if (engine) {
         const plugin: FlutterBoostPlugin | null = FlutterBoostUtils.getPlugin(engine);
-        if (plugin !== undefined) {
+        if (plugin != null) {
           this.plugin = plugin;
         } else {
           throw new Error('getPlugin fail. can not get the FlutterBoostPlugin instance,')
-          return null
         }
       } else {
         throw new Error('getPlugin fail. can not get the engine instance,')
-        return null
       }
     }
     return this.plugin;

example/ohos/hvigor/hvigor-config.json5

@@ -30,8 +30,7 @@ export class FlutterBoostSetupOptionsBuilder {
   public dartEntrypointArgs: string[];
   public shouldOverrideBackForegroundEvent: boolean = false;
   public shellArgs: string[];
-  public flutterEngineProvider: FlutterEngineProvider | null
-  public plugins: List<FlutterPlugin> | null = null;
+  public flutterEngineProvider: FlutterEngineProvider | null;
 
   constructor() {
     this.initialRoute = '/'
@@ -40,7 +39,6 @@ export class FlutterBoostSetupOptionsBuilder {
     this.shouldOverrideBackForegroundEvent = false
     this.shellArgs = []
     this.flutterEngineProvider = null
-    this.plugins = null
   }
 
   public setInitialRoute(initialRoute: string): FlutterBoostSetupOptionsBuilder {
@@ -74,11 +72,6 @@ export class FlutterBoostSetupOptionsBuilder {
     return this;
   }
 
-  public setPlugins(plugins: List<FlutterPlugin>): FlutterBoostSetupOptionsBuilder {
-    this.plugins = plugins;
-    return this;
-  }
-
   public build(): FlutterBoostSetupOptions {
     return new FlutterBoostSetupOptions(this);
   }
@@ -93,8 +86,7 @@ export class FlutterBoostSetupOptions {
   private readonly dartEntrypointArgs: string[];
   private readonly shellArgs: string[];
   private readonly shouldOverrideBackForegroundEvent: boolean;
-  private flutterEngineProvider: FlutterEngineProvider | null
-  private plugins: List<FlutterPlugin> | null = null;
+  private flutterEngineProvider: FlutterEngineProvider | null;
 
   public constructor(builder: FlutterBoostSetupOptionsBuilder) {
     this.initialRoute = builder.initialRoute;
@@ -103,7 +95,6 @@ export class FlutterBoostSetupOptions {
     this.shellArgs = builder.shellArgs;
     this.shouldOverrideBackForegroundEvent = builder.shouldOverrideBackForegroundEvent;
     this.flutterEngineProvider = builder.flutterEngineProvider;
-    this.plugins = builder.plugins
   }
 
   public static createDefault(): FlutterBoostSetupOptions {
@@ -134,10 +125,6 @@ export class FlutterBoostSetupOptions {
     return this.shouldOverrideBackForegroundEvent;
   }
 
-  public getPlugins(): List<FlutterPlugin> | null {
-    return this.plugins;
-  }
-
   public toString(): string {
     let sb: string[] = ['['];
     if (this.shellArgs == null || this.shellArgs.length == 0) {