UWP: 在 UWP 中使用 Entity Framework Core 操作 SQLite 資料庫

来源:https://www.cnblogs.com/wpinfo/archive/2018/02/11/uwp_efcore_sqlite.html
-Advertisement-
Play Games

在應用中使用 SQLite 資料庫來存儲數據是相當常見的。在 UWP 平臺中要使用 SQLite，一般會使用 SQLite for Universal Windows Platform 和 SQLite PCL 之類的庫，前者是 SQLite 引擎庫，而後者則提供了用於操作資料庫的 API ，不過自 ...


在應用中使用 SQLite 資料庫來存儲數據是相當常見的。在 UWP 平臺中要使用 SQLite，一般會使用 SQLite for Universal Windows Platform 和 SQLite PCL 之類的庫，前者是 SQLite 引擎庫，而後者則提供了用於操作資料庫的 API ，不過自從 Windows Fall Creators Update 之後，我們有了新的選擇。

由於 UWP 在其 Windows Fall Creators Update SDK 中增加對 .NET Standard 2.0 的支持，並且 Entity Framework Core 2.0（以下簡稱 EF Core）也支持 .NET Standard 2.0，這就使得我們能在 UWP 應用中使用 EF Core 來操作 SQLite 資料庫。相比前者，使用 EF Core 最明顯的優點是可以使用 Entity Framework 的特性（如 Fluent API、Migration 等）；此外，由於 EF Core 實現了 .NET Standard 並且還在繼續迭代過程中，這些方面都能夠成為我們使用 EF Core 的原因。

接下來，我們將會通過一個簡單的例子來看如何在 UWP 中使用 EF Core，在開始之前，你的環境必須滿足以下幾個條件：

  • Windows 10 Fall Creators Update (10.0.16299.0)；
  • 安裝了 .NET Core 2.0 SDK（或更高版本）；
  • Visual Studio 2017 的版本為 15.4 或更高；

實現

1. 項目創建

創建一個 UWP 項目，名為 LSNote，這是一個可以管理筆記的應用。註意：其最小版本，應該為 Windows Fall Creators Update，如下：

然後，在解決方案中添加一個 .NET Standard 項目，名為 LSNote.Model，我們要在這個項目中添加一些 Model。接著，為 UWP 項目添加對這個 .NET Standard 項目的引用。最終的項目結構如下：

需要說明的是：如果不使用 EF Core 的 Migration 功能，則不需要再創建後面的 .NET Standard 項目（後面我們會提到 Migration）；另外，將 Model 單獨放在一個項目中，也可以使它與其它實現 .NET Standard 的項目共用，如 ASP.net Core 或 WPF/WinForm（目標框架應為 .NET Framework 4.6.1 或更高）。

2.  Model 項目編碼與配置

首先，為它添加對 EF Core 的引用，通過 NuGet，添加對以下兩個包的引用： 

Install-Package Microsoft.EntityFrameworkCore.Sqlite
Install-Package Microsoft.EntityFrameworkCore.Tools

其中，第一個是 EF Core 庫本身，而二個提供了用於 Migration 的工具。

這裡簡單解釋一下 Migration（譯，遷移），它以增量的方式來修改資料庫以及表結構，使 EF Core 的模型與資料庫保持一致，並且不會影響資料庫中現有的數據。

接下來，在 LSNote.Model 項目中，添加以下代碼，其中包括三個類：

using Microsoft.EntityFrameworkCore;

namespace LSNote.Model
{
    public class Note
    {
        public int Id { get; set; }
        public string Title { get; set; }
        public string Content { get; set; }
        public Category Category { get; set; }
    }

    public class Category
    {
        public int Id { get; set; }
        public string Name { get; set; }
    }

    public class NoteDbContext : DbContext
    {
        public DbSet<Category> Categories { get; set; }

        /// <summary>
        /// 資料庫文件的路徑
        /// </summary>
        public string DbFilePath { get; set; }

        public DbSet<Note> Notes { get; set; }

        protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
        {
            base.OnConfiguring(optionsBuilder);

            // 設置資料庫文件的路徑
            optionsBuilder.UseSqlite($"Data Source={DbFilePath}");
        }

        protected override void OnModelCreating(ModelBuilder modelBuilder)
        {
            base.OnModelCreating(modelBuilder);

            // 必填
            modelBuilder.Entity<Category>().Property(m => m.Name).IsRequired();
            modelBuilder.Entity<Note>().Property(m => m.Title).IsRequired();
        }
    }
}

其中：

  • Note：表示一個筆記項；
  • Category: 表示一個類別，即筆記的類別；
  • NoteDbContext: 這個類繼承自 DbContext，它裡面包括了若幹了 DbSet<T> 的屬性，代表對應的數據表；

此外在 NoteDbContext 中，我們重載的兩個方法意義分別如下：

  • OnConfiguring: 配置資料庫，每當 DbContext 實例被創建時，它都會被執行；
  • OnModelCreating: 配置 Model 及其屬性，並最終影響數據表以及欄位；

然後，為了使用 Migration，我們還要編輯 LSNote.Model 項目的屬性（編輯 LSNote.Model.csproj）：

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <TargetFrameworks>netcoreapp2.0;netstandard2.0</TargetFrameworks>  
    <GenerateRuntimeConfigurationFiles>true</GenerateRuntimeConfigurationFiles>
  </PropertyGroup>
  <ItemGroup>
    <PackageReference Include="microsoft.entityframeworkcore.sqlite" Version="2.0.1" />
    <PackageReference Include="microsoft.entityframeworkcore.tools" Version="2.0.1" />
  </ItemGroup>
</Project>

註意其中增加的加粗部分，我們使當前項目的目標框架為 .netcoreapp2.0 和 .netstandard2.0，另外增加了 GenerateRuntimeConfigurationFiles 節點。

此時，設置 LSNote.Model 為啟動項目，然後在 PMC（Package Manager Console）中，確保 Defalut project 也是 LSNote.Model，之後，輸入以下命令：

Add-Migration Init

其中 Init 是本次 Migration 的名稱。之後，可以看到在項目中生成了一個 Migrations 文件夾，其下包括了代表每次 Migration 的類文件，它們繼承自 Migration 類，如下：

註意：執行 Migration 命令，必須使 LSNote.Model 項目為啟動項，這是因為目前版本的 EF Core Tools 還不支持 UWP 這種類型的啟動項目。

3. 在 UWP 項目中調用

首先，為 UWP 項目也添加對 EF Core 的引用，執行命令：

Install-Package Microsoft.EntityFrameworkCore.Sqlite

接下來，在 App.xaml.cs 文件中，增加以下代碼（加粗部分）：

using Microsoft.EntityFrameworkCore;

        public App()
        {
            this.InitializeComponent();
            this.Suspending += OnSuspending;

            DbPath = Path.Combine(ApplicationData.Current.LocalFolder.Path, "notes.db");

            try
            {
                using (var con = new LSNote.Model.NoteDbContext())
                {
                    con.DbFilePath = DbPath;

                    con.Database.Migrate();
                }
            }
            catch (NotSupportedException ex)
            {
            }
            catch (Exception ex)
            {
            }
        }

        public static string DbPath { get; set; }

通過 DatabaseFacade 類的 Migrate 方法，將掛起的 Migration 應用到資料庫，如果資料庫還沒創建，它會先創建資料庫；其中 DatabaseFacade 類由 con.Database 屬性得到。

然後，我們在 MainPage.xaml.cs 中，添加以下代碼：

    public sealed partial class MainPage : Page, INotifyPropertyChanged
    {
        private List<Note> _allNotes;

        public MainPage()
        {
            this.InitializeComponent();

            this.Loaded += MainPage_Loaded;
        }

        public event PropertyChangedEventHandler PropertyChanged;

        public List<Note> AllNotes
        {
            get { return _allNotes; }
            set
            {
                _allNotes = value;
                PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(nameof(AllNotes)));
            }
        }

        private void MainPage_Loaded(object sender, Windows.UI.Xaml.RoutedEventArgs e)
        {
            using (var con = new NoteDbContext())
            {
                // 設置資料庫路徑
                con.DbFilePath = App.DbPath;

                // 添加分類
                if (con.Categories.ToList().Count == 0)
                {
                    var cate1 = new Category { Name = "分類A" };
                    var cate2 = new Category { Name = "分類B" };
                    con.Categories.AddRange(cate1, cate2);
                    con.SaveChanges();
                }

                // 添加筆記
                con.Notes.Add(new Note { Title = "這是一條記錄", Content = "一些備註", Category = con.Categories.First() });
                con.SaveChanges();

                // 查詢
                AllNotes = con.Notes.ToList();
            }
        }
    }

在 MainPage.xaml 中添加以下代碼：

<Page
    ...
    xmlns:model="using:LSNote.Model"
    ...

    <Grid Background="{ThemeResource ApplicationPageBackgroundThemeBrush}">
        <ListView x:Name="list" ItemsSource="{x:Bind AllNotes, Mode=OneWay}">
            <ListView.ItemTemplate>
                <DataTemplate x:DataType="model:Note">
                    <StackPanel Margin="0,4">
                        <TextBlock
                            FontSize="16"
                            FontWeight="SemiBold"
                            Text="{x:Bind Title}" />
                        <TextBlock Text="{x:Bind Content}" />
                        <TextBlock>
                            <Run Text="Category:" />
                            <Run Text="{x:Bind Category.Name}" />
                        </TextBlock>
                    </StackPanel>
                </DataTemplate>
            </ListView.ItemTemplate>
        </ListView>
    </Grid>
</Page>

這時，將 UWP 項目設置為啟動項目，按 F5 運行，即可看到結果：

4. 進一步使用 Migration

前面說過，使用 EF Core，我們可以使用它自身的特性，例如，當我們要對現有的資料庫或表結構修改時，使用 Migration 將會非常簡單。對於上面的 Note 實體，我們要為它新添加一個 IsDelete 屬性，然後再通過 Add-Migration 命令和 Migrate 方法最終影響到資料庫。

首先，添加屬性：

    public bool IsDelete { get; set; }

接下來，仍然要設置 LSNote.Model 為啟動項目，並且在 PMC 中確認 Defalut project 也是它，輸入命令：

Add-Migration AddIsDeleteField

這時，在 Migrations 文件夾會新生成對應的類文件。

切換啟動項目為 UWP 項目，並且在 MainPage.xaml 中增加以下代碼（加粗部分）：

    <DataTemplate x:DataType="model:Note">
        <StackPanel Margin="0,4">
            <TextBlock
                FontSize="16"
                FontWeight="SemiBold"
                Text="{x:Bind Title}" />
            <TextBlock Text="{x:Bind Content}" />
            <TextBlock>
                <Run Text="Category:" />
                <Run Text="{x:Bind Category.Name}" />
            </TextBlock>
            <TextBlock>
                <Run Text="IsDelete:" />
                <Run Text="{x:Bind IsDelete}" />
            </TextBlock>
        </StackPanel>
    </DataTemplate>

按 F5 運行，即可看到更新後的結果：

補充的話：關於 Migration

  • 對於 SQLite，EF Core 的 Migration 目前還有一些限制，並不能滿足所有的功能，如在創建數據表後，再添加外鍵、添加主鍵，等。這裡有一份完整的限制操作列表；如果在 Migration 中，包括這些操作，將會引發 NotSupportedException。不過，值得註意的是，隨著 EF Core 的不斷完善，在將來，這些限制都應該會一一實現；
  • 另外，建議每次在 Migration 前要備份數據；

總結

本文主要討論了在 UWP 中如何使用 EF Core，由於兩者都依賴並且支持 .NET Standard 2.0，所以在 EF Core 能夠被用於 UWP 中，並且運行在任何支持 Win 10 的設備上。接下來，如果你正在開發或者準備開發的應用會用到 SQLite 資料庫，不妨試試 EF Core 。

 

參考資料：

Getting Started with EF Core on Universal Windows Platform

The Secret to Running EF Core 2.0 Migrations from a NET Core or NET Standard Class Library

 

源碼下載


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • JAVAEE——BOS物流項目02：學習計劃、動態添加選項卡、ztree、項目底層代碼構建
    1 學習計劃 1、jQuery easyUI中動態添加選項卡 2、jquery ztree插件使用 n 下載ztree n 基於標準json數據構造ztree n 基於簡單json數據構造ztree（重點） 3、資料庫建模工具PowerDesigner使用方式 4、myeclipse翻轉引擎插件使用 ...
  • Linux系統zookeeper環境搭建（單機、偽分散式、分散式）
    本人現在對zookeeper的環境搭建做一個總結，一般zookeeper的安裝部署可以有三種模式，單機模式、偽分散式和分散式，這三種模式在什麼時候應用具體看大家的使用場景，如果你只有一臺機器且只是想自己開發測試時用，你可以安裝個單機模式，簡單又實用。如果想裝逼但又沒有足夠的機器，那你可以選擇偽分散式 ...
  • SpringMVC用例篇之用戶登錄系統詳細開發流程
    SpringMVC入門項目，用戶登錄系統，詳細記錄了SpringMVC的開發流程！ ...
  • python3 第三十章 - 內置函數之Dictionary相關
    Python字典包含了以下內置函數： dict = {'Name': 'roy', 'Age': 100} print("Age 值為 : %s" % dict.get('Age')) print("Sex 值為 : %s" % dict.get('Sex', "nan")) dict = {'Na ...
  • Eclipse Spring boot項目熱部署
    spring boot項目 熱部署 一,參考文檔:springboot 熱部署 note: 1.使用eclipse: project Build Automatically (選中) 2.Digital Twin 項目使用Spring boot 版本為:1.2.3.RELEASE,使用spring ...
  • 第二章 OpenResty(Nginx+Lua)開發入門（跟我學Nginx+Lua開發學習筆記）
    參考於 http://jinnianshilongnian.iteye.com/blog/2186448 1、example.conf配置文件 location ~ /lua_request/(\d+)/(\d+) { #設置nginx變數 set $a $1; set $b $host; defa ...
  • maven項目在tomcat7/8上的熱部署
    一、給 tomcat 添加用戶名、密碼 在安裝目錄/cong/tomcat-user.xml中添加以下配置 二、在 maven 項目中添加 tomcat 插件 1. 在 pom.xml 中添加插件和依賴 三、startup.bat 啟動伺服器 再右擊項目>run as>maven build... ...
  • cglib源碼主流程源碼－我們到底能走多遠系列48
    扯淡 祝各位在園裡的朋友新年快樂！ 辛苦一年，為更好的自己也為更好的世界，很多人要感謝你們，你們也應該有很多人要感謝吧。 看了馬斯克的採訪視頻，又想起 "蘭迪·鮑許的最後一課" ，時光遷移，唯有夢想可堅持。 概念 在java的世界里，基於jvm實現的語言最終要進入jvm編譯的流程都需要把上層高級語言 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類