Android Studioで依存関係を追加する方法|Gradle設定からサンプルアプリ実装まで完全解説

このチュートリアルでは、Android Studioで依存関係(dependency)を追加する方法を、位置情報を取得するサンプルアプリの作成を通じて段階的に解説します。Gradleファイルへのライブラリ追加の手順だけでなく、実際に動作するアプリのコードもあわせて紹介するので、Android開発の初心者の方でも安心して進められる内容となっています。

ステップ1:新規プロジェクトを作成する

まず、Android Studioで新しいプロジェクトを作成しましょう。メニューバーから「File」→「New Project」を選択し、プロジェクト名やパッケージ名など、必要な項目をすべて入力してプロジェクトを作成します。

ステップ2:レイアウトファイル(activity_main.xml)を編集する

res/layout/activity_main.xmlに以下のコードを追加します。このレイアウトには、位置情報の更新を「開始」「停止」するボタンと「最後の既知の位置情報を取得」するボタンの3つに加え、結果を表示するためのTextViewが配置されています。

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="https://schemas.android.com/apk/res/android"
    xmlns:tools="https://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:gravity="center_horizontal"
    android:orientation="vertical"
    tools:context=".MainActivity">
<Button
    android:id="@+id/btn_start_location_updates"
    android:layout_width="wrap_content"
    android:layout_height="wrap_content"
    android:layout_marginTop="40dp"
    android:onClick="startLocationButtonClick"
    android:text="@string/start_updates" />
<Button
    android:id="@+id/btn_stop_location_updates"
    android:layout_width="wrap_content"
    android:layout_height="wrap_content"
    android:layout_marginTop="10dp"
    android:enabled="false"
    android:onClick="stopLocationButtonClick"
    android:text="@string/stop_updates" />
<Button
    android:id="@+id/btn_get_last_location"
    android:layout_width="wrap_content"
    android:layout_height="wrap_content"
    android:layout_marginTop="10dp"
    android:onClick="showLastKnownLocation"
    android:text="@string/get_last_location" />
<TextView
    android:layout_width="wrap_content"
    android:layout_height="wrap_content"
    android:layout_marginTop="50dp"
    android:gravity="center_horizontal"
    android:text="Location updates will be received only when app is foreground" />
<TextView
    android:id="@+id/location_result"
    android:layout_width="wrap_content"
    android:layout_height="wrap_content"
    android:layout_marginTop="20dp"
    android:textColor="#333"
    android:textSize="18sp" />
<TextView
    android:id="@+id/updated_on"
    android:layout_width="wrap_content"
    android:layout_height="wrap_content"
    android:layout_marginTop="30dp"
    android:textSize="12sp" />
</LinearLayout>

ステップ3:MainActivity.javaを実装する

src/MainActivity.javaに以下のコードを追加します。FusedLocationProviderClientによる位置情報の取得処理、Dexterライブラリを使った実行時パーミッションの要求、画面回転時の状態保存など、実用的な処理がひと通り含まれています。

package app.com.sample;
import androidx.annotation.NonNull;
import androidx.appcompat.app.AppCompatActivity;
import androidx.core.app.ActivityCompat;
import android.Manifest;
import android.annotation.SuppressLint;
import android.app.Activity;
import android.content.Intent;
import android.content.IntentSender;
import android.content.pm.PackageManager;
import android.location.Location;
import android.net.Uri;
import android.os.Bundle;
import android.os.Looper;
import android.provider.Settings;
import android.util.Log;
import android.view.View;
import android.widget.Button;
import android.widget.TextView;
import android.widget.Toast;
import com.google.android.gms.common.api.ApiException;
import com.google.android.gms.common.api.ResolvableApiException;
import com.google.android.gms.location.FusedLocationProviderClient;
import com.google.android.gms.location.LocationCallback;
import com.google.android.gms.location.LocationRequest;
import com.google.android.gms.location.LocationResult;
import com.google.android.gms.location.LocationServices;
import com.google.android.gms.location.LocationSettingsRequest;
import com.google.android.gms.location.LocationSettingsResponse;
import com.google.android.gms.location.LocationSettingsStatusCodes;
import com.google.android.gms.location.SettingsClient;
import com.google.android.gms.tasks.OnCompleteListener;
import com.google.android.gms.tasks.OnFailureListener;
import com.google.android.gms.tasks.OnSuccessListener;
import com.google.android.gms.tasks.Task;
import com.karumi.dexter.Dexter;
import com.karumi.dexter.PermissionToken;
import com.karumi.dexter.listener.PermissionDeniedResponse;
import com.karumi.dexter.listener.PermissionGrantedResponse;
import com.karumi.dexter.listener.PermissionRequest;
import com.karumi.dexter.listener.single.PermissionListener;
import java.text.DateFormat;
import java.util.Date;
public class MainActivity extends AppCompatActivity {
    private static final String TAG = MainActivity.class.getSimpleName();
    TextView txtLocationResult;
    TextView txtUpdatedOn;
    Button btnStartUpdates;
    Button btnStopUpdates;
    // 最終更新時刻
    private String mLastUpdateTime;
    // 位置情報の更新間隔 - 10秒
    private static final long UPDATE_INTERVAL_IN_MILLISECONDS = 10000;
    // 最速の更新間隔 - 5秒
    // 他のアプリが位置情報を要求している場合でも受信できるよう設定
    private static final long FASTEST_UPDATE_INTERVAL_IN_MILLISECONDS = 5000;
    private static final int REQUEST_CHECK_SETTINGS = 100;
    // 位置情報関連のAPI群
    private FusedLocationProviderClient mFusedLocationClient;
    private SettingsClient mSettingsClient;
    private LocationRequest mLocationRequest;
    private LocationSettingsRequest mLocationSettingsRequest;
    private LocationCallback mLocationCallback;
    private Location mCurrentLocation;
    // UIを切り替えるためのフラグ
    private Boolean mRequestingLocationUpdates;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        // 必要なライブラリを初期化
        init();
        // 保存されたインスタンス状態から値を復元
        restoreValuesFromBundle(savedInstanceState);
    }
    private void init() {
        txtLocationResult = findViewById(R.id.location_result);
        txtUpdatedOn = findViewById(R.id.updated_on);
        btnStartUpdates = findViewById(R.id.btn_start_location_updates);
        btnStopUpdates = findViewById(R.id.btn_stop_location_updates);
        mFusedLocationClient = LocationServices.getFusedLocationProviderClient(this);
        mSettingsClient = LocationServices.getSettingsClient(this);
        mLocationCallback = new LocationCallback() {
            @Override
            public void onLocationResult(LocationResult locationResult) {
                super.onLocationResult(locationResult);
                // 位置情報を受信
                mCurrentLocation = locationResult.getLastLocation();
                mLastUpdateTime = DateFormat.getTimeInstance().format(new Date());
                updateLocationUI();
            }
        };
        mRequestingLocationUpdates = false;
        mLocationRequest = new LocationRequest();
        mLocationRequest.setInterval(UPDATE_INTERVAL_IN_MILLISECONDS);
        mLocationRequest.setFastestInterval(FASTEST_UPDATE_INTERVAL_IN_MILLISECONDS);
        mLocationRequest.setPriority(LocationRequest.PRIORITY_HIGH_ACCURACY);
        LocationSettingsRequest.Builder builder = new LocationSettingsRequest.Builder();
        builder.addLocationRequest(mLocationRequest);
        mLocationSettingsRequest = builder.build();
    }
/**
* 保存されたインスタンス状態から値を復元する
*/
    private void restoreValuesFromBundle(Bundle savedInstanceState) {
        if (savedInstanceState != null) {
            if (savedInstanceState.containsKey("is_requesting_updates")) {
                mRequestingLocationUpdates = savedInstanceState.getBoolean("is_requesting_updates");
            }
            if (savedInstanceState.containsKey("last_known_location")) {
                mCurrentLocation = savedInstanceState.getParcelable("last_known_location");
            }
            if (savedInstanceState.containsKey("last_updated_on")) {
                mLastUpdateTime = savedInstanceState.getString("last_updated_on");
            }
        }
        updateLocationUI();
    }
/**
* 位置情報データを表示し、ボタンの有効/無効を切り替えてUIを更新する
*/
    private void updateLocationUI() {
        if (mCurrentLocation != null) {
            txtLocationResult.setText(
                "Lat: " + mCurrentLocation.getLatitude() + ", " + "Lng: " + mCurrentLocation.getLongitude()
            );
            // TextViewに点滅アニメーションを付与
            txtLocationResult.setAlpha(0);
            txtLocationResult.animate().alpha(1).setDuration(300);
            // 最終更新時刻を表示
            txtUpdatedOn.setText("Last updated on: " + mLastUpdateTime);
        }
        toggleButtons();
    }
    @Override
    public void onSaveInstanceState(Bundle outState) {
        super.onSaveInstanceState(outState);
        outState.putBoolean("is_requesting_updates", mRequestingLocationUpdates);
        outState.putParcelable("last_known_location", mCurrentLocation);
        outState.putString("last_updated_on", mLastUpdateTime);
    }
    private void toggleButtons() {
        if (mRequestingLocationUpdates) {
            btnStartUpdates.setEnabled(false);
            btnStopUpdates.setEnabled(true);
        }
        else {
            btnStartUpdates.setEnabled(true);
            btnStopUpdates.setEnabled(false);
        }
    }
/**
* 位置情報の更新を開始する
* 位置情報の設定が満たされているか確認してから、
* 更新をリクエストする
*/
    private void startLocationUpdates() {
        mSettingsClient
        .checkLocationSettings(mLocationSettingsRequest)
        .addOnSuccessListener(this, new OnSuccessListener<LocationSettingsResponse>() {
            @SuppressLint("MissingPermission")
            @Override
            public void onSuccess(LocationSettingsResponse locationSettingsResponse) {
                Log.i(TAG, "All location settings are satisfied.");
                Toast.makeText(getApplicationContext(), "Started location updates!",
                Toast.LENGTH_SHORT).show();
                //noinspection MissingPermission
                mFusedLocationClient.requestLocationUpdates(mLocationRequest,
                mLocationCallback, Looper.myLooper());
                updateLocationUI();
            }
        })
        .addOnFailureListener(this, new OnFailureListener() {
            @Override
            public void onFailure(@NonNull Exception e) {
                int statusCode = ((ApiException) e).getStatusCode();
                switch (statusCode) {
                    case LocationSettingsStatusCodes.RESOLUTION_REQUIRED:
                    Log.i(TAG, "Location settings are not satisfied. Attempting to upgrade " +
"location settings ");
                    try {
                        // startResolutionForResult()を呼び出してダイアログを表示し、
                        // 結果はonActivityResult()で確認する
                        ResolvableApiException rae = (ResolvableApiException) e;
                        rae.startResolutionForResult(MainActivity.this, REQUEST_CHECK_SETTINGS);
                    }
                    catch (IntentSender.SendIntentException sie) {
                        Log.i(TAG, "PendingIntent unable to execute request.");
                    }
                    break;
                    case LocationSettingsStatusCodes.SETTINGS_CHANGE_UNAVAILABLE:
                    String errorMessage = "Location settings are inadequate, and cannot be " + "fixed here. Fix in Settings.";
                    Log.e(TAG, errorMessage);
                    Toast.makeText(MainActivity.this, errorMessage, Toast.LENGTH_LONG).show();
                }
                updateLocationUI();
            }
        });
    }
    public void startLocationButtonClick(View view) {
        // Dexterライブラリを使ってACCESS_FINE_LOCATIONを要求
        Dexter.withActivity(this)
        .withPermission(Manifest.permission.ACCESS_FINE_LOCATION)
        .withListener(new PermissionListener() {
            @Override
            public void onPermissionGranted(PermissionGrantedResponse response) {
                mRequestingLocationUpdates = true;
                startLocationUpdates();
            }
            @Override
            public void onPermissionDenied(PermissionDeniedResponse response) {
                if (response.isPermanentlyDenied()) {
                    // 権限が永久に拒否された場合は
                    // 端末の設定画面を開く
                    openSettings();
                }
            }
            @Override
            public void onPermissionRationaleShouldBeShown(PermissionRequest permission, PermissionToken token) {
                token.continuePermissionRequest();
            }
        }).check();
    }
    public void stopLocationButtonClick(View view) {
        mRequestingLocationUpdates = false;
        stopLocationUpdates();
    }
    public void stopLocationUpdates() {
        // 位置情報の更新を解除
        mFusedLocationClient
        .removeLocationUpdates(mLocationCallback)
        .addOnCompleteListener(this, new OnCompleteListener() {
            @Override
            public void onComplete(@NonNull Task task) {
                Toast.makeText(getApplicationContext(), "Location updates stopped!",
                Toast.LENGTH_SHORT).show();
                toggleButtons();
            }
        });
    }
    public void showLastKnownLocation(View view) {
        if (mCurrentLocation != null) {
            Toast.makeText(getApplicationContext(), "Lat: " + mCurrentLocation.getLatitude() + ", Lng: " + mCurrentLocation.getLongitude(), Toast.LENGTH_LONG).show();
        }
        else {
            Toast.makeText(getApplicationContext(), "Last known location is not available!",
            Toast.LENGTH_SHORT).show();
        }
    }
    @Override
    protected void onActivityResult(int requestCode, int resultCode, Intent data) {
        // startResolutionForResult()に渡したリクエストコードを確認
        if (requestCode == REQUEST_CHECK_SETTINGS) {
            switch (resultCode) {
                case Activity.RESULT_OK:
                Log.e(TAG, "User agreed to make required location settings changes.");
                // 特に何もしない。onResumeでstartLocationupdates()が再度呼ばれる。
                break;
                case Activity.RESULT_CANCELED:
                Log.e(TAG, "User chose not to make required location settings changes.");
                mRequestingLocationUpdates = false;
                break;
            }
        }
    }
    private void openSettings() {
        Intent intent = new Intent();
        intent.setAction(
        Settings.ACTION_APPLICATION_DETAILS_SETTINGS);
        Uri uri = Uri.fromParts("package",
        BuildConfig.APPLICATION_ID, null);
        intent.setData(uri);
        intent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
        startActivity(intent);
    }
    @Override
    public void onResume() {
        super.onResume();
        // ボタンの状態と許可された権限に応じて
        // 位置情報の更新を再開する
        if (mRequestingLocationUpdates && checkPermissions()) {
            startLocationUpdates();
        }
        updateLocationUI();
    }
    private boolean checkPermissions() {
        int permissionState = ActivityCompat.checkSelfPermission(this,
        Manifest.permission.ACCESS_FINE_LOCATION);
        return permissionState == PackageManager.PERMISSION_GRANTED;
    }
    @Override
    protected void onPause() {
        super.onPause();
        if (mRequestingLocationUpdates) {
            // 位置情報の更新を一時停止
            stopLocationUpdates();
        }
    }

ステップ4:build.gradleに依存関係を追加する(本題のポイント)

ここが本記事のテーマである依存関係の追加に該当する部分です。アプリレベルのbuild.gradleファイルを開き、dependenciesブロック内に以下の2行を追加してください。

// 位置情報Playサービス
implementation 'com.google.android.gms:play-services-location:17.0.0'
// Dexter ランタイム権限ライブラリ
implementation 'com.karumi:dexter:4.2.0'

コードを追記したら、エディタの右上に表示される「Sync Now」をクリックしてGradleとの同期を実行します。同期が完了すると、追加したライブラリをプロジェクト内で利用できるようになります。

• play-services-location: Google Play開発者サービスが提供する位置情報API。高精度な現在地の取得や、位置情報の継続的な更新に使用します。
• dexter: ACCESS_FINE_LOCATIONなどの実行時パーミッションをシンプルかつ直感的に扱えるようにする人気のライブラリです。

ステップ5:AndroidManifest.xmlに権限を宣言する

androidManifest.xmlに以下のコードを追加し、位置情報パーミッションを明示的に宣言します。

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="https://schemas.android.com/apk/res/android"
    package="app.com.sample">
    <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"/>
    <application
        android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:roundIcon="@mipmap/ic_launcher_round"
        android:supportsRtl="true"
        android:theme="@style/AppTheme">
        <activity android:name=".MainActivity">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />
                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>
    </application>
</manifest>

アプリを実行して動作を確認する

それでは、アプリケーションを実行してみましょう。実際のAndroidスマートフォンがパソコンに接続されていることを前提として説明します。Android Studioからアプリを実行するには、プロジェクト内のアクティビティファイルをどれか開き、ツールバーのRunアイコンをクリックします。表示されたダイアログで接続中のモバイルデバイスを選択すると、端末にアプリの初期画面が表示されます。