ContentProvider 是Android 四大組件之一,其本質上是一個標準化的數據管道,它屏蔽了底層的數據管理和服務等細節,以標準化的方式在Android 應用間共享數據。用戶可以靈活實現ContentProvider 所封裝的數據存儲以及增刪改查等,所有的ContentProvider 必須實現一個對外統一的接口(URI),內容提供者組件通過請求從一個應用程序向其他的應用程序提供數據。這些請求由類 ContentResolver 的方法來處理。內容提供者可以使用不同的方式來存儲數據。數據可以被存放在數據庫,文件,甚至是網絡。
有時候需要在應用程序之間共享數據。這時內容提供者變得非常有用。內容提供者可以讓內容集中,必要時可以有多個不同的應用程序來訪問。內容提供者的行爲和數據庫很像。你可以查詢,編輯它的內容,使用 insert(), update(), delete() 和 query() 來添加或者刪除內容。多數情況下數據被存儲在 SQLite 數據庫。
內容URI
要查詢內容提供者,你需要以如下格式的URI的形式來指定查詢字符串:
<prefix>://<authority>/<data_type>/<id>
以下是URI中各部分的具體說明:
- prefix 前綴:一直被設置爲content://
- authority 授權:指定內容提供者的名稱,例如聯繫人,瀏覽器等。第三方的內容提供者可以是全名,如:cn.programmer.statusprovider
- data_type 數據類型:這個表明這個特殊的內容提供者中的數據的類型。例如:你要通過內容提供者Contacts來獲取所有的通訊錄,數據路徑是people,那麼URI將是下面這樣:content://contacts/people
- id 這個指定特定的請求記錄。例如:你在內容提供者Contacts中查找聯繫人的ID號爲5,那麼URI看起來是這樣:content://contacts/people/5
內容提供者正常工作,類 ContentProvider 中重寫的一些方法:
- onCreate():當提供者被啓動時調用。
- query():該方法從客戶端接受請求。結果是返回指針(Cursor)對象。
- insert():該方法向內容提供者插入新的記錄。
- delete():該方法從內容提供者中刪除已存在的記錄。
- update():該方法更新內容提供者中已存在的記錄。
- getType():該方法爲給定的URI返回元數據類型。
一、ContentProvider的使用
1、創建和管理提供者內部數據源的幫助類
public class DatabaseHelper extends SQLiteOpenHelper {
private static final String TAG = "wq892373445";
/**
* 數據庫特定常量聲明
*/
private SQLiteDatabase db;
static final String DATABASE_NAME = "College";
static final String STUDENTS_TABLE_NAME = "students";
static final int DATABASE_VERSION = 1;
static final String CREATE_DB_TABLE =
" CREATE TABLE " + STUDENTS_TABLE_NAME +
" (_id INTEGER PRIMARY KEY AUTOINCREMENT, " +
" name TEXT NOT NULL, " +
" grade TEXT NOT NULL);";
DatabaseHelper(Context context){
super(context, DATABASE_NAME, null, DATABASE_VERSION);
}
@Override
public void onCreate(SQLiteDatabase db)
{
Log.e(TAG, "onCreate()");
db.execSQL(CREATE_DB_TABLE);
}
@Override
public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
Log.e(TAG, "onUpgrade()");
db.execSQL("DROP TABLE IF EXISTS " + STUDENTS_TABLE_NAME);
onCreate(db);
}
}
2、創建一個DatabaseProvider類並且繼承ContentProvider
public class DatabaseProvider extends ContentProvider {
private static final String TAG = "wq892373445";
static final String PROVIDER_NAME = "com.wq.contentproviderdemo.databasetest.provider";
static final String URL = "content://" + PROVIDER_NAME + "/students";
static final Uri CONTENT_URI = Uri.parse(URL);
private SQLiteDatabase db;
static final String _ID = "_id";
static final String NAME = "name";
static final String GRADE = "grade";
private static HashMap<String, String> STUDENTS_PROJECTION_MAP;
static final int STUDENTS = 1;
static final int STUDENT_ID = 2;
static final UriMatcher uriMatcher;
static{
uriMatcher = new UriMatcher(UriMatcher.NO_MATCH);
uriMatcher.addURI(PROVIDER_NAME, "students", STUDENTS);
uriMatcher.addURI(PROVIDER_NAME, "students/#", STUDENT_ID);
}
public DatabaseProvider() {
Log.e(TAG, "DatabaseProvider: ");
}
@Override
public boolean onCreate() {
Log.d(TAG,"onCreate()");
Context context = getContext();
DatabaseHelper dbHelper = new DatabaseHelper(context);
/**
* 如果不存在,則創建一個可寫的數據庫。
*/
db = dbHelper.getWritableDatabase();
return (db == null)? false:true;
}
//查詢數據
@Nullable
@Override
public Cursor query(@NonNull Uri uri, @Nullable String[] projection, @Nullable String selection, @Nullable String[] selectionArgs, @Nullable String sortOrder) {
Log.d(TAG,"query()");
SQLiteQueryBuilder qb = new SQLiteQueryBuilder();
qb.setTables(STUDENTS_TABLE_NAME);
switch (uriMatcher.match(uri)) {
case STUDENTS:
qb.setProjectionMap(STUDENTS_PROJECTION_MAP);
break;
case STUDENT_ID:
qb.appendWhere( _ID + "=" + uri.getPathSegments().get(1));
break;
default:
throw new IllegalArgumentException("Unknown URI " + uri);
}
if (sortOrder == null || sortOrder == ""){
/**
* 默認按照學生姓名排序
*/
sortOrder = NAME;
}
Cursor c = qb.query(db, projection, selection, selectionArgs,null, null, sortOrder);
/**
* 註冊內容URI變化的監聽器
*/
c.setNotificationUri(getContext().getContentResolver(), uri);
return c;
}
@Nullable
@Override
public String getType(@NonNull Uri uri) {
Log.d(TAG,"getType()");
switch (uriMatcher.match(uri)){
/**
* 獲取所有學生記錄
*/
case STUDENTS:
return "vnd.android.cursor.dir/vnd.example.students";
/**
* 獲取一個特定的學生
*/
case STUDENT_ID:
return "vnd.android.cursor.item/vnd.example.students";
default:
throw new IllegalArgumentException("Unsupported URI: " + uri);
}
}
//插入數據
@Nullable
@Override
public Uri insert(@NonNull Uri uri, @Nullable ContentValues values) {
Log.d(TAG,"insert()");
/**
* 添加新學生記錄
*/
long rowID = db.insert( STUDENTS_TABLE_NAME, "", values);
/**
* 如果記錄添加成功
*/
if (rowID > 0)
{
Uri _uri = ContentUris.withAppendedId(CONTENT_URI, rowID);
getContext().getContentResolver().notifyChange(_uri, null);
return _uri;
}
throw new SQLException("Failed to add a record into " + uri);
}
//刪除數據表數據
@Override
public int delete(@NonNull Uri uri, @Nullable String selection, @Nullable String[] selectionArgs) {
Log.d(TAG,"delete()");
int count = 0;
switch (uriMatcher.match(uri)){
case STUDENTS:
count = db.delete(STUDENTS_TABLE_NAME, selection, selectionArgs);
break;
case STUDENT_ID:
String id = uri.getPathSegments().get(1);
count = db.delete( STUDENTS_TABLE_NAME, _ID + " = " + id +
(!TextUtils.isEmpty(selection) ? " AND (" + selection + ')' : ""), selectionArgs);
break;
default:
throw new IllegalArgumentException("Unknown URI " + uri);
}
getContext().getContentResolver().notifyChange(uri, null);
return count;
}
//更新數據
@Override
public int update(@NonNull Uri uri, @Nullable ContentValues values, @Nullable String selection, @Nullable String[] selectionArgs) {
Log.d(TAG,"update()");
int count = 0;
switch (uriMatcher.match(uri)){
case STUDENTS:
count = db.update(STUDENTS_TABLE_NAME, values, selection, selectionArgs);
break;
case STUDENT_ID:
count = db.update(STUDENTS_TABLE_NAME, values, _ID + " = " + uri.getPathSegments().get(1) +
(!TextUtils.isEmpty(selection) ? " AND (" +selection + ')' : ""), selectionArgs);
break;
default:
throw new IllegalArgumentException("Unknown URI " + uri );
}
getContext().getContentResolver().notifyChange(uri, null);
return count;
}
}
3、在AndroidManifest.xml文件中註冊DatabaseProvider內容提供者
<provider
android:name=".DatabaseProvider"
android:authorities="com.wq.contentproviderdemo.databasetest.provider"
android:enabled="true"
android:exported="true"></provider>
4、添加布局文件,其中實現增加和查找功能
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:tools="http://schemas.android.com/tools"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:gravity="center"
android:orientation="vertical"
tools:context=".MainActivity">
<TextView
android:id="@+id/textView1"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:text="內容提供者實例"
android:layout_alignParentTop="true"
android:layout_centerHorizontal="true"
android:textSize="30dp" />
<EditText
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:id="@+id/editText"
/>
<EditText
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:id="@+id/editText2"
android:hint="姓名"
android:textColorHint="@android:color/holo_blue_light" />
<EditText
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:id="@+id/editText3"
android:hint="年級"
android:textColorHint="@android:color/holo_blue_bright" />
<Button
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:id="@+id/button2"
android:text="添加"
android:onClick="onClickAddName"/>
<Button
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:text="查詢"
android:id="@+id/button"
android:onClick="onClickRetrieveStudents"/>
</LinearLayout>
5、在MainActivity中實現添加和查找功能
public class MainActivity extends AppCompatActivity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
}
//查詢
public void onClickRetrieveStudents(View view) {
// Retrieve student records
String URL = "content://com.wq.contentproviderdemo.databasetest.provider/students";
Uri students = Uri.parse(URL);
Cursor c = managedQuery(students, null, null, null, "name");
if (c.moveToFirst()) {
do{
Toast.makeText(this,
c.getString(c.getColumnIndex(DatabaseProvider._ID)) +
", " + c.getString(c.getColumnIndex( DatabaseProvider.NAME)) +
", " + c.getString(c.getColumnIndex( DatabaseProvider.GRADE)),
Toast.LENGTH_SHORT).show();
} while (c.moveToNext());
}
}
//添加
public void onClickAddName(View view) {
// Add a new student record
ContentValues values = new ContentValues();
values.put(DatabaseProvider.NAME,
((EditText)findViewById(R.id.editText2)).getText().toString());
values.put(DatabaseProvider.GRADE,
((EditText)findViewById(R.id.editText3)).getText().toString());
Uri uri = getContentResolver().insert(
DatabaseProvider.CONTENT_URI, values);
Toast.makeText(getBaseContext(),
uri.toString(), Toast.LENGTH_LONG).show();
}
}