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

Compose の方法を試す

Jetpack Compose は、Android で推奨される UI ツールキットです。Compose でテキストを使用する方法について学習します。

ダウンロード可能なフォント →

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

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

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

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

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

基本情報

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

• Android Studio と Google Play 開発者サービスを使用
• プログラムを介して使用する
• AndroidX Core ライブラリの使用

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

Android Studio 3.0 以降を使用して、アプリがフォントをダウンロードするように設定できます。ダウンロード可能なフォント機能を利用するにあたっては、Google Play 開発者サービスのフォント プロバイダを使用できます。

1. Layout Editor で TextView を選択します。[Attributes] で、[fontFamily] > [More Fonts] を選択します。

   

   [リソース] ウィンドウが表示されます。
2. [ソース] メニューで [Google Fonts] を選択します。
3. [Fonts] ボックスの [Downloadable] 領域でフォントを選択します。
4. [Create downloadable font] を選択して [OK] をクリックします。

   

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

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

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

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

• android.graphics.fonts.FontRequest: このクラスを使用すると、フォント リクエストを作成できます。
• FontsContractCompat: このクラスを使用すると、フォント リクエストに基づいて新しい Typeface オブジェクトを作成できます。

アプリは、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 クラスのインスタンス
   • フォント リクエストの結果を受け取るコールバック
   • スレッド上のフォントを取得するハンドラ

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

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)

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 ファイルに次の依存関係を追加します。

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

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

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

Android 8.0（API レベル 26）と AndroidX Core では、カスタム フォントを XML レイアウトのリソースとしてすばやく簡単に宣言できるため、つまり、フォントをアセットとしてバンドルする必要はありません。テーマ全体にカスタム フォントを定義できます。Bold、Medium、Light など、複数のウェイトとスタイルがあれば、それによってユーザビリティが向上します。

1. res/font フォルダに新しい XML ファイルを作成します。
2. 次のサンプル XML ファイルに示すように、<font-family> ルート要素を追加してフォント関連の属性を設定します。

<?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 にリソース配列を作成し、プリフェッチするフォントを宣言します。

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 タグを使用して、マニフェストでリソース配列を宣言します。

<meta-data android:name="preloaded_fonts" android:resource="@array/preloaded_fonts" />

証明書を追加する

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

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

1. 証明書の詳細を含む文字列配列を作成します。証明書の詳細については、フォント プロバイダのドキュメントをご覧ください。

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <string-array name="certs">
       <item>MIIEqDCCA5CgAwIBAgIJA071MA0GCSqGSIb3DQEBBAUAMIGUMQsww...</item>
    </string-array>
</resources>

2. fontProviderCerts 属性を配列に設定します。

android:fontProviderCerts="@array/certs"

Compose のダウンロード可能なフォント