C# 輕量級 ORM 框架 NPoco 的簡單應用

来源:https://www.cnblogs.com/timefiles/p/18294967
-Advertisement-
Play Games

目錄簡介快速入門安裝 NuGet 包實體類User資料庫類DbFactory增刪改查InsertSelectUpdateDelete總結 簡介 NPoco 是 PetaPoco 的一個分支，具有一些額外的功能，截至現在 github 星數 839。NPoco 中文資料沒多少，我是被博客園群友推薦的， ...


目錄

簡介

NPoco 是 PetaPoco 的一個分支，具有一些額外的功能，截至現在 github 星數 839。NPoco 中文資料沒多少，我是被博客園群友推薦的，這幾天簡單嘗試了一下：

github: https://github.com/schotime/NPoco

wiki: https://github.com/schotime/NPoco/wiki

NPoco 支持多種資料庫系統，包括但不限於以下幾種：

  • Microsoft SQL Server
  • SQLite
  • MySQL
  • PostgreSQL
  • Oracle
  • Firebird
  • DB2
  • SQL CE (SQL Compact Edition)

快速入門

本文使用SQLite資料庫作為示例，創建一個控制台項目，嘗試一些簡單的用法。

安裝 NuGet 包

對於使用 NPoco 和 SQLite 的情況，只需要安裝兩個 NuGet 包：

  • NPoco - 這是 NPoco ORM 的核心庫。
  • System.Data.SQLite 或 Microsoft.Data.Sqlite - 這是用於連接 SQLite 資料庫的 ADO.NET 提供程式。

選擇 System.Data.SQLite 或 Microsoft.Data.Sqlite 主要取決於正在使用的 .NET 平臺：

  • .NET Core 3.1 或 .NET 5/6/7 的項目選擇 Microsoft.Data.Sqlite
  • .NET Framework 或早期的 .NET Core 版本的項目選擇 System.Data.SQLite

這裡使用 Microsoft.Data.Sqlite ，NuGet 包安裝如下：
image

實體類User

新建一個實體類 User ，並定義實體類和欄位的映射關係，參考 官方文檔 Mapping：

//為了演示 TableName、Column ，表名和列名故意和實體類的屬性名設置的不同
[TableName("Users")]
[PrimaryKey("UserId", AutoIncrement = true)]
public class User
{    
    public int UserId { get; set; }

    [Column("Email")]
    public string UserEmail { get; set; }

    [ComputedColumn]
    public DateTime CreateTime{ get; set; }

    [ComputedColumn]
    public DateTime UpdateTime { get;set; }

    // 重寫 ToString 方法，列印實體類信息
    public override string ToString()
    {
        //SQLite存儲日期和時間的方式是以UTC（協調世界時）為基準的，列印時需要轉換成本地時間
        return $"UserId: {UserId}, " +
            $"Email: {UserEmail}," +
            $" CreatedTime: {CreateTime.ToLocalTime()}," +
            $" UpdateTime: {UpdateTime.ToLocalTime()}";
    }
}

上面用到的 TableName、PrimaryKey、Column 特性根據字面意思很容易理解，需要特別註意 ComputedColumn 相關的三個特性：

  • [Ignore] ：此屬性將被忽略，並且無法映射到此屬性，可以定義一些跟資料庫無關但業務需要的屬性。
  • [ResultColumn] ：可以映射到標有 ResultColumn 列的屬性，但這些屬性不會包含在插入或更新中。需要在 SQL 中顯式指定這些列，它不會包含在自動生成的 SQL 中。
  • [ComputedColumn] ：具有 Computed 列屬性的屬性的工作方式與 Result 列屬性相同，但是它們將在 SQL 中自動選擇。

資料庫類DbFactory

定義一個 DbFactory 類管理連接字元串和資料庫實例，映射部分請參考 基於 Fluent / Convention 的映射：

public static class DbFactory
{
    private static DatabaseFactory dbFactory;

    public static Database GetDatabase()
    {
        return dbFactory.GetDatabase();
    }

    static DbFactory()
    {        
        dbFactory = DatabaseFactory.Config(x =>
        {
            // 也可以在這裡配置實體的映射關係
            x.UsingDatabase(() => new Database(
                "Data Source=mydatabase.db;", 
                DatabaseType.SQLite, 
                SqliteFactory.Instance)
            );             
        });
        InitDB();
    }

    static void InitDB()
    {
        // 創建資料庫文件
        File.Create("mydatabase.db").Close();
        // 創建表
        using (IDatabase db = dbFactory.GetDatabase())
        {
            db.Execute(@"
                -- 創建Users表
                CREATE TABLE IF NOT EXISTS Users (
                    UserId INTEGER PRIMARY KEY AUTOINCREMENT,
                    Email TEXT,
                    CreateTime TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
                    UpdateTime TIMESTAMP DEFAULT CURRENT_TIMESTAMP
                );
                -- 創建觸發器，在Users 表上的數據更新後自動更新 UpdateTime 欄位
                CREATE TRIGGER IF NOT EXISTS update_user_time
                AFTER UPDATE OF Email, CreateTime ON Users
                BEGIN
                    UPDATE Users SET UpdateTime = CURRENT_TIMESTAMP WHERE rowid = NEW.rowid;
                END;"
            );
        }
    }
}

SQLite 並不直接支持在列定義中使用 ON UPDATE 語法，需要創建一個觸發器在 Users 表上更新操作發生時自動更新 UpdateTime 欄位。觸發器觸發時為了避免重新觸發自身（遞歸觸發），要僅在 UpdateTime 之外的欄位被更新時才觸發。

增刪改查

下麵演示一下 Insert、Update、Delete、Query 等操作，主程式如下：

static void Main(string[] args)
{
    Insert();
    Select();
    Thread.Sleep(3000);
    Update();
    Delete();
}

Insert

創建一個 Insert 方法，實現單次插入和批量插入：

static void Insert()
{
    using (IDatabase db = DbFactory.GetDatabase())
    {
        Console.WriteLine("單次插入：");
        var user = new User { UserEmail = $"[email protected]" };
        db.Insert(user);
        Console.WriteLine(user.ToString());

        Console.WriteLine("批量插入：");
        List<User> users = new List<User>();
        for (int i = 0; i < 5; i++)
        {
            user = new User { UserEmail = $"test{i}@example.com" };
            users.Add(user);
        }
        var count = db.InsertBatch(users);
        Console.WriteLine($"批量插入 {count} 條記錄");

        Console.WriteLine();
    }
}

Select

創建一個 Select 方法，實現常見的查詢方法：

static void Select()
{
    using (IDatabase db = DbFactory.GetDatabase())
    {
        Console.WriteLine("查詢所有用戶：");
        var users = db.Fetch<User>();
        users.ForEach(user => Console.WriteLine(user.ToString()));
                    
        Console.WriteLine("使用SQL語句查詢：");
        //下麵兩種方式都可以
        users = db.Query<User>("SELECT * FROM Users WHERE Email LIKE @0", "%@example.com").ToList();
        users = db.Query<User>("WHERE Email LIKE @0", "%@example.com").ToList();           
        users.ForEach(user => Console.WriteLine(user.ToString()));

        Console.WriteLine("使用LINQ語句查詢ID大於1的用戶，並按ID排序：");
        //推薦用法LINQ語句查詢    
        users = db.Query<User>()
            .Where(x => x.UserId > 1)
            .OrderBy(x => x.UserId)
            .ToList();
        users.ForEach(user => Console.WriteLine(user.ToString()));

        Console.WriteLine("通過ID查詢單個用戶：");
        //SingleById還有很多變體，這裡不在單獨舉例
        var user = db.SingleOrDefaultById<User>(1);
        Console.WriteLine(user.ToString());

        Console.WriteLine();
    }
}

註意：如果找不到記錄，SingleById()方法會拋出異常，而 SingleOrDefaultById() 方法會返回 null，推薦使用 SingleOrDefaultById() 方法。

Update

創建一個 Update 方法，實現單個用戶更新和批量更新：

static void Update()
{
    using (IDatabase db = DbFactory.GetDatabase())
    {
        Console.WriteLine("更新單個用戶：");
        var user = db.SingleById<User>(1);
        user.UserEmail = "[email protected]";
        db.Update(user);
        Console.WriteLine(db.SingleById<User>(1).ToString());

        Console.WriteLine("批量更新 ID > 3 的用戶：");
        var users = db.Query<User>()
            .Where(x => x.UserId > 3).ToList()
            .Select(x => UpdateBatch.For(x, db.StartSnapshot(x))).ToList()
            .Select(x => { x.Poco.UserEmail = "[email protected]"; return x; })
            .ToList();
        db.UpdateBatch(users, new BatchOptions { BatchSize = 50 });
        db.Fetch<User>().ForEach(user => Console.WriteLine(user.ToString()));

        Console.WriteLine();
    }
}

註意：關於 UpdateBatch 方法的使用，官方文檔沒有詳細說明，使用方法可以參考 UpdateTests

Delete

創建一個 Delete 方法，實現單個用戶刪除和批量刪除：

static void Delete()
{
    using (IDatabase db = DbFactory.GetDatabase())
    {
        Console.WriteLine("刪除單個用戶：");
        var user = db.SingleById<User>(1);
        db.Delete(user);
        Console.WriteLine($"刪除用戶 {user.ToString()} 成功");

        Console.WriteLine("使用SQL構造器刪除 Id > 4 的：");
        var sql = new Sql();
        sql.Append("DELETE FROM Users WHERE UserId > @0", 4);
        var count=db.Execute(sql);
        Console.WriteLine($"刪除 {count} 條記錄");

        Console.WriteLine("使用SQL語句刪除 Id > 3 的：");
        count = db.Delete<User>("WHERE UserId > @0", 3);
        Console.WriteLine($"刪除 {count} 條記錄");
    }
}

總結

一些簡單功能上手比較容易，代碼侵入性也比較小。複雜一點的功能上手比較難，因為中文資料少、官方文檔也有點落後。

一般的小項目或者小功能模塊可以使用NPoco，大項目還是建議使用國產的FreeSQL、SqlSugar。


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

-Advertisement-
Play Games
更多相關文章
  • 基於EF Core存儲的Serilog持久化服務
    前言 Serilog是 .NET 上的一個原生結構化高性能日誌庫，這個庫能實現一些比內置庫更高度的定製。日誌持久化是其中一個非常重要的功能，生產環境通常很難掛接調試器或者某些bug的觸發條件很奇怪。為了在脫離調試環境的情況下儘可能保留更多線索來輔助解決生產問題，持久化的日誌就顯得很重要了。目前Ser ...
  • dotnet 理解 X11 的 24 位或 32 位色深視窗
    一：背景 1. 講故事 前段時間有位朋友找到我，說他們有一個崩潰的dump讓我幫忙看下怎麼回事，確實有太多的人在網上找各種故障分析最後聯繫到了我，還好我一直都是免費分析，不收取任何費用，造福社區。 話不多說，既然有 dump 來了，那就上 windbg 說話吧。 二：WinDbg 分析 1. 為什麼 ...
  • Simple WPF: S3實現MINIO大文件上傳並顯示上傳進度
    早兩天寫了一篇S3簡單上傳文件的小工具，知乎上看到了一個問題問如何實現顯示MINIO上傳進度，因此拓展一下這個小工具能夠在上傳大文件時顯示進度。 ...
  • 發佈：PhonePrompter_PC(手機錄視頻提詞器_電腦版)
    提高錄製視頻的質量，使腳本內容資料、筆記本電腦屏幕、手機錄製三者有機會整合在一起，主要解決的問題和特點：（1）在手機錄製視頻過程，不會因為眼睛看腳本內容導致眼神漂浮，眼睛與手機攝像頭保持對焦狀態。（2）隨意調整文字腳本區域大小、手機與電腦屏幕倚靠區域大小、引用資料區域大小。（3）載入錄製視頻文字腳本... ...
  • 基於EF Core存儲的國際化服務
    前言 .NET 官方有一個用來管理國際化資源的擴展包Microsoft.Extensions.Localization，ASP.NET Core也用這個來實現國際化功能。但是這個包的翻譯數據是使用resx資源文件來管理的，這就意味著無法動態管理。雖然官方有在文檔中提供了一些第三方管理方案，但是都不太 ...
  • 詳解C#委托與事件
    在C#中，委托是一種引用類型的數據類型，允許我們封裝方法的引用。通過使用委托，我們可以將方法作為參數傳遞給其他方法，或者將多個方法組合在一起，從而實現更靈活的編程模式。委托類似於函數指針，但提供了類型安全和垃圾回收等現代語言特性。 基本概念 定義委托 定義委托需要指定它所代表的方法的原型，包括返回類 ...
  • WPF 實現圖標按鈕
    假設需要實現一個圖標和文本結合的按鈕 ，普通做法是 直接重寫該按鈕的模板； 如果想作為通用的呢？ 兩種做法： 附加屬性 自定義控制項 推薦使用附加屬性的形式 第一種：附加屬性 創建Button的附加屬性 ButtonExtensions 1 public static class ButtonExte ...
  • 使用中台 Admin.Core 實現了一個Razor模板的通用代碼生成器
    前言 前面使用 Admin.Core 的代碼生成器生成了通用代碼生成器的基礎模塊 分組，模板，項目，項目模型，項目欄位的基礎功能，本篇繼續完善，實現最核心的模板生成功能，並提供生成預覽及代碼文件壓縮下載 準備 首先清楚幾個模塊的關係，如何使用，簡單畫一個流程圖 前面完成了基礎的模板組，模板管理，項目 ...
一周排行
    -Advertisement-
    Play Games
  • 實用接地氣的 .NET 微服務框架
    前言 微服務架構已經成為搭建高效、可擴展系統的關鍵技術之一，然而，現有許多微服務框架往往過於複雜，使得我們普通開發者難以快速上手並體驗到微服務帶了的便利。為瞭解決這一問題，於是作者精心打造了一款最接地氣的 .NET 微服務框架，幫助我們輕鬆構建和管理微服務應用。 本框架不僅支持 Consul 服務註 ...
  • 基於surging的木舟IOT平臺如何添加網路組件
    先看一下效果吧: 如果不會寫動畫或者懶得寫動畫，就直接交給Blend來做吧; 其實Blend操作起來很簡單，有點類似於在操作PS，我們只需要設置關鍵幀，滑鼠點來點去就可以了，Blend會自動幫我們生成我們想要的動畫效果. 第一步：要創建一個空的WPF項目 第二步：右鍵我們的項目，在最下方有一個，在B ...
  • Prism:框架介紹與安裝
    Prism:框架介紹與安裝 什麼是Prism? Prism是一個用於在 WPF、Xamarin Form、Uno 平臺和 WinUI 中構建鬆散耦合、可維護和可測試的 XAML 應用程式框架 Github https://github.com/PrismLibrary/Prism NuGet htt ...
  • 不可不知的WPF畫筆（Brush）
    在WPF中，屏幕上的所有內容，都是通過畫筆（Brush）畫上去的。如按鈕的背景色，邊框，文本框的前景和形狀填充。藉助畫筆，可以繪製頁面上的所有UI對象。不同畫筆具有不同類型的輸出（ 如：某些畫筆使用純色繪製區域，其他畫筆使用漸變、圖案、圖像或繪圖）。 ...
  • .NET 8 高併發微服務電商系統實戰
    前言 嗨，大家好！推薦一個基於 .NET 8 的高併發微服務電商系統，涵蓋了商品、訂單、會員、服務、財務等50多種實用功能。 項目不僅使用了 .NET 8 的最新特性，還集成了AutoFac、DotLiquid、HangFire、Nlog、Jwt、LayUIAdmin、SqlSugar、MySQL、 ...
  • 基於surging 如何利用peerjs進行語音視頻通話
    本文主要介紹攝像頭（相機）如何採集數據，用於類似攝像頭本地顯示軟體，以及流媒體數據傳輸場景如傳屏、視訊會議等。 攝像頭採集有多種方案，如AForge.NET、WPFMediaKit、OpenCvSharp、EmguCv、DirectShow.NET、MediaCaptre（UWP），網上一些文章以及 ...
  • [WPF]數據綁定時為何會出現StringFormat失效
    前言 Seal-Report 是一款.NET 開源報表工具，擁有 1.4K Star。它提供了一個完整的框架，使用 C# 編寫，最新的版本採用的是 .NET 8.0 。 它能夠高效地從各種資料庫或 NoSQL 數據源生成日常報表，並支持執行複雜的報表任務。 其簡單易用的安裝過程和直觀的設計界面，我們 ...
  • NET Core 多身份校驗與策略模式
    背景需求： 系統需要對接到XXX官方的API，但因此官方對接以及管理都十分嚴格。而本人部門的系統中包含諸多子系統，系統間為了穩定，程式間多數固定Token+特殊驗證進行調用，且後期還要提供給其他兄弟部門系統共同調用。 原則上：每套系統都必須單獨接入到官方，但官方的接入複雜，還要官方指定機構認證的證書 ...
  • C#自定義控制項—轉換開關
    本文介紹下電腦設備關機的情況下如何通過網路喚醒設備，之前電源S狀態 電腦Power電源狀態- 唐宋元明清2188 - 博客園 (cnblogs.com) 有介紹過遠程喚醒設備，後面這倆天瞭解多了點所以單獨加個隨筆 設備關機的情況下，使用網路喚醒的前提條件： 1. 被喚醒設備需要支持這WakeOnL ...
  • .NET 8.0 前後分離快速開發框架
    前言 大家好，推薦一個.NET 8.0 為核心，結合前端 Vue 框架，實現了前後端完全分離的設計理念。它不僅提供了強大的基礎功能支持，如許可權管理、代碼生成器等，還通過採用主流技術和最佳實踐，顯著降低了開發難度，加快了項目交付速度。 如果你需要一個高效的開發解決方案，本框架能幫助大家輕鬆應對挑戰，實 ...
所有分類