当前位置: 首页 > news >正文

自动将 NuGet 包的引用方式从 packages.config 升级为 PackageReference

在前段时间我写了一篇迁移 csproj 格式的博客 将 WPF、UWP 以及其他各种类型的旧样式的 csproj 文件迁移成新样式的 csproj 文件,不过全过程是手工进行的,而且到最后处理 XAML 问题也非常头疼。

现在,我们可以利用工具自动地完成这个过程。当然,工具并不将 csproj 格式进行迁移,而是在不迁移格式的情况下,使用到 PackageReference 方式 NuGet 引用带来的好处。


自动升级

下载安装 Visual Studio 插件 NuGet PackageReference Upgrader。在安装完成之后,再次启动 Visual Studio,则可以开始迁移。

只有一个步骤:在 packages.config 文件上点击右键,选择 Upgrade to PackageReference

Upgrade to PackageReference

紧接着,稍微等待一下,即可完成一个项目的迁移。如果有多个项目,则每个项目都这么操作即可。

相比于之前写的手工迁移,自动迁移方式没有改变 csproj 的格式,而只是将 NuGet 的引用方式改成了 PackageReference。具体有哪些好处,可以阅读 将 WPF、UWP 以及其他各种类型的旧样式的 csproj 文件迁移成新样式的 csproj 文件。

检查升级后的兼容性问题

packages.config 的 NuGet 包的管理方式有些功能是 PackageReference 没有的。当然,没有这些功能是因为“不需要”,而不是“还没支持”;所以大部分的迁移都不会发生问题(除非发布包使用的是特别老旧的 nuget.exe,或者发布者利用了一些丧心病狂的黑科技)。

install.ps1 脚本将失效

使用 PackageReference 后,在安装和写在的过程中 install.ps1 脚本将不再执行。如果有一些行为依赖于此脚本,那么这个 NuGet 包的行为可能不正常。

但是,不用担心!install.ps1 的存在是因为 packages.config 不支持 PackageReference 中的一些新特性(例如 NuGet 包中新的目录结构,例如包中自带的 msbuild targets)。所以,如果 NuGet 包在发布时满足目录要求,那么即便 install.ps1 不用执行也能保证包的行为正常。

使用 content 方式指定的内容资产将失效

PackageReference 使用 contentFiles 来管理内容资产,这样可以更好地在多个依赖包之间传递和共享。而此前 content 指定的资产将失效。

建议检查所有依赖的 NuGet 包,如果你有权限修改部分依赖包,那么请使用 contentFiles 来替代 content

XDT 变换将失效

使用 PackageReference 后,在安装和写在的过程中 XDT 转换将不会执行,并且会忽略 .xdt 文件。

在 Web 应用开发中会更留意这个问题。

lib 根目录中的程序集将被忽略

lib 文件夹内的程序集都应该按照目标框架建立子文件夹,例如 net45、netstandard2.0、netcoreapp2.0。PackageReference 要求只能引用在某个目标框架下的程序集。

如果是使用默认的方式创建的 NuGet 包,基本上不会遇到这样的问题。除非你在创建 NuGet 包时有自定义操作在根目录放了程序集。

解决升级后的编译错误

最可能出现的编译问题是 NuGet 包引用的版本冲突。

packages.config 方式的包引用要求在 csproj 文件中显式指定一个依赖的包的版本,于是无论依赖使用了哪个版本,最终都由显式指定的版本来指定。

PackageReference 的引用方式是自动管理依赖版本的,只要每个包都在允许的版本范围之内,就自动选择版本,并显示在解决方案的引用中。

PackageReference 出现依赖冲突的提示通常是这样的:

Version conflict detected for NuGet.Versioning. Reference the package directly from the project to resolve this issue.
NuGet.Packaging 3.5.0 -> NuGet.Versioning (= 3.5.0)
NuGet.Configuration 4.0.0 -> NuGet.Versioning (= 4.0.0)

也就是说,引用的两个不同的包要求依赖相同包的不同版本,于是 PackageReference 无法隐式推断依赖包的版本。这时需要将项目的依赖方式改为之前的方式。

当然,在制作和发布 NuGet 包时,尽量使用非特定版本的依赖包,能够极大地避免这种问题带来的影响。关于如何指定非特定版本的依赖包,可以阅读 Version ranges and wildcards 版本范围和通配符。


参考资料

  • Migrating from package.config to PackageReference formats - Microsoft Docs
  • packages.config (PC) to PackageReference (PR) Migrator · NuGet/Home Wiki

相关文章:

  • 冷算法:自动生成代码标识符(类名、方法名、变量名)
  • WPF/UWP 的 Grid 布局竟然有 Bug,还不止一个!了解 Grid 中那些未定义的布局规则
  • Git 更安全的强制推送,--force-with-lease
  • 项目文件中的已知 NuGet 属性(使用这些属性,创建 NuGet 包就可以不需要 nuspec 文件啦)
  • 理解 C# 项目 csproj 文件格式的本质和编译流程
  • 如何创建一个基于命令行工具的跨平台的 NuGet 工具包
  • 如何创建一个基于 MSBuild Task 的跨平台的 NuGet 工具包
  • 如何最快速地将旧的 NuGet 包 (2.x, packages.config) 升级成新的 NuGet 包 (4.x, PackageReference)
  • 每次都要重新编译?太慢!让跨平台的 MSBuild/dotnet build 的 Target 支持差量编译
  • C# 中那些可以被重载的操作符,以及使用它们的那些丧心病狂的语法糖
  • 神器如 dnSpy,无需源码也能修改 .NET 程序
  • Roslyn 入门:使用 .NET Core 版本的 Roslyn 编译并执行跨平台的静态的源码
  • .NET Standard / dotnet-core / net472 —— .NET 究竟应该如何大小写?
  • 微软 Windows 系统检测网络连通性(用于显示感叹号)竟然是通过访问一个特殊网址来实现的
  • 如何根据一个绝对文件路径生成一个相对文件路径
  • 【108天】Java——《Head First Java》笔记(第1-4章)
  • 2018一半小结一波
  • axios请求、和返回数据拦截,统一请求报错提示_012
  • FineReport中如何实现自动滚屏效果
  • JAVA_NIO系列——Channel和Buffer详解
  • Joomla 2.x, 3.x useful code cheatsheet
  • js对象的深浅拷贝
  • Python3爬取英雄联盟英雄皮肤大图
  • Rancher如何对接Ceph-RBD块存储
  • SQL 难点解决:记录的引用
  • Vim Clutch | 面向脚踏板编程……
  • 包装类对象
  • 程序员该如何有效的找工作?
  • 动手做个聊天室,前端工程师百无聊赖的人生
  • 汉诺塔算法
  • 记录:CentOS7.2配置LNMP环境记录
  • 漫谈开发设计中的一些“原则”及“设计哲学”
  • 如何胜任知名企业的商业数据分析师?
  • 深入浅出webpack学习(1)--核心概念
  • 小试R空间处理新库sf
  • 一起参Ember.js讨论、问答社区。
  • UI设计初学者应该如何入门?
  • 数据可视化之下发图实践
  • 小白应该如何快速入门阿里云服务器,新手使用ECS的方法 ...
  • 新海诚画集[秒速5センチメートル:樱花抄·春]
  • 资深实践篇 | 基于Kubernetes 1.61的Kubernetes Scheduler 调度详解 ...
  • #传输# #传输数据判断#
  • $.ajax()
  • (33)STM32——485实验笔记
  • (超详细)2-YOLOV5改进-添加SimAM注意力机制
  • (附表设计)不是我吹!超级全面的权限系统设计方案面世了
  • (附源码)springboot学生选课系统 毕业设计 612555
  • (附源码)小程序儿童艺术培训机构教育管理小程序 毕业设计 201740
  • (蓝桥杯每日一题)love
  • (续)使用Django搭建一个完整的项目(Centos7+Nginx)
  • (一) springboot详细介绍
  • (正则)提取页面里的img标签
  • (转)利用ant在Mac 下自动化打包签名Android程序
  • (转)微软牛津计划介绍——屌爆了的自然数据处理解决方案(人脸/语音识别,计算机视觉与语言理解)...
  • .NET Core工程编译事件$(TargetDir)变量为空引发的思考