欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  移动技术

Android开发之ContentProvider的使用详解

程序员文章站 2023-12-11 22:38:34
前言           content provider为存储数据和获取数据提供了统一...
前言        

  content provider为存储数据和获取数据提供了统一的接口,它可以完成在不同应用程序下的数据共享,而在上一篇文章android开发之sqlite的使用方法讲到的sqlite只能在同一个程序*享数据。另外android为一些常见的数据,比如说音频,视频,图片,通讯录等提供了content provider,这样我们就可以很方便的对这些类型的数据操作了。使用contentprovider的好处是开发人员不需要考虑数据内部是怎么存储的,比如说如果我们想利用contenprovider来存数据,只需告诉insert函数该contentprovider的uri和想存入的数据(包括列名和数值),查询时也是一样,只需输入uri和查询的表,列名和查询条件,至于contentprovider里面是怎么进行这些操作的我们不需要知道。

  实验基础

  在了解本实验的内容,需要用到下面这几个跟contentprovider有关的类。

  urimatcher:

  要了解urimatcher,首先需要了解android中的uri表示方法,众所周知,uri为通用资源标识符,它代表的是要操作的数据,android中的每一种资源(比如文本,图像,视频等)都可以用uri来表示。android中的uri由以下三部分组成:”content://”(即authory),数据的路径,资源标识id(可选),其中如果存在id,则表示某一个具体的资源,如果不存在id,则表示路径下的整体。因此adduri()函数的3个参数也是对应上面的那3个。

  urimatcher的匹配过程分为3步,初始化urimatcher;注册需要用的uri;与已经注册的uri进行匹配。

  contentresolver :

  当使用contentprovider在不同的应用程序*享数据时,其数据的暴露方式是采取类似数据库中表的方法。而contentresolver 是恰好是采用类似数据库的方法来从contentprovider中存取数据的,它是通过uri来查询contentprovider中提供的数据,查询时,还需知道目的数据库的名称,数据段的数据类型,或者说资源的id。

  sqlitequerybuilder:

  sqlitequerybuilder是一个用来生产sql查询语句的辅助类,可以方便的去访问sqlitedatabase. 在构造sql查询语句时,它同样也需要指定表名,指定列名,指定where条件等。

  实验过程

  本文通过一个实例来实现一个contentprovider,其实一般情况下我们是不需要自己来实现的,而是使用andorid内置的contentprovider,但是自己实现一个以后,对它的原理能更深刻的认识,以后使用内置的就得心应手了。这是mars老师的话,本人火候不够,暂时还没深刻的体会。mars老师将实现contentprovider的步骤总结为如下:

  Android开发之ContentProvider的使用详解 

 

  程序中需要4个java文件,下面就分别来介绍实现这些类需注意的事项:

  firstprovidermetadata类:

  因为在继承类firstcontentprovider得到的子类中要用到很多常量,所以这里我们新建了一个类专门用来存储这些常量的,该类这里取名为firstprovidermetadata,里面存着authorty名,数据库名,数据库版本号,表名,字表名,子表uri,子表contentprovider数据类型等等。其中字表是继承basecolumns类的,而basecolumns类中已经有_id和_count这2列了。

  databasehelper类:

  与android中使用sqlite类似,这里同样需要一个继承sqliteopenhelper的子类,子类名为databasehelper,我们在子类的回调函数oncreate()中建立了一个表,表名和表中的列名都是引用firstprovidermetadata类中定义好了的常量的。

  firstcontentprovider类:

  新建一个类,名为firstcontentprovider,继承类contentprovider这个类,且必须重写父类的下面5个方法,否则会报错。这5个方法分别为oncreate(), gettype(), insert(), update(), delete().

  oncreate()为回调函数,是指当contentprovider创建的时候调用,本程序在该函数中使用databasehelper新建了一个sqlite数据库。

  在gettype()方法完成的功能是根据传入的uri,返回该uri所表示的数据类型。函数内部是使用的urimatcher来匹配该函数所传进来的参数,来得到其数据类型。

  insert()函数给指定的数据库表中插入一个指定的值,插入完成后必然会生成一个新的记录,然后利用该记录和表的uri重新生成一个新的uri,这个uri就代表了插入成功的那条记录的uri,该函数返回的也是这个uri。

  mainactivity类:

  在mainactivity中,主要是有2个按钮,分为为它们绑定了监听器,来完成插入和查询操作。

  当单击插入按钮时,在监听器函数中会首先得到一个contentresolver,然后当在执行contentresolver的insert方法时会自动调用contentprovider的insert方法,因为contentresolver的insert方法中的第一个参数就为某个contentprovider的uri。

  androidmanifest.xml:

  contentprovider的使用需要在androidmanifest.xml中进行注册,在activity标签外加入如下声明即可:

<provider android:name="com.example.cptest.firstcontentprovider" android:authorities="com.example.cptest.firstcontentprovider" />

  实验主要部分代码及注释:

mainactivity.java:

复制代码 代码如下:

package com.example.cptest;

//import com.example.cptest.firstprovidermetadata;
import com.example.cptest.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.menu;
import android.view.view;
import android.view.view.onclicklistener;
import android.widget.button;

public class mainactivity extends activity {

    private button insert = null;
    private button query = null;
    @override
    public void oncreate(bundle savedinstancestate) {
        super.oncreate(savedinstancestate);
        setcontentview(r.layout.activity_main);
        insert = (button)findviewbyid(r.id.insert);
        insert.setonclicklistener(new insertonclicklistener());
        query = (button)findviewbyid(r.id.query);
        query.setonclicklistener(new queryonclicklistener());
        system.out.println(getcontentresolver().gettype(firstprovidermetadata.usertablemetadata.content_uri));
    }

    //往子表中插入一条记录
    public class insertonclicklistener implements onclicklistener{

        public void onclick(view arg0) {
            // todo auto-generated method stub   
            contentvalues values = new contentvalues();
            values.put(firstprovidermetadata.usertablemetadata.user_name, "tornadomeet");
            //实际上使用的是contentresolver的insert方法
            //该insert中有2个参数,第一个为代表了contentprovider的uri,第二个参数为要插入的值。此处的insert函数
            //一执行,则自动调用contentprovider的insert方法。
            uri uri = getcontentresolver().insert(firstprovidermetadata.usertablemetadata.content_uri,
                    values);
            system.out.println("uri--->" +uri.tostring());
        }       
    }

   
    //查询也是采用的contentresolver中的query方法。
    public class queryonclicklistener implements onclicklistener{
        public void onclick(view v) {
            // todo auto-generated method stub       
            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)));
        }    
    }

    @override
    public boolean oncreateoptionsmenu(menu menu) {
        getmenuinflater().inflate(r.menu.activity_main, menu);
        return true;
    }
}


databasehelper:
复制代码 代码如下:

package com.example.cptest;

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  verson = 1;//默认的数据库版本

    //继承sqliteopenhelper类的类必须有自己的构造函数
    //该构造函数4个参数,直接调用父类的构造函数。其中第一个参数为该类本身;第二个参数为数据库的名字;
    //第3个参数是用来设置游标对象的,这里一般设置为null;参数四是数据库的版本号。
    public databasehelper(context context, string name, cursorfactory factory, int verson){
        super(context, name, factory, verson);
    }

    //该构造函数有3个参数,因为它把上面函数的第3个参数固定为null了
    public databasehelper(context context, string name, int verson){
        this(context, name, null, verson);
    }

    //该构造函数只有2个参数,在上面函数 的基础山将版本号固定了
    public databasehelper(context context, string name){
        this(context, name, verson);
    }

    //该函数在数据库第一次被建立时调用
    @override
    public void oncreate(sqlitedatabase arg0) {
        // todo auto-generated method stub
        system.out.println("create a database");
        //execsql()为执行参数里面的sql语句,因此参数中的语句需要符合sql语法,这里是创建一个表
        //arg0.execsql("create table user1(id int, name varchar(20))");下面的语句格式是与该句类似
//        arg0.execsql("create table" + firstprovidermetadata.users_table_name
//                + "(" + firstprovidermetadata.usertablemetadata._id
//                + " integer primary key autoincrement," +   //id类型为自增长的整型
//                firstprovidermetadata.usertablemetadata.user_name + " varchar(20));"
//                );
    //    arg0.execsql("create table user1(id int, name varchar(20))");
        arg0.execsql("create table" + firstprovidermetadata.users_table_name + "("
                + firstprovidermetadata.usertablemetadata._id + " integer primary key autoincrement, "
                +firstprovidermetadata.usertablemetadata.user_name + " varchar(20))");
        system.out.println("create a database ok");
    }

    @override
    public void onupgrade(sqlitedatabase arg0, int arg1, int arg2) {
        // todo auto-generated method stub
        system.out.println("update a database");
    }

}


firstprovidermetadata.java:
复制代码 代码如下:

package com.example.cptest;

import android.net.uri;
import android.provider.basecolumns;

public class firstprovidermetadata {

    //这里的authorty为包的全名+contentprovider子类的全名
    public static final string authorty = "com.example.cptest.firstcontentprovider";
    //数据库的名称
    public static final string database_name = "fisrtprovider.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";
        //content_uri为常量uri; parse是将文本转换成uri
        public static final uri content_uri = uri.parse("content://" + authorty + "/users");
        //返回contentprovider中表的数据类型
        public static final string content_type = "vnd.android.cursor.dir/vnd.firstprovider.user";
        //返回contentprovider表中item的数据类型
        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 com.example.cptest;

import java.util.hashmap;

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;

import com.example.cptest.firstprovidermetadata.usertablemetadata;

public class firstcontentprovider extends contentprovider {

    //定义一个urimatcher类对象,用来匹配uri的。
    public static final urimatcher urimatcher;
    //组时的id
    public static final int incoming_user_collection = 1;
    //单个时的id
    public static final int incoming_user_signal = 2;
    private databasehelper dh;//定义一个databasehelper对象
    static{
        urimatcher = new urimatcher(urimatcher.no_match);//urimatcher.no_match表示不匹配任何路径的返回码
        urimatcher.adduri(firstprovidermetadata.authorty, "users", incoming_user_collection);
        urimatcher.adduri(firstprovidermetadata.authorty, "users/#", incoming_user_signal);//后面加了#表示为单个
    }

    public static hashmap<string, string> userprojectionmap;//新建一个hashmap,后面执行插入操作时有用
    static
    {
        userprojectionmap = new hashmap<string, string>();
        //这里可以直接调用另外一个类的public变量,这里put里面的2个参数一样,
        //是因为这里是给数据库表中的列取别名,因此取的是一样的名字
        userprojectionmap.put(usertablemetadata._id, usertablemetadata._id);
        userprojectionmap.put(usertablemetadata.user_name, usertablemetadata.user_name);
    }

    //得到contentprovider的数据类型,返回的参数uri所代表的数据类型
    @override
    public string gettype(uri arg0) {
        // todo auto-generated method stub
        system.out.println("gettype");
        switch(urimatcher.match(arg0)){
        //matcher满足uri的前2项(即协议+路径)为第1种情况时,switch语句的值为uri的第3项,此处为incoming_user_collection
        case incoming_user_collection:
            return usertablemetadata.content_type;
        case incoming_user_signal://同上
            return usertablemetadata.content_type_item;
        default:
            throw new illegalargumentexception("unknown uri" + arg0);//throw是处理异常的,java中的语法
        }
    }

    @override
    public int delete(uri uri, string selection, string[] selectionargs) {
        // todo auto-generated method stub
        system.out.println("delete");
        return 0;
    }

    @override
    public int update(uri uri, contentvalues values, string selection,
            string[] selectionargs) {
        // todo auto-generated method stub
        system.out.println("update");
        return 0;
    }

    @override
    public uri insert(uri uri, contentvalues values) {
        // todo auto-generated method stub
        system.out.println("insert");
//        dh = new databasehelper(getcontext(), firstprovidermetadata.database_name);
        sqlitedatabase db = dh.getwritabledatabase();
        long rowid = db.insert(usertablemetadata.table_name, null, values);
//        system.out.println("insert  ok");
//        system.out.println("" + rowid);
        if(rowid > 0){           
            //发出通知给监听器,说明数据已经改变
            //contenturis为工具类
            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() {
        // todo auto-generated method stub
        system.out.println("oncreate");
        dh = new databasehelper(getcontext(), firstprovidermetadata.database_name);//创建1个databasehelper对象
        return true;
    }

    @override
    public cursor query(uri uri, string[] projection, string selection,
            string[] selectionargs, string sortorder) {
        // todo auto-generated method stub
        system.out.println("query");
        sqlitequerybuilder qb = new sqlitequerybuilder();
        switch(urimatcher.match(uri)){
        case incoming_user_collection:
            qb.settables(usertablemetadata.table_name);//设置表的名称
            qb.setprojectionmap(userprojectionmap);//其中userprojectionmap为上面建立好了的hashmap
            break;
        case incoming_user_signal:
            qb.settables(usertablemetadata.table_name);//设置表的名称
            qb.setprojectionmap(userprojectionmap);//其中userprojectionmap为上面建立好了的hashmap
            //uri.getpathsegments()得到path部分,即把uri的协议+authory部分去掉,把剩下的部分分段获取,这里取第
            //一部分
            qb.appendwhere(usertablemetadata._id + "=" +uri.getpathsegments().get(1));//设置where条件
            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, sortorder);
        //发出通知
        c.setnotificationuri(getcontext().getcontentresolver(), uri);
        return c;
    }

}

上一篇:

下一篇: