.NET 6新特性试用 | 隐式using指令

Posted 2021-12-12 dotNET跨平台

前言

在使用《最小Web API》时，我们发现，相比以前的代码，大量的using指令消失了：

using指令的主要作用是允许使用在命名空间中定义的类型，而无需指定该类型的完全限定命名空间。

那么，在.NET 6下为什么不需要了呢？

ImplicitUsings属性

遍历项目下的所有文件，最后在csproj中找到这样一个属性，应该和using指令相关：

将属性值改成disable，则编译失败：

需要在文件顶部加上using指令：

也就是说，编译时其实还是需要using指令的。

那它们写在哪了？

global using指令

打开obj目录（用于存放编译过程中生成的中间临时文件），在cs文件的对应目录发现了WebApplication1.GlobalUsings.g.cs文件:

原来using都写在这里了：

// <auto-generated/>
global using global::Microsoft.AspNetCore.Builder;
global using global::Microsoft.AspNetCore.Hosting;
global using global::Microsoft.AspNetCore.Http;
global using global::Microsoft.AspNetCore.Routing;
global using global::Microsoft.Extensions.Configuration;
global using global::Microsoft.Extensions.DependencyInjection;
global using global::Microsoft.Extensions.Hosting;
global using global::Microsoft.Extensions.Logging;
global using global::System;
global using global::System.Collections.Generic;
global using global::System.IO;
global using global::System.Linq;
global using global::System.Net.Http;
global using global::System.Net.Http.Json;
global using global::System.Threading;
global using global::System.Threading.Tasks;

global using的官方文档说明如下：

向 using 指令添加 global 修饰符意味着 using 将应用于编译中的所有文件（通常是一个项目）

也就是说，对于任何命名空间，无需再在每个文件上写using指令，只需在一个文件中写global using指令即可。

而WebApplication1.GlobalUsings.g.cs文件是基于ImplicitUsings属性设置自动生成的。

那么，为啥会自动包含这些命名空间呢？

GenerateGlobalUsings任务

使用MSBuild Structured Log Viewer（使用方法请参看《天呐！你知道MSBuild都干了些什么》）查看MSBuild的输出日志，可以看到WebApplication1.GlobalUsings.g.cs文件是由GenerateGlobalUsings任务生成的：

而任务参数数据来源于Using参数：

<GenerateGlobalUsings Usings="@(Using)">
    <Output TaskParameter="Lines" ItemName="_GlobalUsingLines" />
</GenerateGlobalUsings>

而具体值来源于项目引用的SDK:

结论

了解原理后，我们可以使用项目文件，即可增加我们的自定义global using：

<ItemGroup>
    <Using Include="GlobalUsingDemo" />
</ItemGroup>

利用隐式using指令，再也不用在cs文件中写using指令了！

如果你觉得这篇文章对你有所启发，请关注我的个人公众号”My IO“