如何在Visual Studio代码中包含多个项目之间的共享类 将 Directory.Build.props 添加到解决方案文件夹即两个项目的父文件夹:将 Directory.Build.targets 添加到解决方案文件夹即两个项目的父文件夹:

问题描述

我试图在2个项目之间包括一个共享类,但是我似乎无法找出如何将它们添加到Visual Studio代码项目中,因此可以使用它们。我希望这张图片有助于解释我要问的问题

How the folder structure would look

解决方法

我不确定为什么要在项目之间共享源代码而不是最终的编译程序集,但是给出了这种目录结构。 ..

  • ProjectA\
    • ProjectA.csproj
    • Program.cs
  • ProjectB\
    • ProjectB.csproj
    • Program.cs
  • Shared\
    • Shared.cs

...我能够使用这样的共享代码文件(Shared\Shared.cs)...

namespace Shared
{
    internal static class Example
    {
        internal static void SayHello()
        {
            string assemblyName = System.Reflection.Assembly.GetExecutingAssembly().GetName().Name;

            System.Console.WriteLine($"Hello,World!  This is {assemblyName}.");
        }
    }
}

...从这样的控制台应用程序代码文件(ProjectA\Program.csProjectB\Program.cs)...

namespace ProjectA // or ProjectB
{
    class Program
    {
        static void Main()
        {
            Shared.Example.SayHello();
        }
    }
}

...通过将这样的默认控制台应用程序项目文件(ProjectA\ProjectA.csprojProjectB\ProjectB.csproj)修改为.cs目录中的所有Shared\文件include ...

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>netcoreapp3.1</TargetFramework>
  </PropertyGroup>

  <ItemGroup>
    <Compile Include="..\Shared\*.cs" />
  </ItemGroup>
</Project>

...从基本目录运行时产生这些结果...

PS> dotnet run --project ProjectA
Hello,World!  This is ProjectA.
PS> dotnet run --project ProjectB
Hello,World!  This is ProjectB.

有趣的是,我像这样跑dotnet msbuild command ...

dotnet msbuild ProjectA -preprocess:fullproject.xml

...生成一个文件,显示MSBuild将使用的幕后定义,并且其中包含一条注释,描述了相同的层次结构,甚至包括我使用的相同样本名称。

<!-- WARNING: This pattern is there to ignore folders such as .git and .vs,but it will also match items included with a
      relative path outside the project folder (for example "..\Shared\Shared.cs").  So be sure only to apply it to items
      that are in the project folder. -->
<DefaultExcludesInProjectFolder>$(DefaultItemExcludesInProjectFolder);**/.*/**</DefaultExcludesInProjectFolder>

也许不是一个好的解决方案,但是另一个解决方案是使用symlinks / hardlinks / junctions在每个项目中直接包含共享代码文件/目录像这样...

  • ProjectA\
    • ProjectA.csproj
    • Program.cs
    • Shared.cs..\Shared\Shared.cs
  • ProjectB\
    • ProjectB.csproj
    • Program.cs
    • Shared.cs..\Shared\Shared.cs
  • Shared\
    • Shared.cs

...或者这个...

  • ProjectA\
    • ProjectA.csproj
    • Program.cs
    • Shared\..\Shared\
      • Shared.cs
  • ProjectB\
    • ProjectB.csproj
    • Program.cs
    • Shared\..\Shared\
      • Shared.cs
  • Shared\
    • Shared.cs

...虽然我可以看到这会导致源代码管理引起一些麻烦。

在以上所有示例中,我都使用了方便的基本目录和相对路径,但是没有必要,如果需要的话,您不能使用绝对路径。

,

像平常一样创建 ProjectA ProjectB 。然后创建一个共享项目,说 CommonProject 。一旦将共享项目引用到ProjectA和ProjectB中,您就应该能够访问所有引用项目中的所有共享类。您还可以在类中包括条件编译符号,以适合每个项目的类定义。

,

我认为,首先您应该创建一个.NET标准类库项目,并像这样引用它: Reference image

,

对于 .NET Core 和 SDK 风格的项目

将 Directory.Build.props 添加到解决方案文件夹(即两个项目的父文件夹):

<Project>  
    <PropertyGroup>
        <CoreCompileDependsOn>InitGlobal;$(CoreCompileDependsOn)</CoreCompileDependsOn>
    </PropertyGroup>
</Project>

将 Directory.Build.targets 添加到解决方案文件夹(即两个项目的父文件夹):

<Project>  
    <Target Name="InitGlobal" >
        <ItemGroup>
            <Compile Include="$(MSBuildThisFileDirectory)\Global\*.cs" />
        </ItemGroup>
    </Target>
</Project>

终于

将共享/公共类文件添加到 \Global 文件夹(相对于上面的 Directory.Build.* 文件)。小心使用的任何依赖项都包含在每个项目中,或者您在 Directory.Build.props 中添加依赖项。

注意 - 全局文件将包含在 Build 和 IntelliSense 中,但在解决方案中不可见。您可以通过从 .targets 中删除元素并将其放入 .props 文件中,使它们显示为链接类

相关问答

依赖报错 idea导入项目后依赖报错,解决方案:https://blog....
错误1:代码生成器依赖和mybatis依赖冲突 启动项目时报错如下...
错误1:gradle项目控制台输出为乱码 # 解决方案:https://bl...
错误还原:在查询的过程中,传入的workType为0时,该条件不起...
报错如下,gcc版本太低 ^ server.c:5346:31: 错误:‘struct...