.csproj 文件
.csproj,是C#项目文件的扩展名,它是“C Sharp Project”的缩写。.net开发环境中建立项目时,会产生.csproj文件,这是C#的工程文件,其中记录了与工程有关的相关信息,例如包含的文件,程序的版本,所生成的文件的类型和位置信息等。
【作用】
.csproj究竟是做什么用的?它是给开发工具用的,例如我们再熟悉不过的Visual Studio,以及大家可能没有接触过的MSBuild.exe。
Visual Studio会根据csproj里的XML定义来管理项目文件以及相关其他一些种类非常丰富的数据及操作,MSBuild也会根据csproj文件来得知编译这个项目需要有哪些依赖,默认输出路径,Pre-Build和Post-Build需要哪些操作等。
Visual Studio和MSBuild都是开发工具,这就是csproj存在的唯一意义:为“开发工具”提供信息。而到了运行环境中,根本不会有人关心所谓的csproj文件——也就是“程序是从哪里来的”。
即.csproj类似于工程图纸
【各个部件的作用】
PropertyGroup(存放属性)
PropertyGrouph是用来存放属性的地方,这与它的名字非常契合。
在这里写属性就像在代码中定义属性或变量一样,只要写了,就会生成一个指定名称的属性。
比如,我们写:
-
<PropertyGroup>
-
<Foo> watermelon is a fruit </Foo>
-
</PropertyGroup>
那么,就会生成一个 Foo 属性,值为字符串 watermelon is a fruit。至于这个属性有什么用,那就不归这里管了。
PropertyGroup可以定义很多个,里面都可以同等地放属性。至于为什么会定义多个,原因无外乎有两个:
- 增加可读性 —— 将一组相关的属性放在一起,便于阅读和理解意图;
- 便于加条件 —— 有的属性在 Debug 和 Release 下不一样(例如条件编译符 DefineConstants)。
ItemGroup(存放集合)
ItemGroup是用来指定集合的地方。
集合里面一些常见的项:
- Reference:引用某个程序集
- PackageReference:引用某个NuGet包
- ProjectReference:引用某个项目
- Compile:常规的 C# 编译
- None:执行一些通用的操作(或者只是为了在 Visual Studio 列表中能够有一个显示)
- Folder:一个空的文件夹
ItemGroup 也可以放很多组,同样是为了提升可读性或者增加条件。
Import(导入)
Import是为了导入属性(props)和Targets(后面会具体说Targets)。
被我们 Import 进来的那些文件,可以用两种扩展名表示,一种是用来定义属性,为 .props;另一种用来定义行为,为 .targets。这两种文件除了含义不同以外,内容的格式都是完全一样的 —— 即 csproj 文件格式。
虽然 csproj 文件中可以完全实现引入的 props 文件的功能,但为了在多个项目中使用,一处更新,到处生效,因此选择单独用 props 文件来存放。
Target
一般来说, Target 节点写在 csproj 文件的末尾,但这个并不是强制的。Targets 是一种非常强大的功能扩展方式,支持 msbuild 预定义的一些指令,支持命令行,甚至支持使用 C# 直接编写(当然编译成 dll 会更方便些),还支持这些的排列组合和顺序安排。而我们实质上的编译过程便全部由这些 Targets 来完成。甚至可以说,编译过程就是靠这些 Target 的组合来完成的。
Project
所有的 csproj 文件都是以 Project 节点为根节点。
下面列出新旧两款 csproj 文件格式的差异:
其中,在各部件中,白色代表必须,灰色代表可选;而更接近背景色的灰色代表一般情况下都是不需要的。
可以看出,新格式的最大好处之一就是简洁。而这一优势,靠的就是 Project 节点,新格式中的 Project 节点有 sdk 属性 —— 所谓 sdk,其实是一大波 .targets 文件的集合。它帮我们导入了公共的属性、公共的编译任务,还帮我们自动将项目文件夹下所有的 **\*.cs 文件都作为 ItemGroup 的项引入进来。
【 .sln 和 .csproj 的区别】
1. .sln:即 solution,解决方案
.csproj:即 C sharp project,C# 项目
2. 解决方案是项目的集合,项目是文件的集合;一个 sln 中可以包含多个 csproj。一个 csproj 可以包含多个文件; csproj 可以作为单独的项目运行,也可以在 sln 中添加 csproj 统一管理。
3. sln 和 csproj 都可以双击运行,如果解决方案中只有一个项目(就是说一个项目对应一个csproj),但是一个解决方案会包含多个项目,那么两个方式是没有区别的;但是如果一个解决方案中包含多个项目, sln 会加载该解决方案中所有的项目,而 csproj 只会加载当前项目。
4. 关于 sln 和 csproj 的几个问题
(1)C#、.net 中,.sln 文件可以删掉重新生成吗?
.sln 是项目文件,删除后项目的一些设置会无法恢复,因为解决方案里面可能有关于这个项目文件的很多信息,所以一般不建议删除重建;但一般也没有太大的问题,用VS直接打开 .csproj 工程文件,会自动建上 sln 的。
(2)下载的 ASP.net 源码没有.sln 或 .csproj 文件如何使用?
从 Visual Studio IDE 的菜单 "文件" --> "打开" --> "网站" ,然后从右边的目录中选择要打开的网站目录,不需要有 .sln 文件就可以打开网站并调试运行。如果是 WebSite 模式那么是不需要 .sln 文件的,可以通过 File -> WebSite -> OpenWebSite 打开。如果不是 WebSite 模式,那么可以自己建立一个空项目,然后把文件 Copy 进去即可。