Android开发之ContentProvider初步

一、ContentProvider的概念
　　ContentProvider：为存储和获取数据提供统一的接口。可以在不同的应用程序之间共享数据。Android已经为常见的一些数据提供了默认的ContentProvider
　　1、ContentProvider使用表的形式来组织数据
　　    无论数据的来源是什么，ContentProvider都会认为是一种表，然后把数据组织成表格
　　2、ContentProvider提供的方法
　　     query()：查询
　　     insert()：插入
　　     update()：更新
　　     delete()：删除
　　     getType()：得到数据类型
　　     onCreate()：创建数据时调用的回调函数
　　3、每个ContentProvider都有一个公共的URI，这个URI用于表示这个ContentProvider所提供的数据。

           Android所提供的ContentProvider都存放在android.provider包当中。
二、实现ContentProvider的过程
　　一般情况下，我们是需要调用Android系统提供的ContentProvider就可以了。但是实现一个ContentProvider可以更加清楚地的原理。

     自定义一个ContentProvider的步骤：
　　1、定义一个CONTENT_URI常量(里面的字符串必须是唯一)
　　2、定义一个类，继承ContentProvider
　　3、实现ContentProvider的所有方法(query、insert、update、delete、getType、onCreate)  
     4、在AndroidManifest中进行声明 

      先介绍一下ContentProvider用到的UriMatcher。UriMatcher的一个重要的函数是match(Uri uri)。这个函数可以匹配Uri，根据传入的不同Uri返回不同的自定义整形值，以表明Uri访问的不同资源的类型。
      例如：
      public static final UriMatcher uriMatcher;  
      static {  
                     uriMatcher = new UriMatcher(UriMatcher.NO_MATCH);  
                     uriMatcher.addURI(Book.AUTHORITY, "item", Book.ITEM);  
                     uriMatcher.addURI(Book.AUTHORITY, "item/#", Book.ITEM_ID);  
              } 
      这里UriMatcher类型的静态字段是用来匹配传入到ContentProvider中的Uri的类。其构造方法传入的匹配码是使用match()方法匹配根路径时返回的值，这个匹配码可以为一个大于零的数表示匹配根路径或传入-1，即常量UriMatcher.NO_MATCH表示不匹配根路径。addURI()方法是用来增加其他URI匹配路径的，第一个参数传入标识ContentProvider的AUTHORITY字符串。第二个参数传入需要匹配的路径，这里的#号为通配符，代表匹配任意数字，另外还可以用*来匹配任意文本。第三个参数必须传入一个大于零的匹配码，用于match()方法对相匹配的URI返回相对应的匹配码。 例如：sMatcher.addURI(“com.test.provider.personprovider”, “person”, 1);如果match()方法匹配content://com.test.provider.personprovider/person路径，返回匹配码为1。

示例：以下代码源自www.mars-droid.com视频教程中的代码。示例中自定义的ContentProvider的数据来源为SQLite。

main.xml

       <?xml version="1.0" encoding="utf-8"?> <LinearLayout xmlns:android="http://schemas.android.com/apk/res/android" android:orientation="vertical" android:layout_width="fill_parent" android:layout_height="fill_parent"> <TextView android:layout_width="fill_parent" android:layout_height="wrap_content" android:text="@string/hello" /> <Button android:id="@+id/insertButton" android:layout_width="fill_parent" android:layout_height="wrap_content" android:text="@string/insert" /> <Button android:id="@+id/queryButton" android:layout_width="fill_parent" android:layout_height="wrap_content" android:text="@string/query" /> </LinearLayout>   

CPActivity.java

        package idea.org; import idea.org.FirstProviderMetaData.UserTableMetaData; import android.app.Activity; import android.content.ContentValues; import android.database.Cursor; import android.net.Uri; import android.os.Bundle; import android.view.View; import android.widget.Button; public class CPActivity extends Activity { /** Called when the activity is first created. */ private Button insertButton = null; private Button queryButton = null; @Override public void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.main); insertButton = (Button) findViewById(R.id.insertButton); insertButton.setOnClickListener(new View.OnClickListener() { @Override public void onClick(View v) { ContentValues values = new ContentValues(); values.put(FirstProviderMetaData.UserTableMetaData.USER_NAME, "zhangsan"); Uri uri = getContentResolver().insert( FirstProviderMetaData.UserTableMetaData.CONTENT_URI, values); System.out.println("uri ---> " + uri.toString()); } }); queryButton = (Button) findViewById(R.id.queryButton); queryButton.setOnClickListener(new View.OnClickListener() { @Override public void onClick(View v) { Cursor c = getContentResolver().query( FirstProviderMetaData.UserTableMetaData.CONTENT_URI, null, null, null, null); while (c.moveToNext()) { System.out.println(c.getString(c .getColumnIndex(UserTableMetaData.USER_NAME))); } } }); } }

FirstProviderMetaData.java

        package idea.org; import android.net.Uri; import android.provider.BaseColumns; public class FirstProviderMetaData { public static final String AUTHORITY = "idea.org.FirstContentProvider"; // 数据库名称 public static final String DATABASE_NAME = "FirstProvider.db"; // 数据库版本 public static final int DATABASE_VERSION = 1; // 表名 public static final String USERS_TABLE_NAME = "users"; public static final class UserTableMetaData implements BaseColumns { // 表名 public static final String TABLE_NAME = "users"; // 访问该ContentProvider的URI public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/users"); // 该contentProvider所返回的数据类型的定义 public static final String CONTENT_TYPE = "vnd.android.cursor.dir/vnd.firstprovider.user"; public static final String CONTENT_TYPE_ITEM = "vnd.android.cursor.item/vnd.firstprovider.user"; // 列名 public static final String USER_NAME = "name"; // 默认的排序方法 public static final String DEFAULT_SORT_ORDER = "_id desc"; } }

FirstContentProvider.java

       package idea.org; import java.util.HashMap; import idea.org.FirstProviderMetaData.UserTableMetaData; import android.content.ContentProvider; import android.content.ContentUris; import android.content.ContentValues; import android.content.UriMatcher; import android.database.Cursor; import android.database.SQLException; import android.database.sqlite.SQLiteDatabase; import android.database.sqlite.SQLiteQueryBuilder; import android.net.Uri; import android.text.TextUtils; public class FirstContentProvider extends ContentProvider { // UriMatcher用来检查URI是否合法 public static final UriMatcher uriMatcher; public static final int INCOMING_USER_COLLECTION = 1; public static final int INCOMING_USER_SINGLE = 2; private DatabaseHelper dh; static { uriMatcher = new UriMatcher(UriMatcher.NO_MATCH); uriMatcher.addURI(FirstProviderMetaData.AUTHORITY, "users", INCOMING_USER_COLLECTION); uriMatcher.addURI(FirstProviderMetaData.AUTHORITY, "users/#", INCOMING_USER_SINGLE); } public static HashMap<String, String> userProjectionMap; static { userProjectionMap = new HashMap<String, String>(); userProjectionMap.put(UserTableMetaData._ID, UserTableMetaData._ID); userProjectionMap.put(UserTableMetaData.USER_NAME, UserTableMetaData.USER_NAME); } @Override public int delete(Uri arg0, String arg1, String[] arg2) { // TODO Auto-generated method stub System.out.println("delete..."); return 0; } // 根据传入的URI，返回该URI所表示的数据类型 @Override public String getType(Uri uri) { System.out.println("getType..."); switch (uriMatcher.match(uri)) { case INCOMING_USER_COLLECTION: return UserTableMetaData.CONTENT_TYPE; case INCOMING_USER_SINGLE: return UserTableMetaData.CONTENT_TYPE_ITEM; default: throw new IllegalArgumentException("Unknow URI " + uri); } } /** * 该函数的返回值是一个Uri，这个Uri表示的是刚刚那使用这个函数所插入的数据 * content://idea.org.firstContentProivder/users/1 */ @Override public Uri insert(Uri uri, ContentValues values) { System.out.println("insert..."); SQLiteDatabase db = dh.getWritableDatabase(); long rowId = db.insert(UserTableMetaData.TABLE_NAME, null, values); if (rowId > 0) { Uri insertedUserUri = ContentUris.withAppendedId( UserTableMetaData.CONTENT_URI, rowId); // 通知监听器，数据已经修改 getContext().getContentResolver().notifyChange(insertedUserUri, null); return insertedUserUri; } throw new SQLException("Failed to insert row into " + uri); } // 是一个回调方法，所以说在ContentProvider创建的时候执行 @Override public boolean onCreate() { dh = new DatabaseHelper(getContext(), FirstProviderMetaData.DATABASE_NAME); System.out.println("onCreate..."); return true; } @Override public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder) { SQLiteQueryBuilder qb = new SQLiteQueryBuilder(); switch (uriMatcher.match(uri)) { case INCOMING_USER_COLLECTION: qb.setTables(UserTableMetaData.TABLE_NAME); qb.setProjectionMap(userProjectionMap); break; case INCOMING_USER_SINGLE: qb.setTables(UserTableMetaData.TABLE_NAME); qb.setProjectionMap(userProjectionMap); qb.appendWhere(UserTableMetaData._ID + "=" + uri.getPathSegments().get(1)); break; } String orderBy; if (TextUtils.isEmpty(sortOrder)) { orderBy = UserTableMetaData.DEFAULT_SORT_ORDER; } else { orderBy = sortOrder; } SQLiteDatabase db = dh.getWritableDatabase(); Cursor c = qb.query(db, projection, selection, selectionArgs, null, null, orderBy); c.setNotificationUri(getContext().getContentResolver(), uri); System.out.println("query..."); return c; } @Override public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs) { System.out.println("update..."); return 0; } }

DatabaseHelper.java

       package idea.org; import android.content.Context; import android.database.sqlite.SQLiteDatabase; import android.database.sqlite.SQLiteOpenHelper; import android.database.sqlite.SQLiteDatabase.CursorFactory; public class DatabaseHelper extends SQLiteOpenHelper { private static final int VERSION = 1; public DatabaseHelper(Context context, String name, CursorFactory factory, int version) { super(context, name, factory, version); // TODO Auto-generated constructor stub } public DatabaseHelper(Context context, String name, int version) { this(context, name, null, version); } public DatabaseHelper(Context context, String name) { this(context, name, VERSION); } // 该函数是在第一次创建数据库的时候执行，实际上是在第一次得到SQLiteDAtabase对象的时候，才会调用这个方法 @Override public void onCreate(SQLiteDatabase db) { System.out.println("cteate a Database"); // execSQL函数用于执行SQL语句 db.execSQL("create table " + FirstProviderMetaData.USERS_TABLE_NAME + "(" + FirstProviderMetaData.UserTableMetaData._ID + " INTEGER_PARIMARY_AUTOINCREMENT," + FirstProviderMetaData.UserTableMetaData.USER_NAME + " varchar(20))"); } @Override public void onUpgrade(SQLiteDatabase db, int arg1, int arg2) { System.out.println("update a Database"); } }

strings.xml

       <?xml version="1.0" encoding="utf-8"?> <resources> <string name="hello">Hello World, CPActivity!</string> <string name="app_name">ContentProvider</string> <string name="insert">插入数据</string> <string name="query">查询数据</string> </resources>

AndroidManifest.xml

       <?xml version="1.0" encoding="utf-8"?> <manifest xmlns:android="http://schemas.android.com/apk/res/android" package="idea.org" android:versionCode="1" android:versionName="1.0"> <uses-sdk android:minSdkVersion="11" /> <application android:icon="@drawable/icon" android:label="@string/app_name"> <activity android:name=".CPActivity" android:label="@string/app_name"> <intent-filter> <action android:name="android.intent.action.MAIN" /> <category android:name="android.intent.category.LAUNCHER" /> </intent-filter> </activity> <provider android:name="idea.org.FirstContentProvider" android:authorities="idea.org.FirstContentProvider" /> </application> </manifest>

运行结果：

界面：

      

依次点击插入数据和查询数据按钮，控制台输出如下内容：