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 列表。
  对于分析项目信息很有用。

其中有一个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. /// <summary>
8. /// 匹配[工程文件命名]
9. /// </summary>
10. public const string ProjectExt = @"[a-z][\s\.\-\w]+";
11. /// <summary>
12. /// 匹配[相对路径]
13. /// </summary>
14. public const string RelativePathExt = @"(\\?([a-z][\s\.\-\w]+))+";
15. }

下面就是组合这些表达式，以下就是组合后的正则表达式用于匹配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. /// <summary>
26. /// 工程名称
27. /// </summary>
28. public string ProjectName { get; set; }
29. /// <summary>
30. /// 工程相对路径
31. /// </summary>
32. public string ProjectRelativePath { get; set; }
33. /// <summary>
34. /// 工程绝对路径
35. /// </summary>
36. public string ProjectAbsolutePath { get; set; }
37. /// <summary>
38. /// 工程唯一标识
39. /// </summary>
40. public string ProjectID { get; set; }
41. }

有了工程文件的名称，工程文件路径，工程文件的类型，下面就让我们解析工程文件吧

工程文件大家打开自己电脑上的以*.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)

呵呵，有了这些东西我们的整个工程结构是不是都有了呢，下面就可以干我们想干的事情了。