Android WebViewでローカルストレージにキャッシュを保存する方法を実装例つきで解説

はじめに

この記事では、AndroidのWebViewを使って、Webページのキャッシュをアプリ内のローカルストレージに保存する方法を、実際のコード例とともに段階的に解説します。サンプルとして、Facebookのモバイル版ページ（touch.facebook.com）をWebViewで表示し、そのデータをキャッシュするケースを取り上げます。

なお、本記事で使用しているsetAppCachePath()やProgressDialogなどのAPIは、新しいAndroidバージョンでは非推奨（deprecated）となっています。学習用・レガシーコードの理解用として参考にしてください。

ステップ1：新規プロジェクトを作成する

まず、Android Studioで新しいプロジェクトを作成します。メニューから「File」→「New Project」を選択し、必要な項目をすべて入力してプロジェクトを作成しましょう。

ステップ2：activity_main.xmlにコードを追加する

次に、レイアウトファイル res/layout/activity_main.xml に以下のコードを記述します。

<?xml version = "1.0" encoding = "utf-8"?>
<LinearLayout xmlns:android = "https://schemas.android.com/apk/res/android"
   xmlns:app = "https://schemas.android.com/apk/res-auto"
   xmlns:tools = "https://schemas.android.com/tools"
   android:layout_width = "match_parent"
   android:gravity = "center"
   android:layout_height = "match_parent"
   tools:context = ".MainActivity"
   android:orientation = "vertical">
   <WebView
      android:id = "@+id/web_view"
      android:layout_width = "match_parent"
      android:layout_height = "match_parent" />
</LinearLayout>

上記のコードでは、Facebookのページを表示するためのWebViewを配置しています。

ステップ3：MainActivity.javaにコードを追加する

続いて、src/MainActivity.java に以下のコードを追加します。

package com.example.myapplication;
import android.app.ProgressDialog;
import android.os.Build;
import android.os.Bundle;
import android.support.annotation.RequiresApi;
import android.support.v7.app.AppCompatActivity;
import android.view.View;
import android.webkit.WebChromeClient;
import android.webkit.WebSettings;
import android.webkit.WebView;
import android.webkit.WebViewClient;
import android.widget.EditText;
public class MainActivity extends AppCompatActivity {
    @RequiresApi(api = Build.VERSION_CODES.P)
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        final ProgressDialog progressDialog = new ProgressDialog(this);
        progressDialog.setMessage("Loading Data...");
        progressDialog.setCancelable(false);
        WebView web_view = findViewById(R.id.web_view);
        web_view.requestFocus();
        web_view.getSettings().setJavaScriptEnabled(true);
        web_view.getSettings().setAppCachePath(getApplicationContext().getFilesDir().getAbsolutePath() + "/cache");
        web_view.loadUrl("https://touch.facebook.com/");
        web_view.setWebViewClient(new WebViewClient() {
            @Override
            public boolean shouldOverrideUrlLoading(WebView view, String url) {
                view.loadUrl(url);
                return true;
            }
        });
        web_view.setWebChromeClient(new WebChromeClient() {
            public void onProgressChanged(WebView view, int progress) {
                if (progress < 100) {
                    progressDialog.show();
                }
                if (progress == 100) {
                    progressDialog.dismiss();
                }
            }
        });
    }
}

このコードのポイントは以下の通りです。

• setJavaScriptEnabled(true)：JavaScriptを有効化し、動的なWebページを正しく表示できるようにします。
• setAppCachePath()：キャッシュの保存先として、アプリ内部ストレージの files ディレクトリ直下にある「cache」フォルダを指定しています。これにより、Webコンテンツがローカルストレージに保存されます。
• WebViewClient：URLクリック時の遷移をWebView内で完結させるためにオーバーライドしています。
• WebChromeClient：読み込み進進捗を監視し、進行中はプログレスダイアログを表示、完了時に閉じる処理を行います。

ステップ4：AndroidManifest.xmlにコードを追加する

最後に、AndroidManifest.xml を以下のように編集して、インターネット通信の権限を追加します。

<?xml version = "1.0" encoding = "utf-8"?>
<manifest xmlns:android = "https://schemas.android.com/apk/res/android"
    package = "com.example.myapplication">
    <uses-permission android:name = "android.permission.INTERNET"/>
    <application
       android:allowBackup = "true"
       android:icon = "@mipmap/ic_launcher"
       android:label = "@string/app_name"
       android:roundIcon = "@mipmap/ic_launcher_round"
       android:supportsRtl = "true"
       android:theme = "@style/AppTheme">
       <activity android:name = ".MainActivity">
           <intent-filter>
               <action android:name = "android.intent.action.MAIN" />
               <category android:name = "android.intent.category.LAUNCHER" />
           </intent-filter>
       </activity>
   </application>
</manifest>

<uses-permission android:name="android.permission.INTERNET"/> の宣言が必須です。これがないとWebViewでWebページを読み込むことができません。

アプリを実行してみよう

それでは、アプリケーションを実行してみましょう。ここでは、実機のAndroidスマートフォンがPCに接続されているものとします。Android Studioからアプリを起動するには、プロジェクト内のアクティビティファイルを開き、ツールバーの「Run」アイコンをクリックします。デバイス選択画面でお使いのスマートフォンを選択すると、実機の画面に以下のようなデフォルト画面が表示されます。