Windows Phone 8 - 操作SQLite的練習

在WP7.0時有撰寫過<Windows Phone 7 – 下載檔案至Isolated Storage>介紹了IsoatedStorage中放置一個SQLite檔案，

透過SQLite提供的API進行存取，對於當時還未有Local Database時是可以選擇的項目，但到WP7.1就有支援後，

便比較少提到SQLite在WP上的應用。

但對於開發Mobile App可能有些應用是由Android或iOS既有的App移轉支援時，不想重新為一個App建立一個對應

的database時，即會延用另二個平台支援的SQLite做為WP的資料來源，那麼這一篇的介紹可能就變的比較有幫助了。

往下便加以說明，在WP 8環境下，操作SQLite資料庫，至於有沒有適合WP 7.1或7.8呢？下列範例便加以說明；

安裝完上述的SDK後，接著往下透過範例加以說明如何實作一個支援SQLite的WP專案；

(1) 建立一個專案，並加入SQLite SDK的參考：

在建立專案之前，需要安裝一些必要的元件：<Precompiled Binaries for Windows Phone 8>

請先至上述連結下載SQLite的VSIX package，這是Visual Studio的Extension SDK檔，由於只有支援WP8，

所以請透過Visual Studio 2012(或VS Express for Windows phone)開啟該*.vsix檔進行安裝。

=>或者透過Visual Studio中的「Tools/Extensions and Updates」搜尋SQLite進行安裝，如下圖：

安裝完成後，Visual Studio會要求重新啟動，啟動完就安裝完畢了。接下來將它加入專案參考，如下圖：

加以參考後會發現出現警告的畫面，如下圖：

主要是因為專案被設定為「Any CPU」均可以被Compiler，只需要將它改成x86或ARM即可。由於WP 8屬於ARM一種，

所以直接改成ARM即可以正常的編譯。

(2) 將peterhuene / sqlite-net-wp8下載，加入應用程式專案中：

先將檔案下載後，建議放在與應用程式相同的目錄會比較方便參考；接著將它加入專案參考；

(3) 利用套件管理器主控台 (NuGet library Package Manager Console) 安裝sqlite-net至專案中：

執行指令：「Install-package sqlite-net」；它將會安裝兩個重要的操作檔案：SQLite.cs與SQLiteAsync.cs；

最後一步，在應用程式專案的建置中加入一段：_{^{「USE_WP8_NATIVE_SQLITE」，如下圖：}}

形成：SILVERLIGHT;WINDOWS_PHONE;USE_WP8_NATIVE_SQLITE；

完成以上三個步驟，接著就可以透過這些元件來操作我們的SQLite資料。

A. 建立資料庫與建立資料表；

使用SQLite該類別有個好處，如果指定的PATH合法，但沒有找到指定的檔案時，自動建立資料庫。如下：

 1 private SQLiteConnection gDBConn;
 2 private void InitializationDB()
 3 {
 4     // 指定資料庫位置，如果存在，則使用原有檔案，如果沒有則自動新增。
 5     gDBConn = new SQLiteConnection(Utility.GetLocalFolderDBPath(Utility.DBFileName));
 6     // 建立資料表，根據指定的物件類別
 7     gDBConn.CreateTable<AppConfig>();
 8     GetApplicationConfigData();
 9 }
10 protected override void OnNavigatedTo(NavigationEventArgs e)
11 {
12     InitializationDB();
13 }
14 protected override void OnNavigatedFrom(NavigationEventArgs e)
15 {
16     if (gDBConn != null)
17     {
18         // 關閉資料庫連線              
19         gDBConn.Close();
20     }
21 }

建立資料表時使用的也是物件，但需要在類別中的屬性加上宣告的修飾詞，如同Entity Framework要宣告。

1 public sealed class AppConfig
2 {
3    [PrimaryKey]
4    public string Id { get; set; }
5    public string ConfigKey { get; set; }
6    public string ConfigValue { get; set; }
7 }

B. 查詢資料表；

 1 private void GetApplicationConfigData()
 2 {
 3     // 利用物件的方式取得資料
 4     List<AppConfig> tApplicationConfig = 
 5         gDBConn.Table<AppConfig>().ToList<AppConfig>();
 6     int tCount = tApplicationConfig.Count;
 7     AppConfigListBox.Items.Clear();
 8     foreach (var t in tApplicationConfig)
 9     {
10         AppConfigListBox.Items.Add(t);
11     }
12 }

C. 新增資料；

 1 private void AddApplicationConfig()
 2 {
 3     try
 4     {
 5         AppConfig tConfig = new AppConfig
 6         {
 7             Id = Guid.NewGuid().ToString(),
 8             ConfigKey = txtKey.Text,
 9             ConfigValue = txtValue.Text
10         };
11         gDBConn.Insert(tConfig);
12         GetApplicationConfigData();
13         MessageBox.Show("新增資料成功");
14     }
15     catch (Exception ex)
16     {
17         MessageBox.Show(ex.Message);
18     }
19 }

建立新物件，並加入其資料表中。

D. 修改資料；

 1 private void AppConfigListBox_SelectionChanged(object sender, SelectionChangedEventArgs e)
 2 {
 3     if (AppConfigListBox.SelectedItem == null) return;
 4     try
 5     {              
 6         AppConfig tItem = AppConfigListBox.SelectedItem as AppConfig;
 7         tItem.ConfigKey = "ChangeKey";
 8         tItem.ConfigValue = "ChangeKey";
 9         gDBConn.Update(tItem);
10         //GetApplicationConfigData();
11         MessageBox.Show("修改資料成功");
12     }
13     catch (Exception ex)
14     {
15         MessageBox.Show(ex.Message);
16     }
17 }

如果您的資料表要做修改與刪除，要記得在宣告資料表時指定Primary Key才能正常使用，否則會出現Exception。

E. 刪除資料；

 1 private void DeleteApplicationConfig()
 2 {
 3     try
 4     {
 5         AppConfig tItem = AppConfigListBox.SelectedItem as AppConfig;
 6         gDBConn.Delete(tItem);
 7         GetApplicationConfigData();
 8         MessageBox.Show("刪除資料成功");
 9     }
10     catch (Exception ex)
11     {
12         MessageBox.Show(ex.Message);
13     }
14 }

如果您的資料表要做修改與刪除，要記得在宣告資料表時指定Primary Key才能正常使用，否則會出現Exception。

透過上述的範例可以得知，在操作SQLite資料庫裡的資料也是採用物件概念的操作方式，接近Entity framework的概念，

MS提供支援WP的SQL CE也是相同道理，詳細的說明可參考<Windows Phone 7 - Local Database概論 - 1>

與<Windows Phone 7 – Local Database概論 - 2>。

另外，如果您還是比較習慣使用SQL指令來操作的話，

可參考<A new SQLite wrapper for Windows Phone 8 and Windows 8 – The basics>。

》Copy database file to local folder on first startup：

如果您的應用程式XAP裡有內建的SQLite資料庫檔案，要記得在App第一次啟動時(Application_Launching)，

就將該DB檔移動至Local Folder (IsolatedStorage)中。

為甚麼需要這樣做呢？道理在於XAP包裝的資料是被安裝於Install Folder，該資料夾是不可以寫入的，這樣一來也就無法操作資料了。

因此，可以透過下列的方式進行啟動時的檔案搬移：

 1 private async void CopyDBFile()
 2 {
 3     StorageFile tFile = null;
 4     String tFileName = "WPSqlite.db"; 
 5     try
 6     {
 7         // 識別檔案是否存在
 8         string tFilePath = Path.Combine(ApplicationData.Current.LocalFolder.Path, tFileName);
 9         tFile = await StorageFile.GetFileFromPathAsync(tFilePath);
10     }
11     catch (FileNotFoundException)
12     {
13         // 代表檔案不存在
14         if (tFile == null)
15         {
16             // 從installation folder 將檔案複製到 local folder
17             IsolatedStorageFile tIsoFile = IsolatedStorageFile.GetUserStoreForApplication();
18             // 建立一個Stream負責從installation folder將檔案讀出來
19             using (Stream tInput = Application.GetResourceStream(new Uri(tFileName, UriKind.Relative)).Stream)
20             {
21                 // 建立IsolatedStorageFileStream負責寫入 local folder
22                 using (IsolatedStorageFileStream tOutput = tIsoFile.CreateFile(tFileName))
23                 {
24                     byte[] tReadBuffer = new byte[4096];
25                     int tBytesRead = -1;
26                     while ((tBytesRead = tInput.Read(tReadBuffer, 0, tReadBuffer.Length)) > 0)
27                     {
28                         tOutput.Write(tReadBuffer, 0, tBytesRead);
29                     }
30                 }
31             }
32         }
33     }
34 }