はじめに

GoogleMapsPlatformを使用してルート案内方法を覚書程度に記載。

説明するアプリの概要はMap上に現在地を表示し、クリックした場所にマーカーを設置。
設置したマーカーをクリックすると目的地として設定され、現在地から目的地までのルートが描写される。

目次

マップ画面を生成
現在地を取得
目的地を取得
ルート取得API(Directions API)へアクセスするURLを用意
現在地から目的地までのルートを取得
取得したデータをもとにルートを描写

事前準備として、GoogleMapsPlatformのAPI使用を使用できるようにする必要がある。
詳細手順は下記参照。
https://developers.google.com/maps/documentation/android-sdk/overview?hl=ja

内容

マップ画面を生成

activity画面にid=mapのフラグメントを用意し、onCreate時にsetContentViewする。

activity_map.xml

<?xml version="1.0" encoding="utf-8"?>
<fragment xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    android:id="@+id/map"
    android:name="com.google.android.gms.maps.SupportMapFragment"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context=".MainActivity" />

MainActivity.java

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        // 地図フラグメントのハンドルを取得
        SupportMapFragment mapFragment = (SupportMapFragment) getSupportFragmentManager().findFragmentById(R.id.map);
        mapFragment.getMapAsync(this);
    }

    @Override
    public void onMapReady(@NonNull @org.jetbrains.annotations.NotNull GoogleMap googleMap) {
        mGoogleMap = googleMap;
    }

現在地を取得

PlacesクラスはPlaces SDK for Androidのクライアントの作成と管理を行うクラスで、onCreateで初期化をします。
その後、デバイスの現在地を取得するFusedLocationProviderClientを生成します。
本来はパーミッションのチェックまで行ったほうがのいいが記載は割愛
パーミッションチェックについてはこちらを参照→https://developers.google.com/maps/documentation/android-sdk/current-place-tutorial?hl=ja#location-permission

マップ生成後(onMapReady)に、getDeviceLocationメソッド内で現在地取得としてデバイス位置の取得を行い、カメラ位置を現在地に移動させている。
また、GoogleMap等でよく見る現在地へ移動するボタンをマップ上に追加している。

MainActivity.java

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        // Placesオブジェクトの初期化
        Places.initialize(getApplicationContext(), getString(R.string.google_map_key));
        // FusedLocationProviderClientオブジェクトの生成
        fusedLocationProviderClient = LocationServices.getFusedLocationProviderClient(this);
        // 地図フラグメントのハンドルを取得
        SupportMapFragment mapFragment = (SupportMapFragment) getSupportFragmentManager().findFragmentById(R.id.map);
        mapFragment.getMapAsync(this);
    }

    @Override
    public void onMapReady(@NonNull @org.jetbrains.annotations.NotNull GoogleMap googleMap) {
        mGoogleMap = googleMap;
        // 現在地の取得
        getDeviceLocation();
        // 現在値レイアを有効
        mGoogleMap.setMyLocationEnabled(true);
        // 現在地へ移動ボタンを有効
        mGoogleMap.getUiSettings().setMyLocationButtonEnabled(true);
        mGoogleMap.setOnMyLocationButtonClickListener(this);
    }

    private void getDeviceLocation() {
        // 現在位置の取得
        if (locationPermissionGranted) {
            Task<Location> locationTask = fusedLocationProviderClient.getLastLocation();
            locationTask.addOnCompleteListener(this, new OnCompleteListener<Location>() {
                @Override
                public void onComplete(@NonNull @NotNull Task<Location> task) {
                    if (task.isSuccessful()) {
                        myLocation = task.getResult();
                        if (myLocation != null) {
                            // カメラ位置移動
                            mGoogleMap.moveCamera(CameraUpdateFactory.newLatLngZoom(new LatLng(myLocation.getLatitude(), myLocation.getLongitude()), 15));
                        }
                    }
                }
            });
        }
    }

APIキーはstring.xmlにて定義しておけば使いやすい。

string.xml

<resources xmlns:xliff="urn:oasis:names:tc:xliff:document:1.2">
    <string name="app_name">SampleMap</string>
    <integer name="google_play_services_version">12451000</integer>
    <string name="google_map_key" templateMargeStrategty="perserve" translatable="false">ここに入手したAPIキーを記入</string>
</resources>

目的地を取得

画面をタッチした場所にマーカーを設置し、マーカーをクリックした時にその地点を目的地に設定する。
マップ生成後(onMapReady)にマップをクリックしたときのリスナーを設定する。
これでマップをクリックするとonMapClickが呼ばれる。その際にマーカーを追加してマーカーをクリックしたときのリスナーを登録。
下記作りだと、マップをクリックするたびにマーカーが生成されてしまうので、マップを一つだけにする場合は前回マップをクリアするなどの対応が必要となる。
マーカーをクリックされると、onMarkerClickが呼ばれ、引数であるmarkerからLatLngを取得する。

MainActivity.java

    // MAPオブジェクト
    private GoogleMap mGoogleMap;
    // ハンドラ
    Handler mMainHandler = new Handler(Looper.getMainLooper());

    @Override
    public void onMapReady(@NonNull @org.jetbrains.annotations.NotNull GoogleMap googleMap) {
        mGoogleMap = googleMap;

        // マップのクリックリスナー登録
        mGoogleMap.setOnMapClickListener(this);
    }

    @Override
    public void onMapClick(@NonNull @NotNull LatLng latLng) {
        // マーカー追加
        Marker marker = mGoogleMap.addMarker(new MarkerOptions().title("ここへ行く").position(new LatLng(latLng.latitude, latLng.longitude)));
        mGoogleMap.setOnMarkerClickListener(this);
    }

    @Override
    public boolean onMarkerClick(@NonNull @NotNull Marker marker) {
        // 移動ルート取得
        LatLng latLng = marker.getPosition();
        return false;
    }

ルート取得API(Directions API)へアクセスするURLを用意

outPutFormatはjsonとxmlを用意しており推奨はjson
parametersの必須は出発地、目的地、APIキーとなる

出発地をprivateメンバ変数から、目的地を引数から設定。移動手段は自動車に固定した場合。
(現在地はLocation型、目的地はLatLng型)

MainActivity.java

    // 現在地
    private Location myLocation;

    private String getURL(LatLng latLng) {
        // URLの設定
        // 　origin : 出発地
        // 　destination : 目的地
        // 　mode : 移動手段(今回は自動車で固定)
        String str_origin = "origin=" + myLocation.getLatitude() + "," + myLocation.getLongitude();
        String str_dest = "destination=" + latLng.latitude + "," + latLng.longitude;
        String mode = "mode=" + "driving";
        String parameters = str_origin + "&" + str_dest + "&" + mode;
        String output = "json";
        String str_url = "https://maps.googleapis.com/maps/api/directions/" 
                + output + "?" + parameters + "&key=" + getString(R.string.google_map_key);

        return str_url;
    }

現在地から目的地までのルートを取得

getURLメソッドの内容は上記を参照。
取得したデータはルート情報以外にも移動時間等様々な情報があり、今回はpolylineのpointsを使用する。
データの内容については、丁寧に記載している記事があったので割愛
(参考→https://qiita.com/kngsym2018/items/15f19a88ea37c1cd3646)

MainActivity.java

    // MAPオブジェクト
    private GoogleMap mGoogleMap;
    // ハンドラ
    Handler mMainHandler = new Handler(Looper.getMainLooper());


    @Override
    public boolean onMarkerClick(@NonNull @NotNull Marker marker) {
        // 移動ルート取得
        LatLng latLng = marker.getPosition();
        // URLの取得処理
        String url = getURL(latLng);
        AsyncTask.execute(new Runnable() {
            @Override
            public void run() {
                // ルートデータの取得
                String routeData = getRoute(url);
                // 目的地までのルートを表示
                drawRoute(routeData);
            }
        });

        return false;
    }

    private String getRoute(String string){
        String data = "";
        HttpURLConnection urlConnection = null;
        InputStream inputStream = null;

        // URLからデータ取得(MainThreadからはできないので注意)
        try {
            URL url = new URL(string);
            urlConnection = (HttpURLConnection) url.openConnection();
            urlConnection.connect();
            inputStream = urlConnection.getInputStream();
            BufferedReader bufferedReader = new BufferedReader(new InputStreamReader(inputStream));
            StringBuffer stringBuffer = new StringBuffer();
            String line = "";
            while ((line = bufferedReader.readLine()) != null) {
                stringBuffer.append(line);
            }
            data = stringBuffer.toString();
            Log.d("myLog", "Download URL:" + data.toString());
            bufferedReader.close();
        } catch (MalformedURLException e) {
            e.printStackTrace();
        } catch (IOException e) {
            e.printStackTrace();
        } finally {
            try {
                inputStream.close();
            } catch (IOException e) {
                e.printStackTrace();
            }
            urlConnection.disconnect();
        }
        return data;
    }

取得したデータをもとにルートを描写

getURL(), getRoute()は上記を参照。
GoogleMapsPlatformのAPIを使用して取得したルート情報は加工されているためデコードする必要がある。
(参照：https://developers.google.com/maps/documentation/utilities/polylinealgorithm)

MainActivity.java

    // MAPオブジェクト
    private GoogleMap mGoogleMap;
    // ハンドラ
    Handler mMainHandler = new Handler(Looper.getMainLooper());


    @Override
    public boolean onMarkerClick(@NonNull @NotNull Marker marker) {
        // 移動ルート取得
        LatLng latLng = marker.getPosition();
        // URLの取得処理
        String url = getURL(latLng);
        AsyncTask.execute(new Runnable() {
            @Override
            public void run() {
                // ルートデータの取得
                String routeData = getRoute(url);
                // 目的地までのルートを表示
                drawRoute(routeData);
            }
        });

        return false;
    }

    private void drawRoute(String data){
        if(data == null){
            Log.w("SampleMap", "Can not draw route because of no data!!");
            return;
        }

        JSONArray jsonArray = new JSONArray();
        JSONArray legsArray = new JSONArray();
        JSONArray stepArray = new JSONArray();
        ArrayList<ArrayList<LatLng>> list = new ArrayList<>();

        try {
            JSONObject jsonObject = new JSONObject(data);
            jsonArray = jsonObject.getJSONArray("routes");
            for (int i = 0; i < jsonArray.length(); i++) {
                legsArray = ((JSONObject) jsonArray.get(i)).getJSONArray("legs");
            }
            for (int i = 0; i < legsArray.length(); i++) {
                stepArray = ((JSONObject) legsArray.get(i)).getJSONArray("steps");
                for (int stepIndex = 0; stepIndex < stepArray.length(); stepIndex++) {
                    JSONObject stepObject = stepArray.getJSONObject(stepIndex);
                    // ルート案内で必要となるpolylineのpointsを取得し、デコード後にリストに格納
                    list.add(decodePolyline(stepObject.getJSONObject("polyline").get("points").toString()));
                }
            }
        } catch (
                JSONException e) {
            e.printStackTrace();
        }

        mMainHandler.post(new Runnable() {
            @Override
            public void run() {

                PolylineOptions polylineOptions = null;
                polylineOptions = new PolylineOptions();
                for (int i = 0; i < list.size(); i++) {
                    // 経路を追加
                    polylineOptions.addAll(list.get(i));
                }
                // ラインオプション設定
                polylineOptions.width(10);
                polylineOptions.color(Color.RED);
                // ラインを引く
                mGoogleMap.addPolyline(polylineOptions);
            }
        });
    }

    /**
     * Decodes polyline binary data given vy Google directions API. See below.
     * https://developers.google.com/maps/documentation/utilities/polylinealgorithm
     */
    private ArrayList<LatLng> decodePolyline (String encoded) {
        ArrayList<LatLng> point = new ArrayList<>();
        int index = 0;
        int len = encoded.length();
        int lat = 0;
        int lng = 0;

        while (index < len){
            int b;
            int shift = 0;
            int result = 0;
            do {
                b = encoded.charAt(index++) - 63;
                result |= (b & 0x1f) << shift;
                shift += 5;
            } while (b >= 0x20);
            int dlat = ((result & 1) != 0 ? ~(result >> 1) : (result >> 1));
            lat += dlat;

            shift = 0;
            result = 0;
            do {
                b = encoded.charAt(index++) - 63;
                result |= (b & 0x1f) << shift;
                shift += 5;
            } while (b >= 0x20);
            int dlng = ((result & 1) != 0 ? ~(result >> 1) : (result >> 1));
            lng += dlng;

            LatLng p = new LatLng(((double) lat / 1E5), ((double) lng / 1E5));
            point.add(p);
        }

        return point;
    }