1. 程式人生 > >.net的輕量級ORM -- PetaPoco/NPOCO框架使用說明

.net的輕量級ORM -- PetaPoco/NPOCO框架使用說明

list select 1年 刪除 record spa def app 不能

.net的輕量級ORM -- PetaPoco/NPOCO框架使用說明
(具體參看:http://www.toptensoftware.com/petapoco/)

  從11年就開始嘗試使用輕量級ORM:PetaPoco,下文是基本使用方法。另外NPoco是PetaPoco的升級版,是另外一個人維護,原版PetaPoco基本不再維護。NPoco大多數用法和PetaPoco一致,另外有些額外的功能。NPoco我會考慮再寫一篇文章介紹。

  運行查詢

  首先定義POCO
  註:POCO意思是Plain Old CLR Object即指一般指帶有無參構造函數只有get set的簡單.net類:

// Represents a record in the "articles" table
public class article {   public long article_id { get; set; }   public string title { get; set; }   public DateTime date_created { get; set; }   public bool draft { get; set; }   public string content { get; set; } }

查詢

// Create a PetaPoco database object
var db=new PetaPoco.Database("connectionStringName
"); // Show all articles foreach (var a in db.Query<article>("SELECT * FROM articles")) { Console.WriteLine("{0} - {1}", a.article_id, a.title); }

註意: Database有Fetch和Query兩個方法

Fetch返回List<T>.
而Query通過yield return 返回,使得不用遍歷記錄不用通過轉載整個數據到內存裏面.

註意:少量數據用Fetch更方便,大量數據而且只是單向遍歷或者返回請用Query,以節約內存.

返回單個值

long count=db.ExecuteScalar<long>("SELECT Count(*) FROM articles");

返回單條記錄

var a = db.SingleOrDefault<article>("SELECT * FROM articles WHERE [email protected]", 123));

註意:當運行SingleOrDefault返回超過1條記錄會報錯

分頁查詢

註意:所有大數據量查詢請都使用這個分頁的方法,PetaPoco的分頁查詢是數據庫分頁.

var result=db.Page<article>(1, 20, // <-- page number and items per page
"SELECT * FROM articles WHERE [email protected] ORDER BY date_posted DESC", "coolstuff");

會返回

public class Page<T> where T:new()
{
  public long CurrentPage { get; set; }
  public long ItemsPerPage { get; set; }
  public long TotalPages { get; set; }
  public long TotalItems { get; set; }
  public List<T> Items { get; set; }
}

運行分頁方法,實際上PetaPoco會執行兩件事:

返回匹配的所有總記錄數.
得到需要的頁數的字記錄數.

註意:PetaPoco會把你的sql轉換成分頁sql,所以對sql有一定限制,請不要用select * 而且寫得sql嚴格用空格分開,避免PetaPoco不能正確地解析你的sql.

新增,更新,刪除記錄
新增

// Create the article
var a=new article();
a.title="My new article";
a.content="PetaPoco was here";
a.date_created=DateTime.UtcNow;

// Insert it
db.Insert("articles", "article_id", a);
// by now a.article_id will have the id of the new article

更新

// Get a record
var a=db.SingleOrDefault<article>("SELECT * FROM articles WHERE [email protected]", 123);
// Change it
a.content="PetaPoco was here again";
// Save it
db.Update("articles", "article_id", a);

可以用匿名對象更新,以下是僅更新title的例子
db.Update("articles", "article_id", new { title="New title" }, 123);

裝飾你的Poco

// Represents a record in the "articles" table
[PetaPoco.TableName("articles")]
[PetaPoco.PrimaryKey("article_id")]
public class article
{
public long article_id { get; set; }
public string title { get; set; }
public DateTime date_created { get; set; }
public bool draft { get; set; }
public string content { get; set; }
}

這樣就可以簡化操作

// Insert a record
var a=new article();
a.title="My new article";
a.content="PetaPoco was here";
a.date_created=DateTime.UtcNow;
db.Insert(a);

// Update it
a.content="Blah blah";
db.Update(a);

// Delete it
db.Delete(a);

當然也可以這樣運行

// Delete an article
db.Delete<article>("WHERE [email protected]", 123);

// Update an article
db.Update<article>("SET [email protected] WHERE [email protected]", "New Title", 123);

也可以忽略某些屬性

public class article
{
    [PetaPoco.Ignore]
    public long SomeCalculatedFieldPerhaps
    { 
        get; set; 
    }
}    

使用事務

using (var trans =db.getTransaction())
{
    // Do transacted updates here

    // Commit
    trans.Complete();
}

SQL Builder

var id=123;
var sql=PetaPoco.Sql.Builder
    .Append("SELECT * FROM articles")
    .Append("WHERE [email protected]", id);

if (start_date.HasValue)
    sql.Append("AND date_created>[email protected]", start_date.Value);

if (end_date.HasValue)
    sql.Append("AND date_created<[email protected]", end_date.Value);

var a=db.Query<article>(sql);

也可以使用名字命名:

sql.Append("AND date_created>[email protected] AND date_created<[email protected]", 
    new 
    { 
        start=DateTime.UtcNow.AddDays(-2), 
        end=DateTime.UtcNow 
    };
);        

也可以這樣使用

var sql=PetaPoco.Sql.Builder()
    .Select("*")
    .From("articles")
    .Where("date_created < @0", DateTime.UtcNow)
    .OrderBy("date_created DESC");

.net的輕量級ORM -- PetaPoco/NPOCO框架使用說明