[google_maps_flutter_android] Add support to prefer renderer

Author: jokerttu

packages/google_maps_flutter/google_maps_flutter_android/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 2.4.0
+
+* Adds the ability to set the preferred renderer with a
+  metadata key in the AndroidManifest file.
+
 ## 2.3.2
 
 * Update `com.google.android.gms:play-services-maps` to 18.1.0.

packages/google_maps_flutter/google_maps_flutter_android/README.md

@@ -48,7 +48,24 @@ Hybrid Composition, but currently [misses certain map updates][4].
 This mode will likely become the default in future versions if/when the
 missed updates issue can be resolved.
 
+## Map renderer
+
+This plugin supports the option of choosing a preferred [map renderer][5].
+
+Prefer renderer in the application manifest `android/app/src/main/AndroidManifest.xml`:
+
+```xml
+<manifest ...
+  <application ...
+    <meta-data
+        android:name="io.flutter.plugins.googlemaps.PREFERRED_RENDERER"
+        android:value="latest" />
+```
+Available values are `latest` and `legacy`.
+
+
 [1]: https://pub.dev/packages/google_maps_flutter
 [2]: https://flutter.dev/docs/development/packages-and-plugins/developing-packages#endorsed-federated-plugin
 [3]: https://docs.flutter.dev/development/platform-integration/android/platform-views
 [4]: https://github.com/flutter/flutter/issues/103686
+[5]: https://developers.google.com/maps/documentation/android-sdk/renderer

packages/google_maps_flutter/google_maps_flutter_android/android/src/main/java/io/flutter/plugins/googlemaps/GoogleMapController.java

@@ -7,6 +7,7 @@
 import android.Manifest;
 import android.annotation.SuppressLint;
 import android.content.Context;
+import android.content.pm.ApplicationInfo;
 import android.content.pm.PackageManager;
 import android.graphics.Bitmap;
 import android.graphics.Point;
@@ -25,6 +26,8 @@
 import com.google.android.gms.maps.GoogleMap.SnapshotReadyCallback;
 import com.google.android.gms.maps.GoogleMapOptions;
 import com.google.android.gms.maps.MapView;
+import com.google.android.gms.maps.MapsInitializer;
+import com.google.android.gms.maps.MapsInitializer.Renderer;
 import com.google.android.gms.maps.OnMapReadyCallback;
 import com.google.android.gms.maps.model.CameraPosition;
 import com.google.android.gms.maps.model.Circle;
@@ -57,6 +60,7 @@ final class GoogleMapController
         PlatformView {
 
   private static final String TAG = "GoogleMapController";
+  private static boolean preferredRendererInitialized = false;
   private final int id;
   private final MethodChannel methodChannel;
   private final GoogleMapOptions options;
@@ -94,6 +98,9 @@ final class GoogleMapController
     this.id = id;
     this.context = context;
     this.options = options;
+
+    this.initializePreferredRenderer(context);
+
     this.mapView = new MapView(context, options);
     this.density = context.getResources().getDisplayMetrics().density;
     methodChannel =
@@ -175,6 +182,42 @@ public void onMapLoaded() {
         });
   }
 
+  /**
+   * Initializes map renderer if meta-data value for key
+   * "io.flutter.plugins.googlemaps.PREFERRED_RENDERER" is set in AndroidManifest. Renderer can be
+   * initialized only once per application context.
+   *
+   * <p>Supported meta-data values are "legacy" and "latest".
+   */
+  private void initializePreferredRenderer(Context context) {
+    if (!preferredRendererInitialized) {
+      try {
+        ApplicationInfo applicationInfo =
+            context
+                .getPackageManager()
+                .getApplicationInfo(context.getPackageName(), PackageManager.GET_META_DATA);
+
+        if (applicationInfo != null && applicationInfo.metaData != null) {
+          final String preferredRenderer =
+              applicationInfo.metaData.getString(
+                  "io.flutter.plugins.googlemaps.PREFERRED_RENDERER");
+
+          if (preferredRenderer != null) {
+            switch (preferredRenderer) {
+              case "latest":
+                MapsInitializer.initialize(context, Renderer.LATEST, null);
+              case "legacy":
+                MapsInitializer.initialize(context, Renderer.LEGACY, null);
+            }
+          }
+        }
+      } catch (Exception e) {
+        e.printStackTrace();
+      }
+      preferredRendererInitialized = true;
+    }
+  }
+
   private static void postFrameCallback(Runnable f) {
     Choreographer.getInstance()
         .postFrameCallback(
@@ -848,6 +891,11 @@ public void setInitialTileOverlays(List<Map<String, ?>> initialTileOverlays) {
     }
   }
 
+  @Override
+  public void setMapId(String mapId) {
+    Log.e(TAG, "Cannot change MapId after map is initialized.");
+  }
+
   private void updateInitialTileOverlays() {
     tileOverlaysController.addTileOverlays(initialTileOverlays);
   }

packages/google_maps_flutter/google_maps_flutter_android/example/android/app/build.gradle

@@ -42,7 +42,10 @@ android {
     }
 
     defaultConfig {
-        manifestPlaceholders = [mapsApiKey: "$System.env.MAPS_API_KEY"]
+        manifestPlaceholders = [
+            mapsApiKey: "$System.env.MAPS_API_KEY",
+            mapsPreferredRenderer: "$System.env.MAPS_PREFERRED_RENDERER"
+        ]
     }
 
     buildTypes {

packages/google_maps_flutter/google_maps_flutter_android/example/android/app/src/main/AndroidManifest.xml

@@ -12,6 +12,9 @@
         <meta-data
             android:name="com.google.android.geo.API_KEY"
             android:value="${mapsApiKey}" />
+        <meta-data
+            android:name="io.flutter.plugins.googlemaps.PREFERRED_RENDERER"
+            android:value="${mapsPreferredRenderer}" />
         <activity android:name="io.flutter.embedding.android.FlutterActivity"
             android:theme="@style/LaunchTheme"
             android:configChanges="orientation|keyboardHidden|keyboard|screenSize|locale|layoutDirection|fontScale"