2014年1月17日星期五

NuGet学习笔记(2)――使用图形化界面打包自己的类库

 上文NuGet学习笔记(1) 初识NuGet及快速安装使用说到NuGet相对于我们最重要的功能是能够搭建自己的NuGet服务器,实现公司内部类库的轻松共享更新。在安装好NuGet扩展后,我们已经能够通过NuGet轻松下载自己需要的类库,下面来说一说如何将自己的项目类库进行打包发布

  使用图形界面打包自己的类库

  NuGet可以使用NuGet.exe在命令行下进行类库打包,也可以使用图形化界面进行打包,估计很多朋友都和我一样对不熟悉的命令行有些感冒,所以在此仅讲述下使用图形化界面进行类库打包

  1. 首先下载 包包管理器 NuGetPackageExplorer,顾名思义,包包管理器可以用来创建新的类库包,也可以浏览已经创建好的类库包

  2. 下载完成后,双击 NuGetPackageExplorer.application 进行安装,安装完成后会在桌面上生成一个NuGet Package Explorer 的快捷方式

 

  3. 双击NuGet Package Explorer出现启动界面,选择Create a new package(Ctrl+N)创建一个新包

  4. 选择菜单 Edit > Edit Package Metadata (或者 CTRL + K) 编辑包包信息

  这里可以编辑类库包的信息和添加类库、程序集的引用解释下几个比较重要的字段

  Id:用于定位类库包的唯一标示,如在命令行下执行 Install-Package MyPackage 这里的MyPackage就是包包的Id值

  Version:类库的版本号,这里建议和程序集的真实版本号保持一致,以免发生混淆

  Dependencies:此类库依赖的程序集,根据实际情况添加依赖类库的Id和版本号,若无留空即可,这里需要注意下填写的依赖类库需要在NuGet服务器上能找到,否则无法完成自动引用添加

  Framework assemblies:依赖的Framework 程序集,根据实际需要选择即可,一般无需设置

  除以上四项以外其他属性根据实际情况修改即可,若自己用不修改也中,不过为了使用方便还是建议把类库描述(Description)填写下

  5. 编辑好包包信息后接下来添加DLL到包包中

  可以选择 右键-->Add Existinng File... 选择dll添加,也可以直接拖拽DLL到 Package contents 窗口,此例选择拖拽方式

  直接拖拽dll到窗口后,会出现提示:是否将 Winista.HtmlParser.dll放到lib 文件夹下,一般我们选择是

  6. DLL添加完成后,快捷键Ctrl + K 修改包包信息Id为Winista.HtmlParser,版本号为1.8.0

  7. 信息修改和dll都添加完毕后,选择File --> Save(或Ctrl + S)将文件进行保存,默认文件名为Id + 版本号.nupkg

  8. 完成保存后如需要发布到网上,选择File--> Publish...(或Ctrl + P)

  默认的发布地址是官网,发布 Key需要到官网去注册一个账号,然后就可以得到,这里不在复述,若无需发布直接关闭即可

  ps:这里没有讲述如何打包项目文件,一般情况下我们自己将项目文件编译成DLL然后使用图形化界面打包即可满足需求,若实际工作需要高度集成完全自动化操作可自行去研究下官方文档http://docs.nuget.org/

  添加DLL默认会添加Lib文件夹,额外的菜单上还有很多.net文件夹,src等文件夹,这些文件夹只是对文件上的一个物理上的划分而已,只是为了帮助我们做好文件分类,没有其他的用途,dll文件可以随便放置,不过为了规范还是建议按照通常习惯来放置。

NuGet学习笔记(1)――初识NuGet及快速安装使用

关于NuGet园子里已经有不少介绍及使用经验,本文仅作为自己研究学习NuGet一个记录。

  初次认识NuGet是在去年把项目升级为MVC3的时候,当时看到工具菜单多一项Library Package Manager,右键项目文件多了一项Manage Nuget Packages...,这是个神马玩意儿,当时是一头雾水,后台查了些资料才知到NuGet是 Visual Studio的一个扩展,引用dudu的话来说就是管理程序的包包,可以参考msdn上这篇文章使用 NuGet 管理项目库 以及咱们博客园站长dudu写的程序员,用NuGet管理好你的类库 ,有些类似java中常用的maven   

  为什么要使用NuGet

  简单的说NuGet可以是我们的工作更方便,当我们的项目里要引用到的一些库时候,比如JQuery、Newtonsoft.Json、log4net等,我们需要从网上下载这些库,然后依次拷贝到各个项目中,当有的类库有更新时又不得不再重复一遍很是繁琐 ,这时就可以考虑使用NuGet来帮我们管理和更新这些类库,而且更新类库时会自动添加类库的相关引用,方便至极。当然网上一些我们常用的类库更新频率不是很高而且即便出了新版本我们也没必要总是保持最新,故这点对我们的帮助比较有限,个人认为NuGet最大的好处在于可以搭建自己的类库服务器,想想一下吧,在一些较大些的公司里面有很多的项目,然后其中有一些是整个组,甚至整个公司通用的类库,当这些类库有更新后我们需要依次拷贝到我们的项目,甚至于有时候我们自己都搞不清楚各个项目里的版本是否一致,有时偶尔一两个项目忘了复制更新出现莫名其妙的错误,为此头疼不已,现在有了NuGet,世界从此而不同。

  安装NuGet扩展

  要使用NuGet首先需要安装它(在安装了MVC3的系统上已自动安装了NuGet)

  1. 点击 工具-->扩展管理器(R)...-->右上角搜索框输入NuGet

  2. 点击 NuGetPackage Manager 项上面的下载按钮开始下载NuGet

  3. 下载完成后出现安装页面,点安装开始安装

  4. 很快安装完成,然后点击关闭完成整个安装

  5. 安装完后NuGet暂时不能用,需要重新启动下VS才行,重启后完毕后打开 扩展管理器(R)... 在已安装的扩展里可以看到NuGet Package Manager已经安装好了

  使用NuGet下载需要的类库

  1. 打开NuGet管理界面

  2. 出现如下界面,可以在里面找自己想要的类库也可以在右上角搜索里面输入关键字查找自己想要的类库,找到合适自己的类库后点install进行安装

  3. 这里我们选择安装Json.Net,点击安装好出现组件下载界面

  4. 下载完成后会出现提示将类库安装到什么项目,这里我们选择安装到TestConsole项目

  5. 安装完成后可以看到已经安装的Josn.Net显示一个已安装的小对勾

  6. 打开项目引用可以看到我们刚选择的类库Newtonsoft.Json已经自动添加到项目引用中

  使用命令行管理你的类库

  1. NuGet提供了命令行安装方法,在菜单中选择Package Manager Console,打开命令行控制台

  2. 出现NuGet控制台界面,默认类库源(Package source)为官方站点,也可以指向自己搭建的本地或内网站点,Default project表示默认将下载的类库添加到那个项目的引用中

  3. NuGet控制台有几个常用命令

  Get-Package 获取当前项目已经安装的类库

  Install-Package 安装指定类库,命令格式如下:Install-Package 类库ID,如Install-Package Newtonsoft.Json 这里需要注意的是类库的ID是唯一的,指向命令后会自动搜索指定类库源里指定ID类库,若找到则自动下载并添加引用,找不到则会出现找不到类库的提示

  Uninstall-Package 卸载指定类库,命令格式如下:Uninstall-Package 类库ID,如Uninstall-Package Newtonsoft.Json 

  Update-Package 更新指定类库,命令格式如下:Update-Package 类库ID,如Update-Package Newtonsoft.Json 

  ps:刚开始不熟悉时可以使用界面方式下载和更新类库,有一定经验后还是建议使用控制台添加、更新类库这样很方便,由于使用控制台需要知道类库的准确ID,可以到http://www.nuget.org/packages 这里去查找,把自己常用的ID记录下方便以后使用

  下一篇详细介绍下如何从零开始搭建自己的NuGet服务器及发布自己的类库到服务器。

還在揮汗徒手安裝程式庫? 試試NuGet吧

不知道大家是否有在Visual Studio專案中引用過log4net、ELMAH之類的Open Source程式庫,或加入包含css, jpg, js複雜jQuery Plugin的經驗?

在ASP.NET專案裡引用某些Javascript或.NET程式庫,所需的安裝工作常常不只Copy一個dll或js檔這麼簡單,有時還需複製相關的js, css, jpg, gif 放在特定目錄下,有時還必須修改web.config加入適當的httpHandler、httpModule及專屬設定才能讓.NET程式元件順利運作。依我自己的經驗,要是沒耐性看完安裝文件仔細核對,常會落得丟三落四無法運作的下場。在專案中加入程式庫,難道不能像裝軟體一樣,按下一步下一步就搞定?

NuGet是一個簡化程式庫安裝程序的Visual Studio 2010延伸套件,由微軟RD與開發社群共同開發,以Open Source方式釋出。透過NuGet,能有效簡化程式庫的安裝程序,另外還提供版本更新、移除等功能,將下載安裝程式庫的動作簡化到點一下滑鼠就完成。

要取得NuGet,可使用VS2010的Extension Manager搜尋nuget,可以找到NuGet Package Manager這個套件。(若你有安裝ASP.NET MVC3,NuGet也會被一併安裝,或是獨立執行安裝程式也可以,但透過Extension Manager較簡便)

安裝完成後,在Solution Explorer上按右鍵,會出現一個新選項"Add Library Package Reference"。

以在ASP.NET專案加入ELMAH為例,如果手動安裝ELMAH,我們需要Copy elmah.dll到bin,修改web.config加入configureSection及httpHandler, httpModule等設定,現在看看NuGet可以怎麼幫我們省力?

點選它後就會出現很像"Add Reference"選取DLL的對話框,選取Online頁籤,會出現一大票NuGet Package(我姑且將它翻譯成程式包)的清單,在右上方可輸入elmah關鍵字,可對清單進行篩選,只留下elmah程式包。([2011-05-17更新]elmah Package 1.2起另外分出了elmah.qs,elmah程式包只有elmah.dll,elmah.qs則包含了自動加入web.config設定。)

點選Install鈕,VS2010就會自動下載並安裝ELMAH程式包到專案中。

安裝完成後,可發現Bin下多了一個Elmah.dll,而web.config中也冒出了一些設定,只要再補上errorLog、資安管控等設定,ELMAH就可順利啟用了! 另外,專案還會多了一個packages.config檔案,記錄目前已安裝的程式包、版本等資訊。點選上圖的Installed Packages頁籤,會列出現已安裝的程式包,旁邊則有一個"Uninstall"鈕,按下後就會移除Elmah.dll並還原對web.config的修改;Updates頁籤則能協助檢查程式庫是否已有新版,如有需要,按一下鈕就能完成更新。

很方便吧?

NuGet預設的程式包來源來自NuGet Gallery(http://nuget.org)網站,目前還是Beta性質,功能也還很陽春,但已經有近900個程式包可供下載安裝。

NuGet Gallery有很深的社群共同經營色彩,所以只要註冊成會員,任何人都可以上載自己打包好的NuGet程式包,貢獻分享自己的成果。微軟在NuGet Gallery也只是社群成員的角色,提供了一些官方版程式包,而NuGet Gallery的管理團隊,目前對於上傳的Package也不做任何審查。但我猜隨著應用深度與廣度的改變,未來終究還是會需要某種程度的審查及管理機制維護秩序,NuGet Gallery還非常年輕(2011年1月才剛誕生),還需要時間調整、成熟。

NuGet Gallery目前提供了下載次數統計,未來會再補上評分機制(Rating)、評論留言(Comment),是不是挺像iPhone/Android/WP7 Market軟體商店的概念? 說不定有一天還可以衍生出付費下載安裝程式庫的商業模式,讓只會寫工具程式不會寫精美手機軟體的窮酸工程師也能靠寫程式賺些微薄外快,哈! (謎之聲: 想太多了,這位大叔!)

[Unit Test]使用ContextMock以不連結資料庫的方式做單元測試

在Unit Test時最讓我煩惱的是測試時的測試資料,為了讓每一次測試是一致的受測資料,且不被外在環境干擾,有試過很多方法,如在開始測試時新增測試資料到資料庫,測試時只用這些資料,結束測試時刪除測試資料,或是先準備好內有測試資料的mdb每次測試時複制mdb,不斷的掛載與卸離mdb,說真的這些方法都很蠢,不好維護且各個測試又容易互相影嚮(本測試寫了一筆資料,可能影嚮了下一個測試的結果),寫到最後我就放棄寫需要連資料庫的任何Unit Test,直到前陣子看到有人使用Entity Framework然後使用Mock ObjectContext,決解了測試時需要使用到資料庫這個外部資源,讓Unit Test更Unit,我又開始在新的專案中寫Unit Test。

 

一、增加ContextMock

在Entity Framework中建立ContextMock沒有多難,幾個按鍵就可以了。

註:因為使用edmx所產生的Model,都是繼承ObjectContext,而在Entity Framework 4.1中改繼承DbContext,所以我習慣叫它為Context。

 

1.打開Entity Framework的實體資料模型設計檔(edmx),在空白處按右鍵選 加入程式碼產生項目。

image 

 

2.選擇線上範本後選擇 ADO.NET Mocking Context Generator

image 

註:圖片中第一個範本ADO.NET Unit Testable Repository Generator也是會產生利於測試的Entity Framework,不過呢,使用這個範本要改變我對Repository的寫法,以及Entity變動時要維謢BaseRepositoryTest到瘋掉,而且我不喜歡正式專案中載入測試用的dll,這是它的官網 ,有興趣可自己玩玩。

 

這樣你的Entity Framework已經可以離線使用了。

1 //ContextMock的存取是使用在記憶體中的集合,可以把他想成DataSet,原理在第三章說明
2 IModel1 context = new Model1Mock();
3 context.Blogs.AddObject(new Blog() { Id = 1 });
4 context.Blogs.Where(x=>x.Id==1);

3.不過呢,這個範本少了些東西,必需做一點點的小調整,才能真的拿到專案中使用。

請打開YourModel.Context.tt檔

在104行中加入

        : System.IDisposable

在106行中加入

        int SaveChanges();

在131行中插入

        public int SaveChanges() { return 0; }

        public void Dispose() { }

 

同如下範例:

104 <#=Accessibility.ForType(container)#> interface I<#=code.Escape(container)#> : System.IDisposable
105 {
106     int SaveChanges();
107 <#+
108     foreach (EntitySet entitySet in container.BaseEntitySets.OfType<EntitySet>())
109     {
110 #>
111     IObjectSet<<#=code.Escape(entitySet.ElementType)#>> <#=code.Escape(entitySet)#> { get; }
112 <#+
113     }
114 #>
115 }
116 <#+
117 }
118 #>
119  
120 <#+
121 void WriteMockContextBody( EntityContainer container, CodeGenerationTools code )
122 {
123 #>
124 /// <summary>
125 /// The concrete mock context object that implements the context's interface.
126 /// Provide an instance of this mock context class to client logic when testing,
127 /// instead of providing a functional context object.
128 /// </summary>
129 <#=Accessibility.ForType(container)#> partial class <#=code.Escape(container)#>Mock : I<#=code.Escape(container)#>
130 {
131     public int SaveChanges() { return 0; }
132     public void Dispose() { }

註:tt檔是Text Template Transformation Toolkit (俗稱T4)的範本檔,主要用途是可以用範本來產生Code,Visual Studio 2010 中有T4的套件,如Visual T4 ,可以比較方便編輯tt檔。

 

再搭配IoC就可以很方便的使用ContextMock做單元測試了,怎麼做呢,請看下一章。

 

二、使用ContextMock

1.在這個範例中IoC,小弟是使用AutoFac 加上CommonServiceLocator (可參考IoC的中繼器:CommonServiceLocator),當然也可以用別的Ioc套件如Unity。

這二個套件都可以用NuGet下載。

image 

什麼!!你不知道什麼是NuGet,那你真要花點時間去了解,NuGet可是比本篇更實用的東西。

請參考黑大的:還在揮汗徒手安裝程式庫? 試試NuGet吧 

 

2.再來可能要改變一點點寫法,請將所有原本使用的Context,改用介面,請在前面加上I,並使用CommonServiceLocator來產生實例。

01 public class ShippingService
02 {
03     public void AddToCart(int custimeId, Product item)
04     {
05         //使用ServiceLocator來取得實例,一般情況使用正常的Context,在單元測試時使用MockContext
06         using (var context = ServiceLocator.Current.GetInstance<IShopModel>())
07         {
08             //訂算優惠
09             var productPremiums = context.Premiums.Where(x => x.ProductId == item.Id);
10             //.........
11  
12             context.Carts.AddObject(new Cart());
13             context.SaveChanges();
14         }
15     }
16 }

 

3.撰寫單元測試

01 [TestInitialize()]
02 public static void MyTestInitialize()
03 {
04     //測試資料的準備
05     IShopModel context = new ShopModelMock();
06     context.Products.AddObject(new Product()); //商品資料
07     context.Premiums.AddObject(new Premium()); //優惠資料
08  
09     //註冊實例,讓相關測試在ServiceLocator.Current.GetInstance時用同一個實例
10     ContainerBuilder builder = new ContainerBuilder();
11     builder.RegisterInstance<IShopModel>(context);
12     var provider = new AutofacServiceLocator(builder.Build());
13     ServiceLocator.SetLocatorProvider(() => provider);
14 }
15  
16 [TestMethod()]
17 public void ShippingService_AddToCartTest()
18 {
19     //測試時是使用,在MyClassInitialize所準備的資料,不會真的連資料庫
20     var shippingService = new ShippingService();
21     shippingService.AddToCart(1, new Product());
22  
23     //Assert Something
24 }

註1:別忘了在正式環境中也要加上IoC的註冊,把上面的範例中的

builder.RegisterInstance<IShopModel>(context);

改成如下就可以了

builder.RegisterType<ShopModel>().As<IShopModel>();

 
註2:這個範例是在同一個Class下的所有測試,共用同樣的測試資料,如果你每一個單元測試都使用不同的測試資料,可以改在每個單元測試中新增測試資料,且建議改用Unity,因為重新註冊在AutoFac中比較麻煩。

 

三、ContextMock的原理

目前看到的二種Mock的方式,原理都是一樣,產生的Code都很簡單,都是將原本的Context的Set額外定義到Interface,讓原本的Context與ContextMock都是繼承此Interface,我們在撰寫程式時,都是對Interface操作,在搭配IoC讓不同的時機,使用不同的Class,這一點寫過物件導向的人應該不莫生,這就是物件導向的抽象與繼承的應用嘛,而比較麻煩的是要讓一樣的語法,可以對資料庫或集合操作,這部分難的地方Linq幫我們處理掉了,打開YourModelMock.ObjectSet.cs。

01 public partial class MockObjectSet<T> : IObjectSet <T>   where T : class
02 {
03     //使用List存儲資料
04     private readonly IList<T> m_container = new List<T>();
05  
06     //將List轉成Queryable讓它可以如同對Entity Framework般的操作
07     public System.Linq.Expressions.Expression Expression
08     {
09         get { return m_container.AsQueryable<T>().Expression; }
10     }
11  
12     //將List轉成Queryable讓它可以如同對Entity Framework般的操作
13     public IQueryProvider Provider
14     {
15         get { return m_container.AsQueryable<T>().Provider; }
16     }
17 }

你會發現儲存媒體是List,那為什麼List與Entity Framwork的Linq語法可以共用呢?這裡使用了Linq的Queryable與Expression等相關技術,每當使用Linq對Queryable物件操作時,是將語法(如Where)都會轉成Expression,在GetEnumerator時才會使用QueryProvider去真的執行,而List轉成Queryable後QueryProvider是EnumerableQuery<T>,執行時以Linq To Object的方式操作,而Entity Framework的QueryProvider是ObjectQueryProvider,在執行時會剖析Expression轉成Sql對資料庫做操作(小弟有做過雷同的事,請參考Entity Framework批次Update與Delete),這部分的詳細說明小弟會整理到[下一篇IEnumable與IQueryable有什麼不同]。

 

可以看出這個技巧,不限定只能用在Entity Framework,也可以用在其他ORM的套件中(如nhibernate),只要它支援Linq,只是其他ORM可能就沒有那麼好命有相關的工具幫忙,像小弟最近的一個專案ORM是使用Entity Framework 4.1的Code First,完全沒有工具一切自己手打。

註:請不要問我,使用傳統的ADO.NET方式可以套用此方法嗎?我很久沒用傳統ADO.NET了,很久沒有花心思研究它了,不過我猜是不行,因為要解析Sql,每家的Sql都有差異,要轉成對物件操作,可能太複雜。