読者です 読者をやめる 読者になる 読者になる

It’s now or never

IT系の技術ブログです。気になったこと、勉強したことを備忘録的にまとめて行きます。

【Android】コンテンツプロバイダ(ContentProvider)を使ってみる

コンテンツプロバイダは、Androidのアプリケーションが管理しているリソースを 他アプリケーションから参照するための仕組みです。

例えば、連絡先アプリなど他アプリケーションから活用できるデータを持つアプリケーションが、
その他アプリケーションへデータを提供する際に使用されます。

今回は、SQLiteデータベースの情報を取得するサンプルを作成しました。

SQLiteデータベースへアクセスするためのクラスを作成

コンテンツプロバイダのデータ提供元となるデータベースを作成します。

testdbという名前のDBにfruitというテーブルを作成しています。

public class ShareDbHelpler extends SQLiteOpenHelper {

    private static final String DB_NAME = "testdb";
    private static final int DB_VERSION = 1;

    // テーブル情報を定義
    public static final String TABLE_NAME = "fruit";
    public static final String COL_NAME = "firstName";

    // カラムには、必ず「_id」という主キーをAUTOINCREMENTで作成する必要がある
    private static final String STRING_CREATE =
            "CREATE TABLE " + TABLE_NAME + " (_id INTEGER PRIMARY KEY AUTOINCREMENT, "
            +COL_NAME+" TEXT);";

    public ShareDbHelpler(Context context) {
        super(context, DB_NAME, null, DB_VERSION);
    }

    @Override
    public void onCreate(SQLiteDatabase sqLiteDatabase) {
        // データベースのテーブルを作成する
        sqLiteDatabase.execSQL(STRING_CREATE);

        // データベースにサンプル値を挿入
        ContentValues cv = new ContentValues(1);
        cv.put(COL_NAME, "Apple");
        sqLiteDatabase.insert(TABLE_NAME, null, cv);

        cv = new ContentValues(3);
        cv.put(COL_NAME, "Orange");
        sqLiteDatabase.insert(TABLE_NAME, null, cv);

        cv = new ContentValues(3);
        cv.put(COL_NAME, "Banana");
        sqLiteDatabase.insert(TABLE_NAME, null, cv);
    }

    @Override
    public void onUpgrade(SQLiteDatabase sqLiteDatabase, int i, int i2) {
        // DBに変更があった場合は、とりあえずテーブルを削除する
        sqLiteDatabase.execSQL("DROP TABLE IF EXISTS " + TABLE_NAME);
    }
}

コンテンツプロバイダを継承したクラスを作成

コンテンツプロバイダを提供するためにContentProviderのサブクラスを定義します。
ContentProviderを継承したクラスは、以下の6つのメソッドを実装する必要があります。

  • query()
  • insert()
  • update()
  • delete()
  • getType()
  • onCreate()

また、 サブクラスには、ContentProviderへアクセスするためのURI(content://~)および、アクセス可能なカラム名を定数として定義します。

ContentProviderがアクセスする先がデータベースの場合、定義するカラム名とデータベースのカラム名を同じにするのが一般的です。

カラム名には、 レコードのIDとして整数型の_id(定数ID)という名前のカラムを必ず含めるようにしなくてはなりません。
※他に全レコードで一意になるであろうフィールド ( URL など ) を持っていても含めなくてはならない
さらに、SQLiteデータベースを使用する場合は、この
ID フィールドをINTEGER PRIMARY KEY AUTOINCREMENTにしなくてはいけません。

以下は、frauitテーブルへアクセスするためのContentProviderのサンプルです。

public class TestProvider extends ContentProvider {

    // コンテンツプロバイダのURIを定義
    public static final Uri CONTENT_URI =
            Uri.parse("content://com.inon.shareddb.testsprovider/frauit");

    // アクセスが可能なカラムを定義
    public static final class Columns {
        public static final String _ID = "_id";
        public static final String NAME = "name";
    }

    /* URI マッチング */
    // 全行取得とidでの取得を行えるよう、UriMatcherを使用する
    private static final int FRAUIT = 1;
    private static final int FRAUIT_ID = 2;

    private static final UriMatcher matcher = new UriMatcher(UriMatcher.NO_MATCH);
    static {
        matcher.addURI(CONTENT_URI.getAuthority(), "frauit", FRAUIT);
        matcher.addURI(CONTENT_URI.getAuthority(), "frauit/#", FRAUIT_ID);
    }

    SQLiteDatabase db;

    @Override
    public boolean onCreate() {
        // 接続DBの作成
        ShareDbHelpler helpler = new ShareDbHelpler(getContext());
        db = helpler.getWritableDatabase();
        return false;
    }

    @Override
    public Cursor query(Uri uri, String[] projection, String selection, String[]
            selectionArgs, String sortOrder) {
        int result = matcher.match(uri);

        // 指定のURIが正しければ、取得結果(Cursor)を返却する
        switch (result) {
            case FRAUIT:
                return db.query(ShareDbHelpler.TABLE_NAME, projection, selection,
                        selectionArgs, null, null, sortOrder);
            case FRAUIT_ID:
                return db.query(ShareDbHelpler.TABLE_NAME, projection, "_ID = ?",
                        new String[]{uri.getLastPathSegment()}, null, null, sortOrder);
            default:
                return null;
        }
    }

    @Override
    public String getType(Uri uri) {
        return null;
    }

    @Override
    public Uri insert(Uri uri, ContentValues contentValues) {
        long id = db.insert(ShareDbHelpler.TABLE_NAME, null, contentValues);

        if (id >= 0) {
            return Uri.withAppendedPath(uri, String.valueOf(id));
        } else {
            return null;
        }
    }

    @Override
    public int delete(Uri uri, String selection, String[] selectionArgs) {
        int result = matcher.match(uri);
        switch (result) {
            case FRAUIT:
                return db.delete(ShareDbHelpler.TABLE_NAME, selection, selectionArgs);

            case FRAUIT_ID:
                return db.delete(ShareDbHelpler.TABLE_NAME, "_ID = ?",
                        new String[] {uri.getLastPathSegment()});

            default:
                return 0;
        }
    }

    @Override
    public int update(Uri uri, ContentValues contentValues, String selection, String[] selectionArgs) {
        int result = matcher.match(uri);
        switch (result) {
            case FRAUIT:
                return db.update(ShareDbHelpler.TABLE_NAME, contentValues, selection, selectionArgs);

            case FRAUIT_ID:
                return db.update(ShareDbHelpler.TABLE_NAME, contentValues, "_ID = ?",
                        new String[]{uri.getLastPathSegment()});

            default:
                return 0;
        }
    }
}

AndroidManifestでコンテンツプロバイダを宣言する

Content Providerを使用するためにAndroidManifestに定義を追加する必要があります。

<provider
    android:authorities="com.sample.shareddb.testsprovider"
    android:name="com.sample.shareddb.TestProvider">
 </provider>

android:nameには、クラス名を定義します。
android:authorities には、外部からアクセスする際に使用するURIを定義します。
これは、パッケージ名を含めたクラス名を定義するのが一般的です。

コンテンツプロバイダへの問い合わせ

コンテンツプロバイダを介してデータを取得するには、ContentResolverインスタンスを利用します。 query()メソッドを使って取得したCursorオブジェクトから各取得データへのアスセスが可能となります。

以下のサンプルでは、ActivityからContentResolverを利用してデータを取得し、ListViewへデータを表示しています。
本来は、取得したCursorオブジェクトは使用しなくなったタイミングで適切に破棄する必要がありますが、
今回は、サンプルのため何もしていません。

public class MainActivity extends Activity {

    Cursor mCoursor;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        String[] projection = new String[] {TestProvider.Columns._ID,
            TestProvider.Columns.NAME};
        mCoursor = getContentResolver().query(TestProvider.CONTENT_URI, projection, null, null,
        null);

        SimpleCursorAdapter adapter = new SimpleCursorAdapter(this, android.R.layout.simple_list_item_1,
                mCoursor,
                new String[] {TestProvider.Columns.NAME},
                new int[] {android.R.id.text1},
                0);

        ListView list = (ListView) findViewById(R.id.list_view);
        list.setAdapter(adapter);
    }
}

参考

http://www.techdoctranslator.com/android/guide/content-providers