Android四大組件學(xué)習(xí)之ContentProvider

概念

ContentProvider是Android應(yīng)用對(duì)外開(kāi)放的數(shù)據(jù)接口,只要符合它所定義的Uri格式的請(qǐng)求,均可以正常訪問(wèn)執(zhí)行操作。其他的Android應(yīng)用可以使用ContentResolver對(duì)象通過(guò)與ContentProvider同名的方法請(qǐng)求執(zhí)行,被執(zhí)行的就是ContentProvider中的同名的方法。所以ContentProvider很多對(duì)外可以訪問(wèn)的方法,在ContentResolver中均有同名的方法,是一一對(duì)應(yīng)的。

基本使用

ContentProvider是內(nèi)容提供者,實(shí)現(xiàn)Android應(yīng)用之間的數(shù)據(jù)交互,對(duì)于數(shù)據(jù)操作,無(wú)非也就是CRUD而已。下面是ContentProvider必須要實(shí)現(xiàn)的幾個(gè)方法:

  • onCreate():初始化提供者。
  • query(Uri, String[], String, String[], String):查詢數(shù)據(jù),返回一個(gè)數(shù)據(jù)Cursor對(duì)象。
  • insert(Uri, ContentValues):插入一條數(shù)據(jù)。
  • update(Uri, ContentValues, String, String[]):根據(jù)條件更新數(shù)據(jù)。
  • delete(Uri, String, String[]):根據(jù)條件刪除數(shù)據(jù)。
  • getType(Uri) 返回MIME類型對(duì)應(yīng)內(nèi)容的URI。、

除了onCreate()和getType()方法外,其他的均為CRUD操作,這些方法中,Uri參數(shù)為與ContentProvider匹配的請(qǐng)求Uri,剩下的參數(shù)可以參見(jiàn)SQLite的CRUD操作,基本一致。
還有兩個(gè)方法:call()和bulkInsert()方法,使用call,理論上可以在ContentResolver中執(zhí)行ContentProvider暴露出來(lái)的任何方法,而bulkInsert()方法用于插入多條數(shù)據(jù)。

在ContentProvider的CRUD操作,均會(huì)傳遞一個(gè)Uri對(duì)象,通過(guò)這個(gè)對(duì)象來(lái)匹配對(duì)應(yīng)的請(qǐng)求,那么如何確定一個(gè)Uri執(zhí)行哪項(xiàng)操作呢?需要用到一個(gè)UriMatcher對(duì)象,這個(gè)對(duì)象用來(lái)幫助內(nèi)容提供者匹配Uri,它所提供的方法非常簡(jiǎn)單,僅有兩個(gè):

  • void addURI(String authoity,String path,int code):添加一個(gè)Uri匹配項(xiàng),authtity為AndroidManifest.xml中注冊(cè)的ContentProvider的authority屬性;path為一個(gè)路徑,可以設(shè)置通配符,#表示任意數(shù)字,*表示任意字符;code為自定義的一個(gè)Uri代碼

  • int match(Uri uri):匹配傳遞的Uri,返回addUri()傳遞的Code參數(shù)。
    在創(chuàng)建好一個(gè)ContentProvider之后,還需要在AndroidManifest.xml文件中對(duì)ContentProvider進(jìn)行配置,使用一個(gè)<provider.../>節(jié)點(diǎn),一般只需要設(shè)置兩個(gè)屬性即可訪問(wèn),一些額外的屬性就是為了設(shè)置訪問(wèn)權(quán)限而存在的

  1. android:name:provide的響應(yīng)類
    1.android:authorities:Provider的唯一標(biāo)識(shí),用于Uri匹配,一般為ContentProvider類的全名

創(chuàng)建及調(diào)用自己的ContentProvider

  • 授權(quán):
    在Android中,每一個(gè)ContentProvider都會(huì)用類似于域名的字符串來(lái)注冊(cè)自己,我們成為授權(quán)(authority)。這個(gè)唯一標(biāo)識(shí)的字符串是此ContentProvider可提供的一組URI的基礎(chǔ),有了這個(gè)基礎(chǔ),才能夠向外界提供信息的共享服務(wù)。
    授權(quán)是在AndroidManifest.xml中完成的,每一個(gè)ContentProvider必須在此聲明并授權(quán),方式如下:

    <provider android:name=".SomeProvider"
    android:authorities="com.your-company.SomeProvider"/>

上面的<provider>元素指明了ContentProvider的提供者是“SomeProvider”這個(gè)類,并為其授權(quán),授權(quán)的基礎(chǔ)URI為“com.your-company.SomeProvider”。有了這個(gè)授權(quán)信息,系統(tǒng)可以準(zhǔn)確的定位到具體的ContentProvider,從而使訪問(wèn)者能夠獲取到指定的信息。這和瀏覽Web頁(yè)面的方式很相似,“SomeProvider”就像一臺(tái)具體的服務(wù)器,而“com.your-company.SomeProvider”就像注冊(cè)的域名,相信大家對(duì)這個(gè)概念并不陌生,由此聯(lián)想一下就可以了解ContentProvider授權(quán)的作用了。(需要注意的是,除了Android內(nèi)置應(yīng)用程序之外,第三方程序應(yīng)盡量使用以上方式的完全限定的授權(quán)名。)

  • MIME類型:
    就像網(wǎng)站返回給定URL的MIME(Multipurpose Internet Mail Extensions,多用途Internet郵件擴(kuò)展)類型一樣(這使瀏覽器能夠用正確的程序來(lái)查看內(nèi)容),ContentProvider還負(fù)責(zé)返回給定URI的MIME類型。根據(jù)MIME類型規(guī)范,MIME類型包含兩部分:類型和子類型。例如:text/html,text/css,text/xml等等。

了解了以上兩個(gè)知識(shí)點(diǎn)之后,我們就結(jié)合實(shí)例來(lái)演示一下具體的過(guò)程。
我們將會(huì)創(chuàng)建一個(gè)記錄person信息的ContentProvider,實(shí)現(xiàn)對(duì)person的CRUD操作

訪問(wèn)者可以通過(guò)“[BASE_URI]/persons”來(lái)操作person集合,也可以通過(guò)“[BASE_URI]/persons/#”的形式操作單個(gè)person。
我們創(chuàng)建一個(gè)person的ContentProvider需要兩個(gè)步驟:

  1. 創(chuàng)建PersonProvider類:

我們需要繼承ContentProvider類,實(shí)現(xiàn)onCreate、query、insert、update、delete和getType這幾個(gè)方法.

public class PersonProvider extends ContentProvider {  
  
    private static final UriMatcher matcher;  
    private DBHelper helper;  
    private SQLiteDatabase db;  
      
    private static final String AUTHORITY = "com.scott.provider.PersonProvider";  
    private static final int PERSON_ALL = 0;  
    private static final int PERSON_ONE = 1;  
      
    public static final String CONTENT_TYPE = "vnd.android.cursor.dir/vnd.scott.person";  
    public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/vnd.scott.person";  
      
    //數(shù)據(jù)改變后立即重新查詢  
    private static final Uri NOTIFY_URI = Uri.parse("content://" + AUTHORITY + "/persons");  
      
    static {  
        matcher = new UriMatcher(UriMatcher.NO_MATCH);  
          
        matcher.addURI(AUTHORITY, "persons", PERSON_ALL);   //匹配記錄集合  
        matcher.addURI(AUTHORITY, "persons/#", PERSON_ONE); //匹配單條記錄  
    }  
      
    @Override  
    public boolean onCreate() {  
        helper = new DBHelper(getContext());  
        return true;  
    }  
  
    @Override  
    public String getType(Uri uri) {  
        int match = matcher.match(uri);  
        switch (match) {  
        case PERSON_ALL:  
            return CONTENT_TYPE;  
        case PERSON_ONE:  
            return CONTENT_ITEM_TYPE;  
        default:  
            throw new IllegalArgumentException("Unknown URI: " + uri);  
        }  
    }  
      
    @Override  
    public Cursor query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder) {  
        db = helper.getReadableDatabase();  
        int match = matcher.match(uri);  
        switch (match) {  
        case PERSON_ALL:  
            //doesn't need any code in my provider.  
            break;  
        case PERSON_ONE:  
            long _id = ContentUris.parseId(uri);  
            selection = "_id = ?";  
            selectionArgs = new String[]{String.valueOf(_id)};  
            break;  
        default:  
            throw new IllegalArgumentException("Unknown URI: " + uri);  
        }  
        return db.query("person", projection, selection, selectionArgs, null, null, sortOrder);  
    }  
  
    @Override  
    public Uri insert(Uri uri, ContentValues values) {  
        int match = matcher.match(uri);  
        if (match != PERSON_ALL) {  
            throw new IllegalArgumentException("Wrong URI: " + uri);  
        }  
        db = helper.getWritableDatabase();  
        if (values == null) {  
            values = new ContentValues();  
            values.put("name", "no name");  
            values.put("age", "1");  
            values.put("info", "no info.");  
        }  
        long rowId = db.insert("person", null, values);  
        if (rowId > 0) {  
            notifyDataChanged();  
            return ContentUris.withAppendedId(uri, rowId);  
        }  
        return null;  
    }  
  
    @Override  
    public int delete(Uri uri, String selection, String[] selectionArgs) {  
        db = helper.getWritableDatabase();  
        int match = matcher.match(uri);  
        switch (match) {  
        case PERSON_ALL:  
            //doesn't need any code in my provider.  
            break;  
        case PERSON_ONE:  
            long _id = ContentUris.parseId(uri);  
            selection = "_id = ?";  
            selectionArgs = new String[]{String.valueOf(_id)};  
        }  
        int count = db.delete("person", selection, selectionArgs);  
        if (count > 0) {  
            notifyDataChanged();  
        }  
        return count;  
    }  
  
    @Override  
    public int update(Uri uri, ContentValues values, String selection, String[] selectionArgs) {  
        db = helper.getWritableDatabase();  
        int match = matcher.match(uri);  
        switch (match) {  
        case PERSON_ALL:  
            //doesn't need any code in my provider.  
            break;  
        case PERSON_ONE:  
            long _id = ContentUris.parseId(uri);  
            selection = "_id = ?";  
            selectionArgs = new String[]{String.valueOf(_id)};  
            break;  
        default:  
            throw new IllegalArgumentException("Unknown URI: " + uri);  
        }  
        int count = db.update("person", values, selection, selectionArgs);  
        if (count > 0) {  
            notifyDataChanged();  
        }  
        return count;  
    }  
  
    //通知指定URI數(shù)據(jù)已改變  
    private void notifyDataChanged() {  
        getContext().getContentResolver().notifyChange(NOTIFY_URI, null);         
    }  
}  

在PersonProvider中,我們定義了授權(quán)地址為“com.scott.provider.PersonProvider”,基于這個(gè)授權(quán),我們使用了一個(gè)UriMatcher對(duì)其路徑進(jìn)行匹配,“[BASE_URI]/persons"和“[BASE_URI]/persons/#”這兩種路徑我們?cè)谏厦嬉步榻B過(guò),分別對(duì)應(yīng)記錄集合和單個(gè)記錄的操作。在query、insert、update和delete方法中我們根據(jù)UriMatcher匹配結(jié)果來(lái)判斷該URI是操作記錄集合還是單條記錄,從而采取不同的處理方法。在getType方法中,我們會(huì)根據(jù)匹配的結(jié)果返回不同的MIME類型,這一步是不能缺少的,比如我們?cè)趒uery方法中有可能是查詢?nèi)考希锌赡苁遣樵儐螚l記錄,那么我們返回的Cursor或是集合類型,或是單條記錄,這個(gè)跟getType返回的MIME類型是一致的,就好像瀏覽網(wǎng)頁(yè)一樣,指定的url返回的信息是什么類型,那么瀏覽器就應(yīng)該接收到對(duì)應(yīng)的MIME類型。另外,我們注意到,上面代碼中,在insert、update、delete方法中都調(diào)用了notifyDataChanged方法,這個(gè)方法中僅有的一步操作就是通知“[BASE_URI]/persons"的訪問(wèn)者,數(shù)據(jù)發(fā)生改變了,應(yīng)該重新加載了。
在我們的PersonProvider中,我們用到了Person、DBHelper類,代碼如下:

public class Person {  
    public int _id;  
    public String name;  
    public int age;  
    public String info;  
      
    public Person() {  
    }  
      
    public Person(String name, int age, String info) {  
        this.name = name;  
        this.age = age;  
        this.info = info;  
    }  
}  

.

public class DBHelper extends SQLiteOpenHelper {  
  
    private static final String DATABASE_NAME = "provider.db";  
    private static final int DATABASE_VERSION = 1;  
      
    public DBHelper(Context context) {  
        super(context, DATABASE_NAME, null, DATABASE_VERSION);  
    }  
  
    @Override  
    public void onCreate(SQLiteDatabase db) {  
        String sql = "CREATE TABLE IF NOT EXISTS person" +  
                "(_id INTEGER PRIMARY KEY AUTOINCREMENT, name VARCHAR, age INTEGER, info TEXT)";  
        db.execSQL(sql);  
    }  
  
    @Override  
    public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {  
        db.execSQL("DROP TABLE IF EXISTS person");  
        onCreate(db);  
    }  
}  

AndroidManifest.xml:

<provider android:name=".PersonProvider"  
    android:authorities="com.scott.provider.PersonProvider"  
    android:multiprocess="true"/>  

2.調(diào)用PersonProvider類:

public class MainActivity extends Activity {  
     
    private ContentResolver resolver;  
    private ListView listView;  
      
    private static final String AUTHORITY = "com.scott.provider.PersonProvider";  
    private static final Uri PERSON_ALL_URI = Uri.parse("content://" + AUTHORITY + "/persons");  
      
    private Handler handler = new Handler() {  
        public void handleMessage(Message msg) {  
            //update records.  
            requery();  
        };  
    };  
      
    @Override  
    public void onCreate(Bundle savedInstanceState) {  
        super.onCreate(savedInstanceState);  
        setContentView(R.layout.main);  
  
        resolver = getContentResolver();  
        listView = (ListView) findViewById(R.id.listView);  
          
        //為PERSON_ALL_URI注冊(cè)變化通知  
        getContentResolver().registerContentObserver(PERSON_ALL_URI, true, new PersonObserver(handler));  
    }  
      
    /** 
     * 初始化 
     * @param view 
     */  
    public void init(View view) {  
        ArrayList<Person> persons = new ArrayList<Person>();  
          
        Person person1 = new Person("Ella", 22, "lively girl");  
        Person person2 = new Person("Jenny", 22, "beautiful girl");  
        Person person3 = new Person("Jessica", 23, "sexy girl");  
        Person person4 = new Person("Kelly", 23, "hot baby");  
        Person person5 = new Person("Jane", 25, "pretty woman");  
          
        persons.add(person1);  
        persons.add(person2);  
        persons.add(person3);  
        persons.add(person4);  
        persons.add(person5);  
  
        for (Person person : persons) {  
            ContentValues values = new ContentValues();  
            values.put("name", person.name);  
            values.put("age", person.age);  
            values.put("info", person.info);  
            resolver.insert(PERSON_ALL_URI, values);  
        }  
    }  
      
    /** 
     * 查詢所有記錄 
     * @param view 
     */  
    public void query(View view) {  
//      Uri personOneUri = ContentUris.withAppendedId(PERSON_ALL_URI, 1);查詢_id為1的記錄  
        Cursor c = resolver.query(PERSON_ALL_URI, null, null, null, null);  
          
        CursorWrapper cursorWrapper = new CursorWrapper(c) {  
              
            @Override  
            public String getString(int columnIndex) {  
                //將簡(jiǎn)介前加上年齡  
                if (getColumnName(columnIndex).equals("info")) {  
                    int age = getInt(getColumnIndex("age"));  
                    return age + " years old, " + super.getString(columnIndex);  
                }  
                return super.getString(columnIndex);  
            }  
        };  
          
        //Cursor須含有"_id"字段  
        SimpleCursorAdapter adapter = new SimpleCursorAdapter(this, android.R.layout.simple_list_item_2,  
                cursorWrapper, new String[]{"name", "info"}, new int[]{android.R.id.text1, android.R.id.text2});  
        listView.setAdapter(adapter);  
          
        startManagingCursor(cursorWrapper); //管理Cursor  
    }  
      
    /** 
     * 插入一條記錄 
     * @param view 
     */  
    public void insert(View view) {  
        Person person = new Person("Alina", 26, "attractive lady");  
        ContentValues values = new ContentValues();  
        values.put("name", person.name);  
        values.put("age", person.age);  
        values.put("info", person.info);  
        resolver.insert(PERSON_ALL_URI, values);  
    }  
      
    /** 
     * 更新一條記錄 
     * @param view 
     */  
    public void update(View view) {  
        Person person = new Person();  
        person.name = "Jane";  
        person.age = 30;  
        //將指定name的記錄age字段更新為30  
        ContentValues values = new ContentValues();  
        values.put("age", person.age);  
        resolver.update(PERSON_ALL_URI, values, "name = ?", new String[]{person.name});  
          
        //將_id為1的age更新為30  
//      Uri updateUri = ContentUris.withAppendedId(PERSON_ALL_URI, 1);  
//      resolver.update(updateUri, values, null, null);  
    }  
      
    /** 
     * 刪除一條記錄 
     * @param view 
     */  
    public void delete(View view) {  
        //刪除_id為1的記錄  
        Uri delUri = ContentUris.withAppendedId(PERSON_ALL_URI, 1);  
        resolver.delete(delUri, null, null);  
          
        //刪除所有記錄  
//      resolver.delete(PERSON_ALL_URI, null, null);  
    }  
      
    /** 
     * 重新查詢 
     */  
    private void requery() {  
        //實(shí)際操作中可以查詢集合信息后Adapter.notifyDataSetChanged();  
        query(null);  
    }  
}  

我們看到,在上面的代碼中,分別對(duì)應(yīng)每一種情況進(jìn)行測(cè)試,相對(duì)較為簡(jiǎn)單。我們主要講一下registerContentObserver這一環(huán)節(jié)。
在前面的PersonProvider我們也提到,在數(shù)據(jù)更改后,會(huì)向指定的URI訪問(wèn)者發(fā)出通知,以便于更新查詢記錄。大家注意,僅僅是ContentProvider出力還不夠,我們還需要在訪問(wèn)者中注冊(cè)一個(gè)ContentObserver,才能夠接收到這個(gè)通知。
下面我們創(chuàng)建一個(gè)PersonObserver:

public class PersonObserver extends ContentObserver {  
  
    public static final String TAG = "PersonObserver";  
    private Handler handler;  
      
    public PersonObserver(Handler handler) {  
        super(handler);  
        this.handler = handler;  
    }  
      
    @Override  
    public void onChange(boolean selfChange) {  
        super.onChange(selfChange);  
        Log.i(TAG, "data changed, try to requery.");  
        //向handler發(fā)送消息,更新查詢記錄  
        Message msg = new Message();  
        handler.sendMessage(msg);  
    }  
}  

這樣一來(lái),當(dāng)ContentProvider發(fā)來(lái)通知之后,我們就能立即接收到,從而向handler發(fā)送一條消息,重新查詢記錄,使我們能夠看到最新的記錄信息。
最后,我們要在AndroidManifest.xml中為MainActivity添加MIME類型過(guò)濾器,告訴系統(tǒng)MainActivity可以處理的信息類型:

<!-- MIME類型 -->  
<intent-filter>  
    <data android:mimeType="vnd.android.cursor.dir/vnd.scott.person"/>  
</intent-filter>  
<intent-filter>  
    <data android:mimeType="vnd.android.cursor.item/vnd.scott.person"/>  
</intent-filter> 

這樣就完成了訪問(wèn)者的代碼。
參考博客:http://blog.csdn.net/liuhe688/article/details/7050868

Android附帶的ContentProvider

  • Browser:存儲(chǔ)如瀏覽器的信息。
  • CallLog:存儲(chǔ)通話記錄等信息。
  • Contacts:存儲(chǔ)聯(lián)系人等信息。
  • MediaStore:存儲(chǔ)媒體文件的信息。
  • Settings:存儲(chǔ)設(shè)備的設(shè)置和首選項(xiàng)信息。

下一篇:
Android數(shù)據(jù)存儲(chǔ)方式

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

推薦閱讀更多精彩內(nèi)容