一步一步带你做WebApi迁移ASP.NET Core2.0

随着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工程之前,我们要评估一下有哪些具体的迁移工作:

  1. 引用的Nuget和dll迁移
  2. Web.Config文件迁移
  3. 自定义WebApi路由迁移
  4. Controller迁移
  5. HttpModule扩展迁移
  6. 各类自定义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

时间: 2024-07-28 20:46:12

一步一步带你做WebApi迁移ASP.NET Core2.0的相关文章

一步步带你做vue后台管理框架(三)——登录功能

系列教程<一步步带你做vue后台管理框架>第三课 github地址:vue-framework-wz 线上体验地址:立即体验 <一步步带你做vue后台管理框架>第一课:介绍框架 <一步步带你做vue后台管理框架>第二课:上手使用 认证又称"验证"."鉴权",是指通过一定的手段,完成对用户身份的确认.身份验证的方法有很多,基本上可分为:基于共享密钥的身份验证.基于生物学特征的身份验证和基于公开密钥加密算法的身份验证. 登录鉴权功能是

一步步带你做vue后台管理框架(二)——上手使用

系列教程<一步步带你做vue后台管理框架>第二课 github地址:vue-framework-wz 线上体验地址:立即体验 闲扯再多不会用也没白搭,这节课我来带大家直接上手框架,体验到简单方便之后你就会爱上这个框架欲罢不能的. 首先跟所有的vue项目一样,两种方式,一种去项目github地址:vue-framework-wz上下载代码包到本地,或者使用 git clone https://github.com/herozhou/vue-framework-wz.git 无论哪种方式,只要我们

一步步带你做vue后台管理框架(一)——介绍框架

系列教程<一步步带你做vue后台管理框架>第一课 github地址:vue-framework-wz 线上体验地址:立即体验 在如今的科技公司中有很多前端的需求都是要写一个类似于后台管理框架,日常的工作中会有太多重复的内容加重我们程序员的工作,浪费我们的时间,导致不能早点下班回家吃饭. 普通程序员拿到一个项目总是会重新写,写路由花了两小时,写vuex花了两小时,写个Header组件花了1小时,侧边栏又要1小时,这样下来项目拿到手一天的时间都没真正去做项目的需求,再加上改bug,写css,准备工

一步一步带你入门MySQL中的索引和锁 (转)

出处: 一步一步带你入门MySQL中的索引和锁 索引 索引常见的几种类型 索引常见的类型有哈希索引,有序数组索引,二叉树索引,跳表等等.本文主要探讨 MySQL 的默认存储引擎 InnoDB 的索引结构. InnoDB的索引结构 在InnoDB中是通过一种多路搜索树——B+树实现索引结构的.在B+树中是只有叶子结点会存储数据,而且所有叶子结点会形成一个链表.而在InnoDB中维护的是一个双向链表. 你可能会有一个疑问,为什么使用 B+树 而不使用二叉树或者B树? 首先,我们知道访问磁盘需要访问到

用分区表分区交换做历史数据迁移

一.说明: OLTP库中有些表数据量大,且每月有持续的大量数据增加,由于历史数据在此库中不再做访问,而是在另1个OLAP库中做分析,所以会对历史数据迁移至OLAP库中.对这种历史数据迁移的操作,较好的办法是该表采用分区表.按时间分区后,可以对分区进行迁移.通过分区交换和表空间传输会很容易完成,而且性能上影响很小. 关于分区表更多内容:    http://blog.csdn.net/tanqingru/article/category/1397435 关于表空间传更多内容: http://blo

Centos7.2下Nginx配置SSL支持https访问(站点是基于.Net Core2.0开发的WebApi)

准备工作 1.基于nginx部署好的站点(本文站点是基于.Net Core2.0开发的WebApi,有兴趣的同学可以跳http://www.cnblogs.com/GreedyL/p/7422796.html) 2.证书颁发机构(CA)颁发的有效证书,其中我们需要两个文件,一个是 .key文件(私钥),另一个是 .crt或.pem文件(公钥) 核心功能 ? 通过指定由受信任的证书颁发机构(CA)颁发的有效证书,将服务器配置为侦听端口上的HTTPS流量. ? 通过配置nginx.conf文件来加强

如何从Rancher 1.6迁移到Rancher 2.0?这份清单可以帮助你!

Rancher 1.6是一个深受广大用户喜爱的容器编排平台,帮助企业用户在生产环境中运行和管理Docker和Kubernetes.Rancher 1.6支持多种容器编排框架,包括Kubernetes.Mesos.Docker Swarm,默认的基础编排引擎是Cattle,Cattle极简的操作体验受到了大量开源社区用户和企业用户的青睐. 过去一年,Kubernetes流行度快速上升,成为业界公认的容器编排框架标准.Rancher极具前瞻性地早在2017年9月便宣布全面拥抱Kubernetes,R

ASP.NET MVC4.0+ WebAPI+EasyUI+KnockOutJS快速开发框架 通用权限管理系统

在线演示地址:http://115.28.135.49:8099/ 1.基于 ASP.NET MVC4.0 + WebAPI + EasyUI + Knockout 的架构设计开发 2.采用MVC的框架模式,具有耦合性低.重用性高.生命周期成本低.可维护性高.有利软件工程化管理等优点 3.采用WebAPI,客户端完全摆脱了代理和管道来直接进行交互 4.采用EasyUI前台UI界面插件,可轻松的打造出功能丰富并且美观的UI界面 5.采用Knockout,,提供了一个数据模型与用户UI界面进行关联的

SNF快速开发平台之BS页面展示和九大优点-Asp.net+MVC4.0+WebAPI+EasyUI+Knockout

一)经过多年的实践不断优化.精心维护.运行稳定.功能完善: 能经得起不同实施策略下客户的折腾,能满足各种情况下客户的复杂需求. 二)编码实现简单易懂.符合设计模式等理念: 上手快,见效快.方便维护,能控制软件项目后期维护风险. 三)有严谨的分层理念.完全符合主流的SOA理念架构: 程序可以采用不同的实施策略.架构需求,方便维护.方便扩展. 四)符合RBAC的权限理念.同时也能满足国内小型软件项目的灵活性需求: 不仅符合国际通用标准,又能满足国内的小型软件项目的灵活设置需求. 五)不仅支持多数据库