内容提供者ContentProvider
与前文的界面Activity
、服务Service
、广播接收者BroadcastReveiver
,并列称为Android的四大组件,均是需要自定义子类继承上述组件类,并在清单文件中静态注册或逻辑代码中动态注册才能正常使用。
android.content.ContentProvider内容提供者类,是用来对其他应用程序提供分享数据内容的组件类,在应用程序间的文件共享一文中,针对Android7.0以上版本所注册的FileProvider
文件提供者,便是已经定义过的ContentProvider
的使用案例。
分享数据创建
在创建ContentProvider
内容提供者之前,首先要保证有要分享的数据存在。这些数据可能来自用户交互,也可能来自远程服务器返回结果。应用程序收到一系列数据后,可以根据不同数据结构,采用前文不同的数据本地保存策略,包括普通键值对形式的SharedPreferences
、对象结构的SQLiteDatabase
、或者普通二进制的File
。
之后便可以创建继承自android.content.ContentProvider的自定义内容提供者类,并在其实现的相关方法中完成对本地保存数据的读写。而其他应用程序可以通过访问内容提供者的相关方法,进而读写该应用程序要分享的数据。
分享路径授权
由于内容提供者ContentProvider
与其他应用类交互是借助路径定位符Uri
类,所以在创建的内容提供者ContentProvider
中,要先定义并授权允许该类访问的相关Uri
。
在创建的内容提供者ContentProvider
中需要借助android.content.UriMatcher路径定位匹配类,可将传入的Uri
类型转换为普通的int
类型,以方便在内容提供者内部匹配区分。
通常在内容提供者内部定义为静态全局变量类型的UriMatcher
对象,其只有一参的构造方法UriMatcher(int code)
,参数值为UriMatcher.NO_MATCH=-1
。
之后可以调用静态对象的addURI(String authority, String path, int code)
方法,增加一对路径定位符与int
值的匹配。其中参数 authority 是一串固定的授权字符串,在注册该内容提供者ContentProvider
时也必须用到改参数值。参数 path 是追加在 authority 参数之后的子路径,以此区分不同的匹配路径,最终生成的一条数据Uri格式为content://authority/path/id
。参数 code 是绑定的int
值,与每一种Uri格式为content://authority/path
的路径Uri相对应。
在需要根据路径定位符Uri
获取int
值的地方,通常是下文分享数据操作中,可以调用静态对象的match(Uri uri)
方法,如果匹配到的Uri
与上文authority+path组合一致时,返回对应code值,否则返回值为UriMatcher.NO_MATCH=-1
。
分享数据操作
在ContentProvider
中必须实现以下方法以操作本地数据。
创建onCreate()
与其他组件类似,只有在该内容提供者被系统首次加载创建时,系统才会调用该方法。可以在该方法中初始化相关全局变量,但是不建议执行耗时操作。
获取数据类型getType(Uri uri)
由使用该内容提供者的其他应用程序调用。传入参数 uri 作为路径定位符指定一条数据位置,返回该数据对应的MIME类型。通常在 uri 指向文件时,根据不同文件类型以返回对应的MIME类型。其他情况返回null
即可。
增加数据insert(Uri uri, ContentValues values)
由使用该内容提供者的其他应用程序调用。在指定的参数 uri 指定的路径下插入一条数据,其内容格式为content://authority/path
。参数 values 则是要插入的数据内容,其与数据库中的插入方法类似,以key-value键值对形式保存数据。最终在数据插入成功后,需要返回该条数据对应的路径定位符Uri对象。
删除数据delete(Uri uri, String selection, String[] selectionArgs)
由使用该内容提供者的其他应用程序调用。参数 uri 指定要删除数据所在位置,当内容格式为content://authority/path/id
类型时,将删除其指定位置数据,余下两个参数无效;当内容格式为content://authority/path
类型时,将删除该路径下根据其他参数查找匹配的数据,若余下参数为null,则删除该路径下所有数据。参数 selection 为指定删除条件,其符合sql语句,但变量参数可用符合?代替,在后边参数中指定具体参数值;参数 selectionArgs 即为参数值数组,长度与参数 selection 中的?符合数量一致。最终返回int
类型的数据标记总共删除的数据条数。
修改更新数据update(Uri uri, ContentValues values, String selection, String[] selectionArgs)
由使用该内容提供者的其他应用程序调用。参数 uri 指定要修改数据所在位置,与上文删除数据方法中的参数一类似,当内容格式为content://authority/path/id
类型时,将更新其指定位置数据,最后两个参数无效;当内容格式为content://authority/path
类型时,将更新该路径下根据最后两个参数查找匹配的数据,若最后两个参数为null,则更新该路径下所有数据。参数 values 是要插入的数据内容,与增加数据方法中的参数二类似。参数 selection 和参数 selectionArgs 同样与删除数据方法汇总的参数二和参数三类似,可以匹配符合要求的数据。最终返回int
类型的数据标记总共修改的数据条数。
查询数据query(Uri uri, String[] projection, String selection, String[] selectionArgs, String sortOrder)系列方法
由使用该内容提供者的其他应用程序调用。参数 uri 为指定查询路径,与增加数据方法中的参数一类似,格式为content://authority/path
。余下参数与数据库中的查询方法中的参数类似,均可根据相关内容匹配数据。最终返回android.database.Cursor游标指针类型的数据,同样可参考数据库中的查询结果使用。
清单文件注册
最终自定义的内容提供者需要在清单文件中静态注册,才能在其他位置使用。在<application></application>
标签中使用<provider></provider>
标签指定内容提供者。在该标签中,android:name
属性绑定代码中定义的内容提供者全局类名。属性android:authorities
指定授权名称,与代码中UriMatcher
对象的添加路径匹配符方法所传入的 authority 参数一致。属性android:exported
通过设置boolean
类型值,以决定该内容提供者是否可对其他应用程序提供使用。除此之外还有其他一些属性值,可参考官方<provider>
介绍。
借助路径定位符访问分享数据
在其他应用程序或当前应用程序的其他位置,都可借助上下文环境Context
对象的getContentResolver()
方法,获得android.content.ContentResolver内容解析类的对象。通过对内容解析类对象的操作,进而影响自定义的内容提供者。内容解析类ContentResolver
中有一系列方法,均与上述实现的自定义内容提供者ContentProvider
中的增删改查等系列方法相对应,便不再赘述。
通常定义内容提供者的定义场景,是在短信类、通话类应用中将消息或联系人信息提供给其他应用程序使用。而数据访问方只需要获取对应的Uri
即可。