C# NPOCO 輕量級ORM框架（進階）

繼續翻譯NPOCO wiki。

這篇將home上 下面的幾個頁面翻譯。

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

上一篇： http://www.cnblogs.com/Aaxuan/p/7366476.html

 

 

從數據庫映射到現在有對象

 

使用 SingleInto、SingleOrDefaultInto、FirstInto 和 FirstOrDefaultInto 方法，可以將數據庫的列映射到現有對象。只有查詢中的列將被設置在現有對象上。

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

var user = new User() { UserId = 1 };
IDatabase db = new Database("connStringName");
db.SingleOrDefaultInto(user, "select Email from users where userid = @0", 1);

 

一對多的查詢

 

這幫助您映射一個與嵌套列表對象有一對多關系的查詢。鑒於以下類:

    public class UserDto
    {
        public int UserId { get; set; }
        public string Name { get; set; }
        public List<CarDto> Cars { get; set; }
    }

    public class CarDto
    {
        public string Make { get; set; }
        public string Color { get; set; }
    }

查詢：

IDatabase db = new Database("connStringName");

//v2
var users = db.FetchOneToMany<UserDto, CarDto>(x => x.UserId,
    "select u.*, c.* from Users u inner join Cars c on u.UserId = c.UserId order by u.UserId");

//v3
var users = db.FetchOneToMany<UserDto>(x => x.Cars,
    "select u.*, c.* from Users u inner join Cars c on u.UserId = c.UserId order by u.UserId");

這將為您提供一個UserDto對象的列表，並且對於每個對象，也將填充CarDto的列表。

注意：

1. 此方法的第一個參數是 lambda 表達式，該表達式標識第一個對象的惟一屬性。
2. 列的順序非常重要。它必須與定義的泛型參數的順序一致。在這個示例中，查詢指定了u。然后c * 映射到< UserDto,CarDto >。
3. 如果您要映射到用於插入數據的對象，那么你需要確定你對 List<> 使用了 [Ignore] 屬性。
4. 如果您正在使用一個外連接來執行查詢，並且您預期其中的一些將不會被填充，請確保在 FetchOneToMany 調用中使用第二個lambda。這將返回許多對象的主要屬性。在上面的例子中，這可能是x = > x . carid。
5. FetchOneToMany 不能用於獲取嵌套的一對多關系，也不能用於多個一對多關系。例如，如果UserDto也有一個BoatsDto列表，那么只有CarDto列表或BoatsDto列表可以加載並映射到一個查詢。

對嵌套對象映射

 

這將幫助您將查詢映射到有嵌套對象的對象。鑒於以下類:

    public class User
    {
        public int UserId { get; set; }
        public string Name { get; set; }
        public Address Address { get; set; }
    }

    public class Address
    {
        public string Street { get; set; }
        public string City { get; set; }
    }

查詢：

IDatabase db = new Database("connStringName");
var users = db.Fetch<User, Address>("select u.UserId, u.Name, u.Street, u.City from Users");

這將給您一個使用嵌套類映射的 user 對象列表。

注意：

1. 列的順序非常重要。查詢中的列需要按照指定的泛型參數的順序指定。如。首先指定用戶列，然后指定地址列。
2. 如果您要映射到用於插入數據的對象，那么您需要確保使用 [ResultColumn] 屬性忽略地址類。從v3中，您還需要添加[ComplexMapping]s屬性。

 

字典和對象數組查詢

 

有時，您不知道查詢返回的列。這就是能夠映射到字典< string,object >，或object[]的地方。字典和對象數組查詢。

var users = db.Fetch<Dictionary<string, object>>("select * from users");

or

var users = db.Fetch<object[]>("select * from users");

注意：

從NPoco版本 > 1.0.3 開始，所有數組類型(值類型。string[]、int[]、double[]、DateTime[]等)將是一個有效的通用參數。

 

跟蹤更改的更新

 

使用快照

快照用於跟蹤實體的更改，因此只有更改的屬性才會被更新。在下面的示例中，只有新 Name 將被發送到數據庫，因為它的年齡值與啟動快照時的值相同。

IDatabase db = new Database("connString");
var user = db.SingleById<User>(1);  // Name = "Ted", Age = 21

var snapshot = db.StartSnapshot(user);  // 在此之后的任何更改都將被記錄。

user.Name = "Bobby";
user.Age = 21;

db.Update(user, snapshot.UpdatedColumns());  // 只更新Name列

只有在UpdatedColumns()之前的更改將被包含在變更集中。

 

復合主鍵

 

復合鍵可以指定通過放置兩個逗號之間的列名稱 [PrimaryKey] 屬性。

[TableName("Users")]
[PrimaryKey("UserId,UserName")]
public class User
{
    public int UserId { get; set; }
    public string UserName { get;set; }
}

當設置了復合鍵，AutoIncrement屬性總是默認false。

如果你想使用 SingleById 方法查找一個對象，就可以使用匿名類型。

IDatabase db = new Database("connStringName");
var user = db.SingleById<User>(new {UserId = 1, UserName = "user"});

 

多個結果集

 

該特性使您能夠在只調用一次數據庫的情況下映射多個查詢。

FetchMultiple 方法返回一個  Tuple < T >，List < T1 > >。

IDatabase db = new Database("connStringName");
Tuple<List<User>, List<Address>> data = db.FetchMultiple<User, Address>("select * from users;select * from addresses;");
var users = data.Item1;
var addresses = data.Item2;

支持：

這僅支持可以返回多個結果集的數據庫。在IDataReader上實現了NextResult()。通過Npgsql支持Sql Server和Postgresql。

 

流利的映射

 

對於一個類的映射，您可以使用 Map < T > 繼承，其中 T 是要映射的類。

public class UserMapping : Map<User>
{
    public UserMapping()
    {
        PrimaryKey(x => x.UserId);
        TableName("Users");
        Columns(x =>
        {
            x.Column(y => y.Name).Ignore();
            x.Column(y => y.Age).WithName("a_ge");
        });
    }
}

映射也可以從映射繼承，並使用For < >方法在一次類中指定所有的映射。

public class OurMappings : Mappings
{
    public OurMappings()
    {
        For<User>().Columns( ....
    }
}

 

數據庫工廠設置：

 

您只需要創建映射一次，我們使用數據庫工廠來完成此操作。

public void Application_Start()
{
    MyFactory.Setup();
}

 

public static class MyFactory
{
    public static DatabaseFactory DbFactory { get; set; }

    public static void Setup()
    {
        var fluentConfig = FluentMappingConfiguration.Configure(new OurMappings());
        //或單個的映射 
 9         //var fluentConfig = FluentMappingConfiguration.Configure(new UserMapping(), ....);

        DbFactory = DatabaseFactory.Config(x =>
        {
            x.UsingDatabase(() => new Database("connString"));
            x.WithFluentConfig(fluentConfig);
            x.WithMapper(new Mapper());
        });
    }
}

然后你可以在你的代碼中使用它。

var database = MyFactory.DbFactory.GetDatabase();

如果你使用的是容器，那么你可以使用類似的東西

For<IDatabase>().Use(() => MyFactory.DbFactory.GetDatabase());

 

簡單LINQ查詢

 

Query<T>

NPoco介紹了一種使用LINQ查詢獲取對象的簡單方法。這里有一個簡單的例子。

IDatabase db = new Database("connString");
db.Query<User>().Where(x => x.Name == "Bob")
                           .OrderBy(x => x.UserId)
                           .Limit(10, 10)
                           .ToList();

可用的LINQ關鍵字：

• ProjectTo
• Count
• Any
• Where
• OrderBy
• OrderByDescending
• ThenBy
• ThenByDescending
• Limit
• Include
• IncludeMany

這里是你如何使用一個IN子句：

var users = db.Query<User>().Where(x => new[] {1,2,3,4}.Contains(x.UserId)).ToList();
// 或者使用 'In' 擴展方法
var users = db.Query<User>().Where(x => x.UserId.In(new[] {1,2,3,4})).ToList();

在where子句中也可以使用許多字符串方法。這里有幾個例子：

var users = db.Query<User>().Where(x => x.Name.StartsWith("Bo")).ToList();
var users = db.Query<User>().Where(x => x.Name.EndsWith("ob")).ToList();
var users = db.Query<User>().Where(x => x.Name.Contains("o")).ToList();
var users = db.Query<User>().Where(x => x.Name.ToLower() == "bob").ToList();
var users = db.Query<User>().Where(x => x.Name.ToUpper() == "BOB").ToList();

注意：並不是所有的操作都已經實現了。

 

查詢提供

 

Query<T>

查找用戶id大於50的所有用戶，按名稱排序，只返回20個記錄。

var users = db.Query<User>()
   .Where(x => x.UserId > 50)
   .OrderBy(x => x.Name)
   .Limit(20, 40)
   .ToList();

注意：

查詢將只在ToList()、ToEnumerable()或返回1值的標量方法中運行。

 

UpdateMany<T>

在必要的情況下，使用 Where 更新所有類型T 。

var list = new[] {1, 2, 3, 4};
// 只更新模板傳遞的(1、2、3、4)中 UserId 對象的 Name字段
// 如果使用 ExecuteDefaults 方法，則不會設置默認屬性 null，或為0的int
db.UpdateMany<User>()
    .Where( x => x.UserId.In(list))
    //.ExcludeDefaults()
    .OnlyFields(x => x.Name)
    .Execute(new User() {Name = "test"});

注意：

查詢只在執行調用時運行。

 

DeleteMany<T>

在必要的情況下，使用 Where 刪除所有類型T 。

var list = new[] {1, 2, 3, 4};

db.DeleteMany<User>()
    .Where(x => list.Contains(x.UserId))
    .Execute();

注意：

查詢只在執行調用時運行。

 

版本列支持

 

[VersionColumn]

一個數字字段可以用來檢測相互沖突的更新：

[TableName("Users")]
[PrimaryKey("UserId")]
public class User
{
    public int UserId { get;set; }

    [VersionColumn("VersionInt", VersionColumnType.Number)]
    public long VersionInt { get; set; }
}

更新將自動檢查和增加版本，如果它已經過時，就會拋出 DBConcurrencyException 異常。

這可以通過設置來禁用：VersionException = VersionExceptionHandling.Ignore。

 

在SQL Server中，rowversion timestamp　數據類型

可用於與VersionColumnType.RowVersion版本列：

[TableName("Users")]
[PrimaryKey("UserId")]
public class User
{
    public int UserId { get;set; }

    [VersionColumn("Version", VersionColumnType.RowVersion)]
    public byte[] Version { get; set; }
}

 

Sql模板

 

您可以使用SqlBuilder在有條件的地方建立查詢，例如，列，orderby等。

var sqlBuilder = new SqlBuilder();
var template = sqlBuilder.AddTemplate("select * from users where age > @0 and /**where**/", 10);

這里你可以指定一個 Where、Select、Join、LeftJoin、OrderBy、OrderByCols、GroupBy 和 Having 相應的sql令牌在下面指定。

/// Adds a filter. The Where keyword still needs to be specified. Uses /**where**/
    public SqlBuilder Where(string sql, params object[] parameters)

    /// Replaces the Select columns. Uses /**select**/
    public SqlBuilder Select(params string[] columns)

    /// Adds an Inner Join. Uses /**join**/
    public SqlBuilder Join(string sql, params object[] parameters)

    /// Adds a Left Join. Uses /**leftjoin**/
    public SqlBuilder LeftJoin(string sql, params object[] parameters)

    /// Adds an Order By clause. Uses /**orderby**/
    public SqlBuilder OrderBy(string sql, params object[] parameters)

    /// Adds columns in the Order By clause. Uses /**orderbycols**/
    public SqlBuilder OrderByCols(params string[] columns)

    /// Adds a Group By clause. Uses /**groupby**/
    public SqlBuilder GroupBy(string sql, params object[] parameters)

    /// Adds a Having clause. Uses /**having**/
    public SqlBuilder Having(string sql, params object[] parameters)

語句可以被鏈接，並且每個新語句的參數從0開始。

sqlBuilder
    .Where("height >= @0", 176)
    .Where("weight > @0 and weight < @1", 30, 60);

var db = new Database("conn");
db.Fetch<User>(template);

可以在任何可以使用Sql類的地方使用模板。

 

 

 

到此為止，wiki　主頁上的文章除了一篇講調試的，還有右側列表中有二，三篇沒有翻譯。

翻譯過程中挺難受的，英語看的一知半解，代碼也一知半解，經常看完代碼才明白英文意思。。

不過還好是翻譯的意思都差不多，可能會有理解，翻譯錯誤的地方，有發現的園友還請指出，以便改正。

 

翻譯時間  2017/8/20