创建内容提供器的步骤
通过新建一个类去继承ContentProvider的方式来创建一个自己的内容提供器,这个类中有6个抽象方法,我们在使用子类继承它的时候,需要把这个6个方法全部重写
- 新建MyProvider继承自ContentProvider,代码如下
public class MyProvider extends ContentProvider{
@Override
public boolean onCreate() {
return false;
}
@Nullable
@Override
public Cursor query(@NonNull Uri uri, @Nullable String[] strings, @Nullable String s, @Nullable String[] strings1, @Nullable String s1) {
return null;
}
@Nullable
@Override
public String getType(@NonNull Uri uri) {
return null;
}
@Nullable
@Override
public Uri insert(@NonNull Uri uri, @Nullable ContentValues contentValues) {
return null;
}
@Override
public int delete(@NonNull Uri uri, @Nullable String s, @Nullable String[] strings) {
return 0;
}
@Override
public int update(@NonNull Uri uri, @Nullable ContentValues contentValues, @Nullable String s, @Nullable String[] strings) {
return 0;
}
}
这6个方法大部分都是见过的
- onCreate()
- 初始化内容提供器的时候调用,通常在这个里对数据库的创建和升级操作,返回true表示内容提供器初始化成功,返回false表示失败,注意,只有ContentResolver尝试访问程序中的数据的时候,内容提供器才会被初始化
- query()
- 从内容提供器中查询数据的,使用uri参数来确定有那张表,第二个参数是确定查询那些列,第三个第四个参数用于约束查询那些行,第五个参数用于对结果进行排序,查询的结果放在Cursor对象中返回
- insert()
- 向内容提供器中添加一条数据,使用uri参数用于确定添加到的表,待添加的数据保存在values参数中,添加完成后,返回一个用于表示这天记录的URI
- update()
- 更新内容提供器中已有的数据,使用uri参数来确定要更新那张表的数据,新数据保存在第二个参数中,第三个第四个参数用于约束更新那些行,受影响的行数将作为返回值返回
- delete()
- 从内容提供器中删除数据,使用uri参数来确定删除那张表中的数据,第二个第三个参数是用于约束删除那些行,被删除的行数作为返回值返回
- getType()
- 根据传入的URI来返回相应的MIME类型
- 可以看到几乎每一个方法中都会有这个uri参数,这个参数也是调用ContentREsolver的增删改查方法时传递过来的,现在会传入的uri参数进行解析,从中分析出调用方期望访问的表和数据
- 一个标准的uri是这样写的
content://com.example.app.provider/table1
这就表示期望访问的是com.example.app这个应用的table1表中的数据,还可以在内容后面加一个id
content://com.example.app.provider/table1/1
这就表示期望访问的是com.example.app应用的table1表中的id为1的数据 - 内容URI的格式主要就有以上的两种,以路径结尾的就表示期望访问该表中的所有数据,以id结尾表示访问该表中拥有响应id的数据,还可以使用通配符的方式分别来匹配这两种格式的URI
*:表示匹配任意长度的任意字符
#:表示匹配任意长度的数字
所以一个能够匹配任意表的内容的URI就可以写成
content"//com.example.app.provider/*
而一个能够匹配table1表中任意一行数据的内容的URI就可以写成
content"//com.example.app.provider/table/#
- 接着借助这个UriMatcher这个类就可以轻松地实现匹配内容URI的功能,UriMatcher中提供一个addURI()方法,这个方法接收3个参数,分别把
authority、path和一个自定义代码传进去
,这样,当调用UriMatcher的match()方法时,就可以将一个Uri对象传入,返回值就是某个能够匹配这个Uri对象所对应的自定义代码,利用这个代码,就可以判断出调用方期望访问的是那张表中的数据了,修改MyProvider中的代码
public class MyProvider extends ContentProvider{
// table1表中的所有数据
public static final int TABLE1_DIR = 0;
// table1表中的单条数据
public static final int TABLE1_ITEM = 1;
// table2表中的所有数据
public static final int TABLE2_DIR = 2;
// table2表中的单条数据
public static final int TABLE2_ITEM = 3;
private static UriMatcher uriMatcher;
static {
uriMatcher = new UriMatcher(UriMatcher.NO_MATCH);
uriMatcher.addURI("com.example.md.contacts","table1",TABLE1_DIR);
uriMatcher.addURI("com.example.md.contacts","table1/#",TABLE1_ITEM);
uriMatcher.addURI("com.example.md.contacts","table2",TABLE2_DIR);
uriMatcher.addURI("com.example.md.contacts","table2/#",TABLE2_ITEM);
}
@Override
public boolean onCreate() {
return false;
}
@Nullable
@Override
public Cursor query(@NonNull Uri uri, @Nullable String[] strings, @Nullable String s, @Nullable String[] strings1, @Nullable String s1) {
Cursor cursor = null;
switch (uriMatcher.match(uri)){
case TABLE1_DIR:
// 查询table1表中的所有数据
break;
case TABLE1_ITEM:
// 查询table1表中的单条数据
break;
case TABLE2_DIR:
// 查询table2表中的所有数据
break;
case TABLE2_ITEM:
// 传table2表中的单条数据
break;
default:
break;
}
return cursor;
}
// 剩下的和上面的一样
...
}
- 新增了4个整型常量,接着在静态代码块中创建了UriMatcher的实例,
并调用了addURI()方法,将期望匹配的内容URI格式传递进入,
注意这个传入的路径参数是可以使用通配符的 - 当query()方法被调用的时候,
就会通过UriMatcher的match()方法对传入的Uri对象进行匹配,如果发现UriMatcher中的某个内容URI格式成功匹配了该Uri对象,则会返回相应的自定义代码,然然后就可以判断出调用的期望访问的到底是什么数据了
- 上面的query()方法只是一个实例,其实insert(),update(),delete()这几个方法的实现都差不多,它们都会携带这个Uri参数,然后利用UriMatcher的match()方法判断出期望访问的是那张表中的数据,再该表中的数据进行相应的操作就行
- 此外还有一个方法getType()方法,它是所有内容提供器都必须提供的一个方法,用于获取uri对象所对应的MIME类型,一个内容URI所对应的MIME字符串由3部分组成,Android对这3个部分做出了如下格式规定
1. 必须以vnd开头
2. 如果内容URI以路径结尾,则后接android.cursor.dir/,如果内容URI以id结尾,则后接android.cursor.item/
3. 最后接上vnd.<authority>.<path>
最后对于这个content://com.example.app.provider/table1
URI,它所对应的MIME类型就可以写成
vnd.android.cursor.dir/vnd.com.example.app.provider.table1
而这个content://com.example.app.provider/table1/1
URI对应的MIME就可以写成
vnd.android.cursor.item/vnd.com.example.app.provider.table1
- 继续完善MyProvider中的内容,这次来实现getType()方法中的逻辑,
public class MyProvider extends ContentProvider{
...
@Nullable
@Override
public String getType(@NonNull Uri uri) {
switch (uriMatcher.match(uri)){
case TABLE1_DIR:
return "vnd.android.cursor.dir/vnd.com.example.app.provider.table1";
case TABLE1_ITEM:
return "vnd.android.cursor.item/vnd.com.example.app.provider.table1";
case TABLE2_DIR:
return "vnd.android.cursor.dir/vnd.com.example.app.provider.table2";
case TABLE2_ITEM:
return "vnd.android.cursor.dir/vnd.com.example.app.provider.table2";
default:
break;
}
return null;
}
}
- 到这里,一个完整的内容提供器就创建完成了,现在任何一个应用程序都可以使用ContentResolver来访问我们程序中的数据,但是如何保证隐私数据不会泄漏?这个问题在不知不觉中就已经解决了,因为所有的增删改查操作都一定要匹配到相应的内容URI格式才可以
实现跨程序数据共享
-
这里还是使用上一章中DatabaseTest项目的基础上继续开发,通过内容提供器来给它加入外部访问接口,然后创建一个内容提供器,右击包名 new --> Other --> Content Provider,会弹出一个窗口
这里将内容提供器命名为DatabasesProvider,authority指定为com.example.md.d1,Exported属性表示是否允许外部程序访问我们的内容提供器,Enabled属性表示是否启用这个内容提供器,将两个属性勾选上,点击Finish完成
- MyDatabaseHelper中的代码,此时把Toast弹出创建成功提示去掉,因为跨程序中不能直接访问Toast,别的保持不变就可以
public class MyDatabaseHelper extends SQLiteOpenHelper {
// 要创建的数据库
public static final String CREATE_BOOK = "create table book(" +
"id integer primary key autoincrement," +
"author text," +
"price real," +
"pages integer," +
"name text)";
public static final String CREATE_CATEGORY = "create table Category(" +
"id integer primary key autoincrement," +
"category_name text," +
"category_code integer)";
private Context mContent;
// 重写构造方法,接收四个参数
public MyDatabaseHelper(Context context, String name, SQLiteDatabase.CursorFactory factory, int version) {
super(context, name, factory, version);
mContent = context;
}
// 创建数据库
@Override
public void onCreate(SQLiteDatabase sqLiteDatabase) {
// 调用方法
sqLiteDatabase.execSQL(CREATE_BOOK);
// 再创建一个表
sqLiteDatabase.execSQL(CREATE_CATEGORY);
// Toast.makeText(mContent,"创建成功",Toast.LENGTH_SHORT).show();
}
@Override
public void onUpgrade(SQLiteDatabase sqLiteDatabase, int i, int i1) {
sqLiteDatabase.execSQL("drop table if exists Book");
sqLiteDatabase.execSQL("drop table if exists Category");
onCreate(sqLiteDatabase);
}
}
- 修改DatabaseProvider中的代码
public class DatabaseProvider extends ContentProvider {
public static final int BOOK_DIR = 0;
public static final int BOOK_ITEM = 1;
public static final String AUTHORITY = "com.example.md.d1";
public static UriMatcher uriMatcher;
private MyDatabaseHelper databaseHelper;
static {
uriMatcher = new UriMatcher(UriMatcher.NO_MATCH);
uriMatcher.addURI(AUTHORITY,"book",BOOK_DIR);
uriMatcher.addURI(AUTHORITY,"book/#",BOOK_ITEM);
}
public DatabaseProvider() {
}
@Override
public int delete(Uri uri, String selection, String[] selectionArgs) {
// 删除数据
SQLiteDatabase db = databaseHelper.getWritableDatabase();
int deleteRows = 0;
switch (uriMatcher.match(uri)){
// 查询全部的数据
case BOOK_DIR:
deleteRows = db.delete("book",selection,selectionArgs);
break;
case BOOK_ITEM:
String bookId = uri.getPathSegments().get(1);
deleteRows = db.delete("book","id = ?",new String[]{bookId});
break;
default:
break;
}
return deleteRows;
}
@Override
public String getType(Uri uri) {
switch (uriMatcher.match(uri)){
case BOOK_DIR:
return "vnd.android.cursor.dir/vnd.com.example.md.d1.book";
case BOOK_ITEM:
return "vnd.android.cursor.item/vnd.com.example.md.d1.book";
}
return null;
}
@Override
public Uri insert(Uri uri, ContentValues values) {
//添加数据
SQLiteDatabase db = databaseHelper.getWritableDatabase();
Uri uriReturn = null;
switch (uriMatcher.match(uri)){
case BOOK_DIR:
case BOOK_ITEM:
long newBookId = db.insert("book",null,values);
uriReturn = Uri.parse("content://"+AUTHORITY+"/book/"+newBookId);
break;
default:
break;
}
return uriReturn;
}
@Override
public boolean onCreate() {
databaseHelper = new MyDatabaseHelper(getContext(),"BookStore.db",null,2);
return true;
}
@Override
public Cursor query(Uri uri, String[] projection, String selection,
String[] selectionArgs, String sortOrder) {
// 查询数据
SQLiteDatabase db = databaseHelper.getReadableDatabase();
Cursor cursor = null;
switch (uriMatcher.match(uri)){
// 查询全部的数据
case BOOK_DIR:
cursor = db.query("book",projection,selection,null,null,null,sortOrder);
break;
case BOOK_ITEM:
String bookId = uri.getPathSegments().get(1);
cursor = db.query("book",projection,"id = ?",new String[]{bookId},null,null,sortOrder);
break;
default:
break;
}
return cursor;
}
@Override
public int update(Uri uri, ContentValues values, String selection,
String[] selectionArgs) {
// 更新数据
SQLiteDatabase db = databaseHelper.getReadableDatabase();
int updateRows = 0;
switch (uriMatcher.match(uri)){
// 查询全部的数据
case BOOK_DIR:
updateRows = db.update("book",values,selection,selectionArgs);
break;
case BOOK_ITEM:
String categoryId = uri.getPathSegments().get(1);
updateRows = db.update("book",values,"id = ?",new String[]{categoryId});
break;
default:
break;
}
return updateRows;
}
}
- 首先类一开始定义了两个常量,用于访问Book表中的所有数据和Book表中的单条数据,然后
在静态的代码块中对UriMatcher进行初始化操作
,将期望匹配的集中URI格式添加进去 - 接下来就是每个抽象方法的具体实现了,在onCreate()方法中,创建了一个MyDatabaseHelper的实例,然后返回true表示内容提供器初始化成功,这时数据库就已经完成了创建和升级操作
- 在query()方法中,这个方法首先获取到了
SQLiteDatabase的实例
,然后根据传入的Uri参数判断用户想要访问的那张表的数据,再调用SQLiteDatabase的query()方法进行查询,并将Cursor对象返回就可以了,注意当访问单条数据的时候,这里调用Uri对象的getPathSegments()方法,他会将内容URI权限之后的部分以/符号进行分割,并将分割后的结果放入到一个字符串列表中,这个列表的第0个位置就是存放路径的,第1个位置存放的就是id,得到id,再通过约束实现了查询单条数据的功能
- insert()方法,还是获取到了SQLiteDatabase的实例,根据传入的Uri参数判断出用户想要往那张表中添加数据,在通过SQLiteDatabase的insert()方法进行添加就可以了,注意
insert()方法要求返回的是一个能够表示这条新增数据的URI,所以这个时候还需要调用Uri.parse()方法将一个内容URI解析成一个Uri对象,当然这个内容URI是以新增数据的id结尾的
- update()方法,也是获取到了SQLiteDatabase的实例,根据传入的Uri参数判断出用户想要往那张表中更新数据,在通过SQLiteDatabase的update()方法进行更新就可以了,受影响的行数返回就可以了
- delete()方法,和update()几乎一样
- getType()方法,这个方法完全是按照上面的格式进行编写的
- 还有一点,内容提供器一定要在AndroidManifest.xml文件中进行注册在可以使用,由于是使用快捷方式创建的内容提供器,这个时候注册就自动生成了
<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
package="com.example.md.d1">
<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">
...
<provider
android:name=".DatabaseProvider"
android:authorities="com.example.md.d1"
android:enabled="true"
android:exported="true">
</provider>
</application>
</manifest>
- 这个时候多了一个provider标签,使用这个来对DatabaseProvider这个内容提供器进行注册
- 这个时候这个项目就已经拥有跨程序共享数据的功能了,共享的是book表,首先把模拟器上的这个app删除掉,从新运行项目,将这个程序从新安装到模拟器上(此时可以不用任何的操作),关闭这个项目,新建一个项目ProviderTest,通过这个程序访问DatabaseTest中的共享数据
- 修改activity_main.xml中的代码
<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
android:orientation="vertical"
android:layout_width="match_parent"
android:layout_height="match_parent"
>
<Button
android:id="@+id/add_data"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:text="Add To Book"/>
<Button
android:id="@+id/query_data"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:text="Query Book"/>
<Button
android:id="@+id/updata_data"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:text="Updata Book"/>
<Button
android:id="@+id/dalete_data"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:text="Delete Book"/>
</LinearLayout>
- 这四个按钮用于添加,查询,更新,删除数据,
- 修改MainActivity中的代码
public class MainActivity extends AppCompatActivity {
private String newId;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
Button addDate = (Button)findViewById(R.id.add_data);
addDate.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View view) {
// 添加数据
Uri uri = Uri.parse("content://com.example.md.d1/book");
ContentValues values = new ContentValues();
values.put("name","The Da Vinci Code");
values.put("author","Dan Brown");
values.put("pages","454");
values.put("price","17.89");
Uri newUri = getContentResolver().insert(uri,values);
Log.d("aaaaaaaaaaaaaaaa",":"+newUri);
newId = newUri.getPathSegments().get(1);
}
});
Button queryData = (Button)findViewById(R.id.query_data);
queryData.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View view) {
// 查询数据
Uri uri = Uri.parse("content://com.example.md.d1/book");
Cursor cursor = getContentResolver().query(uri,null,null,null,null);
if (cursor != null){
while (cursor.moveToNext()){
// 遍历Cursor对象,取出数据并打印
String name = cursor.getString(cursor.getColumnIndex("name"));
String author = cursor.getString(cursor.getColumnIndex("author"));
int pages = cursor.getInt(cursor.getColumnIndex("pages"));
double price = cursor.getDouble(cursor.getColumnIndex("price"));
Log.d("Mainactivity","book name is "+name);
Log.d("Mainactivity","book author is "+author);
Log.d("Mainactivity","book pages is "+pages);
Log.d("Mainactivity","book price is "+price);
}
cursor.close();
}
}
});
Button updateDate = (Button)findViewById(R.id.updata_data);
updateDate.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View view) {
// 更新数据
Uri uri = Uri.parse("content://com.example.md.d1/book/"+newId);
ContentValues values = new ContentValues();
values.put("name","A Storm of Swords");
values.put("price","20");
getContentResolver().update(uri,values,null,null);
Log.d("Mainactivity","更新成功");
}
});
Button deleteData = (Button)findViewById(R.id.dalete_data);
deleteData.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View view) {
// 删除数据
Uri uri = Uri.parse("content://com.example.md.d1/book/"+newId);
getContentResolver().delete(uri,null,null);
Log.d("Mainactivity","删除成功");
}
});
}
}
- 添加数据的时候调用Uri.parse()方法将一个内容URI解析成Uri对象,然后把要添加的数据存放到ContentValues对象中,接着调用COntentResolver的insert()方法执行添加的操作就可以了,
注意insert()方法返回一个Uri对象,这个对象中包含了新增数据的id,通过getPathSegments()方法将这个id取出
- 查询数据的时候,同样是Uri.parse()方法将一个内容URI解析成Uri对象,然后调用ContentResolver的query()方法去查询数据,查询的数据还是存放在了Cursor中进行遍历,从中去出查询结果
- 更新数据的时候,前面的操作都是一样,这里为了不想让Book表中的其他数据受到影响,在调用Uri.parse()方法时,给内容的URI尾部增加了一个id,这个id正是添加数据时返回的id,这就表示只希望更新刚刚添加的那条数据,Book表中的其他行不受影响
- 删除数据的时候也是这个样子
-
运行这个程序,
点击按钮,点击Add按钮,此时数据就应该添加到了这个程序的(com.example.md.d1)/book/的book表中了,点击Query按钮
-
接下来点击别的按钮
- 此时跨程序共享数据功能就基本完成了,现在任何一个程序都可以访问com.example.md.d1/book/中的数据了,而且也不用担心隐私数据泄漏的问题