Android基础 : Android ContentProvider和getContentResolver

ContentProvider

 

因为在Android系统里面，数据库是私有的。一般情况下外部应用程序是没有权限读取其他应用程序的数据。如果你想公开你自己的数据，你有两个选择：你可以创建你自己的内容提供器（一个ContentProvider子类）或者你可以给已有的提供器添加数据-如果存在一个控制同样类型数据的内容提供器且你拥有写的权限。而外界根本看不到，也不用看到这个应用暴露的数据在应用当中是如何存储的，或者是用数据库存储还是用文件存储，还是通过网上获得，这些一切都不重要，重要的是外界可以通过这一套标准及统一的接口和程序里的数据打交道，可以读取程序的数据，也可以删除程序的数据，当然，中间也会涉及一些权限的问题。

 

而以下方法是需要在子类实现的：

1.    boolean onCreate() Called when the provideris being started. 

2.    Cursor query(Uri uri, String[] projection,String selection, String[] selectionArgs,String sortOrder)通过Uri进行查询，返回一个Cursor。 

3.    Uri insert(Uri url, ContentValues values)将一组数据插入到Uri 指定的地方，返回新inserted的URI。 

4.    int update(Uri uri, ContentValues values,String where, String[] selectionArgs)更新Uri指定位置的数据，返回所影响的行数。 

5.    int delete(Uri url, String where, String[]selectionArgs)删除指定Uri并且符合一定条件的数据，返回所影响的行数。

6.    String getType (Uri uri)获取所查询URI的MIME类型，如果没有类型则返回null。

应用程序可以在Content Provider中执行如下操作:

查询数据

修改数据

添加数据

删除数据

当我们不需要把数据提供给第三方应用程序使用的话，可以不实现Content Provider。

 

 ContentResolver/ getContentResolver()

 

 

外界的程序通过ContentResolver接口可以访问ContentProvider提供的数据，在Activity当中通过getContentResolver()可以得到当前应用的 ContentResolver实例。ContentResolver提供的接口和ContentProvider中需要实现的接口对应，具体可以查看API Doc，不过可以发现ContentResolver里面的方法很多都是final或者static的。在实际应用中，我们很少实现ContentResolver抽象类，更多时候通过getContentResolver()从一个Activity或其它应用程序组件的实现里获取一个ContentResolver：

 

1.   ContentResolver cr =getContentResolver();

 

然后你可以使用这个ContentResolver的方法来和你感兴趣的任何内容提供器交互。

当初始化一个查询时，Android系统识别查询目标的内容提供器并确保它正在运行。系统实例化所有的ContentProvider对象；你从来不需要自己做。事实上，你从来不会直接处理ContentProvider对象。通常，对于每个类型的ContentProvider只有一个简单的实例。但它能够和不同应用程序和进程中的多个ContentProvider对象通讯。进程间的交互通过ContentResolver和ContentProvider类处理。

 

 

 

查询记录:
        在Content Provider中使用的查询字符串有别于标准的SQL查询。很多诸如select, add, delete, modify等操作我们都使用一种特殊的URI来进行，这种URI由3个部分组成， “content://”, 代表数据的路径，和一个可选的标识数据的ID。以下是一些示例URI:

        content://media/internal/images  这个URI将返回设备上存储的所有图片
        content://contacts/people/  这个URI将返回设备上的所有联系人信息
        content://contacts/people/45 这个URI返回单个结果（联系人信息中ID为45的联系人记录）

        尽管这种查询字符串格式很常见，但是它看起来还是有点令人迷惑。为此，Android提供一系列的帮助类（在android.provider包下），里面包含了很多以类变量形式给出的查询字符串，这种方式更容易让我们理解一点，参见下例:

        MediaStore.Images.Media.INTERNAL_CONTENT_URI
        Contacts.People.CONTENT_URI

        因此，如上面content://contacts/people/45这个URI就可以写成如下形式：

        Uri person =ContentUris.withAppendedId(People.CONTENT_URI, 45);

        然后执行数据查询:

        Cursorcur = managedQuery(person, null, null, null);

        这个查询返回一个包含所有数据字段的游标，我们可以通过迭代这个游标来获取所有的数据：

1.   package  com.wissen.testApp;        

2.                     

3.   public class ContentProviderDemo extends  Activity {        

4.       @Override        

5.       public void onCreate(Bundle  savedInstanceState) {        

6.           super.onCreate(savedInstanceState);        

7.           setContentView(R.layout.main);        

8.          displayRecords();        

9.       }        

10.                    

11.      private void displayRecords() {        

12.          //该数组中包含了所有要返回的字段        

13.       String columns[] =new  String[] {People.NAME,People.NUMBER };        

14.         Uri mContacts =People.CONTENT_URI;        

15.         Cursor cur =managedQuery(        

16.             mContacts,        

17.            columns, // 要返回的数据字段        

18.         null,         // WHERE子句        

19.         null,         // WHERE子句的参数        

20.         null        // Order-by子句        

21.       );        

22.         if(cur.moveToFirst()) {        

23.             String name =null;        

24.             String phoneNo =null;        

25.             do {        

26.                //获取字段的值        

27.           name =cur.getString(cur.getColumnIndex(People.NAME));        

28.               phoneNo =cur.getString(cur.getColumnIndex(People.NUMBER));        

29.               Toast.makeText(this, name + ” ” +phoneNo, Toast.LENGTH_LONG).show();         

30.            }while(cur.moveToNext());        

31.         }        

32.      }        

33.  }

 

        上例示范了一个如何依次读取联系人信息表中的指定数据列name和number。

修改记录:

        我们可以使用ContentResolver.update()方法来修改数据，我们来写一个修改数据的方法:

1.   privatevoid updateRecord(int recNo,String name) {          

2.       Uri uri =ContentUris.withAppendedId(People.CONTENT_URI,recNo);         

3.       ContentValues values =newContentValues();         

4.       values.put(People.NAME,name);         

5.       getContentResolver().update(uri, values,null, null);          

6.   }

 

        现在你可以调用上面的方法来更新指定记录：

        updateRecord(10,”XYZ”); //更改第10条记录的name字段值为“XYZ”

 

添加记录:
        要增加记录，我们可以调用ContentResolver.insert()方法，该方法接受一个要增加的记录的目标URI，以及一个包含了新记录值的Map对象，调用后的返回值是新记录的URI，包含记录号。
        上面的例子中我们都是基于联系人信息簿这个标准的Content Provider，现在我们继续来创建一个insertRecord()方法以对联系人信息簿中进行数据的添加：

1.   privatevoid insertRecords(String name, String phoneNo) {         

2.       ContentValues values =newContentValues();         

3.       values.put(People.NAME,name);         

4.       Uri uri =getContentResolver().insert(People.CONTENT_URI,values);         

5.       Log.d(”ANDROID”,uri.toString());         

6.       Uri numberUri =Uri.withAppendedPath(uri,People.Phones.CONTENT_DIRECTORY);         

7.       values.clear();         

8.       values.put(Contacts.Phones.TYPE,People.Phones.TYPE_MOBILE);         

9.       values.put(People.NUMBER,phoneNo);         

10.      getContentResolver().insert(numberUri,values);         

11.  }

 

        这样我们就可以调用insertRecords(name,phoneNo)的方式来向联系人信息簿中添加联系人姓名和电话号码。

删除记录:

        Content Provider中的getContextResolver.delete()方法可以用来删除记录，下面的记录用来删除设备上所有的联系人信息：

1.   privatevoid deleteRecords(){         

2.       Uri uri =People.CONTENT_URI;         

3.       getContentResolver().delete(uri,null, null);         

4.   }

 

        你也可以指定WHERE条件语句来删除特定的记录：

        getContentResolver().delete(uri,“NAME=” + “‘XYZ XYZ’”, null);

        这将会删除name为‘XYZ XYZ’的记录。

创建ContentProvider:
       至此我们已经知道如何使用Content Provider了，现在让我们来看下如何自己创建一个Content Provider。
        要创建我们自己的Content Provider的话，我们需要遵循以下几步：
        1. 创建一个继承了ContentProvider父类的类
        2. 定义一个名为CONTENT_URI，并且是public staticfinal的Uri类型的类变量，你必须为其指定一个唯一的字符串值，最好的方案是以类的全名称，如:
        public static final UriCONTENT_URI = Uri.parse( “content://com.google.android.MyContentProvider”);
        3. 创建你的数据存储系统。大多数Content Provider使用Android文件系统或SQLite数据库来保持数据，但是你也可以以任何你想要的方式来存储。
        4. 定义你要返回给客户端的数据列名。如果你正在使用Android数据库，则数据列的使用方式就和你以往所熟悉的其他数据库一样。但是，你必须为其定义一个叫_id的列，它用来表示每条记录的唯一性。
        5. 如果你要存储字节型数据，比如位图文件等，那保存该数据的数据列其实是一个表示实际保存文件的URI字符串，客户端通过它来读取对应的文件数据，处理这种数据类型的Content Provider需要实现一个名为_data的字段，_data字段列出了该文件在Android文件系统上的精确路径。这个字段不仅是供客户端使用，而且也可以供ContentResolver使用。客户端可以调用ContentResolver.openOutputStream()方法来处理该URI指向的文件资源，如果是ContentResolver本身的话，由于其持有的权限比客户端要高，所以它能直接访问该数据文件。
        6. 声明public static String型的变量，用于指定要从游标处返回的数据列。
        7. 查询返回一个Cursor类型的对象。所有执行写操作的方法如insert(),update()以及delete()都将被监听。我们可以通过使用ContentResover().notifyChange()方法来通知监听器关于数据更新的信息。
        8. 在AndroidMenifest.xml中使用<provider>标签来设置Content Provider。
        9. 如果你要处理的数据类型是一种比较新的类型，你就必须先定义一个新的MIME类型，以供ContentProvider.geType(url)来返回。MIME类型有两种形式:一种是为指定的单个记录的，还有一种是为多条记录的。这里给出一种常用的格式：

        vnd.android.cursor.item/vnd.yourcompanyname.contenttype（单个记录的MIME类型）
        比如,一个请求列车信息的URI如content://com.example.transportationprovider/trains/122可能就会返回typevnd.android.cursor.item/vnd.example.rail这样一个MIME类型。

        vnd.android.cursor.dir/vnd.yourcompanyname.contenttype（多个记录的MIME类型）
        比如,一个请求所有列车信息的URI如content://com.example.transportationprovider/trains可能就会返回vnd.android.cursor.dir/vnd.example.rail这样一个MIME类型。

        下列代码将创建一个Content Provider，它仅仅是存储用户名称并显示所有的用户名称（使用 SQLLite数据库存储这些数据）：

1.   package  com.wissen.testApp;        

2.                     

3.   public class MyUsers {        

4.       public static final  String AUTHORITY  = “com.wissen.MyContentProvider”;        

5.                     

6.       // BaseColumn类中已经包含了 _id字段        

7.      public static final  class  UserimplementsBaseColumns {        

8.           public static final  Uri  CONTENT_URI  = Uri.parse(”content://com.wissen.MyContentProvider”);        

9.           //表数据列         

10.       public  static  final  String  USER_NAME = “USER_NAME”;        

11.      }        

12.  }

 

        上面的类中定义了Content Provider的CONTENT_URI，以及数据列。下面我们将定义基于上面的类来定义实际的Content Provider类：

1.   package  com.wissen.testApp.android;        

2.                     

3.   public  class MyContentProvider   extends  ContentProvider {        

4.       private  SQLiteDatabase     sqlDB;        

5.       private   DatabaseHelper    dbHelper;        

6.       private  static  final  String  DATABASE_NAME     = “Users.db”;        

7.       private  static  final  int        DATABASE_VERSION         = 1;        

8.       private  static  final  String TABLE_NAME   = “User”;        

9.       private  static   final  String TAG = “MyContentProvider”;        

10.                    

11.      private  static  class  DatabaseHelper  extends  SQLiteOpenHelper {        

12.          DatabaseHelper(Context context) {        

13.              super(context,DATABASE_NAME,null, DATABASE_VERSION);        

14.          }        

15.                    

16.          @Override        

17.          publicvoid onCreate(SQLiteDatabase db) {        

18.              //创建用于存储数据的表        

19.          db.execSQL(”Create table ” +TABLE_NAME + “( _id INTEGER PRIMARY KEY AUTOINCREMENT, USER_NAME TEXT);”);        

20.          }        

21.                    

22.          @Override        

23.          publicvoid onUpgrade(SQLiteDatabase db, int oldVersion,int newVersion){        

24.              db.execSQL(”DROP TABLE IF EXISTS ”+ TABLE_NAME);        

25.              onCreate(db);        

26.          }        

27.      }        

28.                    

29.      @Override        

30.      publicintdelete(Uri uri, String s,String[] as) {        

31.          return0;        

32.      }        

33.                    

34.      @Override        

35.      publicString getType(Uri uri) {        

36.          returnnull;        

37.      }        

38.                    

39.      @Override        

40.      public  Uri insert(Uri uri, ContentValues contentvalues){        

41.          sqlDB =dbHelper.getWritableDatabase();        

42.          long rowId =sqlDB.insert(TABLE_NAME, “”, contentvalues);        

43.          if (rowId >0) {        

44.              Uri rowUri =ContentUris.appendId(MyUsers.User.CONTENT_URI.buildUpon(),rowId).build();        

45.              getContext().getContentResolver().notifyChange(rowUri,null);        

46.              return rowUri;        

47.          }        

48.          thrownewSQLException(”Failed to insert row into ” + uri);        

49.      }        

50.                    

51.      @Override        

52.      publicboolean onCreate(){        

53.          dbHelper =newDatabaseHelper(getContext());        

54.          return (dbHelper ==null) ? false : true;        

55.      }        

56.                    

57.      @Override        

58.      public  Cursor query(Uri uri, String[] projection,String selection,String[]selectionArgs,String sortOrder) {        

59.          SQLiteQueryBuilder qb =newSQLiteQueryBuilder();        

60.          SQLiteDatabase db =dbHelper.getReadableDatabase();        

61.          qb.setTables(TABLE_NAME);        

62.          Cursor c =qb.query(db, projection, selection,null, null, null,sortOrder);        

63.          c.setNotificationUri(getContext().getContentResolver(),uri);        

64.          return c;        

65.      }        

66.                    

67.      @Override        

68.      publicint update(Uri uri, ContentValues contentvalues,String s, String[] as) {        

69.          return0;         

70.      }        

71.  }

 

 

        一个名为MyContentProvider的Content Provider创建完成了，它用于从Sqlite数据库中添加和读取记录。
        Content Provider的入口需要在AndroidManifest.xml中配置:

        <providerandroid:name=”MyContentProvider”android:authorities=”com.wissen.MyContentProvider” />

        之后，让我们来使用这个定义好的ContentProvider:

1.   package com.wissen.testApp;      

2.                 

3.   public class  MyContentDemo  extends  Activity {      

4.       @Override      

5.       protected void onCreate(Bundle savedInstanceState) {      

6.           super.onCreate(savedInstanceState);      

7.           insertRecord(”MyUser”);      

8.           displayRecords();      

9.       }      

10.                   

11.      private void insertRecord(String userName){      

12.          ContentValues values =new ContentValues();      

13.          values.put(MyUsers.User.USER_NAME,userName);      

14.          getContentResolver().insert(MyUsers.User.CONTENT_URI,values);      

15.      }      

16.                

17.      private void displayRecords() {      

18.          String columns[] =new String[] {MyUsers.User._ID,MyUsers.User.USER_NAME};      

19.          Uri myUri =MyUsers.User.CONTENT_URI;      

20.          Cursor cur =managedQuery(myUri, columns,null,null, null );      

21.          if(cur.moveToFirst()) {      

22.              String id =null;      

23.              String userName =null;      

24.              do {      

25.                  id =cur.getString(cur.getColumnIndex(MyUsers.User._ID));      

26.                  userName =cur.getString(cur.getColumnIndex(MyUsers.User.USER_NAME));      

27.                  Toast.makeText(this, id + ” ” +userName, Toast.LENGTH_LONG).show();      

28.             }while(cur.moveToNext());      

29.         }      

30.      }      

31.  }

        上面的类将先向数据库中添加一条用户数据，然后显示数据库中所有的用户数据。

        至此，我们已经明白如何来使用和创建Content Provider了。