Android之内容提供器Content Provider详解(一)

本博文是《第一行代码 Android》的读书笔记/摘录。

一、Content Provider简介

内容提供器(Content Provider)主要用于在不同的应用程序之间实现数据共享的功能,它提供了一套完整的机制,允许一个程序访问另一个程序中的数据,同时还能保证被访数据的安全性。目前,使用内容提供器是Android 实现跨程序共享数据的标准方式。不同于文件存储和SharedPreferences 存储中的两种全局可读写操作模式,内容提供器可以选择只对哪一部分数据进行共享,从而保证我们程序中的隐私数据不会有泄漏的风险。

内容提供器的用法一般有两种,一种是使用现有的内容提供器来读取和操作相应程序中的数据,另一种是创建自己的内容提供器给我们程序的数据提供外部访问接口。

二、访问其他程序中的数据

当一个应用程序通过内容提供器对其数据提供了外部访问接口,任何其他的应用程序就都可以对这部分数据进行访问。Android 系统中自带的电话簿、短信、媒体库等程序都提供了类似的访问接口,这就使得第三方应用程序可以充分地利用这部分数据来实现更好的功能。

(一)ContentResolver 的基本用法

对于每一个应用程序来说,如果想要访问内容提供器中共享的数据,就一定要借助ContentResolve 类,可以通过Context 中的getContentResolver()方法获取到该类的实例。

public abstract ContentResolver getContentResolver();

ContentResolver 中提供了一系列的方法用于对数据进行CRUD 操作,其中insert()方法用于添加数据,update()方法用于更新数据,delete()方法用于删除数据,query()方法用于查询数据。

//插入
public final @Nullable Uri insert(@NonNull Uri url, @Nullable ContentValues values);

//更新
public final int update(@NonNull Uri uri, @Nullable ContentValues values,@Nullable String where, @Nullable String[] selectionArgs);

//删除
public final int delete(@NonNull Uri url, @Nullable String where,@Nullable String[] selectionArgs);

//查询
public final @Nullable Cursor query(@NonNull Uri uri, @Nullable String[] projection,@Nullable String selection, @Nullable String[] selectionArgs,@Nullable String sortOrder)

有没有似曾相识的感觉?没错,SQLiteDatabase 中也是使用的这几个方法来进行CRUD操作的,只不过它们在方法参数上稍微有一些区别。

不同于SQLiteDatabase,ContentResolver 中的增删改查方法都是不接收表名参数的,而是使用一个Uri 参数代替,这个参数被称为内容URI。
内容URI 给内容提供器中的数据建立了唯一标识符,它主要由两部分组成,权限(authority)和路径(path)。

权限是用于对不同的应用程序做区分的,一般为了避免冲突,都会采用程序包名的方式来进行命名。比如某个程序的包名是com.example.app,那么该程序对应的权限就可以命名为com.example.app.provider。

路径则是用于对同一应用程序中不同的表做区分的,通常都会添加到权限的后面。比如某个程序的数据库里存在两张表,table1 和table2,这时就可以将路径分别命名为/table1/table2,然后把权限和路径进行组合,内容URI 就变成com.example.app.provider/table1com.example.app.provider/table2

不过,目前还很难辨认出这两个字符串就是两个内容URI,我们还需要在字符串的头部加上协议声明。因此,内容URI 最标准的格式写法如下:

content://com.example.app.provider/table1
content://com.example.app.provider/table2

有没有发现,内容URI 可以非常清楚地表达出我们想要访问哪个程序中哪张表里的数据。也正是因此,ContentResolver 中的增删改查方法才都接收Uri 对象作为参数,因为使用表名的话系统将无法得知我们期望访问的是哪个应用程序里的表。

在得到了内容URI 字符串之后,我们还需要将它解析成Uri 对象才可以作为参数传入。解析的方法也相当简单,代码如下所示:

Uri uri = Uri.parse("content://com.example.app.provider/table1")

只需要调用Uri.parse()方法,就可以将内容URI 字符串解析成Uri 对象了。

现在我们就可以使用这个Uri 对象来查询table1 表中的数据了,代码如下所示:

    Cursor cursor = getContentResolver().query(
            uri,
            projection,
            selection,
            selectionArgs,
            sortOrder);

这些参数和SQLiteDatabase 中query()方法里的参数很像,但总体来说要简单一些,毕竟这是在访问其他程序中的数据,没必要构建过于复杂的查询语句。下表对使用到的这部分参数进行了详细的解释。
1

查询完成后返回的仍然是一个Cursor 对象,这时我们就可以将数据从Cursor 对象中逐个读取出来了。读取的思路仍然是通过移动游标的位置来遍历Cursor 的所有行,然后再取出每一行中相应列的数据,代码如下所示:

    if (cursor != null) {
        while (cursor.moveToNext()) {
            String column1 = cursor.getString(cursor.getColumnIndex("column1"));
            int column2 = cursor.getInt(cursor.getColumnIndex("column2"));
        }
        cursor.close();
    }

掌握了最难的查询操作,剩下的增加、修改、删除操作就更不在话下了。我们先来看看如何向table1 表中添加一条数据,代码如下所示:

ContentValues values = new ContentValues();
values.put("column1", "text");
values.put("column2", 1);
getContentResolver().insert(uri, values);

可以看到,仍然是将待添加的数据组装到ContentValues 中,然后调用ContentResolver的insert()方法,将Uri 和ContentValues 作为参数传入即可。

现在如果我们想要更新这条新添加的数据, 把column1 的值清空, 可以借助ContentResolver 的update()方法实现,代码如下所示:

    ContentValues values = new ContentValues();
        values.put("column1", "");
        getContentResolver().update(uri, values, "column1 = ? and column2 = ?", new String[] {"text", "1"});

注意上述代码使用了selection 和selectionArgs 参数来对想要更新的数据进行约束,以防止所有的行都会受影响。

最后,可以调用ContentResolver 的delete()方法将这条数据删除掉,代码如下所示:

getContentResolver().delete(uri, "column2 = ?", new String[] { "1" });

那么接下来,我们就利用目前所学的知识,看一看如何读取
系统电话簿中的联系人信息。

(二)读取系统联系人

首先,打开模拟器,手动添加几个联系人以便稍后读取:

2

现在新建一个ContactsTest 项目,首先还是来编写一下布局文件,这里我们希望读取出来的联系人信息能够在ListView 中显示,因此,修改activity_main.xml 中的代码,如下所示:

<?xml version="1.0" encoding="utf-8"?>
<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    android:id="@+id/activity_main"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context="wz.com.contactstest.MainActivity">

    <ListView
        android:id="@+id/contacts_ListView"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"></ListView>
</RelativeLayout>

简单起见,RelativeLayout里就只放置了一个ListView。接着修改MainActivity 中的代码,如下所示:

package wz.com.contactstest;

import android.Manifest;
import android.app.Activity;
import android.content.pm.PackageManager;
import android.database.Cursor;
import android.os.Build;
import android.os.Bundle;
import android.provider.ContactsContract;
import android.support.annotation.NonNull;
import android.support.v4.app.ActivityCompat;
import android.support.v4.content.ContextCompat;
import android.widget.ArrayAdapter;
import android.widget.ListView;
import android.widget.Toast;

import java.util.ArrayList;
import java.util.List;

public class MainActivity extends Activity {
    private static final int REQUEST_CODE_ASK_CALL_PHONE = 123;

    private ListView listView;
    private List<String> contactsList = new ArrayList<>();

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        listView = (ListView) findViewById(R.id.contacts_ListView);
    }

    @Override
    protected void onResume() {
        super.onResume();

        //动态权限管理
        if (Build.VERSION.SDK_INT >= 23) {
            int checkCallPhonePermission = ContextCompat.checkSelfPermission(this, Manifest.permission.READ_CONTACTS);
            if (checkCallPhonePermission != PackageManager.PERMISSION_GRANTED) {
                ActivityCompat.requestPermissions(this, new String[]{Manifest.permission.READ_CONTACTS}, REQUEST_CODE_ASK_CALL_PHONE);
                return;
            }
        } else {
            readContacts();
            ArrayAdapter adapter = new ArrayAdapter(this, android.R.layout.simple_list_item_1, contactsList);
            listView.setAdapter(adapter);
        }
    }

    @Override
    public void onRequestPermissionsResult(int requestCode, @NonNull String[] permissions, @NonNull int[] grantResults) {
        switch (requestCode) {
            case REQUEST_CODE_ASK_CALL_PHONE:
                if (grantResults[0] == PackageManager.PERMISSION_GRANTED) {
                    readContacts();
                    ArrayAdapter adapter = new ArrayAdapter(this, android.R.layout.simple_list_item_1, contactsList);
                    listView.setAdapter(adapter);
                } else {
                    // Permission Denied
                    Toast.makeText(this, "READ_CONTACTS Denied", Toast.LENGTH_SHORT).show();
                }
                break;
            default:
                super.onRequestPermissionsResult(requestCode, permissions, grantResults);
        }
    }

    /**
     * 从通讯录中读取联系人数据
     */
    private void readContacts() {
        Cursor cursor = null;
        try {
            cursor = getContentResolver().query(ContactsContract.CommonDataKinds.Phone.CONTENT_URI, null, null, null, null);
            while (cursor.moveToNext()) {
                String name = cursor.getString(cursor.getColumnIndex(ContactsContract.CommonDataKinds.Phone.DISPLAY_NAME));
                String phoneNumber = cursor.getString(cursor.getColumnIndex(ContactsContract.CommonDataKinds.Phone.NUMBER));
                contactsList.add("姓名:" + name + "   电话:" + phoneNumber);
            }
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            if (cursor != null) {
                cursor.close();
            }
        }

    }

}

下面重点看下readContacts()方法,可以看到,这里使用了ContentResolver 的query()方法来查询系统的联系人数据。不过传入的Uri 参数怎么有些奇怪啊, 为什么没有调用Uri.parse() 方法去解析一个内容URI 字符串呢?

这是因为ContactsContract.CommonDataKinds.Phone类已经帮我们做好了封装,提供了一个CONTENT_URI常量,而这个常量就是使用Uri.parse()方法解析出来的结果。接着我们对Cursor 对象进行遍历, 将联系人姓名和手机号这些数据逐个取出, 联系人姓名这一列对应的常量是ContactsContract.CommonDataKinds.Phone.DISPLAY_NAME,联系人手机号这一列对应的常量是ContactsContract.CommonDataKinds.Phone.NUMBER。两个数据都取出之后,将它们进行拼接,并且中间加上换行符,然后将拼接后的数据添加到ListView 里。最后千万不要忘记将Cursor 对象关闭掉。

需要注意的是,Android6.0及以上版本多了动态权限管理,需要处理一下

读取系统联系人也是需要声明权限的,因此修改AndroidManifest.xml 中的代码,如下所示:

<uses-permission android:name="android.permission.READ_CONTACTS" />

运行,点击允许:

3

刚刚添加的两个联系人的数据都成功读取出来了!说明跨程序访问数据的功能确实是实现了。

未完待续。。。

  • 2
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值