我们有几个项目使用共享的公共(public)库(内部的，非公共(public)的)。 (C#.net 项目，使用 Visual Studio，setup 作为解决方案)
Solution A ---|
|----> Common Library (Nuget Package)
Solution B ---|
问题是当我们想要对公共(public)库进行更改时。似乎测试更改的唯一方法是重建公共(public)库，将更新的包发布到提要，升级项目 A 中的包(因为解决方案中有很多项目需要一段时间)，然后进行测试。这个循环需要很长时间。
理想情况下，我正在寻找一种方法，能够将公共(public)库项目包含在与项目 A(或 B)相同的解决方案中，并对库进行更改，然后将所有代码作为一个解决方案运行和调试。但这样做需要很长时间。它需要遍历项目 A 中的所有 csproj 文件，并将所有引用更改为项目引用，而不是包引用。我已经尝试在 csproj 文件中使用条件，以便在使用本地项目和使用 nuget 包进行构建之间轻松切换，但似乎没有效果。 Visual Studio 似乎对引用感到困惑，并且构建失败。
有没有其他选择？我觉得这应该是一个相当普遍的情况，所以是否有一种可接受的典型设置方式，这样既可以将 nuget 包用于公共(public)库，也可以将它们连接在一起并轻松调试。
为了回应@vernou，这是我们尝试在 csproj 文件中使用条件属性设置的内容。我们设置了一个配置类型来控制使用哪个引用。
<ItemGroup Condition=" '$(Configuration)' == 'DebugWithLocalCommon' ">
<ProjectReference Include="$(CommonPath)Common.Project.Name\Common.Project.Name.csproj">
<Project>{11111111-1111-1111-1111-111111111111}</Project>
<Name>Common.Project.Name</Name>
</ProjectReference>
...
Multiple project references continue here
...
</ItemGroup>
<ItemGroup Condition=" '$(Configuration)' != 'DebugWithLocalCommon' ">
<Reference Include="Common.Project.Name, Version=4.0.26.0, Culture=neutral, PublicKeyToken=1111111111111111, processorArchitecture=MSIL">
<HintPath>..\packages\Common.Project.Name.4.0.26\lib\netstandard2.0\Common.Project.Name.dll</HintPath>
</Reference>
...
Multiple package references continue here
...
</ItemGroup>
<ItemGroup Condition=" '$(Configuration)' != 'DebugWithLocalCommon' ">
<PackageReference Include="Common.Project.Name">
<Version>4.0.26</Version>
</PackageReference>
...
Multiple package references continue here
...
</ItemGroup>
我们也在 csproj 中尝试了相同的使用，但结果行为完全相同。
最佳答案
这是一个挑战，解决方案相当复杂。它还取决于您的源代码控制和开发环境的设置方式。但是有一个我可以解释的潜在解决方案。
简而言之，您需要一个自定义工具，它可以只是一个命令行 exe 项目，它将更新 csproj 文件中的引用，而无需进行所有手动更改。
开发环境设置:
您会发现，作为个人的开发人员可能都将源代码克隆到他们机器上的不同位置。所以每个人的代码都在不同的地方。只要每个人在主文件夹中都有相同的结构，这样就可以使用相对位置添加引用，这是可以的。
EG，如果每个人都使用:
C:\Source\Common
C:\Source\App1\
或者:
C:\代码\通用
C:\代码\App1\
这很好，但是如果 Common 文件夹在某人的机器上被称为“cmn”，这对他们来说将是一个问题。
所以现在，在 VS 中，您可以使用相对位置 EG 在 App1 中对您的 Common 项目进行项目引用:
..\Common\Common.csproj
项目类型问题:
您需要考虑您拥有的项目类型。例如，如果您在 Visual Studio 中创建一个新项目并使用 .Net Framework 4.xx，您将拥有现在称为“旧”项目类型的内容。如果您使用 .Net Standard 或 .Net Core 创建，您将获得新的项目类型(这对于执行所有这些 nuget 内容来说要好得多)。
旧项目类型在每个项目的 packages.config 中引用了所有 nuget 包。它还引用了实际项目，包括 csproj 中的确切路径和版本。这就是使过程更加繁琐的原因。
新的项目类型只引用了 csproj 文件中的 nuget 包( super 骗子)。
但是如果您仍然拥有旧的项目类型并不重要，自定义工具仍然可以处理此问题。
工具:
这只是基础知识，所以不是完整的解决方案，但希望您能从中获得足够的信息来实现。
确保您在副本上进行测试，或者首先启动一个新分支以确保没有永久损坏。这仅适用于我假设您正在使用的旧式项目。
创建一个新的 Console Application 项目并添加一些用于处理文件的基本类:
包配置文件
[Serializable]
[DesignerCategory("code")]
[XmlType(AnonymousType = true, IncludeInSchema = true)]
[XmlRoot(ElementName = "packages", IsNullable = false)]
public class PackageConfig
{
[XmlElement("package")]
public Package[] Packages { get; set; }
}
[Serializable]
[DesignerCategory("code")]
public class Package
{
[XmlAttribute("id")]
public string Id { get; set; }
[XmlAttribute("version")]
public string Version { get; set; }
[XmlAttribute("targetFramework")]
public string TargetFramework { get; set; }
}
class XmlSerializer
{
private System.Xml.Serialization.XmlSerializer GetSerializer<T>()
{
return new System.Xml.Serialization.XmlSerializer(typeof(T));
}
public string Serialize<T>(T instance, bool omitXmlDeclaration = false)
{
System.Xml.Serialization.XmlSerializer xmlSerializer = GetSerializer<T>();
StringBuilder stringBuilder = new StringBuilder();
XmlWriterSettings settings = new XmlWriterSettings
{
OmitXmlDeclaration = omitXmlDeclaration,
Encoding = Encoding.UTF8
};
using (XmlWriter writer = XmlWriter.Create(new StringWriter(stringBuilder), settings))
{
xmlSerializer.Serialize(writer, instance);
}
return stringBuilder.ToString();
}
public T Deserialize<T>(string xml)
{
System.Xml.Serialization.XmlSerializer xmlSerializer = GetSerializer<T>();
using (XmlTextReader reader = new XmlTextReader(new StringReader(xml)))
return (T)xmlSerializer.Deserialize(reader);
}
}
class Program
{
static void Main(string[] args)
{
try
{
string packageVersion = null;
if (args != null && args.length == 1)
packageVersion = args[0];
UpdateProjects(packageVersion);
}
catch (Exception ex)
{
Console.Error.WriteLine(ex.ToString());
}
}
const string _packageId = "Common";
delegate string UpdateContent(string content);
static void UpdateProjects(string packageVersion)
{
if (packageVersion == null)
UseLocalReferences();
else
UsePackageReferences(packageVersion);
}
static void UseLocalReferences()
{
RemoveNugetPackage();
ProcessProjects(content =>
{
content = RemoveReference(content);
content = AddReference(content, null);
return content;
});
}
static void UsePackageReferences(string packageVersion)
{
AddNugetPackage(packageVersion);
ProcessProjects(content =>
{
content = RemoveReference(content);
content = AddReference(content, packageVersion);
return content;
});
}
static void ProcessProjects(UpdateContent update)
{
string folder = Environment.CurrentDirectory;
string[] files = Directory.GetFiles(folder, "*.csproj", SearchOption.AllDirectories);
foreach (string fileName in files)
{
try
{
string content = File.ReadAllText(fileName);
content = update(content);
using (StreamWriter writer = new StreamWriter(fileName))
{
writer.Write(content);
}
Console.WriteLine("Updated: " + fileName);
}
catch (Exception ex)
{
Console.Error.WriteLine($"Error updating {fileName}:");
Console.Error.WriteLine(ex.ToString());
}
}
}
static void RemoveNugetPackage()
{
string folder = Environment.CurrentDirectory;
Console.WriteLine($"Updating all packages.config files under {folder}");
XmlSerializer xmlSerializer = new XmlSerializer();
string[] packageConfigFiles = Directory.GetFiles(folder, "packages.config", SearchOption.AllDirectories);
foreach (string packageConfigFile in packageConfigFiles)
{
PackageConfig packageConfig = xmlSerializer.Deserialize<PackageConfig>(File.ReadAllText(packageConfigFile));
List<Package> packages = new List<Package>(packageConfig.Packages);
if (packages.Any(x => x.Id == _packageId))
packages.First(x => x.Id == _packageId).Version = packageVersion;
else
packages.Add(new Package { Id = _packageId, Version = packageVersion, TargetFramework = "net462" }); // may need to change the framework here
packages.Sort((x, y) => string.Compare(x.Id, y.Id));
packageConfig.Packages = packages.ToArray();
File.WriteAllText(packageConfigFile, xmlSerializer.Serialize(packageConfig));
Console.WriteLine($"{packageConfigFile} updated");
}
Console.WriteLine("Update of packages.config files complete");
}
static void AddNugetPackage(string packageVersion)
{
string folder = Environment.CurrentDirectory;
Console.WriteLine($"Updating all packages.config files under {folder}");
XmlSerializer xmlSerializer = new XmlSerializer();
string[] packageConfigFiles = Directory.GetFiles(folder, "packages.config", SearchOption.AllDirectories);
foreach (string packageConfigFile in packageConfigFiles)
{
PackageConfig packageConfig = xmlSerializer.Deserialize<PackageConfig>(File.ReadAllText(packageConfigFile));
List<Package> packages = new List<Package>(packageConfig.Packages);
Package package = packages.FirstOrDefault(x => x.Id == _packageId);
if (package != null)
packages.Remove(package);
packageConfig.Packages = packages.ToArray();
File.WriteAllText(packageConfigFile, xmlSerializer.Serialize(packageConfig));
Console.WriteLine($"{packageConfigFile} updated");
}
Console.WriteLine("Update of packages.config files complete");
}
static string RemoveReference(string content)
{
string[] lines = content.Split(new string[] { "\r\n" }, StringSplitOptions.None);
StringBuilder sb = new StringBuilder();
bool removing = false;
foreach (string line in lines)
{
if (!removing && line.Trim().StartsWith($"<Reference Include=\"{_packageId}\""))
removing = true;
else if (removing)
{
if (line.Trim() == "</Reference>")
removing = false;
}
else
sb.AppendLine(line);
}
return sb.ToString();
}
static string AddReference(string content, string packageVersion)
{
string[] lines = content.Split(new string[] { "\r\n" }, StringSplitOptions.None);
StringBuilder sb = new StringBuilder();
foreach (string line in lines)
{
if (line.Trim() == "<Reference Include=\"System\" />") // find where the references need to be inserted
{
if (packageVersion == null)
{
sb.AppendLine($" <Reference Include=\"{_packageId}\">");
sb.AppendLine($" <SpecificVersion>False</SpecificVersion>");
sb.AppendLine($" <HintPath>..\\Common\\bin\\$(Configuration)\\{_packageId}.dll</HintPath>");
sb.AppendLine($" </Reference>");
}
else
{
sb.AppendLine($" <Reference Include=\"{_packageId}, Version = {packageVersion}, Culture = neutral, processorArchitecture = MSIL\">");
sb.AppendLine($" <HintPath>..\\packages\\{_packageId}.{packageVersion}\\lib\\net462\\{_packageId}.dll</HintPath>"); // again, framework may need updating
sb.AppendLine($" </Reference>");
}
}
sb.AppendLine(line);
}
return sb.ToString();
}
}
编译该工具时，将 exe 复制到您的主项目文件夹 EG C:\Source\App1 - 然后您可以使用以下命令运行它:
updatetool
(to set the local references)
updatetool 1.0.1
(to set to the nuget package and references)
关于c# - 如何使用本地构建的 nuget 包进行调试？，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/69027489/