はじめに
こんにちは。カイザーです。前回に引き続き、WebViewでの注意点をまとめました
Cookie
WebViewに対してCookieの設定や取得を行いたい場合は、「CookieManager」を使用します。
Cookieを設定する
Cookieを設定する場合は、下記のように「setCookie()」メソッドを呼び出します。
| 1 2 3 | val cookieManager = CookieManager.getInstance() cookieManager.setCookie("https://www.example.com/", "KEY=VALUE; domain=example.com; path=/; max-age=3600; Secure; HttpOnly") cookieManager.flush() // Cookieを永続化する |
第一引数にはCookieを使用するURL、第二引数には送信したいCookieをそのまま渡します。
最後に、「flush()」メソッドを呼ぶことで、Cookieを永続化することができます。
また、WebViewで使用する際には、下記のように許可しておく必要があります。
| 1 | cookieManager.setAcceptThirdPartyCookies(webView, true) |
例えば、ログイン時にSet-Cookieされた内容をCookieManagerで永続化させておいて、後からWebViewでセッションを維持する、といった使い方が可能です。
Cookieを取得する
Cookieを取得するには、「getCookie()」メソッドに対し、対象URLを引数に入れて呼び出せば取得できます。
| 1 | val exampleCookie = cookieManager.getCookie("https://www.example.com/") |
ハンドリングの効かないページ遷移
AndroidのWebViewでは、主に下記でページ遷移をハンドリングします。
- shouldOverrideUrlLoading
ページ遷移前 - onPageStarted
ページ読み込み開始時 - onPageFinished
ページ読み込み終了時
しかし、これらに引っかからない、ページ遷移があるため、注意しましょう。
POSTでのページ遷移
POSTでのページ遷移する際は、「shouldOverrideUrlLoading」が呼び出されずに、遷移してしまいます。
そのため、onPageStartedでもハンドリングするようにしましょう。
PDFなど、WebViewで開くことのできないファイル
AndroidのWebViewは、PDFなどのファイル表示に対応していません。
PDF表示の要件が必要である場合は、「shouldOverrideUrlLoading」でハンドリングしましょう。
その時に気をつけたいのが、「onPageStarted」は呼ばれないため、注意してください。
ただし、POST遷移である場合は、そもそも「shouldOverrideUrlLoading」も呼ばれないため、全くハンドリング出来ません!
このような場合は、WEBページ側で修正する必要があります。
Basic認証
開発環境などで、WebViewで表示したいページBasic認証にかかっている場合、WebViewにBasic認証を処理する実装を追加する必要があります。
| 1 2 3 4 5 6 7 8 9 10 11 | webView.webViewClient = object : WebViewClient() { override fun onReceivedHttpAuthRequest( view: WebView?, handler: HttpAuthHandler?, host: String?, realm: String? ) { // ユーザ名、パスワードを指定してBasic認証を進める handler?.proceed("USERNAME", "PASSWORD") } } |
この実装の場合、通常のWEBブラウザと同様の挙動となります。
まず、認証なしでリクエストし、401応答されると、この「onReceivedAuthRequest」が呼び出されます。
そして、「handler?.proceed()」メソッドを呼び出し、認証を続行します。
こうすることにより、Basic認証することができます。
ユーザに入力を求める場合は、入力完了後に「handler?.proceed()」をコールするのが良いでしょう。
URLスキーム
「tel」や「mailto」などのURLスキームに対応する場合も、実装する必要があります。
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 | webView.webViewClient = object : WebViewClient() { override fun shouldOverrideUrlLoading(view: WebView?, request: WebResourceRequest?): Boolean { // http, https以外は、全て外部Activityで開く if (request?.url?.scheme == "http" || request?.url?.scheme == "https" || request == null) { return false } Intent(Intent.ACTION_VIEW).apply { data = request.url startActivity(this) } return true } |
この例では、スキームが「http」か「https」以外は、全て外部アプリで開くようにしています。
また、同アプリ内のURLスキームの場合は、WebViewを閉じてから画面遷移するなど、特別な処理が必要になってくることもありそうです。
さいごに
WebViewはWEBの資産をそのまま表示できる便利なViewですが、実際のWEBブラウザと同じ挙動にするにはかなり作り込みが必要です。
WebViewを多用したアプリの場合、最初からWebViewを考慮して、WEBサイトの開発を進めることが大切ですね。
おすすめ書籍
