Webkit

API リファレンス
androidx.webkit

Android 5 以上で、最新の WebView API を操作します。

最新の更新	安定版リリース	リリース候補版	ベータ版リリース	アルファ版リリース
2023 年 2 月 8 日	1.6.0	-	-	1.7.0-alpha02

依存関係の宣言

Webkit への依存関係を追加するには、Google の Maven リポジトリをプロジェクトに追加する必要があります。詳しくは、Google の Maven リポジトリをご覧ください。

アプリまたはモジュールの build.gradle ファイルに、必要なアーティファクトの依存関係を追加します。

Groovy

dependencies {
    implementation "androidx.webkit:webkit:1.6.0"
}

Kotlin

dependencies {
    implementation("androidx.webkit:webkit:1.6.0")
}

依存関係について詳しくは、ビルド依存関係の追加をご覧ください。

フィードバック

お寄せいただいたフィードバックは Jetpack 改善の参考にさせていただきます。新しい問題が見つかった場合や、このライブラリを改善するアイデアをお持ちの場合は、お知らせください。新しい問題を報告していただく前に、このライブラリの既存の問題をご確認ください。スターボタンをクリックすると、既存の問題に投票できます。

新しい問題を報告する

詳細については、Issue Tracker のドキュメントをご覧ください。

バージョン 1.7

バージョン 1.7.0-alpha02

2023 年 2 月 8 日

androidx.webkit:webkit:1.7.0-alpha02 がリリースされました。バージョン 1.7.0-alpha02 に含まれる commit については、こちらをご覧ください。

バグの修正

DropDataContentProvider のドキュメントに関するバグ。

バージョン 1.7.0-alpha01

2023 年 1 月 25 日

androidx.webkit:webkit:1.7.0-alpha01 がリリースされました。バージョン 1.7.0-alpha01 に含まれる commit については、こちらをご覧ください。

新機能

WebView で画像のドラッグが可能になります。新しい DropDataContentProvider をアプリのマニフェストに追加することで、ユーザーが WebView から画像をドラッグできるようになります。（05a1a6）

バージョン 1.6

バージョン 1.6.0

2023 年 1 月 25 日

androidx.webkit:webkit:1.6.0 がリリースされました。バージョン 1.6.0 に含まれる commit については、こちらをご覧ください。

1.5.0 以降の重要な変更

新しい ProcessGlobalConfig API を追加しました。これによりアプリで、WebView の読み込み前に指定する必要のある構成設定（WebView データディレクトリサフィックスなど）を提供できるようになります。この構成のセットアップと適用は、他のスレッドが WebView をプロセスに読み込むメソッドを呼び出す前に行う必要があります。そのため、アプリ起動時のできるだけ早い段階に組み込んでください。
新しい CookieManagerCompat API を追加しました。これにより、新しい getCookieInfo メソッドで android.webkit.CookieManager が拡張され、特定の URL に設定されているすべての Cookie の属性をすべて取得できるようになります。この API は、Cookie の名前と値の属性のみを返す CookieManager の既存の getCookie API とは異なります。
WebSettingsCompat の新しいメソッドで、EnterpriseAuthenticationAppLinkPolicy（WebView で管理者が設定した場合）の効果を有効または無効にすることや、現在の設定を取得することが可能になりました。この機能により、WebView で認証 URL を開く代わりに認証アプリを開くことができます。この機能は、エンタープライズポリシーで管理されていないデバイスには影響を及ぼしません。
新しい API を WebSettingsCompat に追加します。これにより、アプリパッケージ名を X-Requested-With ヘッダー経由で、許可リストに登録された送信元に明示的に送信できるようになります。このヘッダーは従来、WebView からのリクエストのたびに送信されていました。

バージョン 1.6.0-rc01

2023 年 1 月 11 日

androidx.webkit:webkit:1.6.0-rc01 がリリースされました。バージョン 1.6.0-rc01 に含まれる commit については、こちらをご覧ください。

バグの修正

L より前の SDK で実行した場合の WebViewFeature.isStartupFeatureSupported(Context, String) の NullPointerException を修正しました。（Ic7292）

バージョン 1.6.0-beta01

2022 年 12 月 7 日

androidx.webkit:webkit:1.6.0-beta01 がリリースされました。バージョン 1.6.0-beta01 に含まれる commit については、こちらをご覧ください。

API の変更

ProcessGlobalConfig が変更され、通常のコンストラクタと静的 apply メソッドが使用されるようになりました。apply メソッドはできるだけ早く、プロセスごとに 1 回だけ呼び出します。2 回以上呼び出すと IllegalStateException がスローされます。ProcessGlobalConfig オブジェクトでは、セッターを呼び出す回数に制限がなくなりました。（I456c3）

バージョン 1.6.0-alpha03

2022 年 11 月 9 日

androidx.webkit:webkit:1.6.0-alpha03 がリリースされました。バージョン 1.6.0-alpha03 に含まれる commit については、こちらをご覧ください。

新機能

ProcessGlobalConfig クラスを追加しました。これにより、ユーザーは WebView を読み込む前にプロセスグローバル構成を設定できます。WebView に含まれるプロセスグローバル構成パラメータの一部は、WebView の読み込み後に変更できません（WebView データディレクトリなど）。このクラスを使用すると、それらのパラメータをアプリで設定できます。この構成のセットアップと適用は、他のスレッドが WebView をプロセスに読み込むメソッドを呼び出す前に行う必要があります。そのため、アプリ起動時のできるだけ早い段階に組み込んでください。（I7c0e0、b/250553687）
アプリパッケージ名を X-Requested-With ヘッダー経由で、許可リストに登録された送信元に明示的に送信できる新しい API を追加します。このヘッダーは従来、WebView からのリクエストのたびに送信されていました。（I0adfe、b/226552535）

API の変更

WebSettingsCompat#setAlgorithmicDarkeningAllowed API は WebView バージョン 105 以降、すべての Android バージョンでサポートされます。以前のバージョンの WebView では、この API は Android Q 以降でのみサポートされていました。したがって、この API は @RequiresApi(Build.VERSION_CODES.Q) としてマークされなくなります。（I3ac1d）

バージョン 1.6.0-alpha02

2022 年 10 月 24 日

androidx.webkit:webkit:1.6.0-alpha02 がリリースされました。バージョン 1.6.0-alpha02 に含まれる commit については、こちらをご覧ください。

新機能

新しい CookieManagerCompat クラスと、特定の URL に設定されているすべての Cookie のすべての属性を取得する getCookieInfo API を追加しました。この API は、Cookie の名前と値の属性のみを返す CookieManager の既存の getCookie API とは異なります。（I07365、b/242161756）

バージョン 1.6.0-alpha01

2022 年 8 月 24 日

androidx.webkit:webkit:1.6.0-alpha01 がリリースされました。バージョン 1.6.0-alpha01 に含まれる commit については、こちらをご覧ください。

新機能

WebSettingsCompat に API を追加しました。これは、WebView で管理者が設定した場合に EnterpriseAuthenticationAppLinkPolicy の効果を有効または無効にできるようにするものです。この機能により、WebView は認証 URL を開く代わりに、認証アプリを開くことができます。この機能は、エンタープライズポリシーで管理されていないデバイスには影響を及ぼしません。

バージョン 1.5.0

2022 年 8 月 24 日

androidx.webkit:webkit:1.5.0 がリリースされました。バージョン 1.5.0 に含まれる commit については、こちらをご覧ください。

1.4.0 以降の重要な変更

WebSettingsCompat の新しい setAlgorithmicDarkeningAllowed API は、以前の setForceDark API と setForceDarkStrategy API に代わるものです。SDK 33 以上（T）をターゲットとするアプリでは、この新しい API を使用する必要があります。以前の API はこれらのアプリに対して機能しなくなります。
設定済みのプロキシを使用するための URL の許可リストは、setReverseBypassEnabled を true に設定することで ProxyCofig.Builder から設定できるようになりました。その場合、他のすべての URL はそのプロキシをバイパスします。

バージョン 1.5.0-rc01

2022 年 8 月 10 日

androidx.webkit:webkit:1.5.0-rc01 がリリースされました。1.5.0-beta01 からの変更はありません。バージョン 1.5.0-rc01 に含まれる commit については、こちらをご覧ください。

バージョン 1.5.0-beta01

2022 年 6 月 29 日

androidx.webkit:webkit:1.5.0-beta01 がリリースされました。バージョン 1.5.0-beta01 に含まれる commit については、こちらをご覧ください。

API の変更

アルゴリズムによるダークニング関連の API に API レベル Q を必要とする旨アノテーションが付くようになりました。Q 以前の API レベルでは、ダークモードがデバイスで使用できないため、この API による効果はありません。（I0905e）

バージョン 1.5.0-alpha01

2022 年 5 月 18 日

androidx.webkit:webkit:1.5.0-alpha01 がリリースされました。バージョン 1.5.0-alpha01 に含まれる commit については、こちらをご覧ください。

新機能

WebViewCompat に新しい getVariationsHeader() メソッドを追加しました。このメソッドは、WebView によって送信される X-Client-Data ヘッダー値を取得します。戻り値は、base64 エンコードされた ClientVariations protobuf です。
targetSdk が 33 以上のアプリでアルゴリズムによるダークニングを許可 / 禁止するため、WebSettingsCompat に API を追加しました。（I29597）

API の変更

逆方向のバイパスを設定する新しいメソッドを ProxyCofig.Builder に追加しました。逆方向のバイパスを true に設定すると、バイパスリストに含まれる URL のみがプロキシ設定を使用するようになります。（I9eaa2、b/168728599）

バグの修正

ダークモードのドキュメントのスペルミスを修正しました。（I36ebf、b/194343633）
WebViewAssetLoader.Builder メソッドが意図せず順序に依存するバグを修正しました。（If420d、b/182196765）

バージョン 1.4.0

2020 年 12 月 16 日

androidx.webkit:webkit:1.4.0 がリリースされました。バージョン 1.4.0 に含まれる commit については、こちらをご覧ください。

1.3.0 以降の主な変更

setSafeBrowsingWhitelist() に代わる新しい setSafeBrowsingAllowlist() API を追加しました。これにより、サポートが終了した API と同じ範囲の Android SDK バージョンと WebView バージョンをサポートしつつ、差別的な用語を避けるためにアプリのコードを更新できます。
setProxyOverride でフォールバックルールが正しく適用されないバグを修正しました。

バージョン 1.4.0-rc02

2020 年 12 月 2 日

androidx.webkit:webkit:1.4.0-rc02 がリリースされました。バージョン 1.4.0-rc02 に含まれる commit については、こちらをご覧ください。

バグの修正

setProxyOverride を使用したときにフォールバックルールが正しく適用されないバグを修正しました。

バージョン 1.4.0-rc01

2020 年 11 月 11 日

androidx.webkit:webkit:1.4.0-rc01 がリリースされました。1.4.0-beta01 からの変更はありません。バージョン 1.4.0-rc01 に含まれる commit については、こちらをご覧ください。

バージョン 1.4.0-beta01

2020 年 10 月 14 日

androidx.webkit:webkit:1.4.0-beta01 がリリースされました。1.4.0-alpha01 からの変更はありません。バージョン 1.4.0-beta01 に含まれる commit については、こちらをご覧ください。

バージョン 1.4.0-alpha01

2020 年 9 月 16 日

androidx.webkit:webkit:1.4.0-alpha01 がリリースされました。バージョン 1.4.0-alpha01 に含まれる commit については、こちらをご覧ください。

API の変更

setSafeBrowsingWhitelist() に代わる新しい WebViewCompat#setSafeBrowsingAllowlist() API を追加しました。これにより、サポートが終了した API と同じ範囲の Android SDK バージョンと WebView バージョンをサポートしつつ、差別的な用語を避けるためにアプリのコードを更新できます。（I8d65d）

バージョン 1.3.0

2020 年 8 月 19 日

androidx.webkit:webkit:1.3.0 がリリースされました。バージョン 1.3.0 に含まれる commit については、こちらをご覧ください。

1.2.0 以降の主な変更

ForceDarkStrategy API により WebView ダークニング（CSS / ウェブコンテンツのダークニング対自動ダークニング）の制御が強化されました。
WebMessageListener API とその関連 API は、ウェブコンテンツと WebView 埋め込みアプリ間の通信を確立するためのシンプルで安全なメカニズムを提供します。
isMultiProcessEnabled API を使用して、WebView がマルチプロセスで実行されているかどうかを確認します。これは Android O 以降で可能です。ウェブコンテンツは、アプリプロセスとは別のサンドボックスレンダラプロセスでレンダリングされます。このサンドボックス化されたレンダラは、同じアプリの他の WebView と共有できますが、他のアプリプロセスとは共有されません。

バージョン 1.3.0-rc02

2020 年 8 月 5 日

androidx.webkit:webkit:1.3.0-rc02 がリリースされました。バージョン 1.3.0-rc02 に含まれる commit については、こちらをご覧ください。

バグの修正

ローカルでの開発中にアプリを Android Studio Instant Run で開始した場合に WebMessageListener がクラッシュすることがある互換性の問題を修正しました。

バージョン 1.3.0-rc01

2020 年 6 月 24 日

androidx.webkit:webkit:1.3.0-rc01 がリリースされました。1.3.0-beta01 からの変更はありません。バージョン 1.3.0-rc01 に含まれる commit については、こちらをご覧ください。

バージョン 1.3.0-beta01

2020 年 6 月 10 日

androidx.webkit:webkit:1.3.0-beta01 がリリースされました。バージョン 1.3.0-beta01 に含まれる commit については、こちらをご覧ください。

新機能

WebView ダークニング（CSS / ウェブコンテンツのダークニング対自動ダークニング）を制御する ForceDarkStrategy API。
WebMessageListener API は、ウェブコンテンツと WebView 埋め込みアプリ間の通信を確立するためのシンプルで安全なメカニズムを提供します。
MultiProcessEnabled API を使用して、WebView がマルチプロセスモードで実行されているかどうかを確認します。

バージョン 1.3.0-alpha03

2020 年 5 月 27 日

androidx.webkit:webkit:1.3.0-alpha03 がリリースされました。バージョン 1.3.0-alpha03 に含まれる commit については、こちらをご覧ください。

API の変更

addWebMessageListener メソッドが、許可されているオリジンのルールの Set<String> を受け取るようになりました（以前は List<String> でした）。

バージョン 1.3.0-alpha02

2020 年 4 月 29 日

androidx.webkit:webkit:1.3.0-alpha02 がリリースされました。バージョン 1.3.0-alpha02 に含まれる commit については、こちらをご覧ください。

新機能

MultiProcessEnabled API を使用して、WebView がマルチプロセスモードで実行されているかどうかを確認します。

API の変更

すべてのダークストラテジー定数に DARK_STRATEGY プレフィックスが付きました。

バージョン 1.3.0-alpha01

2020 年 4 月 15 日

androidx.webkit:webkit:1.3.0-alpha01 がリリースされました。バージョン 1.3.0-alpha01 に含まれる commit については、こちらをご覧ください。

新機能

WebView ダークニング（CSS/ウェブコンテンツのダークニング対自動ダークニング）を制御する ForceDarkStrategy API。
WebMessageListener API は、ウェブコンテンツと WebView 埋め込みアプリ間の通信を確立するためのシンプルで安全なメカニズムを提供します。

バージョン 1.2.0

2020 年 3 月 4 日

androidx.webkit:webkit:1.2.0 がリリースされました。バージョン 1.2.0 に含まれる commit については、こちらをご覧ください。

1.1.0 以降の主な変更

WebView をダークモードでレンダリングするかどうかを制御する ForceDark API を追加しました。

バージョン 1.2.0-rc01

2020 年 2 月 19 日

androidx.webkit:webkit:1.2.0-rc01 がリリースされました。1.2.0-beta01 からの変更はありません。バージョン 1.2.0-rc01 に含まれる commit については、こちらをご覧ください。

バージョン 1.2.0-beta01

2020 年 2 月 5 日

androidx.webkit:webkit:1.2.0-beta01 がリリースされました。1.2.0-alpha01 からの変更はありません。バージョン 1.2.0-beta01 に含まれる commit については、こちらをご覧ください。

バージョン 1.2.0-alpha01

2019 年 12 月 18 日

androidx.webkit:webkit:1.2.0-alpha01 がリリースされました。バージョン 1.2.0-alpha01 に含まれる commit については、こちらをご覧ください。

新機能

WebView をダークモードでレンダリングするかどうかを制御する ForceDark API。

バージョン 1.1.0

2019 年 11 月 7 日

androidx.webkit:webkit:1.1.0 がリリースされました。バージョン 1.1.0 に含まれる commit については、こちらをご覧ください。

1.0.0 以降の重要な変更

setWebViewClient() と setWebChromeClient() を補完する Getter API
アプリの WebView のネットワークリクエストプロキシを設定する ProxyController API
リクエストのインターセプトを介してアプリデータディレクトリからの APK アセット、リソース、ファイルの読み込みを簡素化する WebViewAssetLoader API。これにより、CORS を無効にすることなくウェブリソースとローカルリソースにアクセスできます。
デバッグ目的で WebView トレース情報を収集する TracingController API
WebView レンダラサービスを管理し、動作の不完全なコンテンツによって WebView レンダラが応答しなくなったことを検出する、RenderProcess API
既存の API を更新し、null 可能性アノテーション（@NonNull、@Nullable）とスレッドアノテーション（@UiThread、@WorkerThread）を追加しました。

バージョン 1.1.0-rc01

2019 年 10 月 9 日

androidx.webkit:webkit:1.1.0-rc01 がリリースされました。バージョン 1.1.0-rc01 に含まれる commit については、こちらをご覧ください。

バグの修正

null クライアントが渡されると setWebViewRenderProcessClient() がクラッシュすることがある問題を修正しました。

バージョン 1.1.0-beta01

2019 年 9 月 5 日

androidx.webkit:webkit:1.1.0-beta01 がリリースされました。このバージョンに含まれる commit については、こちらをご覧ください。

新機能

アプリのデータディレクトリからファイルを読み込むための、WebViewAssetLoader の新しい InternalStoragePathHandler

API の変更

ProxyConfig#getProxyRules() が ProxyRule インスタンスの変更不可能なリストを返すようになりました。これは、スキームフィルタとそれに対応するプロキシ URL を保持する新しいクラスです。

バグの修正

ファイルパスから MIME タイプを推測できない場合、WebViewAssetLoader はデフォルトで（null ではなく）「text/plain」MIME タイプに設定されます。
パス名に特殊文字を含むファイルを読み込んだときに、WebViewAssetLoader が NullPointerException をスローしなくなりました。

バージョン 1.1.0-alpha02

2019 年 8 月 7 日

androidx.webkit:webkit:1.1.0-alpha02 がリリースされました。このバージョンに含まれる commit については、こちらをご覧ください。

新機能

アプリがカスタムパス処理機能を作成できるように、WebViewAssetLoader が PathHandler インターフェースを公開します。

API の変更

WebViewAssetLoader は、サブクラス化されることを意図しないため、最終クラスになりました。
WebViewAssetLoader#PathHandler 実装が公開され最終版になりました。
ProxyConfig メソッド名に小さな変更を加えました。
ProxyController: サーバーに直接接続するための新しいメソッド addDirect() と addDirect(String) を追加し、DIRECT String を削除しました。
既存の API を更新し、null 可能性アノテーション（@NonNull、@Nullable）とスレッドアノテーション（@UiThread、@WorkerThread）を追加しました。

バージョン 1.1.0-alpha01

2019 年 5 月 7 日

androidx.webkit:webkit:1.1.0-alpha01 がリリースされました。このバージョンに含まれる commit については、こちらをご覧ください。

新機能

setWebViewClient() と setWebChromeClient() を補完する Getter API
アプリの WebView のネットワークリクエストプロキシを設定する ProxyController API
リクエストのインターセプトを介して APK アセットとリソースの読み込みを簡素化する AssetLoader API。CORS を無効にすることなくウェブリソースにアクセスできます。
デバッグ目的で WebView トレース情報を収集する TracingController API
WebView レンダラサービスを管理し、動作の不完全なコンテンツによって WebView レンダラが応答しなくなったことを検出する、RenderProcess API

バグの修正

既存の API のドキュメント形式を若干修正しました。