Visual Studio的工程結構解析

標籤：ext   eid   web   led   comm   share   property   alt   hex   

近來由於需要分析VS的工程結構，大家都知道以.sln結尾的就是Visual Studio的解決方案檔案

廢話不多說，首先查看下一個簡單的sln檔案結構

1. Microsoft Visual Studio Solution File, Format Version 11.00 
2. # Visual Studio 2010 
3. Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ConsoleApplication1", 
4. "ConsoleApplication1\ConsoleApplication1.csproj", "{CD680A35-B1DB-4A3D-9073-2A604600D396}" 
5. EndProject 
6. Global 
7.  GlobalSection(SolutionConfigurationPlatforms) = preSolution 
8.   Debug|x86 = Debug|x86 
9.   Release|x86 = Release|x86 
10.  EndGlobalSection 
11.  GlobalSection(ProjectConfigurationPlatforms) = postSolution 
12.   {CD680A35-B1DB-4A3D-9073-2A604600D396}.Debug|x86.ActiveCfg = Debug|x86 
13.   {CD680A35-B1DB-4A3D-9073-2A604600D396}.Debug|x86.Build.0 = Debug|x86 
14.   {CD680A35-B1DB-4A3D-9073-2A604600D396}.Release|x86.ActiveCfg = Release|x86 
15.   {CD680A35-B1DB-4A3D-9073-2A604600D396}.Release|x86.Build.0 = Release|x86 
16.  EndGlobalSection 
17.  GlobalSection(SolutionProperties) = preSolution 
18.   HideSolutionNode = FALSE 
19.  EndGlobalSection 
20. EndGlobal 

其中第一行是檔案說明，裡面有一句Format Version 11.00 這句說明的就是解決方案的vs版本

其中以Project開頭的就是解決方案所包含的工程，另外還有已Global開頭EndGlobal結尾的片段，這裡有解決方案的一些全域配置，裡面內容一看就明白，這裡就不多說了。重點看Project片段，此例中只包含一個Project，大家有沒有發現Project後面跟了一個GUID，這個是什麼呢？

進過查資料發現，這裡的GUID代表著工程類型，例如上面的"FAE04EC0-301F-11D3-BF4B-00C04F79EFBC"代表的是一個C#的工程，後面是工程名以及工程檔案路徑

下面附上GUID代表的工程類型表

Visual Studio 所使用的 *.sln,*.csproj,*.vbproj 等檔案表示項目類型的 GUID 清單。
  對於分析項目資訊很有用。

Project Type Description	Project Type Guid
Windows (C#)	{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}
Windows (VB.NET)	{F184B08F-C81C-45F6-A57F-5ABD9991F28F}
Windows (Visual C++)	{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}
Web Application	{349C5851-65DF-11DA-9384-00065B846F21}
Web Site	{E24C65DC-7377-472B-9ABA-BC803B73C61A}
Distributed System	{F135691A-BF7E-435D-8960-F99683D2D49C}
Windows Communication Foundation (WCF)	{3D9AD99F-2412-4246-B90B-4EAA41C64699}
Windows Presentation Foundation (WPF)	{60DC8134-EBA5-43B8-BCC9-BB4BC16C2548}
Visual Database Tools	{C252FEB5-A946-4202-B1D4-9916A0590387}
Database	{A9ACE9BB-CECE-4E62-9AA4-C7E7C5BD2124}
Database (other project types)	{4F174C21-8C12-11D0-8340-0000F80270F8}
Test	{3AC096D0-A1C2-E12C-1390-A8335801FDAB}
Legacy (2003) Smart Device (C#)	{20D4826A-C6FA-45DB-90F4-C717570B9F32}
Legacy (2003) Smart Device (VB.NET)	{CB4CE8C6-1BDB-4DC7-A4D3-65A1999772F8}
Smart Device (C#)	{4D628B5B-2FBC-4AA6-8C16-197242AEB884}
Smart Device (VB.NET)	{68B1623D-7FB9-47D8-8664-7ECEA3297D4F}
Workflow (C#)	{14822709-B5A1-4724-98CA-57A101D1B079}
Workflow (VB.NET)	{D59BE175-2ED0-4C54-BE3D-CDAA9F3214C8}
Deployment Merge Module	{06A35CCD-C46D-44D5-987B-CF40FF872267}
Deployment Cab	{3EA9E505-35AC-4774-B492-AD1749C4943A}
Deployment Setup	{978C614F-708E-4E1A-B201-565925725DBA}
Deployment Smart Device Cab	{AB322303-2255-48EF-A496-5904EB18DA55}
Visual Studio Tools for Applications (VSTA)	{A860303F-1F3F-4691-B57E-529FC101A107}
Visual Studio Tools for Office (VSTO)	{BAA0C2D2-18E2-41B9-852F-F413020CAA33}
SharePoint Workflow	{F8810EC1-6754-47FC-A15F-DFABD2E3FA90}
XNA (Windows)	{6D335F3A-9D43-41b4-9D22-F6F17C4BE596}
XNA (XBox)	{2DF5C3F4-5A5F-47a9-8E94-23B4456F55E2}
XNA (Zune)	{D399B71A-8929-442a-A9AC-8BEC78BB2433}
SharePoint (VB.NET)	{EC05E597-79D4-47f3-ADA0-324C4F7C7484}
SharePoint (C#)	{593B0543-81F6-4436-BA1E-4747859CAAE2}
Silverlight	{A1591282-1198-4647-A2B1-27E5FF5F6F3B}
ASP.Net MVC Application	{603C0E0B-DB56-11DC-BE95-000D561079B0}

 其中有一個GUID不在列表中大家也有可能會經常遇到，那就是解決方案檔案夾，它的類型ID為"2150E333-8FDC-42A3-9474-1A3956D46DE8"

如何擷取解決方案的內容呢？

這裡我使用的Regex，下面為GUID,命名規則，相對路徑的運算式

1. public class RegexExpressionConst 
2.     { 
3.         /// <summary> 
4.         /// GUID的Regex,格式 FAE04EC0-301F-11D3-BF4B-00C04F79EFBC 
5.         /// </summary> 
6.         public const string GuidExp = @"\w{8}-(\w{4}-){3}\w{12}"; 
7.  
8.         /// <summary> 
9.         /// 匹配[工程檔案命名] 
10.         /// </summary> 
11.         public const string ProjectExt = @"[a-z][\s\.\-\w]+"; 
12.  
13.         /// <summary> 
14.         /// 匹配[相對路徑] 
15.         /// </summary> 
16.         public const string RelativePathExt = @"(\\?([a-z][\s\.\-\w]+))+"; 
17.  
18.     } 

下面就是組合這些運算式，以下就是組合後的Regex用於匹配sln中的工程

1. var projectRegexExp = string.Format("Project\\(\"{{{0}}}\"\\)\\s*=\\s*\"{1}\"\\s*,\\s*\"{2}\"\\s*,\\s*\"{{{3}}}\"", 
2.    RegexExpressionConst.GuidExp, RegexExpressionConst.ProjectExt, RegexExpressionConst.RelativePathExt, RegexExpressionConst.GuidExp); 

擷取其中的工程檔案的名稱，工程檔案路徑，工程檔案的類型，這裡還定義了一個新的實體方便儲存操作

1. var projectPropertyModels = new List<ProjectPropertyModel>();  
2. var projectReg = new Regex(projectRegexExp, RegexOptions.Compiled | RegexOptions.IgnoreCase); 
3. var projectContexts = projectReg.Matches(fileContent); 
4. foreach (var projectContext in projectContexts) 
5. { 
6.     var projectPropertyModel = new ProjectPropertyModel(); 
7.     var projectContextprojectContextArr = projectContext.ToString().Split(new string[]{"="}, StringSplitOptions.RemoveEmptyEntries); 
8.     projectPropertyModel.ProjectTypeID = new Regex(RegexExpressionConst.GuidExp).Match(projectContextArr[0]).ToString().Trim(); 
9.     var projectValueArr = projectContextArr[1].Split(new string[] { "," }, StringSplitOptions.RemoveEmptyEntries); 
10.     projectPropertyModel.ProjectName = projectValueArr[0].Replace("\"", "").Trim(); 
11.     projectPropertyModel.ProjectRelativePath = projectValueArr[1].Replace("\"", "").Trim(); 
12.     projectPropertyModel.ProjectID = projectValueArr[2].Replace("\"{", "").Replace("}\"", "").Trim(); 
13.     projectPropertyModel.ProjectAbsolutePath = Path.Combine(slnFolderPath, projectPropertyModel.ProjectRelativePath); 
14.      projectPropertyModels.Add(projectPropertyModel); 
15. } 
16. /// <summary> 
17.     /// 工程檔案屬性 
18.     /// </summary> 
19.     public class ProjectPropertyModel 
20.     { 
21.         /// <summary> 
22.         /// 工程類型ID 
23.         /// </summary> 
24.         public string ProjectTypeID { get; set; } 
25.  
26.         /// <summary> 
27.         /// 工程名稱 
28.         /// </summary> 
29.         public string ProjectName { get; set; } 
30.  
31.         /// <summary> 
32.         /// 工程相對路徑 
33.         /// </summary> 
34.         public string ProjectRelativePath { get; set; } 
35.  
36.         /// <summary> 
37.         /// 工程絕對路徑 
38.         /// </summary> 
39.         public string ProjectAbsolutePath { get; set; } 
40.  
41.         /// <summary> 
42.         /// 工程唯一標識 
43.         /// </summary> 
44.         public string ProjectID { get; set; } 
45.     } 

有了工程檔案的名稱，工程檔案路徑，工程檔案的類型，下面就讓我們解析工程檔案吧

工程檔案大家開啟自己電腦上的以*.csproj這個結尾的檔案看看吧，這裡就不貼了，太長了

說道解析工程檔案解析這裡就不得不提Microsoft.Build.Evaluation.ProjectCollection,這個集合可以直接載入一個工程到集合中，並返回一個Project

1. ProjectCollection pc = new ProjectCollection(); 
2. Project _Project = pc.LoadProject(projectFilePath) 

這裡我們就可以很簡單的擷取工程檔案中的內容了

1. 組件檔夾 
2. _Project.DirectoryPath 
3. 擷取程式集名稱 
4. _Project.GetPropertyValue("AssemblyName");  
5. 擷取編譯後檔案夾 
6. _Project.GetPropertyValue("TargetDir"); 
7. 擷取編譯後路徑 
8. _Project.GetPropertyValue("TargetPath"); 
9. 擷取所有引用項 
10. _Project.AllEvaluatedItems.Where(e => e.ItemType == "Reference") 
11. 擷取所有編譯項 
12. _Project.AllEvaluatedItems.Where(e => e.ItemType == "Compile") 
13. 擷取所有頁面 
14. _Project.AllEvaluatedItems.Where(e => e.ItemType == "Page") 
15. 擷取其他項 
16. _Project.AllEvaluatedItems.Where(e => e.ItemType == "None") 

這裡列出來一些常用項，更詳細的大家可以直接查看http://technet.microsoft.com/zh-cn/microsoft.build.evaluation.project(v=vs.90)

呵呵，有了這些東西我們的整個工程結構是不是都有了呢，下面就可以幹我們想乾的事情了。

Visual Studio的工程結構解析