Reface.NPI 方法名稱決議規則詳解

在上次的文章中簡單介紹了 Reface.NPI 中的功能，
本期，將對這方法名稱決議規則進行詳細的解釋和說明，
以便開發者可以完整的使用 Reface.NPI 中的各種功能，

基本規則

• 方法名稱以 Insert , Delete , Select , Update 開頭
• 方法名以數個單詞構成，關鍵字、欄位、運算子、引數名都是一個單詞
• 每個單詞以大寫開頭，其余全小寫
  • UserName 會被認作兩個單詞
  • Username 會被認作一個單詞
• 使用入參填充 Sql引數 時，不計大小寫，你可以用 id 填充 @Id 的值

1 Insert 規則

僅使用 Insert 將使用物體中的所有欄位的值寫入，

void Insert(Entity entity);

開發者也可以通過 Without 關鍵字排除一些欄位的寫入，特別是那些依賴資料庫本身的欄位，

下面的例子不會對 Id 和 CreateTime 欄位寫入

bool InsertWithoutIdCreatetime(User user);

2 Delete 規則

Delete 方法名包含一個 條件規則，

條件規則 允許開發者定義一個 where 子語，

2.1 使用 By 宣告一個 條件規則

要在方法名中宣告一個條件，必須以 By 作為開始，

下面的方法，將會生成 where Id = @Id , 并以入參的 id 作為 @Id 的值，

void DeleteById(int id);

2.2 使用 And 和 Or 合并多個條件

你也可以使用 And 和 Or 合并多個條件

下面兩個方法將會生成 where Id = @Id and/or Name = @Name 并以入參的 id 和 name 分別作用 @Id 和 @Name 的值，

bool DeleteByIdAndName(int id, string name)

bool DeleteByIdOrName(int id, string name)

注意

• 因為沒有想到一個好的方法可以對條件進行分組，所以目前不可以宣告條件組，形如 where ( Id = @Id and Name = @Name ) or ( State = @State and Loginname = @Loginname )，

如果您有好的想法，您也可以告訴我，共同完善 Library ，非常期待您的分享，感謝！

2.3 更多的運算子

很明顯，我們不可能總是用 = 作為條件的判斷操作，
我們還有 大于，小于，Like等等，

你可以在欄位名后面加上運算子來實作此功能，

下面的例子會生成 where Name Like @Name 的條件，

int DeleteByNameLike(string name)

目前系統中支持的運算子有

2.4 自定義引數名

在上面的例子中，引數名直接與欄位名相同，

我們也可以在運算子后加上引數名來改名這個默認的引數名，

下面的例子會生成 where Password Like @Badpassworda Or Password Like @Badpasswordb

int DeleteByPasswordLikeBadpasswordaOrPasswordLikeBadpasswordb(string badPasswordA, string badPasswordB);

3 Update 規則

Update 規則由兩個部分組成

• 條件規則 ( 與 Delete 規則相同)
• Set 規則

Set 規則

3.1 指定 set 的欄位

Update 關鍵字后接的部分，一直到 By 之前，都是 Set 的欄位，

下面的例子會生成 set Password = @Password where Id = @Id

void UpdatePasswordById(int id, string password);

3.2 多個 set

你可以用 And 連接多個 set，

下面的例子會生成 set Password = @Password , Changingtime = @Changingtime where Id = @Id，

bool UpdatePasswordAndChangingtimeById(int id, string password, DateTime changingTime);

3.3 自定義 set 引數

和 條件規則 一樣，生成的陳述句中，會默認使用欄位名作為引數名，

你也可以在欄位后添加 Equals 再加上 引數名稱 來自定義引數名，

下面的例子會生成 set Count = @Newcount where Id = @Id And Count = @Oldcount

int UpdateCountEqualsNewcountByIdAndCountIsOldcount(int id, int oldCount, int newCount);

3.4 不指定 set 子句

當沒有 set 子句的時候，
會以排除了 By 子句的條件后的所有欄位作為 set 子句，

下面的例子會生成 update [user] set name = ?, password = ? where id = ?

// User : Id, Name, Password
int UpdateById(int id, User user);

若表中還有一些欄位在 Update 時即不是條件，也不打算更新，可以使用 Without 關鍵字指定，
下面的例子中，User 包含四個屬性

• Id
• Name
• Password
• CreateTime

// 下面的陳述句不會對 CreateTime 進行更新
void UpdateWithoutCreatetimeById(int id, User user);

4 Select 規則

Select規則 包含以下三個規則

• 條件規則 ( 與 Delete 和 Update 相同 )
• 輸出欄位規則
• 排序規則
• 分頁查詢

4.1 輸出欄位

這個規則比較簡單，
只要把欄位列在 Select 后即可，
多個欄位可以用 And 連接，
輸出欄位是可選的，你可以跳過這個部分直接撰寫條件，

IList<Entity> SelectIdAndNameAndCreatetime();

4.2 條件規則

與 Update 和 Delete 一樣，使用 By 關鍵字開始條件子句

User SelectById(int id);

4.3 排序規則

4.3.1 Orderby 子句

排序規則是由關鍵字 Orderby 開頭的 ( 除了 O 都是 小寫 )，

下面的例子會生成 ORDER BY Id Asc / Desc

IList<Entity> SelectOrderbyId();
IList<Eneity> SelectOrderbyIdDesc();

4.3.2 多個排序

多個排序不需要使用 And 連接，直接拼接即可，

IList<User> SelectOrderbyUsernameCreatetime();

4.3.3 分頁查詢

為 Select 方法前加上 Paging 就可以使用分頁查詢功能，

注意

• 使用分頁查詢時，必須提供型別為 Paging 的引數，

IList<Order> PagingSelectByCreatetimeGt(DateTime createTime);

使用基于 Reface.AppStarter 開發的 Reface.AppStarter.NPI 你可以不避手動創建代理類，
只需要通過建構式注入那些實作了 NPI 的介面，就可以直接對資料庫進行增刪改查的操作了，

在后面的文章中，會介紹 Reface.AppStarter.NPI 的功能和使用方法，

相關鏈接

• Reface.NPI @ Github
• Reface.AppStarter.NPI @ Github
• Reface.AppStarter.NPI.SqlServer @ Github

關注公眾平臺【清水潭】，可以查閱更多資料

標籤：C#

上一篇：行程守護工具

下一篇：C#佇列學習筆記：RabbitMQ實作客戶端相互通訊