.NET Core项目从xproj+project.json向csproj迁移简介

3月7日,微软发布了Visual Studio 2017 RTM,与之一起发布的还有.NET Core Runtime 1.1.0以及.NET Core SDK 1.0.0,尽管这些并不是最新版,但也已经从preview版本升级到了正式版。所以,在安装Visual Studio 2017时如果启用了.NET Core开发的相关功能,那么在安装完成后,你可以在命令行直接执行dotnet.exe,此时你可以看到.NET Core版本是1.1.0,而如果是执行dotnet.exe --version命令,那么你看到的SDK版本将会是1.0.0(并不带preview字样)。

在此介绍如何查看.NET Core SDK版本,主要是源于一件非常有趣的事情,而这件事对于.NET Core项目从老的xproj+project.json迁移到csproj有一定的影响。如果你曾经使用Visual Studio 2015 + .NET Core Tools for Visual Studio + .NET Core SDK开发过项目,并希望在全新的Visual Studio 2017中继续开发的话,了解一下这方面的内容还是很有必要的。

总的来说,迁移一个.NET Core项目,大致有以下几个步骤:

  • 迁移准备
  • 使用Visual Studio 2017对项目进行单项升级
  • 在Jenkins CI服务器上安装最新版的.NET Core SDK
  • 修改Jenkins CI系统编译任务,成功完成编译与发布

下面我就以自己的一个开源项目HAL为例,简单介绍一下各个步骤的做法。

迁移准备

HAL项目本来就是托管在Github上的一个开源项目,为了能够平滑地实现项目迁移,并确保Jenkins CI能够正常工作,在进行项目迁移之前,我首先在Github上新建了一个分支(branch)。Github中创建分支的成本是很低的,在一切调试通过之后,将分支合并(merge)到主分支后,直接删掉就行了。

Github中分支创建完成后,更新本地代码库,完成代码同步。

在Visual Studio 2017中打开并升级.NET Core项目

在我之前有篇简文中介绍过,在安装了Visual Studio 2017 RC之后,如何还能继续在Visual Studio 2015中打开并编译xproj项目,因为当安装完Visual Studio 2017后,dotnet.exe已经升级到1.0.0的版本,此时的dotnet.exe已经是使用MSBuild进行项目编译,它并不认识xproj+project.json这样的项目类型和文档组织结构,因此,在Visual Studio 2015中即使能够打开xproj项目文件,也无法正常编译。当时的解决方案是,在项目的根目录级别创建一个global.json文件,在文件中显式指定.NET Core SDK的版本,使得在项目编译时,强制使用老版本的.NET Core SDK,于是问题也就得到了解决。对于如何修改global.json以指定SDK的版本,这里就不多介绍了,请参考这篇文章

对于这个问题,我们可以做一个实验,假定你的机器上装有Visual Studio 2015 + .NET Core Tools for Visual Studio 2015 + preview版本的.NET Core SDK,同时装有Visual Studio 2017。那么,当你直接在命令行执行dotnet.exe --version命令,你会看到,.NET Core SDK的版本为1.0.0:

如果你进入到一个在global.json中指定了SDK版本的项目的根目录下,同样执行dotnet.exe --version命令,你会发现,此时的SDK版本却是global.json中指定的版本:

OK,如果你之前有修改global.json文件使得xproj项目能够继续在Visual Studio 2015中打开并编译的话,现在就需要去掉global.json文件中对SDK版本的显式声明,否则,在Visual Studio 2017中进行项目迁移的时候,将无法正常完成。因为此时Visual Studio会使用旧版本的SDK,而这个版本的SDK没有migrate功能。

总的来说,在Visual Studio 2017中迁移xproj还是比较平滑稳定的,一般不会遇到稀奇古怪的问题,只需要确认单向迁移就行了。在迁移完成后,会产生新的解决方案文件(sln)。

在Jenkins服务器上安装新的.NET Core SDK

当Visual Studio 2017成功完成项目迁移之后,就可以把代码提交到Github上的临时分支了,这样就能在Jenkins上进行构建测试。在此之前,需要安装新版本的.NET Core SDK。安装过程很简单,到dotnet官方网站上根据Jenkins master或者slave的操作系统选择相应的.NET Core SDK进行下载安装即可。安装完成后,可以使用dotnet --version命令,确认.NET Core SDK已经正确安装。

修改Jenkins系统编译任务

就HAL项目而言,我首先在Jenkins中克隆了编译任务(build job),然后修改这个编译任务,使得它能从Github中的临时分支获取代码。整个过程也没有出现什么难以解决的问题,原有的dotnet restore/build/pack等命令也能够正常继续使用,不过你会发现,编译过程已经使用Microsoft Build Engine(MSBuild)了。

需要注意的是,原来基于xUnit的dotnet test,有一个-xml的隐藏参数,它能够产生JUnit XML格式的单元测试结果报告,但在.NET Core SDK 1.0下,这个参数就不能用了,有个解决办法是使用-l(--logger)参数,它能够产生MSTest格式的单元测试报告,此时,在Jenkins中安装一个MSTest的插件,就能够继续将测试报告显示在主页上。

最后,在Github中,将临时分支合并到主线分支,并在Jenkins中手动修改主线分支对应的build job,最后把克隆的build job删除即可。不建议继续沿用克隆的build job,那样会造成编译版本的混乱。

时间: 2024-10-13 16:23:06

.NET Core项目从xproj+project.json向csproj迁移简介的相关文章

[.NET Core 24]把project.json迁移到.csproj

链接:https://blog.jetbrains.com/dotnet/2017/04/04/rider-eap-update-csproj-based-net-core-support-migrate/ how to migrate from the (deprecated) project.json format to the new .csproj format. First, Microsoft greatly simplified the .csprojformat. In mini

LostRoutes项目日志——编辑project.json

第一个Scene编译后运行会报错: Uncaught TypeError: Cannot read property 'style' of null 这是因为没有在project.json中包含已经编辑好的常量文件SystemConst.js和HomeScene.js文件,添加后的project.json内容如下: { "project_type": "javascript", "debugMode" : 1, "showFPS&quo

project.json 和 csproj 属性之间的映射

作者 Nate McMaster .NET Core 工具的开发过程中实施了一项重要的设计更改,即不再支持 project.json 文件,而是将 .NET Core 项目转移到 MSBuild/csproj 格式. 本文介绍 project.json 中的设置如何以 MSBuild/csproj 格式表示,以便用户可学习如何使用新格式,并了解将项目升级到最新版本的工具时由迁移工具做出的更改. csproj 格式 新格式 *.csproj 是一种基于 XML 的格式. 以下示例演示使用 Micr

难以接受你的改变:从project.json到.csproj

自从微软做了一个艰难的决定——.NET Core彻底放弃project.json,全面改回.csproj——至今,虽然赞美之声不断,但我依然不喜欢也难以接受这样的改变. 难以接受主要有两方面的原因: 1)由繁入简易,由简入繁难 习惯了json格式的简洁,很难再适应xml格式的繁琐.无论微软怎么简化.csproj,与project.json天生的简洁相比也是望尘莫及.简单对比一下,立马就能体会到. <Project Sdk="Microsoft.NET.Sdk" ToolsVers

.NET Core 工具从 project.json 移动到基于 MSBuild 的项目后的使用

.NET Core 从preview 4 开始弃用project.json 可以从这下载最新版本: https://github.com/dotnet/cli 使用VS2017 RC新建.net core项目已经从project.json转为msbuild了 打开vs2017,新建.net core 控制台项目: 项目自动生成的代码: using System; class Program { static void Main(string[] args) { Console.WriteLine

[asp.net core]project.json(1)

摘要 前面介绍了使用vs2015新建asp.net core web的内容,这篇文章学习下project.json文件的内容. project.json 原文:https://docs.microsoft.com/zh-cn/dotnet/articles/core/tools/project-json project.json文件用来定义asp.net core项目的元数据,编译信息和依赖.在本篇文章中,你可以看到你能在project.json中定义的所有属性列表. Note .NET Cor

.NET Core项目修改project.json来引用其他目录下的源码等文件的办法 &amp; 解决多框架时 project.json 与 app.config冲突的问题

作者: zyl910 一.缘由 项目规模大了后,经常会出现源码文件分布在不同目录的情况,但.NET Core项目默认只有项目目录下的源码文件,且不支持“Add As Link”方式引入文件.这时需要手工修改project.json文件了. 可能是因为最新版本已将 project.json 转为 .csproj,导致我花了一些功夫才找到配置办法,故写了这篇笔记. 二.引用其他目录下的源码等文件的办法 2.1 官网说明 官网的 project.json 和 csproj 属性之间的映射 里简单介绍了

.NET Core系列 : 2 、project.json 这葫芦里卖的什么药

.NET Core系列 : 1..NET Core 环境搭建和命令行CLI入门 介绍了.NET Core环境,本文介绍.NET Core中最重要的一个配置文件project.json的相关内容.我们可以使用.NET Core 的dotnet 命令行接口(CLI)dotnet new命令创建一个应用,也可以用Visual Studio 2015 update 3创建一个应用,他们都有一个project.json ,它是项目的配置文件,类似之前的*.csrpoj文件.Project.json 是一个

如果没有Visual Studio 2015,我们如何创建.NET Core项目 ?

对于.NET开发人员来说,我们已经习惯了VS这个世界上最强大的IDE,所以对他们来说,项目的创建直接利用安装到VS中相应的项目模板即可.当.NET Core跨出了Windows的围栏,正式拥抱其他平台,意味着VS已经不再是唯一的IDE.于此同时,.NET Core充分借鉴了目前非常流行的基于“脚手架(Scaffolding)”的源文件生成方式,在它的核心命令行“dotnet”也添加了脚手架的命令行开关.除此之外,.NET Core真正对社区敞开胸怀,我们可以直接利用现有的脚手架工具Yeoman来