全面解析ASP.NET MVC模塊化架構方案

什麼叫架構？揭開架構神秘的面紗，無非就是：分層+模塊化。任意複雜的架構，你也會發現架構師也就做了這兩件事。本文將會全面的介紹我們團隊在模塊化設計方面取得的經驗。之所以加了“全面”二字，是因為本文的內容將會涉及到：資料庫、路由、C#、JavaScript、CSS、HTML等一個完整模塊所需要的內容。 ...

什麼叫架構？揭開架構神秘的面紗，無非就是：分層+模塊化。任意複雜的架構，你也會發現架構師也就做了這兩件事。

本文將會全面的介紹我們團隊在模塊化設計方面取得的經驗。之所以加了“全面”二字，是因為本文的內容將會涉及到：資料庫、路由、C#、JavaScript、CSS、HTML等一個完整模塊所需要的內容。

在閱讀本文之前後，你也可以轉到我們的開源項目：https://github.com/leotsai/mvcsolution。這個開源項目完整的總結了我們團隊在ASP.NET MVC領域的分層架構思想，同時也定義了很多標準。

本文的目的則主要是介紹架構思想之模塊化。

當前項目架構以及模塊化架構圖

一個模塊的運行通常要依托於一個完整的系統。在本文的例子中，模塊化依托於我們的開源項目MvcSolution這個架構。下麵先看看這個架構的工程引用關係圖：

上面這個架構是系統原本的架構，而在這個原本的架構之上，我們怎麼添加模塊的呢？請看下圖：

從上圖可以看出，我們增加的模塊是引用了系統原來的多個工程的，這雖然會增加模塊與當前系統的耦合度，但是卻讓模塊的開發變得簡單很多。而對於我們團隊來講，因為所有項目都是基於MvcSolution這個架構，所以每一個模塊都可以很快的融入每一個系統。

下麵在看看添加了模塊之後的項目文件結構：

由於我們這個模塊不算大，所以就把所有C#文件都放到一個工程裡面了，分層只在心中。這也有利於我們將這個模塊搬運到其他項目中。

1. 模塊的入口

我們模塊的入口非常簡單，沒有反射，也沒有動態初始化，就是一個再普通不過的System.Web.MvcAreaRegistration。在Global.ascx.cs文件中，通過AreaRegistration.RegisterAllAreas();把所有引用的Area全部註冊。

在這個AreaRegistration類中，主要完成了路由的註冊以及IOC的註冊，如下圖：

這樣，這個模塊的公開URL地址就已經生成了，如：http://www.example.com/donating。你可以在程式其他地方添加這個鏈接，那麼用戶就可以訪問這個模塊了。

2. 模塊化之數據訪問

模塊內的數據訪問如何跟現有系統的數據訪問共存，這個問題是所有模塊化架構師最難處理的問題，相比其他文件（C#、JS、CSS、HTML），數據訪問最難處理好，因為下麵這個目標很難達到：

目標：模塊內可以很輕易的訪問現有資料庫的所有內容，但是卻最好不對現有資料庫進行任何更改，只有這樣，當該模塊移除之後，才不會留下任何無用的代碼；

在我們的實踐當中，基本上可以達到這個目標。下麵我就詳細介紹我們是如何進行數據訪問設計的，基於EF CodeFirst。

原有系統使用著一個非常複雜且龐大的資料庫，我們希望新增加的模塊不做任何更改。原有資料庫大概長這個樣子的：

我們增加的模塊化工程的文件結構如下圖：

我們是增加了一個新的資料庫DonatingDataContext，當然，這個資料庫繼承自原有系統的資料庫。這樣，新增加的模塊就可以完全訪問原有資料庫了。請看模塊資料庫代碼：

 1 namespace Lin.Plugins.Donating.Data
 2 {
 3     public class DonatingDataContext : LinDataContext
 4     {
 5         public DbSet<DonateComment> DonateComments { get; set; } 
 6         public DbSet<DonatePost> DonatePosts { get; set; }
 7         public DbSet<DonateWant> DonateWants { get; set; }
 8 
 9         public DonatingDataContext()
10         {
11             Database.SetInitializer<DonatingDataContext>(null);
12         }
13 
14         protected override void OnModelCreating(DbModelBuilder modelBuilder)
15         {
16             base.OnModelCreating(modelBuilder);
17             var mappings = typeof(DonatingDataContext).Assembly.GetInheritedTypes(typeof(EntityTypeConfiguration<>));
18             foreach (var mapping in mappings)
19             {
20                 dynamic instance = Activator.CreateInstance(mapping);
21                 modelBuilder.Configurations.Add(instance);
22             }
23         }
24     }
25 }

View Code

上方代碼請註意 base.OnModelCreating(modelBuilder); 這句話非常重要，乾什麼的就不用解釋了。

在增加新模塊才用到的表的時候，難免需要跟原有系統的表建立外鍵關係。正常的做法，我們是通過EntityTypeConfiguration<T>來添加，如下圖：

但是在模塊化設計中，由於不能修改原有系統中表的定義，所以用EntityTypeConfiguration<T>是無法完成外鍵關係定義的。這時，只能用DataAnnotations的方式：

public Guid CreatorUserId { get; set; }

[ForeignKey("CreatorUserId")]
public virtual User CreatorUser { get; set; }

這樣，在新資料庫中，就可以隨意的訪問原有資料庫了。如下所示：

1 public DonatePost GetPost(Guid postId)
2 {
3     using (var db = new DonatingDataContext())
4     {
5         return db.DonatePosts.Get(postId);
6     }
7 }

而在發佈到產品伺服器的時候，只需要在產品資料庫上執行新模塊的SQL腳本即可（可以通過EF生成新庫，再用ManagementStudio生成腳本）。

3. 模塊化之靜態文件（JS、CSS、HTML）

從本文最開始的文件結構圖中可以看到，我們把幾乎所有靜態文件都放到了一個叫“Plugins/Donating”的文件夾中了，這將非常有利於我們搬運這個模塊到其他項目中。

請註意上面段落中的“幾乎”二字，這說明還有小部分文件不在這裡。這部分特殊的文件都是JS，有兩部分，一部分在“_js-plugins/donating”，另一部分在“_grunt/gruntfile.js”中。用過grunt的都知道，這是JS未壓縮為混淆的源文件了，你也可以參考我們的開源項目MvcSolution 瞭解更多這兩部分JS的設計思想。簡單的將，這兩部分JS在發佈網站的時候，是要被刪除的，不需要拷貝到伺服器的。

下麵，請看靜態文件結構圖：