.NetFramework类库迁移到.NetCore过程记录

最新推荐文章于 2024-05-24 14:18:07 发布
最新推荐文章于 2024-05-24 14:18:07 发布
阅读量4.2k 收藏 9
点赞数
分类专栏： C# 文章标签： c#
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_38138153/article/details/110403824
版权

.NetFramework类库迁移到.NetCore过程记录

适用场景

场景描述

目前在.Net开发中.Net Core已经是大势所趋了，未来的.Net 5也被认为是下一代的.Net Core。.Net Framework作为一个曾经的老大哥确实正在逐渐步下神坛，但是从.Net Framework到.Net Core的转换依然需要一个过程。相信各位小伙伴在工作中必然遇到过需要在新的.Net Core项目中引用以前的.Net Framework类库的问题。如果类库只有几个文件的话还好，直接复制粘贴重新创建.Net Core类库也不复杂，但是如果类库结构比较复杂，而且旧项目和新项目要一齐引用它的话就可能需要将这个类库变成多目标框架类库。

多目标框架类库

目标框架

所谓的目标框架可以理解为不同的CLR，如.NetFramework和.NetCore就是不同的目标框架，此外还有Xamarin等。在Visual Studio中右键项目选择属性即可看到。
在这里插入图片描述

多目标框架类库

所谓多目标框架类库就是一个类库可以被不同目标框架的项目引用，看起来似乎有点不可思议，一个dll怎么可能被不同的目标框架引用呢？但实际上是可以的。
如果是以.NetStandard为目标框架的类库，那么它天生就可以被不同目标框架的的项目引用，至于为什么，可以参考以下文档。
.NetStandard概述
如果不是也可以采用多目标框架的形式被不同目标框架引用，也就是该类库生成的时候会根据指定好的多个目标框架生成多个不同的dll，当被引用时会自动根据启动项目的类型选择对应的dll引用。像我们在Nuget中看到的类库大部分都是多目标框架类库，例如下图的Newtonsoft.Json就支持那么多的目标框架。
在这里插入图片描述

场景假设

假设现在我们有一个.NetCore 3.1的项目需要引用一个.NetFramework4.5.2的类库，同时该类库还被许多旧项目引用。此时，我们可以有两种方案来解决这个问题。

  1. 将这个类库变成.NetStandard类库（一了百了，谁都能用）
  2. 将这个类库保留.NetFramework4.5.2的目标框架，添加其他目标框架，作为一个多目标框架类库。

显然这里第一种方案是最省事的，但是如果这么简单就没必要特地写这篇文章记录了。根据微软自己的文档，.NetFramework4.5.2只能使用.NetStandard1.2，而1.2版本里面很多方法都用不了，最坑的是，很多引用到Nuget包还不支持.NetStandard1.2。
在这里插入图片描述
例如Dapper这个很常用的第三方库。Dapper是从1.5.0开始支持.NetStandard的，但是最低版本也要求.NetStandard 1.3 。由于我们还有其他.NetFramework的老项目要用这个类库，所以不能将它直接改成.NetStandard。需要在保持.NetFramework 4.5.2目标框架的基础上添加.NetStandard 2.0的目标框架，将它变成多目标框架类库。

迁移步骤

首先说明，迁移的过程中全程几乎不需要改动任何代码，所有的改动都针对类库的csproj文件进行。

先决条件

迁移之前有一些条件需要满足。
1. 必须要清楚迁移的类库引用了什么第三方库及版本。
因为后续我们需要根据不同的目标框架调整类库的引用项及版本，所以这里必须清楚原类库引用了什么，这样才能保证原有的东西不被影响。
2. 保证类库依赖的第三方库(or dll)有对应的目标框架版本
例如上例中的类库引用了Dapper,Dapper是支持.NetFramework 4.5.2和.NetStandard 2.0的，但是如果类库中直接引用dll，而这颗dll只有一个目标框架(非.NetStandard)的版本，那就不能迁移了。
3. 最好将dll引用换成Nuget引用
一些老项目特别喜欢直接用文件路径引用dll，直接将目标框架绑死，这时候就需要先查一下有没有相同的Nuget可以引用，如果有，就去除该dll的引用，改成引用Nuget。

示例

下文我将以一个.NetFramework 4.5.2的类库为例子，将其改造成即支持.NetFramework 4.5.2也支持.NetStandard 2.0的多目标框架类库。
该类库一开始引用了以下的第三方库。

  • Dapper v1.60.6
  • Microsoft.Data.Sqlite v1.1.1

类库代码只有一个执行SQL语句的方法。

using System;
using Dapper;
using Microsoft.Data.Sqlite;

namespace MyLib
{
    public class MyClass
    {
        public string ConnStr { get; set; }

        public MyClass(string connStr)
        {
            this.ConnStr = connStr;
        }

        public int ExecSQL(string sql, object param)
        {
            int ret = 0;
            SqliteConnection conn = new SqliteConnection(ConnStr);
            try
            {
                ret = conn.Execute(sql, param);
            }
            catch (Exception)
            {
                throw;
            }
            finally
            {
                conn.Dispose();
            }
            return ret;
        }
    }
}

csproj文件转换

第一步需要将旧的csproj文件格式转成新的csproj格式。
转换之前建议把类库中引用的第三方Nuget和版本找个东西记下来。
旧格式
在这里插入图片描述
新格式
在这里插入图片描述
可以看到，旧格式里面不仅保存了项目引用还有各种杂七杂八的东西，非常不好阅读。新格式中几乎就只保存了项目的引用，看上去非常舒服。
当然这个转换肯定不可能由人来完成。这时需要用到一个叫try-convert的工具，是微软自家的，可以安心使用。
安装：
打开cmd输入以下指令安装，注意需要.NetCore的SDK。

dtonet tool install --global try-convert

使用也是非常简单，在cmd中进入到类库目录，即csproj所在文件夹。直接执行try-convert即可。

cd {类库文件夹}
try-convert

在这里插入图片描述
完成后将看到项目的csproj文件变成了新的格式，旧文件也替你备份成{类库名}.csproj.old。

处理引用

工具处理完之后就该我们处理了，由于工具默认是帮我们将类库转成.NetStandard 2.0的版本，所以我们还要手动将它调回.NetFramework 4.5.2的版本。因为我们首先要保证原本引用这个类库的项目还能继续引用，然后再考虑增加新的目标框架被新项目引用。

保证原目标框架可使用

还记得前文提到的先决条件中的第一条吗？必须要清楚原类库引用的第三方库和版本。 这里就需要我们将这些类库保留，同时去除不需要引用。
刚转换完成的csproj文件。

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <TargetFramework>netstandard2.0</TargetFramework>
    <OutputType>Library</OutputType>
    <GenerateAssemblyInfo>false</GenerateAssemblyInfo>
  </PropertyGroup>
  <ItemGroup>
    <Reference Include="System.IO.Compression" />
  </ItemGroup>
  <ItemGroup>
    <PackageReference Include="Microsoft.CSharp" Version="4.7.0" />
    <PackageReference Include="System.ComponentModel.Composition" Version="5.0.0" />
    <PackageReference Include="System.Data.DataSetExtensions" Version="4.5.0" />
  </ItemGroup>
  <ItemGroup>
    <PackageReference Include="Dapper" Version="1.60.6" />
    <PackageReference Include="Microsoft.Data.Sqlite" Version="1.1.1" />
    <PackageReference Include="Microsoft.NETCore.Platforms" Version="1.1.0" />
    <PackageReference Include="NETStandard.Library" Version="1.6.1" />
    <PackageReference Include="SQLite" Version="3.13.0" />
    <PackageReference Include="System.Collections" Version="4.3.0" />
    <PackageReference Include="System.Collections.Concurrent" Version="4.3.0" />
    <PackageReference Include="System.Diagnostics.Debug" Version="4.3.0" />
    <PackageReference Include="System.Diagnostics.Tools" Version="4.3.0" />
    <PackageReference Include="System.Diagnostics.Tracing" Version="4.3.0" />
    <PackageReference Include="System.Globalization" Version="4.3.0" />
    <PackageReference Include="System.IO" Version="4.3.0" />
    <PackageReference Include="System.IO.Compression" Version="4.3.0" />
    <PackageReference Include="System.Linq" Version="4.3.0" />
    <PackageReference Include="System.Linq.Expressions" Version="4.3.0" />
    <PackageReference Include="System.Net.Primitives" Version="4.3.0" />
    <PackageReference Include="System.ObjectModel" Version="4.3.0" />
    <PackageReference Include="System.Reflection" Version="4.3.0" />
    <PackageReference Include="System.Reflection.Extensions" Version="4.3.0" />
    <PackageReference Include="System.Reflection.Primitives" Version="4.3.0" />
    <PackageReference Include="System.Resources.ResourceManager" Version="4.3.0" />
    <PackageReference Include="System.Runtime" Version="4.3.0" />
    <PackageReference Include="System.Runtime.Extensions" Version="4.3.0" />
    <PackageReference Include="System.Runtime.InteropServices" Version="4.3.0" />
    <PackageReference Include="System.Runtime.InteropServices.RuntimeInformation" Version="4.3.0" />
    <PackageReference Include="System.Runtime.Numerics" Version="4.3.0" />
    <PackageReference Include="System.Text.Encoding" Version="4.3.0" />
    <PackageReference Include="System.Text.Encoding.Extensions" Version="4.3.0" />
    <PackageReference Include="System.Text.RegularExpressions" Version="4.3.0" />
    <PackageReference Include="System.Threading" Version="4.3.0" />
    <PackageReference Include="System.Threading.Tasks" Version="4.3.0" />
    <PackageReference Include="System.Threading.Timer" Version="4.3.0" />
    <PackageReference Include="System.Xml.ReaderWriter" Version="4.3.0" />
    <PackageReference Include="System.Xml.XDocument" Version="4.3.0" />
  </ItemGroup>
</Project>

首先，我们需要把目标框架改回net452，再把多余的引用去除。
何为多余的引用呢? System开头的，转换前没有引用的，全部去除。
至于为什么会产生这么多多余引用，是因为工具帮我们转换成了.NetStandard 2.0的类库但是类库中原本引用的第三方Nuget类库版本却不是支持.NetStandard 2.0的版本，所以它需要将旧的版本中引用到的东西全部引用回来。而现在我们需要改回.NetFramework 4.5.2，既然我们以前就没有引用过这些东西，现在自然也不用引用它们，所以大胆地删掉就好了。
将xml中的TargetFramework节由netstandard2.0改回net452, 把原先没有引用的包全部去掉。
因为我类库原先只引用了Dapper 和Microsoft.Data.Sqlite 所以处理完成之后的csproj文件变成这个样子。

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <TargetFramework>net452</TargetFramework>
    <OutputType>Library</OutputType>
    <GenerateAssemblyInfo>false</GenerateAssemblyInfo>
  </PropertyGroup>
  <!--保留net452的引用-->
  <ItemGroup>
    <PackageReference Include="Dapper" Version="1.60.6" />
    <PackageReference Include="Microsoft.Data.Sqlite" Version="1.1.1" />
  </ItemGroup>
</Project>

此时可以在旧项目中测试一下这个类库能否继续使用，把引用都整理好并测试可用之后就可以进行下一步：引入新的目标框架。

引入新目标框架

此时，我们希望在net452的基础上添加netstandard2.0的目标框架以便后续供.NetCore或者Xamarin使用。
首先，将TargetFramework节改成复数形式TargetFrameworks。
然后在记录引用的ItemGroup 中添加条件控制。

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <TargetFrameworks>netstandard2.0;net452</TargetFrameworks>
    <OutputType>Library</OutputType>
    <GenerateAssemblyInfo>false</GenerateAssemblyInfo>
  </PropertyGroup>
  <!--保留net452的引用-->
  <ItemGroup Condition=" '$(TargetFramework)' == 'net452' ">
    <PackageReference Include="Dapper" Version="1.60.6" />
    <PackageReference Include="Microsoft.Data.Sqlite" Version="1.1.1" />
  </ItemGroup>

  <!--使用netstandard的引用-->
  <ItemGroup Condition=" '$(TargetFramework)' == 'netstandard2.0' ">
    <PackageReference Include="Dapper" Version="2.0.78" />
    <PackageReference Include="Microsoft.Data.Sqlite" Version="5.0.0" />
  </ItemGroup>
</Project>

因为这个类库已经可以支持.Net Standard 2.0了，所以引用的第三方库可以尽情使用最新的稳定版(考虑好代码兼容性)。

部分代码可能需要兼容实现

如果类库中某些调用的API存在不兼容的问题，就需要使用预处理器指令编写条件代码，针对每个目标框架进行编译。

        private string Test()
        {
            string ret = "";
        #if NET452
            ret = "Target framework: .NET Framework 4.5.2";
        #elif NETSTANDARD2_0
            ret = "Target framework: .NET Standard 2.0";
        #else
            ret = "Unknown";
        #endif
            return ret;
        }

至此，该类库已经可以支持多目标框架了，不同目标框架可以在VS中的左上角切换。
在这里插入图片描述
另外，因为类库已经是多目标框架了，所以类库项目的属性中目标框架一栏会变成灰色，这是正常的。
在这里插入图片描述

最后，还有一个注意的地方，后续如果这个类库还要引用其他Nuget，要注意选择好版本，在csproj文件中做好不同目标框架的版本控制。

参考文章

.NetStandard概述
将 .NET Framework 项目转换为 .NET Standard 项目
SDK 样式项目中的目标框架

初夏de遐想
关注
  • 0
    点赞
  • 踩
  • 9
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
.NET平台系列24：从.NET Framework迁移到.NET Core/.NET5的技术指南
weixin_48967543的博客
06-14 834
系列目录 【已更新最新开发文章，点击查看详细】 　　本文讲解了在将代码从 .NET Framework 移植到 .NET（旧称为 .NET Core）时应考虑的事项。 对于许多项目，从 .NET Framework 移植到 .NET 是相对简单的。 项目的复杂性决定了在项目文件的初始迁移之后要做多少工作。 　　应用模型在 .NET 中可用的项目（如库、控制台应用和桌面应用）通常不需要太大的更改。 需要使用新应用模型的项目（如从 ASP.NET 迁移到 ASP.NET Core）需要的工作要多一点。...
Net到NetCore移植
08-26
Net到NetCore移植.pdf 详细描述了从dotNet到dotNet Core的移植
.NET Core与.NET Framework的区别
最新发布
exlink2012的专栏
05-24 1423
.NET Core和.NET Framework是微软提供的两种主要的开发平台，用于构建各种应用程序。虽然它们都基于.NET技术，但在架构、平台支持、性能、开发工具和社区支持等方面存在显著差异。本文将详细探讨.NET Core和.NET Framework的主要区别，帮助开发人员选择适合其项目需求的开发平台。
.netframework迁移到.netcore方法
weixin_43180499的博客
04-08 7278
一 .netframework程序迁移到.netcore5.0 对于.netframwork程序想要升级为.netcore5.0的方法,微软官方也给出了方法见 https://docs.microsoft.com/en-us/dotnet/desktop/winforms/migration/?view=netdesktop-5.0,我这里总结记录一下. 1.首先要检查自己应用程序适不适合迁移 .netframework框架和.netcore框架有很大的不同,首先得确保自己当前基于.netframework
.net core 2.0学习笔记（四）：迁移.net framework 工程到.net core
ogog123的博客
08-22 2276
在迁移.net core的过程中，第一步就是要把.net framework 工程的目标框架改为.net core2.0，但是官网却没有提供转换工具，需要我们自己动手完成了。.net framework 工程迁移为.net core工程大体上有两种方案：      1.创建一个.net core的工程，然后把所有的文件挪过去。这是比较笨的一种办法，如果工程比较小，还好弄。如果有几百工程，那就哭了
.net framework 迁移至.net core2.0专题
胡杰的专栏
09-29 4171
度量.net framework 迁移到.net core的工作量(转) 1 度量.net framework 迁移到.net core的工作量 2 迁移.net framework 工程到.net core 3 程序配置&ConfigurationManager
.net framework 转为 .net core
Chiyunyinlong的博客
10-28 4570
## 评价 1).net core 从3.0开始，.net framework 有的，它都有。控制台、WPF、WinForm、库。之前的版本，则只有控制台程序。 2) 这个转换挺无缝的。因为两个框架，语言、函数居然不需要作任何改动！ ## 步骤 1) 找一个.net Core工程文件(可以新建或从某处复制一个过来)，放到要升级的工程目录。 2) 加载到VS,然后修改它。把它改的和要升级的...
MySql.Data.EntityFrameworkCore.dll
09-30
MySql.Data.EntityFrameworkCore.dll NuGet 程序包，用以在.NET Core程序中连接MySql数据库的组件，当nuget程序包管理器无法正常安装时可以添加此引用到项目中。
DNSPod4NETCore2:DNSPod API For NETCore 2.x 公共类库
05-10
DNSPod4NETCore2DNSPod API For NETCore 2.x 公共类库，兼容.Net Core 3支持 Asp .Net Core DI移植自：现已上架Nuget：DNSPod4NETCore2.Cli配上一个Cli的例子，可用于修改域名记录，使用 .net core global tools ...
Bing：Bing是基于.NetFramework 4.5的框架，旨在提升团队的开发输出能力，由常用公共操作类（工具类，帮助类），分层架构基类，第三方组件封装，第三方业务接口封装等组成。netcore版本：https：github.combing-frameworkBing.NetCore.git
02-05
Bing是基于.NetFramework4.5的框架，旨在提升团队的开发输出能力，由常用公共操作类（工具类，帮助类），分层架构基类，第三方组件封装，第三方业务接口封装等组成。 开发环境以及类库依赖 以下是我们在项目开发和...
net core日志记录Serilog用法.docx
05-10
使用日志记录器可以将日志记录到控制台和文件中。 Log.Logger = ErrorLog; Log.Error("遇到错误"); Log.Logger = InfoLog; Log.Information("信息记录"); 在上面的代码中，我们使用 ErrorLog 记录了一个错误日志...
.net core项目中常用的几款类库详解（值得收藏）
10-18
主要给大家介绍了关于.net core项目中常用的几款类库的相关资料，文章通过示例代码介绍的非常详细，对大家学习或者使用.net core具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧。
NetStitch:NetStitch是基于.NetFramework.NETCore构建的Http RPC框架
05-15
NetStitch是基于.NetFramework / .NETCore构建的Http RPC框架。 它为C＃提供了简单易用的Http WebApi调用。 该框架由两个项目NetStitch.Server和NetStitch.Client组成。 NetStitch服务器 NetStitch.Server是ASP...
.NET FrameWork 转 .NET Core遇到的问题
It_sharp的博客
06-13 3794
== 声明： 此处笔记并不通用，供个人参考== 一、使用ConfigurationHelper时 ConfigurationHelper.AppSettings(“key”,false) 前置条件: 1、添加 DotNet.Utilities; 2、添加 webConfig中添加 3、引用 Framework.Apollo.Client 二、类库转换 System.Web.Mvc ==&gt...
.NET Framework 项目到 .NET Core 的自动迁移工具
精通电脑科技的博客
05-07 693
使用方法很简单，这个工具设计为 dotnet tool 工具，使用之前先使用下面命令进行安装。接着进入到需要转换的项目所在的文件夹。
.NET Framework迁移到.NET Core方案
windowsliusheng的专栏
04-22 7713
方案一、新建项目拷贝。 方案二、编辑.csproj文件，下面演示方案二编辑csproj文件迁移方式 1.右键指定项目“卸载项目” 2.右键编辑项目.csproj文件，删除文件全部内容 类库项目粘贴以下配置： <Project Sdk="Microsoft.NET.Sdk"> <PropertyGroup> <TargetFramework&gt...
度量.net framework 迁移到.net core的工作量
dotNET跨平台
08-23 1091
把现有的.net framework程序迁移到.net core上，是一个非常复杂的工作，特别是一些API在两个平台上还不能同时支持。两个类库的差异性,通过人工很难识别全。好在微软的工程师们考虑到了我们顾虑，为我们提前设计了一个工具：.NET Portability Analyzer。通过此工具我们可以快速的确定.net framework 程序用到的API与.net core的匹配度，并给出详细
.NET项目迁移到.NET Core操作指南
dotNET跨平台
06-19 841
这篇文章，汇集了大量优秀作者写的关于".NET迁移到.NET Core"资料文章以及微软官方教程文档。是我在迁移公司框架项目到.NET Core和.NET Stand...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值