首页 > 代码库 > 使用 NuGet 管理我们的程序集 - 预发行版

使用 NuGet 管理我们的程序集 - 预发行版

2024-07-29 20:53:56   224人阅读

1、缘起

在我们的项目中，需要引用的组件统一放在一个 Libs 目录下。无论对于平台上的公共组件，还是应用模块，都是如此。

如果一个应用模块，例如能源管理（EM），要引用平台提供的公共组件，例如数据库访问（Platform.PL），那么不但要把Platform.PL程序集拷贝到EM的Libs目录下，也要把Platform.PL所引用的程序集，也就是Platform.PL的Libs目录下的文件，拷贝到EM的Libs目录下。

随着平台上应用模块的增多，Platform.PL被引用得也越来越多。我们是怎么把Platform.PL自身及其Libs下的程序集给到这些应用模块的呢？是通过手工拷贝的方式。

那么问题来了——Platform.PL升级了怎么办？答案是，只能一一手工拷贝了。

这种做法很老土，而且因为手工拷贝，容易出错。最好是把共用组件放到服务器上，应用模块引用或升级时就去服务器上下载或更新。实际上，业界已经这么做很久了，就是用 NuGet 获取程序集。只是这些程序集一般情况下都是公开的，例如 NHibernate、Spring.Net等等。我们可以使用 NuGet 的机制，并且把共用的程序集放到内部的服务器上。

因此，这里介绍的，不是怎么用 NuGet 来管理一个解决方案所使用的程序集，而是怎么把我们自己开发的公共组件放到内部的服务器上，让其他模块下载、更新。

顺带说一下开发环境，当然是 .NET 了，Visual Studio的版本是 2012。这个版本已经缺省安装了 NuGet 包管理器。

2、准备待发布的程序集

开发好公共组件后，要将其发布到 NuGet 服务器上，需要做些准备工作。

0. 下载 NuGet.exe。地址在这里。这是一个控制台程序，以后要在命令行下面运行。下载后，将其放到一个合适的位置，并用path指向这个位置。当然，这个文件只需要下载一次。

1. 创建清单文件。打开命令行程序，进入公共组件所在项目的文件夹，运行 nuget spec。就像下面这样：

这样就会创建一个文件：Platform.PL.nuspec。打开这个文件，会看到是这个样子的：

<?xml version="1.0"?>
<package >
  <metadata>
    <id>$id$</id>
    <version>$version$</version>
    <title>$title$</title>
    <authors>$author$</authors>
    <owners>$author$</owners>
    <licenseUrl>http://LICENSE_URL_HERE_OR_DELETE_THIS_LINE</licenseUrl>
    <projectUrl>http://PROJECT_URL_HERE_OR_DELETE_THIS_LINE</projectUrl>
    <iconUrl>http://ICON_URL_HERE_OR_DELETE_THIS_LINE</iconUrl>
    <requireLicenseAcceptance>false</requireLicenseAcceptance>
    <description>$description$</description>
    <releaseNotes>Summary of changes made in this release of the package.</releaseNotes>
    <copyright>Copyright 2014</copyright>
    <tags>Tag1 Tag2</tags>
  </metadata>
</package>

其中有些内容是不需要的，可以删除它。licenseUrl，projectUrl，iconUrl，都可以删掉，反正它提示我们删掉。releaseNotes和tags一定要修改，否则下一步会出现警告。

例如，我把这个文件修改成这样：

<?xml version="1.0"?>
<package >
  <metadata>
    <id>$id$</id>
    <version>$version$</version>
    <title>$title$</title>
    <authors>$author$</authors>
    <owners>$author$</owners>
    <requireLicenseAcceptance>false</requireLicenseAcceptance>
    <description>$description$</description>
    <releaseNotes>MES平台数据库访问组件首次发布到NuGet服务器上</releaseNotes>
    <copyright>Copyright 2014</copyright>
    <tags>MES平台 数据库访问</tags>
  </metadata>
</package>

2.打包。在上面的命令行界面下，运行 nuget pack，像下面这样：

这样就会创建一个文件 Platform.PL.xyz.nupkg。这就是我们将要发布到NuGet服务器上的包。

有一种情况值得一提：因为某种原因，我们不得不使用spring.net的预发行版(pre-release)。好奇么？这个原因就是，spring.net在并发环节使用了Dictionary，而这个类不是线程安全的，导致在运行时出现问题。spring.net在预发行版 2.0.0-RC1解决了这一问题，但还没有出稳定(Stable)版，所以我们就使用这个预发行版了。nuget有一项规定：如果使用了非稳定版的程序集，所发布的程序集就不能是稳定版本。否则，打包是就会出现这样的错误：

为此，需要将我们要发布的包设置为测试版或预发行版，做法是手工编辑所在项目的 Properties/AssemblyInfo.cs 文件：

其中的36行就是我们加进去的。

3、将程序集发布到内部服务器上

经过上一步，我们生成了要发布的包：Platform.PL.3.1.0-alpha.nupkg。这个包可以发布到公共的NuGet服务器上，供所有人下载。但现在我们不想这么做，我们只是发布到内部服务器上，仅供项目组内部使用。

要做到这一点，我们首先要创建一个网站，用常规的方法创建IIS网站，可以给这个网站起名为 NuGetServer。

其次，我们要创建一个Web应用。利用VS，创建一个 ASP.NET空Web应用程序。可以给这个项目起名为 NuGetServer。

再次，在这个应用程序中，用 NuGet 添加 NuGet.Server 包引用：

引用了NuGet.Server包以后，会自动加入很多它引用的包。

再再次，将我们刚创建的 Platform.PL.3.1.0-alpha.nupck 文件，加入到这个Web项目的packages文件夹中：

最后，将这个应用发布到网站 NuGetServer 中就可以了。

发布成功后，打开这个网站，可以看到类似这样的内容：

4、引用程序集

将程序集在内部NuGet服务器上发布成功后，就可以将其引用到应用模块中了。在应用模块引用之前，还需要做一件准备工作：将服务器添加到NuGet配置中。

在VS 2012中，点击菜单 工具 --> NuGet程序包管理器 --> 管理解决方案的NuGet程序包，在弹出的对话框中，点击左下角的“设置”按钮，会弹出“选项”对话框，点击右上角的大加号，可以添加“可用程序包源”，将上面ie提示的地址，如http://localhost:8010/nuget，添加上去就可以了。可以起名字为mes：

至此，就可以像从公共NuGet服务器上下载程序集一样，从内部的NuGet服务器上下载我们自己的程序集了。

5、其它

这个帖子的标题带有“预发行版”，表示这个做法刚实验通过。真正用起来，应该会面临诸多意想不到的问题。即便如此，也推荐使用。

建议我们的项目组：

1、摈弃用Libs管理所引用的程序集，转用 NuGet 下载程序集的方式；

2、MES平台搭建统一的 NuGet 服务器；

3、公共组件统一发布到 NuGet 服务器上，并参考语义化版本的方式设置版本号。



使用 NuGet 管理我们的程序集 - 预发行版


联系
我们