feat: Migrate to Android V2 embedding

hardy716 · hardy716 · commit 66463969b301 · 2023-04-14T11:29:09.000+09:00
2023. 04. 14

- Update to analysis_options.yaml
- Update to android/build.gradle
- Update to android/gradle.properties
- Update to android/src/main/java/com/flutter_webview_plugin/FlutterWebviewPlugin.java
- Update to example/android/app/src/main/java/com/yourcompany/flutter_webview_plugin_example/MainActivity.java
- Update to example/android/app/src/main/java/io/flutter/plugins/GeneratedPluginRegistrant.java

- Update to example/ios/Runner/GeneratedPluginRegistrant.h
- Update to example/ios/Runner/GeneratedPluginRegistrant.m
diff --git a/analysis_options.yaml b/analysis_options.yaml
@@ -12,7 +12,7 @@ linter:
   # - always_specify_types
   - annotate_overrides
   # - avoid_annotating_with_dynamic # conflicts with always_specify_types
-  - avoid_as
+  # - avoid_as
   # - avoid_bool_literals_in_conditional_expressions # not yet tested
   # - avoid_catches_without_on_clauses # we do this commonly
   # - avoid_catching_errors # we do this commonly
@@ -71,7 +71,7 @@ linter:
   # - parameter_assignments # we do this commonly
   - prefer_adjacent_string_concatenation
   - prefer_asserts_in_initializer_lists
-  - prefer_bool_in_asserts
+  # - prefer_bool_in_asserts
   - prefer_collection_literals
   - prefer_conditional_assignment
   - prefer_const_constructors
@@ -97,7 +97,7 @@ linter:
   - slash_for_doc_comments
   - sort_constructors_first
   - sort_unnamed_constructors_first
-  - super_goes_last
+  # - super_goes_last
   - test_types_in_equals
   - throw_in_finally
   # - type_annotate_public_apis # subset of always_specify_types
diff --git a/android/build.gradle b/android/build.gradle
@@ -34,13 +34,15 @@ allprojects {
 apply plugin: 'com.android.library'
 
 android {
-    compileSdkVersion 28
+    // compileSdkVersion 28
+    compileSdkVersion 30
 
     defaultConfig {
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
         // NOTE(jeffmikels): When targetSdkVersion or minSdkVersion is not set or < 4, gradle adds 
         // additional scary permissions such as WRITE_EXTERNAL_STORAGE and READ_PHONE_STATE.
         minSdkVersion 16
+        targetSdkVersion 30
     }
     lintOptions {
         disable 'InvalidPackage'
diff --git a/android/gradle.properties b/android/gradle.properties
@@ -1,2 +1,4 @@
 org.gradle.jvmargs=-Xmx1536M
 android.enableR8=true
+android.useAndroidX=true
+android.enableJetifier=true
diff --git a/android/src/main/java/com/flutter_webview_plugin/FlutterWebviewPlugin.java b/android/src/main/java/com/flutter_webview_plugin/FlutterWebviewPlugin.java
@@ -20,30 +20,86 @@
 import io.flutter.plugin.common.MethodChannel;
 import io.flutter.plugin.common.MethodChannel.MethodCallHandler;
 import io.flutter.plugin.common.PluginRegistry;
+import io.flutter.embedding.engine.plugins.FlutterPlugin;
+import io.flutter.embedding.engine.plugins.activity.ActivityAware;
+import io.flutter.embedding.engine.plugins.activity.ActivityPluginBinding;
+import io.flutter.plugin.common.BinaryMessenger;
 
 /**
  * FlutterWebviewPlugin
  */
-public class FlutterWebviewPlugin implements MethodCallHandler, PluginRegistry.ActivityResultListener {
+public class FlutterWebviewPlugin implements MethodCallHandler, FlutterPlugin, ActivityAware, PluginRegistry.ActivityResultListener {
+    // private Activity activity;
+    // private WebviewManager webViewManager;
+    // private Context context;
+    // static MethodChannel channel;
+    // private static final String CHANNEL_NAME = "flutter_webview_plugin";
+    // private static final String JS_CHANNEL_NAMES_FIELD = "javascriptChannelNames";
+
+    // public static void registerWith(PluginRegistry.Registrar registrar) {
+    //     if (registrar.activity() != null) {
+    //         channel = new MethodChannel(registrar.messenger(), CHANNEL_NAME);
+    //         final FlutterWebviewPlugin instance = new FlutterWebviewPlugin(registrar.activity(), registrar.activeContext());
+    //         registrar.addActivityResultListener(instance);
+    //         channel.setMethodCallHandler(instance);
+    //     }
+    // }
+
+    // FlutterWebviewPlugin(Activity activity, Context context) {
+    //     this.activity = activity;
+    //     this.context = context;
+    // }
+
     private Activity activity;
     private WebviewManager webViewManager;
     private Context context;
     static MethodChannel channel;
     private static final String CHANNEL_NAME = "flutter_webview_plugin";
     private static final String JS_CHANNEL_NAMES_FIELD = "javascriptChannelNames";
 
-    public static void registerWith(PluginRegistry.Registrar registrar) {
-        if (registrar.activity() != null) {
-            channel = new MethodChannel(registrar.messenger(), CHANNEL_NAME);
-            final FlutterWebviewPlugin instance = new FlutterWebviewPlugin(registrar.activity(), registrar.activeContext());
-            registrar.addActivityResultListener(instance);
-            channel.setMethodCallHandler(instance);
+    @Override
+    public void onAttachedToEngine(FlutterPluginBinding binding) {
+        BinaryMessenger messenger = binding.getBinaryMessenger();
+        channel = new MethodChannel(messenger, CHANNEL_NAME);
+        channel.setMethodCallHandler(this);
+    }
+
+    @Override
+    public void onDetachedFromEngine(FlutterPluginBinding binding) {
+        if (channel != null) {
+            channel.setMethodCallHandler(null);
+            channel = null;
         }
     }
 
-    FlutterWebviewPlugin(Activity activity, Context context) {
-        this.activity = activity;
-        this.context = context;
+    @Override
+    public void onAttachedToActivity(ActivityPluginBinding binding) {
+        activity = binding.getActivity();
+        context = activity.getApplicationContext();
+        binding.addActivityResultListener(this);
+    }
+
+    @Override
+    public void onDetachedFromActivityForConfigChanges() {
+        if (activity != null) {
+            activity = null;
+            context = null;
+        }
+    }
+
+    @Override
+    public void onReattachedToActivityForConfigChanges(ActivityPluginBinding binding) {
+        activity = binding.getActivity();
+        context = activity.getApplicationContext();
+        binding.addActivityResultListener(this);
+    }
+
+    @Override
+    public void onDetachedFromActivity() {
+        if (activity != null) {
+            activity = null;
+            context = null;
+        }
     }
 
     @Override
diff --git a/example/android/app/src/main/java/com/yourcompany/flutter_webview_plugin_example/MainActivity.java b/example/android/app/src/main/java/com/yourcompany/flutter_webview_plugin_example/MainActivity.java
@@ -1,14 +1,21 @@
-package com.yourcompany.flutter_webview_plugin_example;
+// package com.yourcompany.flutter_webview_plugin_example;
+
+// import android.os.Bundle;
+
+// import io.flutter.app.FlutterActivity;
+// import io.flutter.plugins.GeneratedPluginRegistrant;
 
-import android.os.Bundle;
+// public class MainActivity extends FlutterActivity {
+//     @Override
+//     protected void onCreate(Bundle savedInstanceState) {
+//         super.onCreate(savedInstanceState);
+//         GeneratedPluginRegistrant.registerWith(this);
+//     }
+// }
+
+package com.yourcompany.flutter_webview_plugin_example;
 
-import io.flutter.app.FlutterActivity;
-import io.flutter.plugins.GeneratedPluginRegistrant;
+import io.flutter.embedding.android.FlutterActivity;
 
 public class MainActivity extends FlutterActivity {
-    @Override
-    protected void onCreate(Bundle savedInstanceState) {
-        super.onCreate(savedInstanceState);
-        GeneratedPluginRegistrant.registerWith(this);
-    }
 }
diff --git a/example/android/app/src/main/java/io/flutter/plugins/GeneratedPluginRegistrant.java b/example/android/app/src/main/java/io/flutter/plugins/GeneratedPluginRegistrant.java
@@ -1,25 +1,35 @@
 package io.flutter.plugins;
 
-import io.flutter.plugin.common.PluginRegistry;
+// import io.flutter.plugin.common.PluginRegistry;
+import androidx.annotation.NonNull;
+import io.flutter.embedding.engine.FlutterEngine;
+import io.flutter.embedding.engine.plugins.shim.ShimPluginRegistry;
 import com.flutter_webview_plugin.FlutterWebviewPlugin;
 
 /**
  * Generated file. Do not edit.
  */
-public final class GeneratedPluginRegistrant {
-  public static void registerWith(PluginRegistry registry) {
-    if (alreadyRegisteredWith(registry)) {
-      return;
-    }
-    FlutterWebviewPlugin.registerWith(registry.registrarFor("com.flutter_webview_plugin.FlutterWebviewPlugin"));
-  }
+// public final class GeneratedPluginRegistrant {
+//   public static void registerWith(PluginRegistry registry) {
+//     if (alreadyRegisteredWith(registry)) {
+//       return;
+//     }
+//     FlutterWebviewPlugin.registerWith(registry.registrarFor("com.flutter_webview_plugin.FlutterWebviewPlugin"));
+//   }
 
-  private static boolean alreadyRegisteredWith(PluginRegistry registry) {
-    final String key = GeneratedPluginRegistrant.class.getCanonicalName();
-    if (registry.hasPlugin(key)) {
-      return true;
-    }
-    registry.registrarFor(key);
-    return false;
+//   private static boolean alreadyRegisteredWith(PluginRegistry registry) {
+//     final String key = GeneratedPluginRegistrant.class.getCanonicalName();
+//     if (registry.hasPlugin(key)) {
+//       return true;
+//     }
+//     registry.registrarFor(key);
+//     return false;
+//   }
+// }
+
+public final class GeneratedPluginRegistrant {
+  public static void registerWith(@NonNull FlutterEngine flutterEngine) {
+      ShimPluginRegistry shimPluginRegistry = new ShimPluginRegistry(flutterEngine);
+      FlutterWebviewPlugin.registerWith(shimPluginRegistry.registrarFor("com.flutter_webview_plugin.FlutterWebviewPlugin"));
   }
 }
diff --git a/example/ios/Runner/GeneratedPluginRegistrant.h b/example/ios/Runner/GeneratedPluginRegistrant.h
@@ -2,6 +2,8 @@
 //  Generated file. Do not edit.
 //
 
+// clang-format off
+
 #ifndef GeneratedPluginRegistrant_h
 #define GeneratedPluginRegistrant_h
 
diff --git a/example/ios/Runner/GeneratedPluginRegistrant.m b/example/ios/Runner/GeneratedPluginRegistrant.m
@@ -2,6 +2,8 @@
 //  Generated file. Do not edit.
 //
 
+// clang-format off
+
 #import "GeneratedPluginRegistrant.h"
 
 #if __has_include(<flutter_webview_plugin/FlutterWebviewPlugin.h>)
