ダウンロード可能なフォントを使用する

Compose をお試しください
Jetpack Compose は、Android で推奨される UI ツールキットです。Compose でテキストを使用する方法をご覧ください。
ダウンロード可能フォント →

ダウンロード可能フォント機能を使用すると、API は、アプリにファイルをバンドルしたり、アプリにフォントをダウンロードさせたりする代わりに、プロバイダ アプリケーションにフォントをリクエストできます。ダウンロード可能なフォントは、AndroidX Core ライブラリを介して、Android API バージョン 14 以降を搭載しているデバイスで利用できます。

ダウンロード可能なフォントには、次のようなメリットがあります。

  • アプリのサイズが小さくなり、インストール成功率が上がる。
  • 複数のアプリがプロバイダを介して同じフォントを共有できるので、システム全体の健全性が向上する。これにより、ユーザーのモバイルデータ、スマートフォンのメモリ、ディスク容量を節約できます。このモデルでは、必要に応じてフォントがネットワーク経由で取得されます。
ダウンロード可能フォントを実際に試すには、DownloadableFonts サンプルアプリをご覧ください。

ダウンロード可能なフォントの仕組み

フォント プロバイダは、フォントを取得してローカルにキャッシュに保存するアプリケーションです。これにより、他のアプリがフォントをリクエストして共有できるようになります。次の図に、このプロセスを示します。

EmojiCompat プロセスの主なコンポーネントを示す画像
図 1. ダウンロード可能フォントのプロセス。

基本情報

ダウンロード可能なフォント機能は、次の方法で使用できます。個々の方法については、以降のセクションで詳しく説明します。

Android Studio と Google Play 開発者サービスでダウンロード可能なフォントを使用する

Android Studio 3.0 以降を使用すると、フォントをダウンロードするようにアプリを設定できます。ダウンロード可能なフォント機能をすぐに使い始められるように、Google Play 開発者サービスのフォント プロバイダを使用できます。

  1. Layout Editor で、TextView を選択します。[Attributes] で、[fontFamily] > [More Fonts] を選択します。
    Android Studio Layout Editor を示す画像
    図 2. Layout Editor を使用します。
    [Resources] ウィンドウが表示されます。
  2. [ソース] メニューで [Google Fonts] を選択します。
  3. [フォント] ボックスで、[ダウンロード可能] 領域のフォントを選択します。
  4. [Create downloadable font] を選択して、[OK] をクリックします。
    [Resources] ウィンドウからフォントを選択する方法を示す画像
    図 3. [Resources] ウィンドウからフォントを選択する。

    5. アプリでフォントを正しくレンダリングするために必要な関連 XML ファイルを Android Studio が自動的に生成します。

    フォントをプレビューする方法を示す画像
    図 4. フォント ファイルをプレビューしています。

プログラムを介してダウンロード可能なフォントを使用する

Android 8.0（API レベル 26）以降、AndroidX Core はダウンロード可能なフォントを完全にサポートしています。AndroidX Core ライブラリの使用方法について詳しくは、このページのダウンロード可能なフォントの AndroidX Core ライブラリ セクションをご覧ください。

プログラムを介してダウンロード可能なフォント機能を使用するには、次の 2 つの主要なクラスを操作します。

アプリは、FontsContract API を使用してフォント プロバイダからフォントを取得します。各プロバイダには、サポートする Android のバージョンとクエリ言語に関する独自の制限があります。Android のバージョンとクエリ形式の詳細については、プロバイダのドキュメントをご覧ください。

フォントをダウンロードする手順は次のとおりです。

  1. android.graphics.fonts.FontRequest クラスのインスタンスを作成して、プロバイダにフォントをリクエストします。リクエストを作成するには、次のパラメータを渡します。
    • フォント プロバイダの権限。
    • プロバイダの ID を確認するためのフォント プロバイダ パッケージ
    • フォントの文字列クエリ。クエリ形式の詳細については、Google Fonts など、フォント プロバイダのドキュメントをご覧ください。
    • プロバイダの ID を確認するための、証明書のハッシュセットのリスト。

    Kotlin

    val request = FontRequest(
        "com.example.fontprovider.authority",
        "com.example.fontprovider",
        "my font",
        certs
)

    Java

    FontRequest request = new FontRequest("com.example.fontprovider",
                   "com.example.fontprovider", "my font", certs);
  2. FontsContract.FontRequestCallback クラスのインスタンスを作成します。
  3. onTypefaceRetrieved() メソッドをオーバーライドして、フォント リクエストが完了したことを示します。取得したフォントをパラメータとして指定します。 このメソッドを使用して、必要に応じてフォントを設定できます。たとえば、TextView でフォントを設定できます。
  4. onTypefaceRequestFailed() メソッドをオーバーライドして、フォント リクエスト プロセスでのエラーに関する情報を受け取ります。エラーコードの詳細については、エラーコード定数をご覧ください。
  5. FontsContract.requestFont() メソッドを呼び出して、フォント プロバイダからフォントを取得します。このメソッドは、フォントがキャッシュに存在するかどうかを判断するチェックを開始します。フォントがローカルで使用できない場合は、フォント プロバイダを呼び出し、フォントを非同期で取得して、結果をコールバックに渡します。次のパラメータを渡します。
    • Context クラスのインスタンス
    • android.graphics.fonts.FontRequest クラスのインスタンス
    • フォント リクエストの結果を受け取るコールバック
    • スレッドでフォントを取得するハンドラ

次のサンプルコードは、ダウンロード可能なフォントのプロセス全体を示しています。

Kotlin

val request = FontRequest(
        "com.example.fontprovider.authority",
        "com.example.fontprovider",
        "my font",
        certs
)
val callback = object : FontsContract.FontRequestCallback() {

    override fun onTypefaceRetrieved(typeface: Typeface) {
        // Your code to use the font goes here.
        ...
    }

    override fun onTypefaceRequestFailed(reason: Int) {
        // Your code to deal with the failure goes here.
        ...
    }
}
FontsContract.requestFonts(context, request, handler, null, callback)

Java

FontRequest request = new FontRequest("com.example.fontprovider.authority",
        "com.example.fontprovider", "my font", certs);
FontsContract.FontRequestCallback callback =
    new FontsContract.FontRequestCallback() {
        @Override
        public void onTypefaceRetrieved(Typeface typeface) {
            // Your code to use the font goes here.
            ...
        }

        @Override
        public void onTypefaceRequestFailed(int reason) {
            // Your code to deal with the failure goes here.
            ...
        }
};
FontsContract.requestFonts(context, request, handler, null, callback);

フォント プロバイダからフォントをダウンロードする方法について詳しくは、DownloadableFonts サンプルアプリをご覧ください。

AndroidX Core でダウンロード可能なフォントを使用する

AndroidX Core は、Android API バージョン 14 以降を搭載しているデバイスで、ダウンロード可能なフォント機能をサポートします。androidx.core.provider パッケージには、下位互換性のあるダウンロード可能なフォント機能のサポートを実装するクラス FontsContractCompat および FontRequest が含まれています。AndroidX クラスにはフレームワーク メソッドに似たメソッドが含まれており、フォントをダウンロードするプロセスは、このページのプログラムを介してダウンロード可能なフォントを使用するセクションで説明されているプロセスに似ています。

AndroidX を使用してフォントをダウンロードするには、androidx.core.provider パッケージから FontsContractCompat クラスと FontRequest クラスをインポートします。FontsContract フレームワーク クラスと android.graphics.fonts.FontRequest フレームワーク クラスの代わりに、これらのクラスのインスタンスを作成します。

AndroidX Core の依存関係を追加する

FontsContractCompat クラスと FontRequest クラスを使用するには、開発環境内でアプリ プロジェクトのクラスパスの依存関係を変更する必要があります。

アプリケーション プロジェクトに AndroidX Core を追加するには、アプリの build.gradle ファイルに次の依存関係を追加します。

Groovy

dependencies {
    ...
    implementation "androidx.core:core-ktx:1.19.1"
}

Kotlin

dependencies {
    ...
    implementation("androidx.core:core-ktx:1.19.1")
}

ダウンロード可能なフォントを XML のリソースとして使用する

Android 8.0（API レベル 26）と AndroidX Core には、カスタム フォントを XML レイアウトのリソースとして迅速かつ簡単に宣言する方法が用意されています。つまり、フォントをアセットとしてバンドルする必要はありません。カスタム フォントはテーマ全体に対して定義できるため、Bold、Medium、Light といった複数のウェイトとスタイルが提供されている場合、それらが使いやすくなります。

  1. res/font フォルダに新しい XML ファイルを作成します。
  2. 次の XML ファイルの例に示すように、<font-family> ルート要素を追加し、フォント関連の属性を設定します。
    3. <?xml version="1.0" encoding="utf-8"?>
<font-family xmlns:android="http://schemas.android.com/apk/res/android"
        android:fontProviderAuthority="com.example.fontprovider.authority"
        android:fontProviderPackage="com.example.fontprovider"
        android:fontProviderQuery="example font"
        android:fontProviderCerts="@array/certs">
</font-family>
  3. レイアウト XML ファイルで、このファイルを @font/font_file_name として参照します。getFont() メソッドを使用して、getFont(R.font.font_file_name) などのファイルをプログラムで取得することもできます。

マニフェストでフォントを事前宣言する

レイアウトのインフレーションとリソースの取得は同期タスクです。デフォルトでは、フォントを取得する最初の試行でフォント プロバイダへのリクエストがトリガーされるため、最初のレイアウト時間が長くなります。この遅延を回避するには、取得する必要があるフォントをマニフェストで事前に宣言します。システムがプロバイダからフォントを取得すると、すぐに使用できるようになります。フォントの取得に想定以上の時間がかかると、システムは取得プロセスを中止し、デフォルトのフォントを使用します。

マニフェストでフォントを事前宣言する手順は次のとおりです。

  1. res/values/arrays.xml にリソース配列を作成し、プリフェッチするフォントを宣言します。
    2. res/values/arrays.xml
<?xml version="1.0" encoding="utf-8"?>
<resources>
    <array name="preloaded_fonts">
        <item>@font/font1</item>
        <item>@font/font2</item>
    </array>
</resources>
  2. meta-data タグを使用して、マニフェストでリソース配列を宣言します。
    3. <meta-data android:name="preloaded_fonts" android:resource="@array/preloaded_fonts" />

証明書の追加

フォント プロバイダがプリインストールされていない場合、または AndroidX Core ライブラリを使用している場合は、フォント プロバイダが署名されている証明書を宣言します。システムは、証明書を使用してフォント プロバイダの ID を確認します。

証明書を追加するには、次の手順に従います。

  1. 証明書の詳細を含む文字列配列を作成します。証明書の詳細については、フォント プロバイダのドキュメントをご覧ください。
    2. <?xml version="1.0" encoding="utf-8"?>
<resources>
    <string-array name="certs">
       <item>MIIEqDCCA5CgAwIBAgIJA071MA0GCSqGSIb3DQEBBAUAMIGUMQsww...</item>
    </string-array>
</resources>
  2. fontProviderCerts 属性を配列に設定します。
    3. android:fontProviderCerts="@array/certs"