AppBox升級進行時 - 擁抱Entity Framework的Code First開發模式
AppBox 是基於 FineUI 的通用權限管理框架，包括用戶管理、職稱管理、部門管理、角色管理、角色權限管理等模塊。 php
從Subsonic到Entity Framework
Subsonic最先發佈於2008年，當時他的無代碼生成模式吸引了不少人的眼球，ActiveRecord模式的支持也是Subsonic迅速流行的緣由之一。Subsonic也曾經一度被認爲是NHibernate的有力競爭對手。惋惜在2009年左右Subsonic的做者Rob Conery被微軟挖去作Asp.net MVC以後，Subsonic實際上已經死去，雖而後來Subsonic 3.0的CodingHorror也試圖東山再起，但仍是因爲性能緣由以及各個競爭對手的衝擊而逐漸沒落。 html
不太高手的確是高手，Rob Conery在2011年發表的一篇文章《Massive: 400 Lines of Data Access Happiness》出其不意地掀起了一陣Micro-ORM的熱潮，隨後出現了更多的微型ORM框架，比較著名的有PetaPoco，Dapper，ServiceStack.OrmLite，Simple.Data。我也曾經試用過ServiceStack.OrmLite，對他的易用性讚不絕口，特別是對其經過代碼徹底控制數據庫的建立和操做的方式印象深入，以下所示。 前端
class Note
{
[AutoIncrement] // Creates Auto primary key
public int Id { get; set; }
public string NoteText { get; set; }
public DateTime? LastUpdated { get; set; }
}
static void Main(string[] args)
{
//Using Sqlite DB
var dbFactory = new OrmLiteConnectionFactory(
SqliteFileDb, false, SqliteDialect.Provider);
using (var db = dbFactory.Open()) {
db.CreateTableIfNotExists<Note>();
// Insert
db.Insert(
new Note {
SchemaUri = "tcm:0-0-0",
NoteText = "Hello world 5",
LastUpdated = new DateTime(2013, 1, 5)
});
// Read
var notes = db.Where<Note>(new { SchemaUri = "tcm:0-0-0" });
foreach (Note note in notes)
{
Console.WriteLine("note id=" + note.Id + "noteText=" + note.NoteText);
}
}
Console.ReadLine();
}
注：上面示例代碼來自博客。 git
但最終仍是由於ServiceStack.OrmLite相關資料太少，對關聯表的支持不夠而放棄。 github
=================== 數據庫
題外話：我很是欣賞ServiceStack.OrmLite的地方還有他對類和表的處理方式，將複雜類型按照 JSV 的格式存儲在一個文本字段中。 後端
JSV Format (i.e. JSON-like Separated Values) is a JSON inspired format that uses CSV-style escaping for the least overhead and optimal performance. api
JSV：相似JSON，可是採用的是CSV風格。這樣作不只能夠減小存儲空間，並且加快了讀取和寫入速度（官方聲稱JSV的讀寫速度是JSON讀寫速度的 5.3 倍）。 mvc
=================== app
其實ServiceStack.OrmLite的代碼和Entity Framework的Code First代碼很是相似，AppBox之因此最終採用Entity Framework的Code First，除了官方支持、資料多（這一點很是重要，方便遇到問題時解決）外，最重要的是簡潔易懂，這也是FineUI所追求的目標。因此使用FineUI作前端展示，EntityFramework（CodeFirst）作後端數據操做，簡直就是絕配。
Entity Framework官方資料：http://msdn.microsoft.com/en-us/data/ee712907
Entity Framework遇到問題時搜索：http://stackoverflow.com/questions/tagged/entity-framework
使用Subsonic和Entity Framework的代碼對比
Entity Framework不只減小了代碼量，並且結構更加清晰，下面對加載單個用戶數據的代碼進行簡單的對比。
Subsonic：
int id = GetQueryIntValue("id");
XUser current = XUser.FetchByID(id);
if (current == null)
{
// 參數錯誤，首先彈出Alert對話框而後關閉彈出窗口
Alert.Show("參數錯誤！", String.Empty, ActiveWindow.GetHideReference());
return;
}
labName.Text = current.Name;
labRealName.Text = current.ChineseName;
labEmail.Text = current.CompanyEmail;
labPersonalEmail.Text = current.PersonalEmail;
labCellPhone.Text = current.CellPhone;
labOfficePhone.Text = current.OfficePhone;
labOfficePhoneExt.Text = current.OfficePhoneExt;
labHomePhone.Text = current.HomePhone;
labRemark.Text = current.Remark;
labEnabled.Text = current.Enabled ? "啓用" : "禁用";
labGender.Text = current.Gender;
// 表關聯查詢用戶所屬的角色列表
XRoleCollection roles = new Select().From(XRole.Schema)
.InnerJoin(XRoleUser.RoleIdColumn, XRole.IdColumn)
.Where(XRoleUser.UserIdColumn).IsEqualTo(current.Id)
.ExecuteAsCollection<XRoleCollection>();
StringBuilder sb = new StringBuilder();
foreach (XRole role in roles)
{
sb.AppendFormat("{0}，", role.Name);
}
labRole.Text = sb.ToString().TrimEnd('，');
// 初始化職稱列表的選擇項
XJobTitleCollection jobs = new Select().From(XJobTitle.Schema)
.InnerJoin(XJobTitleUser.JobTitleIdColumn, XJobTitle.IdColumn)
.Where(XJobTitleUser.UserIdColumn).IsEqualTo(current.Id)
.ExecuteAsCollection<XJobTitleCollection>();
sb = new StringBuilder();
foreach (XJobTitle job in jobs)
{
sb.AppendFormat("{0}，", job.Name);
}
labJobTitle.Text = sb.ToString().TrimEnd('，');
// 所屬部門
// 初始化角色複選框列表的選擇項
XDeptCollection depts = new Select().From(XDept.Schema)
.InnerJoin(XDeptUser.DeptIdColumn, XDept.IdColumn)
.Where(XDeptUser.UserIdColumn).IsEqualTo(current.Id)
.ExecuteAsCollection<XDeptCollection>();
if (depts.Count > 0)
{
labDept.Text = depts[0].Name;
}
Entity Framework：
int id = GetQueryIntValue("id");
User current = DB.Users
.Include(u => u.Roles)
.Include(u => u.Dept)
.Include(u => u.Titles)
.Where(u => u.UserID == id).FirstOrDefault();
if (current == null)
{
// 參數錯誤，首先彈出Alert對話框而後關閉彈出窗口
Alert.Show("參數錯誤！", String.Empty, ActiveWindow.GetHideReference());
return;
}
labName.Text = current.Name;
labRealName.Text = current.ChineseName;
labCompanyEmail.Text = current.CompanyEmail;
labEmail.Text = current.Email;
labCellPhone.Text = current.CellPhone;
labOfficePhone.Text = current.OfficePhone;
labOfficePhoneExt.Text = current.OfficePhoneExt;
labHomePhone.Text = current.HomePhone;
labRemark.Text = current.Remark;
labEnabled.Text = current.Enabled ? "啓用" : "禁用";
labGender.Text = current.Gender;
// 用戶所屬角色
labRole.Text = String.Join(",", current.Roles.Select(r => r.Name).ToArray());
// 用戶的職稱列表
labTitle.Text = String.Join(",", current.Titles.Select(t => t.Name).ToArray());
// 用戶所屬的部門
if (current.Dept != null)
{
labDept.Text = current.Dept.Name;
}
對比：
使用Subsonic加載單個用戶的數據須要進行 4 次數據庫查詢，總代碼量達到 61 行。
使用Entity Framework加載單個用戶的數據須要進行 1 次數據庫查詢，總代碼量減小爲 36 行，而且結構更加清晰易懂，是否是很心動。
使用Entity Framework的準備工做
1. 使用Visual Studio 2012
雖然說Visual Studio 2012不是必須的，你徹底能夠在VS2010中完成所有編碼工做。可是VS2012包含LocalDB數據庫，而且全部的官方示例都是基於VS2012的，因此使用VS2012可以幫助新手快速入門。
而且VS2012的界面真的很漂亮，灰白色的背景，藍底色的重點關注區域，能夠引導咱們的注意力到最須要關注的地方。
2. 使用NuGet安裝EntityFramework
在VS的工具 -> 庫程序包管理器 -> 管理解決方案的NuGet程序包，搜索Entity Framework並安裝，以下圖所示。
編寫Code First所需的模型類（Model）
這裏就以用戶角色爲例，首先定義角色的模型類。
public class Role
{
[Key]
public int ID { get; set; }
[Required, StringLength(50)]
public string Name { get; set; }
[StringLength(500)]
public string Remark { get; set; }
public virtual ICollection<User> Users { get; set; }
}
而後是用戶的模型類：
public class User
{
[Key]
public int ID { get; set; }
[Required, StringLength(50)]
public string Name { get; set; }
[Required, StringLength(100)]
public string Email { get; set; }
[Required, StringLength(50)]
public string Password { get; set; }
[Required]
public bool Enabled { get; set; }
[StringLength(10)]
public string Gender { get; set; }
[StringLength(100)]
public string ChineseName { get; set; }
[StringLength(100)]
public string EnglishName { get; set; }
[StringLength(200)]
public string Photo { get; set; }
[StringLength(50)]
public string QQ { get; set; }
[StringLength(100)]
public string CompanyEmail { get; set; }
[StringLength(50)]
public string OfficePhone { get; set; }
[StringLength(50)]
public string OfficePhoneExt { get; set; }
[StringLength(50)]
public string HomePhone { get; set; }
[StringLength(50)]
public string CellPhone { get; set; }
[StringLength(500)]
public string Address { get; set; }
[StringLength(500)]
public string Remark { get; set; }
[StringLength(50)]
public string IdentityCard { get; set; }
public DateTime? Birthday { get; set; }
public DateTime? TakeOfficeTime { get; set; }
public DateTime? LastLoginTime { get; set; }
public DateTime? CreateTime { get; set; }
public virtual ICollection<Role> Roles { get; set; }
}
注意，咱們在此定義了兩個導航屬性（Navigation Property），分別是 Role.Users 和 User.Roles，而且聲明爲 virtual ，其實這就啓用了Entity Framework的延遲加載特性。在後面的代碼中，你會看到咱們都是使用 Include 來即時加載數據（內部SQL實現是表關聯），從而避免了延遲加載形成的屢次數據庫鏈接。
在上面定義中，咱們使用了一些Data Annotations來聲明屬性，好比Key用來跟蹤每個模型類的實例（也就是實體 - Entity，這也許就是Entity Framework名字的由來），對應到數據庫表中的主鍵。StringLength則用來定義屬性的長度，對應到數據庫表中字段的長度。更多的Data Annotations請參考：http://msdn.microsoft.com/en-us/data/jj591583
使用Fluent API來配置模型類的關係
雖然使用Data Annotation也能設定模型類的關係，可是不夠靈活。Entity Framework還提供了另外一種方式Fluent API來設置關係，詳細的介紹能夠參考博客園 dudu 老大的這篇文章：http://www.cnblogs.com/dudu/archive/2011/07/11/ef_one-to-one_one-to-many_many-to-many.html
定義用戶和角色之間多對多的關係：
public class AppBoxContext : DbContext
{
public DbSet<User> Users { get; set; }
public DbSet<Role> Roles { get; set; }
protected override void OnModelCreating(DbModelBuilder modelBuilder)
{
base.OnModelCreating(modelBuilder);
modelBuilder.Entity<Role>()
.HasMany(r => r.Users)
.WithMany(u => u.Roles)
.Map(x => x.ToTable("RoleUsers")
.MapLeftKey("RoleID")
.MapRightKey("UserID"));
}
}
用更加通俗的話來解釋上面的代碼：
1. 一個角色（Role）有不少（HasMany）用戶（Users）；
2. 每一個用戶（Users）又有不少（WithMany）角色（Roles）；
3. 把這種多對多的關係映射到一張表（RoleUsers），外鍵分別是RoleID和UserID。
須要注意的是，在Entity Framework不能直接對關聯表進行操做，須要經過Role或者User實體來修改添加刪除關係。
編寫數據庫初始化代碼
1. 首先在Global.asax中設置數據庫初始化類：
protected void Application_Start(object sender, EventArgs e)
{
Database.SetInitializer(new AppBoxDatabaseInitializer());
}
2. 定義數據庫初始化類：
public class AppBoxDatabaseInitializer : DropCreateDatabaseIfModelChanges<AppBoxContext> // DropCreateDatabaseAlways<AppBoxContext>
{
protected override void Seed(AppBoxContext context)
{
GetUsers().ForEach(u => context.Users.Add(u));
GetRoles().ForEach(r => context.Roles.Add(r));
}
private static List<Role> GetRoles()
{
var roles = new List<Role>()
{
new Role()
{
Name = "系統管理員",
Remark = ""
},
new Role()
{
Name = "部門管理員",
Remark = ""
},
new Role()
{
Name = "項目經理",
Remark = ""
},
new Role()
{
Name = "開發經理",
Remark = ""
},
new Role()
{
Name = "開發人員",
Remark = ""
},
new Role()
{
Name = "後勤人員",
Remark = ""
},
new Role()
{
Name = "外包人員",
Remark = ""
}
};
return roles;
}
private static List<User> GetUsers()
{
string[] USER_NAMES = { "男", "童光喜", "男", "方原柏", "女", "祝春亞", "男", "塗輝", "男", "舒兆國" };
string[] EMAIL_NAMES = { "qq.com", "gmail.com", "163.com", "126.com", "outlook.com", "foxmail.com" };
var users = new List<User>();
var rdm = new Random();
for (int i = 0, count = USER_NAMES.Length; i < count; i += 2)
{
string gender = USER_NAMES[i];
string chineseName = USER_NAMES[i + 1];
string userName = "user" + i.ToString();
users.Add(new User
{
Name = userName,
Gender = gender,
Password = PasswordUtil.CreateDbPassword(userName),
ChineseName = chineseName,
Email = userName + "@" + EMAIL_NAMES[rdm.Next(0, EMAIL_NAMES.Length)],
Enabled = true,
CreateTime = DateTime.Now
});
}
// 添加超級管理員
users.Add(new User
{
Name = "admin",
Gender = "男",
Password = PasswordUtil.CreateDbPassword("admin"),
ChineseName = "超級管理員",
Email = "admin@examples.com",
Enabled = true,
CreateTime = DateTime.Now
});
return users;
}
}
開始查詢數據庫
使用以下代碼查詢單個用戶：
using(var db = new AppBoxContext())
{
int id = Convert.ToInt32(Request.QueryString["id"]);
User current = db.Users
.Include(u => u.Roles)
.Where(u => u.UserID == id).FirstOrDefault();
if (current != null)
{
labName.Text = current.Name;
labRealName.Text = current.ChineseName;
labGender.Text = current.Gender;
// 用戶所屬角色
labRole.Text = String.Join(",", current.Roles.Select(r => r.Name).ToArray());
}
}
可是每次都寫using 會以爲很煩，能不能就將AppBoxContext實例存儲在一個變量中呢，下面這篇文章給出了最佳實踐：
One DbContext per Request
咱們的實現，在Global.asax的後臺代碼中：
protected void Application_BeginRequest(object sender, EventArgs e)
{
}
protected virtual void Application_EndRequest()
{
var context = HttpContext.Current.Items["__AppBoxContext"] as AppBoxContext;
if (context != null)
{
context.Dispose();
}
}
而後在PageBase基類中：
public static AppBoxContext DB
{
get
{
// http://stackoverflow.com/questions/6334592/one-dbcontext-per-request-in-asp-net-mvc-without-ioc-container
if (!HttpContext.Current.Items.Contains("__AppBoxContext"))
{
HttpContext.Current.Items["__AppBoxContext"] = new AppBoxContext();
}
return HttpContext.Current.Items["__AppBoxContext"] as AppBoxContext;
}
}
下載或捐贈AppBox
1. AppBox v2.1 是免費軟件，免費提供下載：http://fineui.com/bbs/forum.php?mod=viewthread&tid=3788
2. AppBox v3.0 是捐贈軟件，你能夠經過捐贈做者來獲取AppBox v3.0的所有源代碼（http://fineui.com/donate/）。
- 1. Entity Framework first code
- 2. AppBox升級進行時 - 如何向OrderBy傳遞字符串參數（Entity Framework）
- 3. Entity Framework 4.x 進行代碼優先 (Code-First) 開發
- 4. Entity Framework Code First級聯刪除
- 5. Entity Framework 學習 Code First(1)
- 6. Oracle中使用Entity Framework 6.x Code-First方式開發
- 7. 【轉】學習Entity Framework 中的Code First
- 8. Entity Framework Code First （八）遷移 Migrations
- 9. AppBox升級進行時 - 扁平化的權限設計
- 10. Entity Framework應用：Code First的實體繼承模式
- 更多相關文章...
- • Redis發佈訂閱模式 - Redis教程
- • SVN 啓動模式 - SVN 教程
- • 委託模式
- • PHP開發工具
-
每一个你不满意的现在，都有一个你没有努力的曾经。
- 1. Entity Framework first code
- 2. AppBox升級進行時 - 如何向OrderBy傳遞字符串參數（Entity Framework）
- 3. Entity Framework 4.x 進行代碼優先 (Code-First) 開發
- 4. Entity Framework Code First級聯刪除
- 5. Entity Framework 學習 Code First(1)
- 6. Oracle中使用Entity Framework 6.x Code-First方式開發
- 7. 【轉】學習Entity Framework 中的Code First
- 8. Entity Framework Code First （八）遷移 Migrations
- 9. AppBox升級進行時 - 扁平化的權限設計
- 10. Entity Framework應用：Code First的實體繼承模式