Android的Content Provider组件

来源:互联网 发布:js 控制重新打开页面 编辑:程序博客网 时间:2024/05/21 22:29

        在Android中,应用程序之间是相互独立的,分别运行在各自的进程中。如果应用程序之间相互共享数据该如何实现呢?例如当我们要发送一条短信时,需要用到联系人应用程序,从中选择要发送的人。在这种情况下,Android提供了应用程序之间相互访问的统一接口,这些接口被定义在Content Provider中,其中包括添加、删除、修改和查询等操作。

        ContentProvider定义在android.content包下。我们顶一个ContentProvider必须实现几个抽象方法,这些抽象方法是:

  • Uri insert(Uri uri, ContentValues values)   添加方法
  • int delete(Uri uri, String selection, String[] selectionArgs)  删除方法
  • Cursor query(Uri uri, String[] projection, String selection,String[] selectionArgs, String sortOrder)  查询方法
  • int update(Uri uri, ContentValues values, String selection,String[] selectionArgs)    更新方法
  • String getType(Uri uri)  获得MIME数据类型
1、ContentResolver
        我们是在ContentProvider中实现我们实际操作数据的方法,但是,客户端调用时用到了另外一个接口,它就是ContentResolver.。ContentResolver提供和ContentProvider中对应的方法。我们是间接地通过操作ContentResolver来操作ContentProvider的。
        ContentResolver通过应用程序的getContentResolver()方法获得。一般情况下,ContentResolver是单例的,但是可以有多个ContentResolver在不同的应用进程之间和ContentProvider交互。
2、URI
         ContentProvider又是如何共享其数据的呢?这里用到的是URI,ContentProvider就是通过该对象来共享其数据的。一个URI对象必须以"content://"开头,接下来就是URI的授权部分,这部分要和AndroidManifest.xml配置文件中声明的授权内容一致,后面还可能有数据类型和记录ID。
        通过URI可以使得ContentResolver知道和哪个ContentProvider对应,并且操作哪些表及哪些记录。
        在Android中提供大量的数据ContentProvider。这些内容在android.content包中。下面实现系统对现有的ContentProvider进行操作。
public class MainActivity  extends Activity{private Button btnQuery;private Button btnInsert;@Overrideprotected void onCreate(Bundle savedInstanceState) {super.onCreate(savedInstanceState);setContentView(R.layout.main);btnQuery = (Button) findViewById(R.id.btnQuery);btnInsert = (Button) findViewById(R.id.btnInsert);btnQuery.setOnClickListener(queryListener);btnInsert.setOnClickListener(insertListener);}private OnClickListener queryListener = new OnClickListener() {@Overridepublic void onClick(View v) {//获得ContentResolver实例ContentResolver cr = getContentResolver();//定义UriUri uri = Contacts.People.CONTENT_URI;//定义查询类数组String []projection = {Contacts.PeopleColumns.NAME,Contacts.PeopleColumns.NOTES};//查询条件String selection = Contacts.PeopleColumns.NAME + "=?";//查询条件参数String []selectionArgs = {"Wang Wu"};//排序列String sortOrder = Contacts.PeopleColumns.NAME;//查询获得游标Cursor c = cr.query(uri, projection, selection, selectionArgs, sortOrder);//判断游标是否为空if(c.moveToFirst()){//遍历游标for(int i = 0;i<c.getCount();i++){c.moveToPosition(i);//获得列索引int idname = c.getColumnIndexOrThrow(PeopleColumns.NAME);int idnote = c.getColumnIndexOrThrow(PeopleColumns.NOTES);Log.d("contacts","--------name:"+c.getString(idname)+"     ---note:"+c.getString(idnote));}}}};private OnClickListener insertListener = new OnClickListener() {@Overridepublic void onClick(View v) {//获得ContentResolver实例ContentResolver cr = getContentResolver();//定义UriUri uri = Contacts.People.CONTENT_URI;//实例化ContentValuesContentValues values = new ContentValues();//添加名字values.put(People.NAME, "tom");//添加备注values.put(People.NOTES, "tom is my good friend");//插入数据cr.insert(uri, values);}};}
AndroidManifest.xml程序清单如下
    <!-- 申请读取联系人的权限 -->    <uses-permission android:name="android.permission.READ_CONTACTS"/>    <!-- 申请写联系人的权限 -->    <uses-permission android:name="android.permission.WRITE_CONTACTS"/>       <application        android:allowBackup="true"        android:icon="@drawable/ic_launcher"        android:label="@string/app_name"        android:theme="@style/AppTheme" >        <activity android:name=".MainActivity"            android:label="@string/app_name" >            <intent-filter>                <action android:name="android.intent.action.MAIN" />                <category android:name="android.intent.category.LAUNCHER" />            </intent-filter>        </activity>    </application>
运行效果如下:


点击“插入”按钮,就往联系人里添加一条“tom”的信息,执行完后再进入联系人界面进行查看,如下图:


3、自定义ContentProvider

        上面程序操作的是Android系统自带的核心应用程序的Contacts(通讯录) ContentProvider。当然,我们也可以定义自己的ContentProvider对象来共享数据。要使用ContentProvider来操作数据,必须要有保存数据的场所。可以使用文件或SQLite数据库来保存数据。为了访问数据,就要提供访问数据的接口。这里需要继承ContentProvider类,实现其中访问数据的抽象方法。定义好的ContentProvider必须在AndroidManifest.xml配置文件中声明才能使用。声明中必须添加的参数是授权属性"android:authorities"。

        下面通过一个实例来演示如何创建和使用ContentProvider。该例子主要是员工信息维护,包括添加、删除、修改和查询员工信息。

        3.1、创建一个常量类,该类主要是用来声明一些常量,如列名称、拍序列、URI和内容类型等。该类有一个内部类Employee实现BaseColumns接口,BaseColumns接口是一个常量接口,里面有一个“_id”和“_count”字符串常量,分别用来表示记录ID和记录总数。

/** * 员工信息常量类 */public final class Employees {// 授权常量    public static final String AUTHORITY = "com.igood.provider.Employees";    private Employees() {}    // 内部类    public static final class Employee implements BaseColumns {    // 构造方法        private Employee() {}        // 访问Uri        public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/employee");        // 内容类型        public static final String CONTENT_TYPE = "vnd.android.cursor.dir/vnd.igood.employees";        public static final String CONTENT_ITEM_TYPE = "vnd.android.cursor.item/vnd.igood.employees";                // 默认排序常量        public static final String DEFAULT_SORT_ORDER = "name DESC";// 按姓名排序        // 表字段常量        public static final String NAME = "name";// 姓名        public static final String GENDER= "gender";// 性别        public static final String AGE = "age"; // 年龄    }}
        3.2、创建一个数据库帮助类,该类继承SQLiteOpenHelper类,在其中声明了数据库名称、数据库版本和表名称一些常量,该类有三个方法:构造函数用来创建数据库;onCreate方法用来创建表;onUpgrade方法是当数据库版本改变时更新表。

/** * 数据库工具类 */public class DBHelper extends SQLiteOpenHelper{    // 数据库名称常量    private static final String DATABASE_NAME = "Employees.db";    // 数据库版本常量    private static final int DATABASE_VERSION = 1;    // 表名称常量    public static final String EMPLOYEES_TABLE_NAME = "employee";// 构造方法public DBHelper(Context context) {// 创建数据库super(context, DATABASE_NAME,null, DATABASE_VERSION);}// 创建时调用public void onCreate(SQLiteDatabase db) {        db.execSQL("CREATE TABLE " + EMPLOYEES_TABLE_NAME + " ("                + Employee._ID + " INTEGER PRIMARY KEY,"                + Employee.NAME + " TEXT,"                + Employee.GENDER + " TEXT,"                + Employee.AGE + " INTEGER"                + ");");}// 版本更新时调用public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {// 删除表db.execSQL("DROP TABLE IF EXISTS employee");        onCreate(db);}}
        3.3、创建EmployeeProvider类,该类继承ContentProvider,实现其抽象方法来操作数据库。该类引用DBHelper类来获得数据库实例,引用UriMatcher工具类来对URI进行匹配比较,引用HashMap保存查询列,在onCreate方法中实例化DBHelper获得数据库实例,在insert方法中实现插入数据,在delete方法中实现删除数据,在query方法中实现查询数据,在update方法中实现更新数据。

public class EmployeeProvider extends ContentProvider{// 数据库帮助类private DBHelper dbHelper;    // Uri工具类    private static final UriMatcher sUriMatcher;    // 查询、更新条件    private static final int EMPLOYEE = 1;    private static final int EMPLOYEE_ID = 2;    // 查询列集合    private static HashMap<String, String> empProjectionMap;    static {    // Uri匹配工具类        sUriMatcher = new UriMatcher(UriMatcher.NO_MATCH);        sUriMatcher.addURI(Employees.AUTHORITY, "employee", EMPLOYEE);        sUriMatcher.addURI(Employees.AUTHORITY, "employee/#", EMPLOYEE_ID);        // 实例化查询列集合        empProjectionMap = new HashMap<String, String>();        // 添加查询列        empProjectionMap.put(Employee._ID, Employee._ID);        empProjectionMap.put(Employee.NAME, Employee.NAME);        empProjectionMap.put(Employee.GENDER, Employee.GENDER);        empProjectionMap.put(Employee.AGE, Employee.AGE);    }// 创建是调用public boolean onCreate() {// 实例化数据库帮助类dbHelper = new DBHelper(getContext());return true;}// 添加方法public Uri insert(Uri uri, ContentValues values) {// 获得数据库实例SQLiteDatabase db = dbHelper.getWritableDatabase();// 插入数据,返回行IDlong rowId = db.insert(DBHelper.EMPLOYEES_TABLE_NAME, Employee.NAME, values);// 如果插入成功返回uri        if (rowId > 0) {            Uri empUri = ContentUris.withAppendedId(Employee.CONTENT_URI, rowId);            getContext().getContentResolver().notifyChange(empUri, null);            return empUri;        }return null;}// 删除方法public int delete(Uri uri, String selection, String[] selectionArgs) {// 获得数据库实例SQLiteDatabase db = dbHelper.getWritableDatabase(); // 获得数据库实例        int count;        switch (sUriMatcher.match(uri)) {        // 根据指定条件删除        case EMPLOYEE:            count = db.delete(DBHelper.EMPLOYEES_TABLE_NAME, selection, selectionArgs);            break;        // 根据指定条件和ID删除        case EMPLOYEE_ID:            String noteId = uri.getPathSegments().get(1);            count = db.delete(DBHelper.EMPLOYEES_TABLE_NAME, Employee._ID + "=" + noteId                    + (!TextUtils.isEmpty(selection) ? " AND (" + selection + ')' : ""), selectionArgs);            break;        default:            throw new IllegalArgumentException("错误的 URI " + uri);        }        getContext().getContentResolver().notifyChange(uri, null);        return count;}// 获得类型public String getType(Uri uri) {return null;}// 查询方法public Cursor query(Uri uri, String[] projection, String selection,String[] selectionArgs, String sortOrder) { SQLiteQueryBuilder qb = new SQLiteQueryBuilder();        switch (sUriMatcher.match(uri)) {        // 查询所有        case EMPLOYEE:            qb.setTables(DBHelper.EMPLOYEES_TABLE_NAME);            qb.setProjectionMap(empProjectionMap);            break;        // 根据ID查询        case EMPLOYEE_ID:            qb.setTables(DBHelper.EMPLOYEES_TABLE_NAME);            qb.setProjectionMap(empProjectionMap);            qb.appendWhere(Employee._ID + "=" + uri.getPathSegments().get(1));            break;        default:            throw new IllegalArgumentException("Uri错误! " + uri);        }        // 使用默认排序        String orderBy;        if (TextUtils.isEmpty(sortOrder)) {            orderBy = Employee.DEFAULT_SORT_ORDER;        } else {            orderBy = sortOrder;        }        // 获得数据库实例        SQLiteDatabase db = dbHelper.getReadableDatabase();        // 返回游标集合        Cursor c = qb.query(db, projection, selection, selectionArgs, null, null, orderBy);        c.setNotificationUri(getContext().getContentResolver(), uri);        return c;}// 更新方法public int update(Uri uri, ContentValues values, String selection,String[] selectionArgs) {    // 获得数据库实例        SQLiteDatabase db = dbHelper.getWritableDatabase();        int count;        switch (sUriMatcher.match(uri)) {        // 根据指定条件更新        case EMPLOYEE:            count = db.update(DBHelper.EMPLOYEES_TABLE_NAME, values, selection, selectionArgs);            break;        // 根据指定条件和ID更新        case EMPLOYEE_ID:            String noteId = uri.getPathSegments().get(1);            count = db.update(DBHelper.EMPLOYEES_TABLE_NAME, values, Employee._ID + "=" + noteId                    + (!TextUtils.isEmpty(selection) ? " AND (" + selection + ')' : ""), selectionArgs);            break;        default:            throw new IllegalArgumentException("错误的 URI " + uri);        }        getContext().getContentResolver().notifyChange(uri, null);        return count;}}
        3.4、ContentProvider必须声明才能使用,因此,需要在AndroidManifest.xml配置文件中声明。声明很简单,需要雷鸣和授权名称两个属性。

        <provider android:name="EmployeeProvider"     android:authorities="com.igood.provider.Employees"/>
        3.5、测试,在MainActivity中创建添加、删除、更新和查询方法。
public class MainActivity  extends Activity{@Overrideprotected void onCreate(Bundle savedInstanceState) {super.onCreate(savedInstanceState);        setContentView(R.layout.main);        // 添加        insert();        // 查询        query();        // 更新        update();        // 查询        query();        // 删除        del();        // 查询        query();    }    // 删除方法    private void del(){    Log.i("emp", "--delete id=1 data --------");    // 删除ID为1的记录    Uri uri = ContentUris.withAppendedId(Employee.CONTENT_URI, 1);    // 获得ContentResolver,并删除    getContentResolver().delete(uri, null, null);    }    // 更新    private void update(){    Log.i("emp", "--update change James to James --------");    // 更新ID为1的记录    Uri uri = ContentUris.withAppendedId(Employee.CONTENT_URI, 1);    ContentValues values = new ContentValues();    // 添加员工信息    values.put(Employee.NAME, "James");    values.put(Employee.GENDER, "male");    values.put(Employee.AGE,31);    // 获得ContentResolver,并更新getContentResolver().update(uri, values, null, null);    }    // 查询    private void query(){    Log.i("emp", "--query database --------");    // 查询列数组       String[] PROJECTION = new String[] {        Employee._ID, // 0       Employee.NAME, // 1       Employee.GENDER, // 2       Employee.AGE // 3    };    // 查询所有备忘录信息Cursor c = managedQuery(Employee.CONTENT_URI, PROJECTION, null,null, Employee.DEFAULT_SORT_ORDER);// 判断游标是否为空if (c.moveToFirst()) {// 遍历游标for (int i = 0; i < c.getCount(); i++) {c.moveToPosition(i);// 获得姓名String name = c.getString(1);String gender = c.getString(2);int age = c.getInt(3);// 输出日志Log.i("emp", name+":"+gender+":"+age);}}else{Log.i("emp", "--no data --------");}    }    // 插入    private void insert(){    // 声明Uri    Uri uri = Employee.CONTENT_URI;    // 实例化ContentValues    ContentValues values = new ContentValues();    // 添加员工信息    values.put(Employee.NAME, "Lin");    values.put(Employee.GENDER, "male");    values.put(Employee.AGE,28);    // 获得ContentResolver,并插入    getContentResolver().insert(uri, values);        Log.i("emp", "--insert Employee: Lin --------");    }}

          运行效果如下:


0 0
原创粉丝点击