Xamarin.Android之ContentProvider

一、前言

掌握了如何使用SQLiteOpenHelper之后，我们就可以进行下一步的学习。本章我们将会学习如何使用ContentProvider来将数据库方面的操作封装起来，同时它还可以供其他应用访问并操作数据库。

二、概念

首先我们不会急于写代码，而是要搞懂如何利用ContentProvider对数据库进行操作，因为我们不会直接操作数据库对象，而是通过URI来操作数据库。这就好比你要获取User表的全部内容，那么这个URI就是content://base/user其中base是自己命名的，最好是能够唯一。因为我们需要依靠这个区分数据库，然后就是user是用来区分操作的是哪个表，当然你也可以不用命名为user可以是其他的名称，最终反正要依靠代码去判断的。这样我们就可以避免在活动中直接对数据库对象操作，也方便对数据库进行统一的维护。

三、实际操作

1、搭建基本框架

新建一个LocationContentProvider类，并且继承自ContentProvider，还要重写该类的OnCreate、Delete、GetType、Insert、Query和Update方法。

2、设计数据库以及URI

下面是笔者设计好的结构：

public static string PROVIDER_NAME = "xamarin-cn.location";

private const string DATABASE_NAME = "location";
private const int DATABASE_VERSION = 1;

private const string USERTABLE_NAME = "tuser";
private const int USER = 1;
private const int USER_ID = 2;
private static IDictionary<string, string> userProjectionMap;
public class UserTable
{
    public static Android.Net.Uri CONTENT_URI = Android.Net.Uri.Parse("content://" + PROVIDER_NAME + "/user");
    public const string _ID = "_id";
    public const string UserName = "username";
    public const string UserPwd = "userpwd";
    public const string Age = "age";
}

 其中 PROVIDER_NAME 是URI的基址，DATABASE_NAME和DATABASE_VERSION是数据库的命名的和版本号，下面就是tuser表的信息，分别是表名、URI标识1、URI标识2、表结构键值对。UserTable类中的就是该表公开的属性，其中包含表的字段以及查询该表的URI路径。我们可以看到该表的URI路径为content://xamarin-cn.location/user。

3、初始化UriMatcher

我们需要通过UriMatcher这个类来判断URI操作的是哪个数据库的哪个表，这样就不需要我们自己通过字符串进行判断，具体的初始化可以见如下代码：

        private static UriMatcher uriMatcher;
        static LocationContentProvider()
        {
            userProjectionMap = new Dictionary<string, string>();
            userProjectionMap.Add(UserTable._ID, UserTable._ID);
            userProjectionMap.Add(UserTable.UserName, UserTable.UserName);
            userProjectionMap.Add(UserTable.UserPwd, UserTable.UserPwd);
            userProjectionMap.Add(UserTable.Age, UserTable.Age);
            uriMatcher = new UriMatcher(UriMatcher.NoMatch);
            uriMatcher.AddURI(PROVIDER_NAME, "user", USER);
            uriMatcher.AddURI(PROVIDER_NAME, "user/#", USER_ID);
        }

 这里我们通过UriMatcher的AddURI方法添加的不同类型URI，其中有针对整张表的，还有针对表中某条数据的。

4、建立数据库

这里我就不一一介绍了直接放出代码：

        private LocationSqliteOpenHelper dbHelper;
        class LocationSqliteOpenHelper : SQLiteOpenHelper
        {
            public LocationSqliteOpenHelper(Context context)
                : base(context, DATABASE_NAME, null, DATABASE_VERSION)
            {
            }

            public override void OnCreate(SQLiteDatabase db)
            {
                StringBuilder strSql = new StringBuilder();
                strSql.AppendFormat("CREATE TABLE {0} (", USERTABLE_NAME);
                strSql.AppendFormat("{0} INTEGER PRIMARY KEY NOT NULL,", UserTable._ID);
                strSql.AppendFormat("{0} TEXT NOT NULL,", UserTable.UserName);
                strSql.AppendFormat("{0} TEXT NOT NULL,", UserTable.UserPwd);
                strSql.AppendFormat("{0} INTEGER NOT NULL)", UserTable.Age);
                db.ExecSQL(strSql.ToString());
            }

            public override void OnUpgrade(SQLiteDatabase db, int oldVersion, int newVersion)
            {
                db.ExecSQL("DROP TABLE IF EXISTS " + USERTABLE_NAME);
                OnCreate(db);
            }
        }

5.初始化ContentProvider

首先我们需要在OnCreate方法中将dbHelper初始化：

public override bool OnCreate()
{
   dbHelper = new LocationSqliteOpenHelper(Context);
   return true;
}

6.完善Query方法

为了能够方便的组织查询语句这里笔者使用了SQLiteQueryBuilder对象来组织，下面就是查询的代码：

        public override Android.Database.ICursor Query(Android.Net.Uri uri, string[] projection, string selection, string[] selectionArgs, string sortOrder)
        {
            SQLiteQueryBuilder qb = new SQLiteQueryBuilder();
            qb.Tables = USERTABLE_NAME;
            //根据uri判断查询的是某条数据还是针对整个表，从而决定条件语句
            switch (uriMatcher.Match(uri))
            {
                case USER:
                    {
                        //设置需要获取的字段
                        //userProjectionMap默认包含的所有字段
                        qb.SetProjectionMap(userProjectionMap);
                    }
                    break;
                case USER_ID:
                    {
                        qb.SetProjectionMap(userProjectionMap);
                        //拼接条件语句
                        //其中uri.PathSegments.ElementAt(1) 将会获取第二个片段，
                        //就是第二个“/”后台的内容，如果后面还存在“/”则获取他们之间的内容
                        qb.AppendWhere(UserTable._ID + "=" + uri.PathSegments.ElementAt(1));
                    }
                    break;
            }
            SQLiteDatabase db = dbHelper.ReadableDatabase;
            ICursor c = qb.Query(db, projection, selection, selectionArgs, null, null, " _id desc");
            c.SetNotificationUri(Context.ContentResolver, uri);
            return c;
        }

 代码中的注释已经将重点部分都介绍了，关于Query的参数可以跟数据库对象的Query进行比较，都是一样的只是少了一部分参数。

7.完善Insert

因为SQLite规定了id只能是数据库自动生成的，所以在插入数据库这块只需要判断操作的是哪个表，介于笔者这里只有一个表所以没有该项操作，下面是具体的代码：

        public override Android.Net.Uri Insert(Android.Net.Uri uri, ContentValues values)
        {
            SQLiteDatabase db = dbHelper.WritableDatabase;
            long rowId = db.Insert(USERTABLE_NAME, null, values);
            //拼接最终形成的URI
            Android.Net.Uri result = ContentUris.WithAppendedId(UserTable.CONTENT_URI, rowId);
            Context.ContentResolver.NotifyChange(result, null);
            return result;
        }

唯一要说明的就是在添加完数据之后要将这条数据组成的uri返回，这样就可以方便以后的查询。

8.完善Update

        public override int Update(Android.Net.Uri uri, ContentValues values, string selection, string[] selectionArgs)
        {
            SQLiteDatabase db = dbHelper.WritableDatabase;
            int count = 0;
            switch (uriMatcher.Match(uri))
            {
                case USER:
                    {
                        count = db.Update(USERTABLE_NAME, values, selection, selectionArgs);
                    }
                    break;
                case USER_ID:
                    {
                        String userid = uri.PathSegments.ElementAt(1);
                        string select = "";
                        //如果还有附加的查询语句则拼接上去
                        if (selection != null)
                            select = " AND(" + selection + ")";
                        count = db.Update(USERTABLE_NAME, values, UserTable._ID + "=" + userid + select, selectionArgs);
                    }
                    break;
            }
            Context.ContentResolver.NotifyChange(uri, null);
            return count;
        }

这里跟查询一样，需要判断是针对某条数据还是整个表。

9.完善Delete

理解了Update，删除就简单了，只是将db.Update方法改写成Delete即可，代码如下所示：

        public override int Delete(Android.Net.Uri uri, string selection, string[] selectionArgs)
        {
            SQLiteDatabase db = dbHelper.WritableDatabase;
            int count = 0;
            switch (uriMatcher.Match(uri))
            {
                case USER:
                    {
                        count = db.Delete(USERTABLE_NAME, selection, selectionArgs);
                    }
                    break;
                case USER_ID:
                    {
                        String userid = uri.PathSegments.ElementAt(1);
                        string select = "";
                        if (selection != null)
                            select = " AND(" + selection + ")";
                        count = db.Delete(USERTABLE_NAME,
                            UserTable._ID + "=" + userid + select,
                            selectionArgs);
                    }
                    break;
            }
            Context.ContentResolver.NotifyChange(uri, null);
            return count;
        }

 最后就是GetType方法，只要返回空字符串即可。

四、操作ContentProvider

现在我们回到MainActivity中使用ContentProvider对数据库进行操作，其中最关键的是ContentResolver是不是跟ContentProvider是配对的？通过ContentResolver我们就可以通过URI来操作数据库，而不需要关注具体的数据库对象，比如下面的代码我们进行了插入、查询、更新和删除操作，代码量要比使用SQLiteOpenHelper更少，同时也便于后期的维护：

            ContentValues values = new ContentValues();
            values.Put(LocationContentProvider.UserTable.UserName, "yzf");
            values.Put(LocationContentProvider.UserTable.UserPwd, "123");
            values.Put(LocationContentProvider.UserTable.Age, 23);
            Android.Net.Uri uri = ContentResolver.Insert(LocationContentProvider.UserTable.CONTENT_URI, values);

            var c = ContentResolver.Query(uri, null, null, null, null);
            c.MoveToFirst();
            string username = c.GetString(c.GetColumnIndex(LocationContentProvider.UserTable.UserName));

            values.Clear();
            values.Put(LocationContentProvider.UserTable.UserName, "zn");
            ContentResolver.Update(uri, values, null, null);

            c = ContentResolver.Query(uri, null, null, null, null);
            c.MoveToFirst();
            username = c.GetString(c.GetColumnIndex(LocationContentProvider.UserTable.UserName));

            ContentResolver.Delete(uri, null, null);

示例项目下载请点我