ContentProvider总结(Android)

ContentProvider

1.适用场景

1) ContentProvider为存储和读取数据提供了统一的接口

2) 使用ContentProvider，应用程序能够实现数据共享

3) android内置的很多数据都是使用ContentProvider形式，供开发人员调用的(如视频，音频，图片，通讯录等)

2.相关概念介绍

1）ContentProvider简单介绍

       当应用继承ContentProvider类，并重写该类用于提供数据和存储数据的方法，就能够向其它应用共享其数据。尽管使用其它方法也能够对外共享数据，但数据訪问方式会因数据存储的方式而不同，如：採用文件方式对外共享数据，须要进行文件操作读写数据；採用sharedpreferences共享数据，须要使用sharedpreferences API读写数据。而使用ContentProvider共享数据的优点是统一了数据訪问方式。

2）Uri类简单介绍

Uri uri = Uri.parse("content://com.changcheng.provider.contactprovider/contact")

在Content Provider中使用的查询字符串有别于标准的SQL查询。非常多诸如select, add, delete, modify等操作我们都使用一种特殊的URI来进行，这样的URI由3个部分组成， “content://”, 代表数据的路径，和一个可选的标识数据的ID。下面是一些演示样例URI:

     content://media/internal/images  这个URI将返回设备上存储的全部图片

     content://contacts/people/  这个URI将返回设备上的全部联系人信息

     content://contacts/people/45 这个URI返回单个结果（联系人信息中ID为45的联系人记录）

　　虽然这样的查询字符串格式非经常见，可是它看起来还是有点令人迷惑。为此，Android提供一系列的帮助类（在android.provider包下），里面包括了非常多以类变量形式给出的查询字符串，这样的方式更easy让我们理解一点，因此，如上面content://contacts/people/45这个URI就能够写成例如以下形式：

　　Uri person = ContentUris.withAppendedId(People.CONTENT_URI,  45);

然后运行数据查询:

Cursor cur = managedQuery(person, null, null, null);

这个查询返回一个包括全部数据字段的游标，我们能够通过迭代这个游标来获取全部的数据：

package com.wissen.testApp;
public class ContentProviderDemo extends Activity {
    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.main);
       displayRecords();
    }

    private void displayRecords() {
        //该数组中包括了全部要返回的字段
     String columns[] = new String[] { People.NAME, People.NUMBER };
       Uri mContacts = People.CONTENT_URI;
       Cursor cur = managedQuery(
          mContacts,
          columns,  // 要返回的数据字段
       　　null,          // WHERE子句
       　　null,         // WHERE 子句的參数
      　　 null         // Order-by子句
     );
       if (cur.moveToFirst()) {
           String name = null;
           String phoneNo = null;
           do {
              // 获取字段的值
         　　 name = cur.getString(cur.getColumnIndex(People.NAME));
             phoneNo = cur.getString(cur.getColumnIndex(People.NUMBER));
             Toast.makeText(this, name + ” ” + phoneNo, Toast.LENGTH_LONG).show();
          } while (cur.moveToNext());
       }
    }
}

　　上例示范了一个怎样依次读取联系人信息表中的指定数据列name和number。

改动记录:

我们能够使用ContentResolver.update()方法来改动数据，我们来写一个改动数据的方法:

private void updateRecord(int recNo, String name) {
    Uri uri = ContentUris.withAppendedId(People.CONTENT_URI, recNo);
    ContentValues values = new ContentValues();
    values.put(People.NAME, name);
    getContentResolver().update(uri, values, null, null);
}

如今你能够调用上面的方法来更新指定记录：

updateRecord(10, ”XYZ”);   //更改第10条记录的name字段值为“XYZ”

加入记录:

要添加记录，我们能够调用ContentResolver.insert()方法，该方法接受一个要添加的记录的目标URI，以及一个包括了新记录值的Map对象，调用后的返回值是新记录的URI，包括记录号。

上面的样例中我们都是基于联系人信息簿这个标准的Content Provider，如今我们继续来创建一个insertRecord() 方法以对联系人信息簿中进行数据的加入：

private void insertRecords(String name, String phoneNo) {
    ContentValues values = new ContentValues();
    values.put(People.NAME, name);
    Uri uri = getContentResolver().insert(People.CONTENT_URI, values);
    Log.d(”ANDROID”, uri.toString());
    Uri numberUri = Uri.withAppendedPath(uri, People.Phones.CONTENT_DIRECTORY);
    values.clear();
    values.put(Contacts.Phones.TYPE, People.Phones.TYPE_MOBILE);
    values.put(People.NUMBER, phoneNo);
    getContentResolver().insert(numberUri, values);
}

这样我们就能够调用insertRecords(name, phoneNo)的方式来向联系人信息簿中加入联系人姓名和电话号码。

删除记录:

Content Provider中的getContextResolver.delete()方法能够用来删除记录，以下的记录用来删除设备上全部的联系人信息：

private void deleteRecords() {
    Uri uri = People.CONTENT_URI;
    getContentResolver().delete(uri, null, null);
}

你也能够指定WHERE条件语句来删除特定的记录：

getContentResolver().delete(uri, “NAME=” + “‘XYZ XYZ’”, null);

这将会删除name为‘XYZ XYZ’的记录。

3. 创建ContentProvider

要创建我们自己的Content Provider的话，我们须要遵循下面几步：

a. 创建一个继承了ContentProvider父类的类



b. 定义一个名为CONTENT_URI，而且是public static final的Uri类型的类变量，你必须为其指定一个唯一的字符串值，最好的方案是以类的全名称， 如:

public static final Uri CONTENT_URI = Uri.parse( “content://com.google.android.MyContentProvider”);

c. 定义你要返回给client的数据列名。假设你正在使用Android数据库，必须为其定义一个叫_id的列，它用来表示每条记录的唯一性。

d. 创建你的数据存储系统。大多数Content Provider使用Android文件系统或SQLite数据库来保持数据，可是你也能够以不论什么你想要的方式来存储。



e. 假设你要存储字节型数据，比方位图文件等，数据列事实上是一个表示实际保存文件的URI字符串，通过它来读取相应的文件数据。处理这样的数据类型的Content Provider须要实现一个名为_data的字段，_data字段列出了该文件在Android文件系统上的精确路径。这个字段不仅是供client使用，并且也能够供ContentResolver使用。client能够调用ContentResolver.openOutputStream()方法来处理该URI指向的文件资源；假设是ContentResolver本身的话，因为其持有的权限比client要高，所以它能直接訪问该数据文件。



f. 声明public static String型的变量，用于指定要从游标处返回的数据列。



g. 查询返回一个Cursor类型的对象。全部运行写操作的方法如insert(), update() 以及delete()都将被监听。我们能够通过使用ContentResover().notifyChange()方法来通知监听器关于数据更新的信息。



h. 在AndroidMenifest.xml中使用<provider>标签来设置Content Provider。



i. 假设你要处理的数据类型是一种比較新的类型，你就必须先定义一个新的MIME类型，以供ContentProvider.geType(url)来返回。MIME类型有两种形式:一种是为指定的单个记录的，另一种是为多条记录的。这里给出一种经常使用的格式：

　　vnd.android.cursor.item/vnd.yourcompanyname.contenttype （单个记录的MIME类型）

　　比方, 一个请求列车信息的URI如content://com.example.transportationprovider/trains/122 可能就会返回typevnd.android.cursor.item/vnd.example.rail这样一个MIME类型。

　　vnd.android.cursor.dir/vnd.yourcompanyname.contenttype （多个记录的MIME类型）

　　比方, 一个请求全部列车信息的URI如content://com.example.transportationprovider/trains 可能就会返回vnd.android.cursor.dir/vnd.example.rail这样一个MIME 类型。

下列代码将创建一个Content Provider，它不过存储username称并显示全部的username称（使用 SQLLite数据库存储这些数据）：

public class MyUsers {
    public static final String AUTHORITY  = “com.wissen.MyContentProvider”;

    // BaseColumn类中已经包括了 _id字段
   public static final class User implements BaseColumns {
        public static final Uri CONTENT_URI  = Uri.parse(”content://com.wissen.MyContentProvider”);
        // 表数据列
        public static final String  USER_NAME  = “USER_NAME”;
    }
}

上面的类中定义了Content Provider的CONTENT_URI，以及数据列。以下我们将定义基于上面的类来定义实际的Content Provider类：

public class MyContentProvider extends ContentProvider {
    private SQLiteDatabase     sqlDB;
    private DatabaseHelper    dbHelper;
    private static final String  DATABASE_NAME = “Users.db”;
    private static final int  DATABASE_VERSION= 1;
    private static final String TABLE_NAME= “User”;
    private static final String TAG = “MyContentProvider”;

    private static class DatabaseHelper extends SQLiteOpenHelper {
        DatabaseHelper(Context context) {
            super(context, DATABASE_NAME, null, DATABASE_VERSION);
        }

        @Override
        public void onCreate(SQLiteDatabase db) {
            //创建用于存储数据的表
        db.execSQL(”Create table ” + TABLE_NAME + “( _id INTEGER PRIMARY KEY AUTOINCREMENT, USER_NAME TEXT);”);
        }

        @Override
        public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
            db.execSQL(”DROP TABLE IF EXISTS ” + TABLE_NAME);
            onCreate(db);
        }
    }

    @Override
    public int delete(Uri uri, String s, String[] as) {
        return 0;
    }

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

    @Override
    public Uri insert(Uri uri, ContentValues contentvalues) {
        sqlDB = dbHelper.getWritableDatabase();
        long rowId = sqlDB.insert(TABLE_NAME, “”, contentvalues);
        if (rowId > 0) {
            Uri rowUri = ContentUris.appendId(MyUsers.User.CONTENT_URI.buildUpon(), rowId).build();
            getContext().getContentResolver().notifyChange(rowUri, null);
            return rowUri;
        }
        throw new SQLException(”Failed to insert row into ” + uri);
    }

    @Override
    public boolean onCreate() {
        dbHelper = new DatabaseHelper(getContext());
        return (dbHelper == null) ? false : true;
    }

    @Override
    public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder) {
        SQLiteQueryBuilder qb = new SQLiteQueryBuilder();
        SQLiteDatabase db = dbHelper.getReadableDatabase();
        qb.setTables(TABLE_NAME);
        Cursor c = qb.query(db, projection, selection, null, null, null, sortOrder);
        c.setNotificationUri(getContext().getContentResolver(), uri);
        return c;
    }

    @Override
    public int update(Uri uri, ContentValues contentvalues, String s, String[] as) {
        return 0;
    }
}

一个名为MyContentProvider的Content Provider创建完毕了，它用于从Sqlite数据库中加入和读取记录。

Content Provider的入口须要在AndroidManifest.xml中配置:

<provider android:name=”MyContentProvider” android:authorities=”com.wissen.MyContentProvider” />

之后，让我们来使用这个定义好的Content Provider:

1）为应用程序加入ContentProvider的訪问权限。

2）通过getContentResolver()方法得到ContentResolver对象。

3）调用ContentResolver类的query()方法查询数据，该方法会返回一个Cursor对象。

4）对得到的Cursor对象进行分析，得到须要的数据。

5）调用Cursor类的close()方法将Cursor对象关闭。

public class MyContentDemo extends Activity {
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        insertRecord(”MyUser”);
        displayRecords();
    }

    private void insertRecord(String userName) {
        ContentValues values = new ContentValues();
        values.put(MyUsers.User.USER_NAME, userName);
        getContentResolver().insert(MyUsers.User.CONTENT_URI, values);
    }

    private void displayRecords() {
        String columns[] = new String[] { MyUsers.User._ID, MyUsers.User.USER_NAME };
        Uri myUri = MyUsers.User.CONTENT_URI;
        Cursor cur = managedQuery(myUri, columns,null, null, null );
        if (cur.moveToFirst()) {
            String id = null;
            String userName = null;
            do {
                id = cur.getString(cur.getColumnIndex(MyUsers.User._ID));
                userName = cur.getString(cur.getColumnIndex(MyUsers.User.USER_NAME));
                Toast.makeText(this, id + ” ” + userName, Toast.LENGTH_LONG).show();
           } while (cur.moveToNext());
       }
    }
}