Android 基础-Android内容提供器之创建自己的内容提

作者: 琼珶和予 | 来源:发表于2017-11-21 21:40 被阅读22次

前面说了怎么访问其他应用程序中的数据，总体来说还是非常的简单。同时，如果我们想要将自己的数据共享出去，Google推荐的方式是使用内容提供器，可以通过继承ContentProvider类的方式来创建一个自己的内容提供器。

1.创建内容提供器

ContentProvider类中有6个抽象方法，我们在使用子类的继承他的时候，必须将其全部重写。

public class MyProvider extends ContentProvider {
    @Override
    public boolean onCreate() {
        return false;
    }

    @Nullable
    @Override
    public Cursor query(@NonNull Uri uri, @Nullable String[] projection, @Nullable String selection, @Nullable String[] selectionArgs, @Nullable String sortOrder) {
        return null;
    }

    @Nullable
    @Override
    public String getType(@NonNull Uri uri) {
        return null;
    }

    @Nullable
    @Override
    public Uri insert(@NonNull Uri uri, @Nullable ContentValues values) {
        return null;
    }

    @Override
    public int delete(@NonNull Uri uri, @Nullable String selection, @Nullable String[] selectionArgs) {
        return 0;
    }

    @Override
    public int update(@NonNull Uri uri, @Nullable ContentValues values, @Nullable String selection, @Nullable String[] selectionArgs) {
        return 0;
    }
}

其中query()、insert()、update()、delete()方法，我们在ContentResolver类中已经见到过，所以我们重点放在onCreate()方法和getType()方法。

(1).onCreate()方法

在初始化内容提供器的时候调用。通常在这里完成对数据库的创建和升级等操作，返回true表示内容提供器初始化成功，返回false则表示失败。注意，只有当存在ContentResolver尝试访问当前程序的数据时，内容提供器才会被初始化。

(2).getType()方法

这个方法根据传入的内容URI来会返回相应的MIME类型。我们发现，在以上的方法中，几乎每一个方法都带一个Uri的参数，这个参数也正是调用ContentResolver的相关方法传递过来的，而现在，我们需要对传入的Uri参数进行解析，从中分析出调用者想要访问的数据。
首先，一个标准的内容Uri写法是如下的格式：
content://com.example.demo.provider/table1
这个表示调用者想要访问com.example.demo这个应用的table1表数据。除此之外，我们还可以在这个内容Uri的后面加上一个id，如下格式
content://com.example.demo.provider/table1/1
这个表示调用者想要访问table1表中id为1的数据
内容Uri的格式主要分为上面两种，以路径结尾的Uri表示想要访问该表中所有的数据，以id结尾就表示想要访问该表中相应id的数据。我们可以使用通配符的方式来分别匹配这两种格式的Uri

A*:表示匹配任意长的任意字符

B.#:表示匹配任意长度的数字

所以，一个能够匹配任意表的内容Uri格式就可以表示为:
content://com.example.demo.provider/*
一个能够特定表(这里指明是table1)表中任意一行数据的内容Uri就可以表示为：
content://com.example.demo.provider/table1/#
然后，我们借助UriMatcher这个类就可以轻松的实现匹配内容Uri的功能。UriMatcher中提供一个addURI()方法，这个方法接收三个参数，可以分别把authority、path和自定义的代码传入。这样，当调用match()方法时，就可以把一个Uri对象传入，返回值就是该Uri对象对应的自定义代码，利用这个代码，我们就可以判断出调用者想要哪一张表中的数据。

private static final int TABLE1_DIR = 0;
    private static final int TABLE1_ITEM = 1;
    private static final int TABLE2_DIR = 3;
    private static final int TABLE2_ITEM = 4;
    private static UriMatcher matcher = null;

    static {
        matcher = new UriMatcher(UriMatcher.NO_MATCH);
        matcher.addURI("com.example.pby.demo.provider", "table1", TABLE1_DIR);
        matcher.addURI("com.example.pby.demo.provider", "table1/#", TABLE1_ITEM);
        matcher.addURI("com.example.pby.demo.provider", "table2", TABLE2_DIR);
        matcher.addURI("com.example.pby.demo.provider", "table2/#", TABLE1_ITEM);
    }


    @Nullable
    @Override
    public Cursor query(@NonNull Uri uri, @Nullable String[] projection, @Nullable String selection, @Nullable String[] selectionArgs, @Nullable String sortOrder) {
        switch (matcher.match(uri)) {
            //查询table1表中的所有数据
            case TABLE1_DIR: {
                break;
            }
            //查询table1表中的某一条数据
            case TABLE1_ITEM: {
                break;
            }
            //查询table2表中的所有数据
            case TABLE2_DIR: {
                break;
            }
            //产讯table2表中的某一条数据
            case TABLE2_ITEM: {
                break;
            }
        }
        return null;
    }

除此之外，还有一个getType()方法。它是所有的内容提供器都必须提供的方法，用于获取Uri对象对应的MIME类型。
一个内容URI所对应的MIME字符串主要由3部分组成，Android对这3个部分做了如下格式规定：

A.必须以vnd开头。

B.如果URI以路径结尾，则后接android.cursor.dir/；如果是以id结尾，则后接android.cursor.item/

C.最后接上vnd.<authority>.<path>

例如：
content://com.example.pby.demo.provider/table1这个内容Uri对应的MIME类型：vnd.android.cursor.dir/vnd.com.example.pby.demo.provider.table1
content://com.example.pby.demo.provider/table1/1对应vnd.android.cursor.item/vnd.com.example.pby.demo.provider.table1

@Nullable
    @Override
    public String getType(@NonNull Uri uri) {
        switch(matcher.match(uri))
        {
            case TABLE1_DIR:
            {
                return "vnd.android.cursor.dir/vnd.com.example.pby.demo.provider.table1";
            }
            case TABLE1_ITEM:
            {
                return "vnd.android.cursor.item/vnd.com.example.pby.demo.provider.table1";
            }
            case TABLE2_DIR:
            {
                return "vnd.android.cursor.dir/vnd.com.example.pby.demo.provider.table2";
            }
            case TABLE2_ITEM:
            {
                return "vnd.android.cursor.item/vnd.com.example.pby.demo.provider.table2";
            }
        }
        return null;
    }

2.实现跨程序数据共享

通过之前的知识点介绍，初步的学习到了怎么创建一个自己的内容提供器，我们来做一个小demo来测试一下

提供数据的app

(1).MyProvider代码

public class MyProvider extends ContentProvider {
    private static final int PHONETABLE_DIR = 0;
    private static final int PHONETABLE_ITEM = 1;
    private static final String AUTHORITY = "com.example.android_demo.provider";
    private static UriMatcher matcher = null;
    private MySQLiteHelper sqliteHelper = null;

    static {
        matcher = new UriMatcher(UriMatcher.NO_MATCH);
        matcher.addURI("com.example.android_demo.provider", "phoneTable", PHONETABLE_DIR);
        matcher.addURI("com.example.android_demo.provider", "phoneTable/#", PHONETABLE_ITEM);
    }

    @Override
    public boolean onCreate() {
        sqliteHelper = new MySQLiteHelper(getContext(), "dataBase", null, 1);
        return true;
    }

    @Nullable
    @Override
    public Cursor query(@NonNull Uri uri, @Nullable String[] projection, @Nullable String selection, @Nullable String[] selectionArgs, @Nullable String sortOrder) {
        Cursor cursor = null;
        SQLiteDatabase dataBase = sqliteHelper.getReadableDatabase();
        try {
            switch (matcher.match(uri)) {
                case PHONETABLE_DIR: {
                    cursor = dataBase.query("phoneTable", projection, selection, selectionArgs, null,null,sortOrder);
                    break;
                }
                case PHONETABLE_ITEM: {
                    //getPathSegments()方法，它会将内容URI权限之后的部分(也就是authority之后)进行分割，并把分割后
                    //的结果放入到一个字符创列表中去，0表示存放的路径--path,1表示的path之后的id
                    String id = uri.getPathSegments().get(1);
                    cursor = dataBase.query("phoneTable", projection, "id = ?", new String[]{id}, null, null, sortOrder);
                    break;
                }
            }
        } catch (Exception e) {

        } finally {
        }
        return cursor;
    }

    @Nullable
    @Override
    public String getType(@NonNull Uri uri) {
        switch(matcher.match(uri))
        {
            case PHONETABLE_DIR:
            {
                return "vnd.android.cursor.dir/vnd.com.example.android_demo.provider.phoneTable";
            }
            case PHONETABLE_ITEM:
            {
                return "vnd.android.cursor.item/vnd.example.android_demo.provider.phoneTable";
            }
        }
        return null;
    }

    @Nullable
    @Override
    public Uri insert(@NonNull Uri uri, @Nullable ContentValues values) {
        SQLiteDatabase dataBase = sqliteHelper.getWritableDatabase();
        long newId = dataBase.insert("phoneTable", null, values);
        Uri returnUri = Uri.parse("content://" + AUTHORITY + "/phoneTable/" + newId);
        return returnUri;
    }

    @Override
    public int delete(@NonNull Uri uri, @Nullable String selection, @Nullable String[] selectionArgs) {
        int deleteRowsNumber = 0;
        SQLiteDatabase dataBase = sqliteHelper.getWritableDatabase();
        deleteRowsNumber = dataBase.delete("phoneTable", selection, selectionArgs);
        return deleteRowsNumber;
    }

    @Override
    public int update(@NonNull Uri uri, @Nullable ContentValues values, @Nullable String selection, @Nullable String[] selectionArgs) {
        int updateRowNumber = 0;
        SQLiteDatabase dataBase = sqliteHelper.getWritableDatabase();
        updateRowNumber = dataBase.update("phoneTable", values, selection, selectionArgs);
        return updateRowNumber;
    }
}

( 2).SQLiteHelper代码

public class MySQLiteHelper extends SQLiteOpenHelper {
    private static final String SQL_CREATE_PHONENUMBER = "create table phoneTable("+
            "id integer primary key autoincrement,"
            +"name varchar(20),"
            +"phoneNumber varchar(20))";
    private Context context = null;
    public MySQLiteHelper(Context context, String name, SQLiteDatabase.CursorFactory factory, int version) {
        super(context, name, factory, version);
        this.context = context;
    }

    @Override
    public void onCreate(SQLiteDatabase db) {
        db.execSQL(SQL_CREATE_PHONENUMBER);

    }

    @Override
    public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {

    }
}

( 3).MainActivity代码

public class MainActivity extends AppCompatActivity implements View.OnClickListener {
    private Button buttonRead = null;
    private Button buttonAdd = null;
    private RecyclerView myRecyclerView = null;
    private MyAdapter myAdapter = null;
    private List<Bean> datas = null;
    private MySQLiteHelper sqliteHelper = null;

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        initView();
    }

    private void initView() {
        buttonRead = (Button) findViewById(R.id.id_button_read);
        buttonRead.setOnClickListener(this);
        buttonAdd = (Button) findViewById(R.id.id_button_add);
        buttonAdd.setOnClickListener(this);
        myRecyclerView = (RecyclerView) findViewById(R.id.id_recyclerView);
        datas = new ArrayList<>();
        myAdapter = new MyAdapter(this, datas);
        myRecyclerView.setLayoutManager(new LinearLayoutManager(this, LinearLayoutManager.VERTICAL, false));
        myRecyclerView.setAdapter(myAdapter);
        sqliteHelper = new MySQLiteHelper(this, "dataBase", null, 1);
    }

    @Override
    public void onClick(View v) {
        switch (v.getId()) {
            case R.id.id_button_read: {
                query();
                break;
            }
            case R.id.id_button_add: {
                Intent intent = new Intent(this, AddActivity.class);
                startActivity(intent);
                break;
            }
        }
    }

    private void query() {
        SQLiteDatabase dataBase = sqliteHelper.getReadableDatabase();
        datas.clear();
        Cursor cursor = dataBase.query("phoneTable", null, null, null, null, null, null);
        try {
            if(cursor != null)
            {
                while(cursor.moveToNext())
                {
                    String name = cursor.getString(cursor.getColumnIndex("name"));
                    String telePhoneNumber = cursor.getString(cursor.getColumnIndex("phoneNumber"));
                    Bean bean = new Bean(name, telePhoneNumber);
                    datas.add(bean);
                }
                myAdapter.notifyDataSetChanged();
            }
        } catch (Exception e) {

        }finally{
            if(cursor != null)
            {
                cursor.close();
            }
        }
    }
}

(4).配置AndroidManifest.xml文件

创建了一个内容提供器，我们还需要在AndroidManifest.xml文件配置它，这样其他应用程序才能正常的访问到我们的数据

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.example.android_demo">


    <application
        android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:roundIcon="@mipmap/ic_launcher_round"
        android:supportsRtl="true"
        android:theme="@style/AppTheme">
        <activity
            android:name=".main.MainActivity"
            android:launchMode="singleTask">
            <intent-filter>
                <action android:name="android.intent.action.MAIN"></action>
                <category android:name="android.intent.category.LAUNCHER"></category>
            </intent-filter>
        </activity>
        <activity android:name=".main.AddActivity"></activity>
        <provider
            android:name=".provider.MyProvider"
            android:authorities="com.example.android_demo.provider"
            android:enabled="true"
            android:exported="true"></provider>
    </application>
</manifest>

其中属性中的name表示provider的名字，android:authorities表示provider的authority，而android:enabled和android:exported属性则是根据我们刚才勾选的状态生成的，这里表示provider能够被其他应用程序进行访问

(5).添加数据

先向数据库中添加一定的数据，然后在本app上测试一下效果

(6).其他app上测试

在另一个app上测试是否能够成功获取数据

public class MainActivity extends AppCompatActivity implements View.OnClickListener {
    private Button buttonRead = null;
    private RecyclerView myRecyclerView = null;
    private MyAdapter myAdapter = null;
    private List<Bean> datas = null;

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        initView();
    }

    private void initView() {
        buttonRead = (Button) findViewById(R.id.id_button_read);
        buttonRead.setOnClickListener(this);
        myRecyclerView = (RecyclerView) findViewById(R.id.id_recyclerView);
        datas = new ArrayList<>();
        myAdapter = new MyAdapter(this, datas);
        myRecyclerView.setLayoutManager(new LinearLayoutManager(this, LinearLayoutManager.VERTICAL, false));
        myRecyclerView.setAdapter(myAdapter);
    }

    @Override
    public void onClick(View v) {
        switch (v.getId()) {
            case R.id.id_button_read: {
                query();
                break;
            }
        }
    }

    private void query() {
        Uri uri = Uri.parse("content://com.example.android_demo.provider/phoneTable");
        Cursor cursor = getContentResolver().query(uri, null, null, null, null, null);
        datas.clear();
        if (cursor != null) {
            try {
                while (cursor.moveToNext()) {
                    String name = cursor.getString(cursor.getColumnIndex("name"));
                    String phoneNumber = cursor.getString(cursor.getColumnIndex("phoneNumber"));
                    Bean bean = new Bean(name, phoneNumber);
                    datas.add(bean);
                }
                myAdapter.notifyDataSetChanged();
            } catch (Exception e) {
            } finally {
                cursor.close();
            }
        }
    }
}