Android四大组件学习之ContentProvider

概念

ContentProvider是Android应用对外开放的数据接口，只要符合它所定义的Uri格式的请求，均可以正常访问执行操作。其他的Android应用可以使用ContentResolver对象通过与ContentProvider同名的方法请求执行，被执行的就是ContentProvider中的同名的方法。所以ContentProvider很多对外可以访问的方法，在ContentResolver中均有同名的方法，是一一对应的。

基本使用

ContentProvider是内容提供者，实现Android应用之间的数据交互，对于数据操作，无非也就是CRUD而已。下面是ContentProvider必须要实现的几个方法：

  • onCreate()：初始化提供者。
  • query(Uri, String[], String, String[], String)：查询数据，返回一个数据Cursor对象。
  • insert(Uri, ContentValues)：插入一条数据。
  • update(Uri, ContentValues, String, String[])：根据条件更新数据。
  • delete(Uri, String, String[])：根据条件删除数据。
  • getType(Uri) 返回MIME类型对应内容的URI。、

除了onCreate()和getType()方法外，其他的均为CRUD操作，这些方法中，Uri参数为与ContentProvider匹配的请求Uri，剩下的参数可以参见SQLite的CRUD操作，基本一致。
还有两个方法：call()和bulkInsert()方法，使用call，理论上可以在ContentResolver中执行ContentProvider暴露出来的任何方法，而bulkInsert()方法用于插入多条数据。

在ContentProvider的CRUD操作，均会传递一个Uri对象，通过这个对象来匹配对应的请求，那么如何确定一个Uri执行哪项操作呢？需要用到一个UriMatcher对象，这个对象用来帮助内容提供者匹配Uri，它所提供的方法非常简单，仅有两个：

  • void addURI(String authoity,String path,int code):添加一个Uri匹配项，authtity为AndroidManifest.xml中注册的ContentProvider的authority属性；path为一个路径，可以设置通配符，#表示任意数字，*表示任意字符；code为自定义的一个Uri代码

  • int match(Uri uri):匹配传递的Uri，返回addUri()传递的Code参数。
    在创建好一个ContentProvider之后，还需要在AndroidManifest.xml文件中对ContentProvider进行配置，使用一个<provider.../>节点，一般只需要设置两个属性即可访问，一些额外的属性就是为了设置访问权限而存在的

  1. android:name:provide的响应类
    1.android:authorities:Provider的唯一标识，用于Uri匹配，一般为ContentProvider类的全名

创建及调用自己的ContentProvider

  • 授权：
    在Android中，每一个ContentProvider都会用类似于域名的字符串来注册自己，我们成为授权(authority)。这个唯一标识的字符串是此ContentProvider可提供的一组URI的基础，有了这个基础，才能够向外界提供信息的共享服务。
    授权是在AndroidManifest.xml中完成的，每一个ContentProvider必须在此声明并授权，方式如下：

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

上面的<provider>元素指明了ContentProvider的提供者是“SomeProvider”这个类，并为其授权，授权的基础URI为“com.your-company.SomeProvider”。有了这个授权信息，系统可以准确的定位到具体的ContentProvider，从而使访问者能够获取到指定的信息。这和浏览Web页面的方式很相似，“SomeProvider”就像一台具体的服务器，而“com.your-company.SomeProvider”就像注册的域名，相信大家对这个概念并不陌生，由此联想一下就可以了解ContentProvider授权的作用了。（需要注意的是，除了Android内置应用程序之外，第三方程序应尽量使用以上方式的完全限定的授权名。）

  • MIME类型：
    就像网站返回给定URL的MIME（Multipurpose Internet Mail Extensions，多用途Internet邮件扩展）类型一样（这使浏览器能够用正确的程序来查看内容），ContentProvider还负责返回给定URI的MIME类型。根据MIME类型规范，MIME类型包含两部分：类型和子类型。例如：text/html，text/css，text/xml等等。

了解了以上两个知识点之后，我们就结合实例来演示一下具体的过程。
我们将会创建一个记录person信息的ContentProvider，实现对person的CRUD操作

访问者可以通过“[BASE_URI]/persons”来操作person集合，也可以通过“[BASE_URI]/persons/#”的形式操作单个person。
我们创建一个person的ContentProvider需要两个步骤：

  1. 创建PersonProvider类：

我们需要继承ContentProvider类，实现onCreate、query、insert、update、delete和getType这几个方法.

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";  
      
    //数据改变后立即重新查询  
    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数据已改变  
    private void notifyDataChanged() {  
        getContext().getContentResolver().notifyChange(NOTIFY_URI, null);         
    }  
}

在PersonProvider中，我们定义了授权地址为“com.scott.provider.PersonProvider”，基于这个授权，我们使用了一个UriMatcher对其路径进行匹配，“[BASE_URI]/persons"和“[BASE_URI]/persons/#”这两种路径我们在上面也介绍过，分别对应记录集合和单个记录的操作。在query、insert、update和delete方法中我们根据UriMatcher匹配结果来判断该URI是操作记录集合还是单条记录，从而采取不同的处理方法。在getType方法中，我们会根据匹配的结果返回不同的MIME类型，这一步是不能缺少的，比如我们在query方法中有可能是查询全部集合，有可能是查询单条记录，那么我们返回的Cursor或是集合类型，或是单条记录，这个跟getType返回的MIME类型是一致的，就好像浏览网页一样，指定的url返回的信息是什么类型，那么浏览器就应该接收到对应的MIME类型。另外，我们注意到，上面代码中，在insert、update、delete方法中都调用了notifyDataChanged方法，这个方法中仅有的一步操作就是通知“[BASE_URI]/persons"的访问者，数据发生改变了，应该重新加载了。
在我们的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.调用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注册变化通知  
        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) {  
                //将简介前加上年龄  
                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() {  
        //实际操作中可以查询集合信息后Adapter.notifyDataSetChanged();  
        query(null);  
    }  
}

我们看到，在上面的代码中，分别对应每一种情况进行测试，相对较为简单。我们主要讲一下registerContentObserver这一环节。
在前面的PersonProvider我们也提到，在数据更改后，会向指定的URI访问者发出通知，以便于更新查询记录。大家注意，仅仅是ContentProvider出力还不够，我们还需要在访问者中注册一个ContentObserver，才能够接收到这个通知。
下面我们创建一个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发送消息,更新查询记录  
        Message msg = new Message();  
        handler.sendMessage(msg);  
    }  
}

这样一来，当ContentProvider发来通知之后，我们就能立即接收到，从而向handler发送一条消息，重新查询记录，使我们能够看到最新的记录信息。
最后，我们要在AndroidManifest.xml中为MainActivity添加MIME类型过滤器，告诉系统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>

这样就完成了访问者的代码。
参考博客：http://blog.csdn.net/liuhe688/article/details/7050868

Android附带的ContentProvider

  • Browser：存储如浏览器的信息。
  • CallLog：存储通话记录等信息。
  • Contacts：存储联系人等信息。
  • MediaStore：存储媒体文件的信息。
  • Settings：存储设备的设置和首选项信息。

下一篇：
Android数据存储方式

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 206,482评论 6赞 481
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 88,377评论 2赞 382
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 152,762评论 0赞 342
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 55,273评论 1赞 279
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 64,289评论 5赞 373
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 49,046评论 1赞 285
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 38,351评论 3赞 400
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,988评论 0赞 259
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 43,476评论 1赞 300
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,948评论 2赞 324
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,064评论 1赞 333
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,712评论 4赞 323
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 39,261评论 3赞 307
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,264评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,486评论 1赞 262
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 45,511评论 2赞 354
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 42,802评论 2赞 345

推荐阅读更多精彩内容