C# NPOCO 輕量級ORM框架（入門）

目前公司使用這個框架，搜不到很詳細的中文資料。

只有英文wiki，所以翻譯學習一下。

因為博主也是低水平的，可能會有一些理解不到位的地方。

可能會有錯誤的地方，如果有園友發現可以指出。

wiki地址：http://github.com/schotime/NPoco/wiki

 

第一個查詢：

public class User 
{
    public int UserId { get;set; }
    public string Email { get;set; }
}

using (IDatabase db = new Database("connStringName")) 
{
    List<User> users = db.Fetch<User>("select userId, email from users");
}

注： Database 需要關閉連接(可以把它當做你的對象)。

這是通過將列名映射的屬性的名稱User對象。匹配不區分大小寫。沒有使用映射(查詢)。

 

映射

 

默認情況下不需要映射。如果不指定其屬性將會假設 表名 是類名，主鍵是“ID”。

最常用的一些基本特性映射是：

1. [TableName]需要一個“名稱”參數，將被映射到表名。

2. [PrimaryKey]表示表的主鍵列。多個鍵之間用逗號分隔。還有一個“增量”屬性（AutoIncrement），用於指示是否將自動遞增主鍵列例如標識列的SQL服務器。缺省為真。

3. [Column]如果列名稱不匹配的使用這種屬性。

4. [Ignore]此屬性將被忽略，並且不被映射。

5. [ResultColumn]標記為查詢或計算結果列，這些屬性將不被包括在插入或更新。注：需要被明確指定的SQL。它不會自動生成SQL。

6. [ComputedColumn]標記為計算列屬性，但他們將會自動生成SQL。

7. [SerializedColumn](V3+)序列化的屬性將序列化的數據的默認實現IColumnSerializer。有npoco.jsonnet庫允許您使用JsonNetColumnSerializer。

demo：

[TableName("Users")]
[PrimaryKey("UserId")]
public class User
{
    public int UserId { get;set; }
    [Column("emailAddress")]
    public string Email { get;set; }
    [ResultColumn]
    public string ExtraInfo { get;set; }
    [Ignore]
    public int Temp { get;set; }
}

 

查詢單個對象

 

從數據庫中查詢一個對象可以幾種不同方法來完成。

通過ID

最簡單的方式是使用 SingleById<T>()方法。

IDatabase db = new Database("connStringName");
User u = db.SingleById<User>(3);

通過SQL

如果您不顯式提供 字段 將自動為您生成 ，子句將隨后附上。

User u = db.Single<User>("where emailaddress = @0", "[e-mail]");
or
User u = db.Single<User>("select u.* from users u where emailaddress = @0", "[e-mail]");

這兩種方法都有一個“ordefault”方法。如果您不確定對象是否存在的話，請使用這些方法。如果對象不存在，而且您沒有使用到 ordefault 就會引發空引用異常。

還有 First<T> 和 FirstOrDefault<T> 如果有多條數據將拋出一個異常。如果不多於1個記錄將返回結果。

 

插入，更新，刪除

插入新記錄

IDatabase db = new Database("connStringName");
User u = new User() 
{
    Email = "[e-mail]",
    LastLoggedIn = DateTime.UtcNow
};

db.Insert(u);

更新記錄

var user = db.SingleById(1);
user.Email = "[e-mail]";
db.Update(user);

刪除記錄

var user = db.SingleById(1);
db.Delete(user);
or
db.Delete<User>(1);

覆蓋或新建記錄

IDatabase db = new Database("connStringName");
User u = new User() 
{
    Email = "[e-mail]",
    LastLoggedIn = DateTime.UtcNow
};

db.Save(u);

這樣會插入一個新記錄或更新一個現有記錄。它是否存在是由主鍵確定的。

這個語句很危險，一定要確定你的對象里沒有主鍵或主鍵不在數據庫中，博主曾經用這個語句錯誤更新了正式環境幾百條數據！

 

查詢列表

 

獲取所有：

List<User> users = db.Fetch<User>();

標准獲取：

List<User> users = db.Fetch<User>("where isActive = 1");

使用SQL：

List<User> users = db.Fetch<User>("select u.* from users where u.isActive = 1");

懶惰模式

警告：以下方法Query<T>使用生成的關鍵字。運行該查詢的結果都j將被遍歷。如果你不完全理解這一概念，請使用 Fetch<T>。

List<User> users = db.Query<User>("select u.* from users where u.isActive = 1");

 

查詢分頁

主要有兩種方法用於查詢分頁。

Page<T>

IDatabase db = new Database("connStringName");
Page<T> pagedUsers = db.Page<User>(2, 10, "select u.* from users u order by userid");

其中Page<T>被定義為：

public class Page<T> 
{
    public long CurrentPage { get; set; }
    public long TotalPages { get; set; }
    public long TotalItems { get; set; }
    public long ItemsPerPage { get; set; }
    public List<T> Items { get; set; }
}

注意:您必須在SQL語句中提供一個 order by 語句，以便查詢知道您希望數據分頁的順序。
頁面的第一個參數是頁面編號。這個數字從第一個頁面的1開始。第二個參數是頁面的大小。在上面的示例中，將返回包含10個用戶的第二個頁面。

SkipTake<T>

SkipTake<T> 方法與在LINQ中跳過采取方法非常相似。它具有與頁面< T >方法相同的參數數量，但第一個參數不是頁碼，而是記錄的數量（即要取的記錄數量？）。第二個參數是跳過x個記錄之后返回的記錄數（即開始的位置？）。為了返回與Page<T>方法相同的結果，查詢將如下所示：

List<User> users = db.SkipTake<User>(10, 10, "select u.* from users u order by userid");

 

對事務的支持

 

示例1

using (IDatabase db = new Database("connStringName")) 
{
    db.BeginTransaction();
    //Your CRUD operation here
    db.CompleteTransaction();
}

示例2

using (IDatabase db = new Database("connStringName")) 
{
    using (var transaction = db.GetTransaction())
    {
        //Your CRUD operation here
        transaction.Complete();
    }
}

 

翻譯時間  2017/8/15