Support Library のセットアップ

開発プロジェクトで Android Support Library をセットアップする方法は、使用する機能と、アプリでサポートする Android プラットフォーム バージョンの範囲によって異なります。

このドキュメントでは、Support Library パッケージをダウンロードして、開発環境にライブラリを追加する手順について説明します。

Support Library のダウンロード

Android Support Repository パッケージは Android SDK を補完するものであり、Android SDK Manager からダウンロードできます。Support Library ファイルを入手するには、以下の手順を実行します。

SDK Manager から Support Library をダウンロードする方法:

  1. Android SDK Manager を起動します。
  2. [SDK Manager] ウィンドウで [Packages] リストを番下までスクロールし、「Extras」フォルダを探して、必要に応じてコンテンツが表示されるように展開します。
  3. [Android Support Repository] アイテムを選択します。
  4. [Install packages...] ボタンをクリックします。

図 1. Android SDK Manager で [Android Support Repository] が選択されている

ダウンロードが完了すると、既存の Android SDK ディレクトリに Support Library がインストールされます。ライブラリ ファイルは、SDK のサブディレクトリである <sdk>/extras/android/m2repository/com/android/support/ ディレクトリ内に格納されます。

Support Library の選択

Support Library をアプリに追加する前に、含める機能と、どの Android バージョン以降をサポートするのかを決めます。さまざまなライブラリで提供されている機能については、Support Library の機能をご覧ください。

Support Library の追加

Support Library を使用するには、開発環境内でプロジェクトのクラスパスの依存関係を変更する必要があります。使用する Support Library ごとにこの手順を実行します。

アプリのプロジェクトに Support Library を追加するには:

  1. SDK Manager を使用して Android Support Repository がダウンロードできたことを確認します。
  2. アプリの build.gradle ファイルを開きます。
  3. Support Library を dependencies セクションに追加します。たとえば、v4 core-utils ライブラリを追加するには、次の行を追加します。
    dependencies {
        ...
        compile "com.android.support:support-core-utils:24.2.0"
    }
    

警告: 動的依存関係(palette-v7:23.0.+ など)を使用すると、予期しないバージョンのアップデートや退行による非互換性の問題が発生する可能性があります。そのため、ライブラリのバージョン(palette-v7:24.2.0 など)を明示的に指定することをお勧めします。

Support Library API の使用

既存のフレームワーク API 向けのサポートを提供する Support Library クラスは通常、フレームワーク クラスと同じ名前が付けられていますが、android.support クラス パッケージに配置されているか、末尾に *Compat が付いています。

警告: Support Library のクラスを使用するときは、必ず適切なパッケージからクラスをインポートしてください。たとえば、ActionBar クラスを提供する場合は次のようになります。

  • Support Library を使用するときは android.support.v7.app.ActionBar
  • API レベル 11 以上のみを対象に開発するときは android.app.ActionBar

注: アプリ プロジェクトに Support Library を追加した後は、アプリの APK のリリースに備えて ProGuard ツールを使用することをお勧めします。ProGuard ツールはソース コードの保護に加えて、アプリに追加したどのライブラリからも使用されていないクラスを削除し、アプリのダウンロード サイズを最小限に抑えることができます。詳細については、ProGuard をご覧ください。

Support Library 機能の使用に関する詳細は、Android デベロッパー トレーニング クラスガイド、サンプルをご覧ください。Support Library の個々のクラスやメソッドについては、API リファレンスの android.support パッケージをご覧ください。

マニフェストの宣言の変更

Support Library を使用して、既存アプリの下位互換性を以前のバージョンの Android API にまで広げる場合は、必ずアプリのマニフェストを更新してください。特に、以下に示すマニフェストの <uses-sdk> タグの android:minSdkVersion 要素を、新しい下位のバージョン番号に更新する必要があります。

  <uses-sdk
      android:minSdkVersion="14"
      android:targetSdkVersion="23" />

このマニフェストの設定は、アプリが Android 4.0(API レベル 14)以上を搭載する端末にインストール可能であることを Google Play に示します。

Gradle ビルドファイルを使用している場合、マニフェストの設定よりもビルドファイル内の minSdkVersion の設定が優先されます。

apply plugin: 'com.android.application'

android {
    ...

    defaultConfig {
        minSdkVersion 16
        ...
    }
    ...
}

この例のビルド ファイルの設定では、アプリのデフォルトのビルド バリアントが Android 4.1(API レベル 16)以上を搭載する端末にインストール可能であることを Google Play に示します。ビルド バリアントの詳細については、ビルド システムの概要をご覧ください。

注: 複数の Support Library を追加する場合は、最低 SDK バージョンには、指定したライブラリで必要な最高のバージョンを指定する必要があります。たとえば、アプリに v14 Preference Support libraryv17 Leanback library の両方を追加する場合は、最低 SDK バージョンを 17 以上にしてください。