Visual Studio的工程结构解析

Posted jackking

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Visual Studio的工程结构解析相关的知识，希望对你有一定的参考价值。

近来由于需要分析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"

如何获取解决方案的内容呢？

这里我使用的正则表达式，下面为GUID,命名规则，相对路径的表达式

  1. public class RegexExpressionConst 
  2.     { 
  3.         /// <summary> 
  4.         /// GUID的正则表达式,格式 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.     } 

下面就是组合这些表达式，以下就是组合后的正则表达式用于匹配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的工程结构解析的主要内容，如果未能解决你的问题，请参考以下文章

Visual Studio 2013新建工程导入现有代码文件夹并且保持目录结构

无法登录 Visual Studio

在 ASP.Net (Visual Studio 2013) 中以结构格式解析 Json 数据

Visual Studio中把文件夹导入工程中

Microsoft Visual Studio 更改默认主题

为 Linux 系统构建 Visual Studio 项目