如何配置CSharpCompilation.Create启用全局隐式usings
配置
CSharpCompilation.Create使用全局隐式usings的实现方案 CSharpCompilation.Create不会自动读取.NET 6项目的<ImplicitUsings>enable</ImplicitUsings>配置,全局隐式usings本质是.NET SDK在编译阶段自动注入全局using声明代码的语法糖,你可以通过手动注入对应语法树的方式实现完全一致的效果,具体操作如下:
核心原理
开启隐式usings时,.NET SDK会根据项目SDK类型(控制台、类库、ASP.NET Core等)自动生成包含一系列global using声明的临时C#文件,和项目代码一起参与编译,不存在编译器层面的特殊逻辑。

具体实现步骤
- 确定需要引入的全局using集合
普通.NET 6类库/控制台项目默认引入的全局using如下:
ASP.NET Core、WPF、WinForms等项目类型会追加对应领域的默认命名空间,你也可以加入项目中通过global using System; global using System.Collections.Generic; global using System.IO; global using System.Linq; global using System.Net.Http; global using System.Threading; global using System.Threading.Tasks;<Using Include="XXX"/>自定义配置的全局命名空间。 - 将全局using代码解析为语法树
注意global using是C# 10及以上版本支持的语法,解析时需要指定匹配的语言版本:var globalUsingsSource = @" global using System; global using System.Collections.Generic; global using System.IO; global using System.Linq; global using System.Net.Http; global using System.Threading; global using System.Threading.Tasks; "; var parseOptions = new CSharpParseOptions(LanguageVersion.CSharp10); var globalUsingsTree = CSharpSyntaxTree.ParseText(globalUsingsSource, parseOptions); - 创建编译实例时注入该语法树
把全局using对应的语法树和你自己的业务代码语法树一同传入syntaxTrees参数即可:var compilation = CSharpCompilation.Create( assemblyName: "YourTargetAssembly", syntaxTrees: new[] { yourBusinessCodeTree, globalUsingsTree }, references: LoadAllRequiredMetadata(), // 传入项目依赖的所有元数据引用 options: new CSharpCompilationOptions(OutputKind.DynamicallyLinkedLibrary) ); - 更精准的适配方案
如果你需要和项目实际编译行为100%一致,不需要手动维护全局using列表,可以直接读取对应项目obj目录下SDK自动生成的全局using文件,默认路径为obj/[编译配置]/[目标框架]/[项目名称].GlobalUsings.g.cs,将该文件内容解析为语法树加入编译即可,文件内已经包含所有默认和自定义配置的全局using声明。
注意:如果解析时未指定C# 10及以上的语言版本,会触发
global using相关的语法报错。
内容的提问来源于stack exchange,提问作者Santiago
相关产品推荐
相关产品推荐

