保证相同版本的nuget包

时间:2015-06-16 12:30:48

标签: c# visual-studio-2013 nuget nuget-package nuget-spec

我们有一个框架,在一个解决方案中分成许多单独的项目。我现在想为每个单独的项目创建 NuGet 包,但是保证只能在一个解决方案中使用一个版本的框架(可能跨多个项目)。

例如,假设框架由两个项目组成:

Framework
   Framework_1
   Framework_2

现在使用此框架时,一个项目可能引用Framework_1,而另一个项目引用Framework_2。我想确保两个软件包具有相同的版本(如果有一个简单的单步过程升级到新版本,则可获得奖励积分)

我想我会定义一个解决方案级别的Framework包,所有其他包都严格依赖。问题是 NuGet 只需安装多个版本的解决方案级别包就没有问题。

基本上我尝试了以下内容:

解决方案级 nuspec 文件:

<?xml version="1.0"?>
<package xmlns="http://schemas.microsoft.com/packaging/2011/08/nuspec.xsd">
  <metadata>
    <id>My.Framework</id>
    <version>1.0.0</version>
    <title>My.Framework</title>
    <authors>voo</authors>
    <owners>voo</owners>
    <requireLicenseAcceptance>false</requireLicenseAcceptance>
    <description>Some Framework Solution Package</description>
    <copyright>Copyright ©  2015</copyright>
  </metadata>
</package>

一个部分的 nuspec 包:

<?xml version="1.0"?>
<package xmlns="http://schemas.microsoft.com/packaging/2011/08/nuspec.xsd">
  <metadata>
    <id>My.Framework.BL</id>
    <version>1.0.0</version>
    <title>My.Framework.BL</title>
    <authors>voo</authors>
    <owners>voo</owners>
    <requireLicenseAcceptance>false</requireLicenseAcceptance>
    <description>Business Layer</description>
    <copyright>Copyright ©  2015</copyright>
    <dependencies> 
        <dependency id="My.Framework" version="[1.0.0]"/>
    </dependencies>
  </metadata>
</package>

现在的问题是,如果我尝试安装,请说另一个版本为My.Framework.EF的{​​{1}}包,并明确依赖1.0.1 1.0.1 My.Framework只会安装{ {1}}两次 - 一次使用版本1.0.0,一次使用1.0.1。

4 个答案:

答案 0 :(得分:5)

您可以使用packages.config中的以下语法限制软件包的版本,如:

<package id="jQuery" version="1.9.1" allowedVersions="[1.9.1]" />

同样来自原始的nuget文档: 创建NuGet包时,可以在.nuspec文件中指定包的依赖关系。

<dependency id="ExamplePackage" version="[1,3)" />

在示例中,版本1和版本2.9是可接受的,但不是0.9或3.0。

我认为您可以通过这种方式将其限制为单个版本或特定版本。 Here您可以阅读更多相关信息。

答案 1 :(得分:1)

您可以在解决方案中创建一个简单的单元测试,以便在出现问题时发出警告。代码如下。

您需要在单元测试项目中install-package NuGet.Core才能使以下代码生效。

using System;
using System.Diagnostics;
using System.IO;
using System.Linq;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using NuGet;

[TestClass]
public class NugetPackagesTest
{
    /// <summary>
    /// This test method makes sure that we do not install different versions of the same nuget package
    /// across the solution. For example this test will fail if one project references EntityFramework
    /// version 6.1.3 and another project references version 6.2.0. Having different versions of the same
    /// package installed often results in unexpected and hard-to-understand errors.
    /// </summary>
    [TestMethod]
    public void PackagesAccrossProjectsAreOfSameVersion()
    {
        var dir = GetSolutionRoot();

        Debug.Assert(dir != null, nameof(dir) + " != null");

        var filePaths = Directory.GetFiles(dir.FullName, "*packages.config", SearchOption.AllDirectories);
        var installedPackages = filePaths
            .Select(t => new PackageReferenceFile(t))
            .SelectMany(t => t.GetPackageReferences().Select(x => new { File = t, Package = x }))
            .GroupBy(t => t.Package.Id)
            .ToList();

        foreach (var package in installedPackages)
        {
            var versions = package
                .Select(t => t.Package.Version.ToNormalizedString())
                .Distinct()
                .ToList();

            var report = package
                .Select(t => $"{t.Package.Version} @ {t.File.FullPath}")
                .OrderBy(t => t);

            Assert.IsTrue(
                versions.Count == 1,
                $"Multiple versions of package {package.Key} are installed: {string.Join(", ", versions)}.\n" +
                $"{string.Join("\n", report)}");
        }
    }

    private static DirectoryInfo GetSolutionRoot()
    {
        var current = AppDomain.CurrentDomain.BaseDirectory;
        var dir = Directory.GetParent(current);

        while (dir != null)
        {
            // TODO: replace with name your solution's folder.
            if (dir.Name == "MySolution")
            {
                dir = dir.Parent;
                break;
            }

            dir = dir.Parent;
        }

        return dir;
    }
}

答案 2 :(得分:0)

我会删除“解决方案级NuGet包”,并将您的框架划分为组件,并为每个组件创建一个NuGet包。没有人会有一个单独的项目引用你的“Framework Wrapper”NuGet包,以及单个项目中的业务逻辑,数据访问和WCF的代码。

然后你需要做的是,弄清楚你的依赖逻辑究竟是什么,以及想要严格执行同一版本策略背后的原因是什么。

例如,假设My.Framework.BL依赖于My.Framework.DAL。所以此时你只有2个Nuspec文件和2个NuGet包,你的My.Framework.BL的.nuspec看起来像这样:

<dependencies>
  <dependency id="My.Framework.DAL" version="1.0.0" />
</dependencies>

并且您的My.Framework.DAL不包含My.Framework特定的依赖项。

这很好,并且由于某些原因,您希望紧密耦合与版本相关联的数字的解决方案存在问题。第一个也是最重要的是,如果你在更改了0时更新了My.Framework.DAL,它会让你的框架消费者感到困惑,但你必须更新它,因为你改变了My.Framework.BL。

你可以花一个月或更多时间,而不必更新My.Framework依赖项,具体取决于框架的抽象级别,以及你正在做什么程度的低级编程。在我看来,当没有实际任何新的更改时,必须更新Core Framework DLL版本是一个比所有My.Framework dll版本号相同的问题。干杯。 :)

Here是nuspec参考文档。

答案 3 :(得分:0)

事实证明,您可以在 Install.ps1中调用Install-Package $package.Id -version <someVersion> ,这将导致卸载最初安装的版本并安装指定的版本。

稍微简化的版本如下:

param($installPath, $toolsPath, $package, $project)

function GetInstallingVersion() {
    $package.Version
}

# Gets the current version of the used framework. 
# If no framework is yet installed, we set the framework version 
# to the one that's being installed right now.
function GetCurrentFrameworkVersion() {
    $solutionPath = Split-Path $dte.Solution.FileName
    $fwkVersionFile = "${solutionPath}\framework_version.txt"
    if (Test-Path $fwkVersionFile) {
        return Get-Content $fwkVersionFile
    } 
    else {
        $installingVersion = GetInstallingVersion
        $installingVersion > $fwkVersionFile
        return $installingVersion
    }
}

$currentFwkVersion = GetCurrentFrameworkVersion
$installingVersion = GetInstallingVersion

if ($currentFwkVersion -ne $installingVersion) {
    Install-Package $package.Id -version $currentFwkVersion
}