.Net Core技术研究-WebApi迁移ASP.NET Core2.0

概述随着ASP.NET Core 2.0发布之后，原先运行在Windows IIS中的ASP.NET WebApi站点，就可以跨平台运行在Linux中。我们有必要先说一下ASP.NET Core。 ASP

随着ASP.NET Core 2.0发布之后，原先运行在windows IIS中的ASP.NET WebAPI站点，就可以跨平台运行在linux中。我们有必要先说一下ASP.NET Core。

ASP.NET Core 是新一代的 ASP.NET，第一次出现时的代号为 ASP.NET vNext，后来命名为ASP.NET 5，随着它的完善与成熟，最终命名为 ASP.NET Core，这表明它已不是 ASP.NET 的升级，而是一个重新设计的Web开发框架。而它一个非常重要的变化就是它不再依赖于IIS，而是一个独立的自寄宿的控制台应用程序，这也是它可以跨平台的根本。

两个关键词：IIS解耦和独立自寄宿的控制台应用程序。

我们对比一下ASP.NET和ASP.NET Core。ASP.NET 是强依赖于windows IIS的，因为System.Web 中有很多方法都是直接调用的 IIS相关的 API，同时它还是驻留在IIS进程中的。然而 ASP.NET Core 运行时则是一个完全独立的控制台应用程序，它有自己的 Kestrel Server，可以直接对外部提供服务。不过当前已有的 Kestrel Server 的功能相对比较简单，所以我们还是需要一个反向代理服务器将 Kestrel 服务器保护起来。因此，部署在linux环境下，可以考虑Nginx+Kestrel Server的组合，windows环境下，支持和IIS的直接集成(UseIISIntegration)，部署在IIS中。

我们进入今天的主题，将原有ASP.NET WebAPI工程迁移到ASP.NET Core 2.0.

一、ASP.NET Core WebAPI工程

打开VS2017（版本一定要大于15.3），新建项目：ASP.NET Core Web应用程序

新建后的解决方案和工程：

二、ASP.NET Core WebHost构造和运行

大家可以发现，有了Program.cs类，有了Main函数，控制台应用程序就可以运行了。

继续看，构造并启动了一个WebHost. 疑问来了，WebHost是什么机制？如果构造的？

WebHost.CreateDefaultBuilder是在ASP.NET Core 2.0中新增的，在Microsoft.AspNetCore命名空间下。我们看一下CreateDefaultBuilder的源码：

     整个WebHost对象的构造过程是这样的：

         1. 注册 Kestrel 中间件，指定当前WebHost 要使用的 Server（http服务器）。

         2. 设置 Content 根目录，将当前项目的根目录作为 ContentRoot 的目录。

         3. 读取 appsettinggs.Json 配置文件，开发环境下的 UserSecrets 以及环境变量和命令行参数。

         4. 读取配置文件中的 Logging 节点，对日志系统进行配置。

         5. 添加 IISIntegration 中间件，集成到IIS中运行。

         6. 设置开发环境下， ServiceProvIDer 的 ValIDateScopes 为 true，避免直接在 Configure 方法中获取 Scope 实例。

         7. 指定 Startup 类，通过 Build 方法创建 WebHost 对象。

      Main函数中，BuilDWebHost(args).Run(); 运行创建好的WebHost。

三、调试运行

ValuesController中的Action实现：

四、ASP.NET WebAPI迁移评估

在真正迁移ASP.NET WebAPI工程之前，我们要评估一下有哪些具体的迁移工作：

引用的Nuget和dll迁移Web.Config文件迁移自定义WebAPI路由迁移Controller迁移httpModule扩展迁移各类自定义Attribute迁移

我们服务网关用的WebAPI主要涉及上述6个部分，大家可以根据实际情况增加和删除。

五、一步一步迁移ASP.NET Core WebAPI

1. 迁移之前首先要建立一个空的ASP.NET Core2.0 WebAPI项目：

2. 迁移Controller和Model

在新建的工程中复刻已有的Controller和Model的，例如：

3. 迁移各类Attribute，属性标签，例如：本例中的自定义异常处理标签

4. 迁移Web.Config

为了更好的兼容.NET 原有的配置文件和配置系统。虽然提供了Nuget：

System.Configuration.ConfigurationManager

但是实际上，Web.Config是为了IIS而设计的，在新的ASP.NET Core中推荐使用appSettings.Json替换改造。即：将XML化的配置文件修改为JsON配置文件。

核心的nameSpace：Microsoft.Extensions.Configuration

具体可以参考微软的官方资料：

https://docs.microsoft.com/en-us/aspnet/core/fundamentals/configuration?tabs=basicconfiguration

配置读取示例：

5. WebAPI自定义路由重写

在很多WebAPI项目中，采用了自定义路由，例如我们的CommonController，自定义路由在ASP.NET Core2.0中如何支持的呢？

在StartUp类中，提供Configure方法：

在这里，我们加入自定义路由配置，对应我们刚才的CommonController：

6. IhttpModule扩展迁移ASP.NET Core2.0

在ASP.NET Core2.0中提供了中间件的概念，支持请求和响应之间的链式扩展：

具体可以参考微软官方资料：

https://docs.microsoft.com/en-us/aspnet/core/fundamentals/middleware

https://docs.microsoft.com/en-us/aspnet/core/migration/http-modules

这里，示例一下我们自己写的自定义中间件：

这里巧妙的通过扩展方法的方式，扩展了接口IApplicationBuilder，

同时在StartUp的Configure方法中加载扩展的自定义中间件：

 

以上就是我们在将WebAPI站点迁移到ASP.NET Core2.0中用到的点滴技术，分享给大家。

 

周国庆

2017/9/28

 

总结

以上是内存溢出为你收集整理的.Net Core技术研究-WebApi迁移ASP.NET Core2.0全部内容，希望文章能够帮你解决.Net Core技术研究-WebApi迁移ASP.NET Core2.0所遇到的程序开发问题。

如果觉得内存溢出网站内容还不错，欢迎将内存溢出网站推荐给程序员好友。