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);

 

 

示例項目下載請點我