在 .NET Core 2.x csproj 项目中可靠地生成 C# 代码？

Question

描述

我一直无法让 C# 代码生成在我的 .NET 项目中可靠地工作。我可以让它构建（a）当源文件预先存在时或（b）当源文件预先不存在时。我无法在两种情况下使用相同的设置。

为什么这很重要：如果我在我的开发机器上构建，我可能以前构建过代码，所以我需要它来重新生成现有的源代码。但是，在构建机器上构建时，这些文件不存在，因此在这种情况下我需要它从头开始生成代码。

设置

复制此文件只需要一个 csproj 和一个源文件。

这是一个引用示例的简单程序 GeneratedClass:

class Program
{
    public static void Main(string[] args)
    {
        System.Console.WriteLine(GeneratedClass.MESSAGE);
    }
}

这是我能想到的最简单的 csproj 文件。

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <TargetFramework>netstandard2.0</TargetFramework>
  </PropertyGroup>
  <Target Name="GenerateCode" BeforeTargets="CoreCompile">

    <!-- Removing the source code beforehand makes no difference
    <Exec Command="rm $(ProjectDir)Generated/*.cs" IgnoreExitCode="true" />
    -->

    <Exec Command="echo 'class GeneratedClass { public static int MESSAGE = 1; }' > Generated/GeneratedClass.cs" />

    <!-- Toggling this setting will cause failures in some scenarios and success in others
    <ItemGroup>
      <Compile Include="Generated/*$(DefaultLanguageSourceExtension)" />
    </ItemGroup> -->

  </Target>
</Project>

创建一个名为 "Generated" 的空目录。

要构建，运行 dotnet build 来自 csproj 和 Program.cs 文件所在的目录。

我运行在 Linux 上安装 .NET Core 2.0.3。我的 Docker 构建容器使用 microsoft/dotnet:2.0-sdk 图像；我可以在 Docker.

内部和外部复制问题

症状

请注意，在上面的 csproj 文件中，有一个 <Compile Include 设置被注释掉了。另请注意，运行多次构建将生成代码。（可手动删除代码，复制构建开始时代码不存在的情况。）

这是我发现错误和未发现错误的矩阵：

+----------------------+----------------------+-----------------------------------+
| Compile Include=...? | Code Already Exists? |              Result               |
+----------------------+----------------------+-----------------------------------+
| Present              | YES                  | ERROR! "specified more than once" |
| Present              | NO                   | SUCCESS!                          |
| Commented Out        | YES                  | SUCCESS!                          |
| Commented Out        | NO                   | ERROR! "does not exist"           |
+----------------------+----------------------+-----------------------------------+

"specified more than once" 错误的完整错误文本：/usr/share/dotnet/sdk/2.0.3/Roslyn/Microsoft.CSharp.Core.targets(84,5): error MSB3105: The item "Generated/GeneratedClass.cs" was specified more than once in the "Sources" parameter. Duplicate items are not supported by the "Sources" parameter. [/home/user/tmp/CodeGenExample.csproj]

"does not exist" 错误的完整错误文本：Program.cs(5,34): error CS0103: The name 'GeneratedClass' does not exist in the current context [/home/user/tmp/CodeGenExample.csproj]

请求帮助

我最好的猜测是我的 BeforeTargets="CoreCompile" 是错误的。我在那里尝试了很多不同的值（抱歉不记得是哪些）而且我总是运行遇到这样或那样的问题。这只是一个猜测。

我做错了什么？

Answer 1

免责声明：您的实际项目中似乎有上述内容未包含的内容，因此我不确定此解决方案是否有效。

以下是一个 hacky 方法，因为它的行为不尽如人意。
然而，它可能足以满足您的目的 - 这由您决定。我说它是 hacky 的原因是 pre-build 文件删除似乎执行了不止一次。¹

我的 csproj 文件是这样做的：

删除生成目录中的所有文件。这是通过 CleanGen 目标完成的，并作为 Project 节点中的初始目标启动。
GeneratedCode 目标附加到输出文件，以证明它只发生一次。
启用 ItemGroup 节点以允许编译生成的文件。
回显变量 $(NuGetPackageRoot) 以表明它已设置。

在此处完成 csproj 文件：

<Project InitialTargets="CleanGen" Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <TargetFramework>netstandard2.0</TargetFramework>
  </PropertyGroup>
  <Target Name="CleanGen">
    <Exec Command="echo 'Cleaning files...'" />
    <Exec Command="rm $(ProjectDir)Generated/*$(DefaultLanguageSourceExtension)" IgnoreExitCode="true" />
  </Target>
  <Target Name="GenerateCode" BeforeTargets="CoreCompile">
    <Exec Command="echo 'Generating files... $(NuGetPackageRoot)'" />
    <Exec Command="echo 'class GeneratedClass { public static int MESSAGE = 1; }' >> Generated/GeneratedClass.cs" />

    <ItemGroup>
      <Compile Include="Generated/*$(DefaultLanguageSourceExtension)" />
    </ItemGroup>
  </Target>
</Project>

这看起来确实比它应该做的要难...

¹ OP 指出，为避免多次执行 rm 命令，您可以将 Condition 添加到 Exec:

<Exec 
    Command="rm $(ProjectDir)Generated/*$(DefaultLanguageSourceExtension)"
    Condition="Exists('$(ProjectDir)Generated/GeneratedClass$(DefaultLanguageSourceExtension)')" />

遗憾的是 Exists 不接受 glob，因此您必须至少指定一个您知道将在该文件夹中生成的特定文件。通过这种妥协，您还可以摆脱 IgnoreExitCode="true"，因为它只应在有文件要删除时执行。

Answer 2

我能够通过重新包含生成的项目使其工作：

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <TargetFramework>netstandard2.0</TargetFramework>
  </PropertyGroup>
  <Target Name="GenerateCode" BeforeTargets="CoreCompile">

    <Exec Command="mkdir Generated" Condition="!Exists('Generated')" />
    <Exec Command="echo class GeneratedClass { public static int MESSAGE = 1; } > Generated/GeneratedClass.cs" />

    <ItemGroup>
      <Compile Include="Generated/*$(DefaultLanguageSourceExtension)" Exclude="@(Compile)" />
    </ItemGroup>

  </Target>
</Project>

2019 年 4 月 16 日更新：

SpecFlow 3 使用巧妙的 Exclude="@(Compile)" 技巧来编译生成的文件 (https://specflow.org/2019/updating-to-specflow-3/):

<ItemGroup>
  <Compile Include="Generated/*$(DefaultLanguageSourceExtension)" Exclude="@(Compile)" />
</ItemGroup>

2018 年 9 月 20 日更新：

请在此处查看示例 git 存储库：https://github.com/altso/SO49075282

在 cmd 中重现的步骤：

C:\Temp>dotnet --version
2.1.402

C:\Temp>git clone https://github.com/altso/SO49075282.git
Cloning into 'SO49075282'...
remote: Counting objects: 5, done.
remote: Compressing objects: 100% (4/4), done.
remote: Total 5 (delta 0), reused 5 (delta 0), pack-reused 0
Unpacking objects: 100% (5/5), done.

C:\Temp>cd SO49075282

C:\Temp\SO49075282>dotnet build
Microsoft (R) Build Engine version 15.8.166+gd4e8d81a88 for .NET Core
Copyright (C) Microsoft Corporation. All rights reserved.

  Restoring packages for C:\Temp\SO49075282\SO49075282.csproj...
  Generating MSBuild file C:\Temp\SO49075282\obj\SO49075282.csproj.nuget.g.props.
  Generating MSBuild file C:\Temp\SO49075282\obj\SO49075282.csproj.nuget.g.targets.
  Restore completed in 311.61 ms for C:\Temp\SO49075282\SO49075282.csproj.
  SO49075282 -> C:\Temp\SO49075282\bin\Debug\netcoreapp2.1\SO49075282.dll

Build succeeded.
    0 Warning(s)
    0 Error(s)

Time Elapsed 00:00:02.95

C:\Temp\SO49075282>dotnet build
Microsoft (R) Build Engine version 15.8.166+gd4e8d81a88 for .NET Core
Copyright (C) Microsoft Corporation. All rights reserved.

  Restore completed in 60.66 ms for C:\Temp\SO49075282\SO49075282.csproj.
  SO49075282 -> C:\Temp\SO49075282\bin\Debug\netcoreapp2.1\SO49075282.dll

Build succeeded.
    0 Warning(s)
    0 Error(s)

Time Elapsed 00:00:02.17

C:\Temp\SO49075282>

在 .NET Core 2.x csproj 项目中可靠地生成 C# 代码？

Reliably generating C# code in .NET Core 2.x csproj project?

c#

.net-core

code-generation

csproj

描述

设置

症状

请求帮助