解读 Microsoft.NET.Sdk 的源码,你能定制各种奇怪而富有创意的编译过程
在 csproj 中,Project
中的 Sdk
属性是 MSBuild 15.0 开始支持的,也就是 Visual Studio 2017 开始支持。有了 Sdk 属性的存在,MSBuild 编译过程能够扩展得非常强大,而不止是过去 Import
的一个 props
和 targets
文件。
本文将介绍 Microsoft.NET.Sdk 的源码,以及利用源码中的一些线索来完成官方文档中没有提及的功能扩展。
This post is written in multiple languages. Please select yours:
在计算机上全局搜索 Microsoft.NET.Sdk
可以找到不同版本的多个 Sdk 目录,由于我安装了 .NET Core 3.0,所以找到的目录是:C:\Program Files\dotnet\sdk\3.0.100-preview6-012264
。当然,按照官网 How to: Reference an MSBuild Project SDK 的描述,如果自己实现了一套 Sdk,也可以以 NuGet 包的形式发布。
搜索 Microsoft.NET.Sdk
▲ 我计算机上的 Sdk 文件夹
Sdk 中的 NuGet 部分在 GitHub 上的仓库地址:
NuGet.Client/src/NuGet.Core at dev · NuGet/NuGet.Client
在打开看 Microsoft.NET.Sdk
的目录结构后,我们可以发现这几乎就是 NuGet 包要求的目录结构。
关于 NuGet 包的目录结构,我在下面两篇文章中都有提到过:
如何创建一个基于 MSBuild Task 的跨平台的 NuGet 工具包
如何创建一个基于命令行工具的跨平台的 NuGet 工具包
官方对 NuGet 的目录结构也有介绍:How to create a NuGet package from a convention-based working directory。
不过,Sdk 类型的 NuGet 包会多一个 Sdk
文件夹。
Sdk
文件夹中的 Sdk.props
和 Sdk.targets
是会被默认 Import
的,这一点在官方文档 How to: Reference an MSBuild Project SDK - Visual Studio 中是有说明的,以下两段代码的含义相同:
<Project Sdk="Microsoft.NET.Sdk"> <PropertyGroup> <TargetFramework>net48</TargetFramework> </PropertyGroup></Project>
<Project> <!-- Implicit top import --> <Import Project="Sdk.props" Sdk="Microsoft.NET.Sdk" /> <PropertyGroup> <TargetFramework>net48</TargetFramework> </PropertyGroup> <!-- Implicit bottom import --> <Import Project="Sdk.targets" Sdk="Microsoft.NET.Sdk" /></Project>
由于这两个文件的默认引入,Sdk 可以完成非常多的编译任务。而且通常 Sdk 带有扩展性,使得我们可以很方便地对项目的编译过程进行扩展,这一点在我前面提到了两篇制作 NuGet 工具包的文章中都有说明。
在 Sdk 文件夹中搜索 Target
节点的个数,我得到了 174 个(随 .NET Core 2.1 发布);不过有一些是同名的,会被重写(类似于 C#/.NET 中的继承和重写);核心的并没有那么多。
CollectPackageReferences
用于收集PackageReference
收集到的所有依赖(也就是 NuGet 包依赖)CoreCompile
核心的编译过程GenerateAssemblyInfo
用于生成AssemblyInfo.cs
文件(以前可是手工写的呢)Pack
用于将当前程序集打包成一个 NuGet 包GenerateNuspec
在打包之前生成 nuspec 文件
下面是 Microsoft.NET.Sdk 中发现的一些富有创意的编译过程:
<Target Name="DontRestore" BeforeTargets="Restore"> <Error Text="This project should not be restored" /> </Target>
▲ 如果有 Restore
,那么让你编译不通过
<Target Name="ReferenceStaticLegacyPackage" BeforeTargets="CollectPackageReferences"> <ItemGroup> <PackageReference Remove="LiteDB" /> <PackageReference Include="LiteDB" Version="2.0.2" /> </ItemGroup></Target>
▲ 这是我另外写的一篇文章:阻止某个 NuGet 包意外升级
参考资料
How to: Reference an MSBuild Project SDK - Visual Studio - Microsoft Docs
原文地址:https://walterlv.com/post/read-microsoft-net-sdk.html
.NET社区新闻,深度好文,欢迎访问公众号文章汇总 http://www.csharpkit.com
解读 Microsoft.NET.Sdk 的源码,你能定制各种奇怪而富有创意的编译过程相关推荐
- 淘宝top sdk java源码中的问题
最近做一个项目,需要对接拼多多的api接口,其本身没有提供sdk,但是发现api设计与淘宝top结构非常类似,之前由于对接过淘宝的top,对淘宝top sdk的结构比较了解,且淘宝sdk整体比较清晰, ...
- OGRE 所有版本(从0.1到1.7) (SDK 及 源码 及 扩展库) 下载地址
OGRE 所有版本 (SDK 及 源码) 下载地址 http://zh.sourceforge.jp/projects/sfnet_ogre/releases/ 或者SVN地址 https://svn ...
- Alian解读SpringBoot 2.6.0 源码(八):启动流程分析之刷新应用上下文(中)
目录 一.背景 1.1.刷新的整体调用流程 1.2.本文解读范围 二.调用后处理器 2.1.调用在上下文中注册为beanFactory的后置处理器 2.2.invokeBeanFactoryPostP ...
- Alian解读SpringBoot 2.6.0 源码(七):启动流程分析之准备应用上下文
目录 一.背景 1.1.run方法整体流程 1.2.本文解读范围 二.准备应用上下文 2.1.整体流程 2.2.设置环境 2.3.应用上下文进行后置处理 2.4.应用所有初始化器 2.5.发布应用上下 ...
- Alian解读SpringBoot 2.6.0 源码(十):启动流程之自动装配原理
目录 一.背景 1.1.主类的加载 1.2.后置处理器的获取 二.配置类后处理器 2.1.获取配置类 2.2. 2.3.解析主类 2.3.1.整体解析过程 2.3.2.核心解析过程 2.3.3.延迟导 ...
- Alian解读SpringBoot 2.6.0 源码(六):启动流程分析之创建应用上下文
目录 一.背景 1.1.run方法整体流程 1.2.本文解读范围 二.创建应用上下文 2.1.初始化入口 2.2.初始化AbstractApplicationContext 2.3.初始化Generi ...
- Alian解读SpringBoot 2.6.0 源码(八):启动流程分析之刷新应用上下文(下)
目录 一.背景 1.1.刷新的整体调用流程 1.2.本文解读范围 二.初始化特定上下文子类中的其他特殊bean 2.1.初始化主体资源 2.2.创建web服务 三.检查监听器bean并注册它们 四.实 ...
- Alian解读SpringBoot 2.6.0 源码(九):启动流程分析之应用上下文刷新后处理(启动完成事件,Runner运行器,就绪事件)
目录 一.背景 1.1.run方法整体流程 1.2.本文解读范围 二.应用上下文刷新后置处理 三.时间信息.输出日志记录执行主类名 四.发布应用上下文启动完成事件 4.1.ApplicationSta ...
- Alian解读SpringBoot 2.6.0 源码(二):启动流程分析之监听器解析
目录 一.背景 1.1.run方法整体流程 1.2.本文解读范围 二.记录应用启动的开始时间 三.初始化启动上下文 3.1.初始化启动上下文 3.2.初始化应用程序事件广播器 3.3.初始化应用上下文 ...
最新文章
- SBIO | 西农韦革宏组-大豆土壤细菌门间负向互作影响群落的动态变化和功能
- 化工设备与反应器 第二章 直杆的拉伸与压缩
- 图片优化之下一代图片格式WebP和AVIF
- python数据获取手段包括哪些_python开发应用-本地数据获取方法
- VMware 9 安装 Mac OS X 10.8 Mountain Lion 图文全程
- CodeForces	 841C (C) Leha and Function 贪心
- MySQL源码编译与初始化
- 阿里java架构师面试128题含答案:分布式架构+Dubbo+多线程+Redis
- 海缆修好之前,上网悠着点
- 静态库与动态库的制作
- 颜色代码:网页颜色代码大全及色彩搭配教程
- coq程序编写好用的IDE推荐
- CSAPP Lab2
- uos 序列号_体验一把国产统一操作系统——UOS
- 80端口、443端口、8080端口、8000端口的区别
- 大学四年到阿里技术专家,我是怎么走过来的
- 7K7K小游戏《黑客是怎样炼成的》攻略
- Vue进阶(三十六):created() 详解
- 哈工大演化计算PPT1(精译)
- Redis Cluste部署