MapsWrapper

Wrapper that unifies Google Maps (GM) and Huawei Maps (HM) SDKs in a single API. At runtime, the wrapper routes the calls according to the map resolution strategy which by default will use GM first and HM second (if GM is not available). On the new HMS Huawei devices, only HM is available.

The wrapper is mainly intended as an addition to an already existent GM implementation, when support for HM is also needed. Because the wrapper's API is 1:1 with the GM API (except the actual map that has been renamed fromGoogleMap/HuaweiMap to ExtendedMap) replacing/renaming the current imports from com.google.android.gms.maps.* to maps.wrapper.* would result in a working implementation on both GM and HM, in a couple of minutes of work. Explicit calls to GoogleMap need as well a rename to ExtendedMap.

Usage

Here's an activity layout with a SupportMapFragment:

<?xml version="1.0" encoding="utf-8"?>
<fragment xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    android:id="@+id/map"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    app:type="auto">
</fragment>

This is the activity class:

import androidx.appcompat.app.AppCompatActivity;
import android.os.Bundle;
import maps.wrapper.CameraUpdateFactory;
import maps.wrapper.ExtendedMap;
import maps.wrapper.LatLng;
import maps.wrapper.MarkerOptions;
import maps.wrapper.OnMapReadyCallback;
import maps.wrapper.SupportMapFragment;

/**
 * This shows how to create a simple activity with a map and a marker on the map.
 */
public class BasicMapDemoActivity extends AppCompatActivity implements OnMapReadyCallback {
    private SupportMapFragment fragment;
    private LatLng sydney = new LatLng(-33.862, 151.21);
    private float zoomLevel = 13f;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_basic_map_demo);
        fragment = (SupportMapFragment)
                this.getSupportFragmentManager().findFragmentById(R.id.id_framelayout_map);
        assert  fragment != null;
        fragment.getMapAsync(this);
    }

    /**
     * This is where we can add markers or lines, add listeners or move the camera. In this case,
     * we just move the camera to Sydney and add a marker in Sydney.
     */
    @Override
    public void onMapReady(ExtendedMap map) {
        map.moveCamera(CameraUpdateFactory.newLatLngZoom(sydney, zoomLevel));
        map.addMarker(new MarkerOptions().position(sydney));
    }
}

Map resolution strategy

Note the app:type="auto" attribute in the fragment layout. This defines the map resolution strategy. Currently 5 strategies are available:

• auto: same as google_then_huawei.
• google_then_huawei: tries to use Google Maps first. If not available falls back to Huawei. If not available either throws an error.
• huawei_then_google: tries to use Huawei Maps first. If not available falls back to Google. If not available either throws an error.
• force_google: tries to use Google Maps. If not available throws error.
• force_huawei: tries to use Huawei Maps. If not available throws error.

If no map resolution strategy is defined it defaults to the strategy defined in MapResolverStrategy.default. By default this is auto but can be overridden programmatically.

You can check the testapplication module for an example app that contains more exhaustive examples for each part of the maps API.

Extended API

Some classes have enhanced API support:

• SupportMapFragment supports a suspend mapAsync() method that returns a ExtendedMap.
• MapView supports a suspend mapAsync() method that returns a ExtendedMap.

Add as dependency

In your root build.gradle add Jitpack to the list of known repositories. Check that the Huawei and Google own repositories are there as well.

allprojects {
	repositories {
		...
		maven { url 'https://jitpack.io' }
		maven { url 'https://developer.huawei.com/repo/' }
		google()
	}
}

Then add the actual library dependency in your app build.gradle:

dependencies {
    implementation 'com.github.franalma:MapsWrapper:1.1.11'
}

Note that you no longer need to define Google Maps or Huawei Maps dependencies explicitly in your app's build.gradle, this library already has dependencies on both of them.

Obtaining an API key

Both maps SDKs require an API key. Follow the instructions on how to setup your app:

• Google Maps: https://developers.google.com/maps/documentation/android-sdk/start
• Huawei Maps: https://developer.huawei.com/consumer/en/doc/development/HMSCore-Guides-V5/android-sdk-config-agc-0000001061560289-V5

Keep in mind that HM requires by default client authentication -> see https://github.com/abusuioc/from-gms-to-hms#authenticate-your-app

Is the desired map type supported?

For now, HM lacks terrain information and satellite imagery. You can callExtendedMap.isMapTypeSupported() (go to definition) to check at runtime if the underlying map supports the desired map type and react accordingly (i.e. by hiding the UI element that switches to satellite view).

Requesting a map type ExtendedMap.MAP_TYPE_HYBRID will display on HM the equivalent of ExtendedMap.MAP_TYPE_NORMAL .