设为首页 收藏本站
查看: 1458|回复: 0

[经验分享] 一步一步带你做WebApi迁移ASP.NET Core2.0

[复制链接]

尚未签到

发表于 2017-12-28 18:54:32 | 显示全部楼层 |阅读模式
  随着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应用程序
DSC0000.jpg

DSC0001.png

  新建后的解决方案和工程:
DSC0002.png

  二、ASP.NET Core WebHost构造和运行
  大家可以发现,有了Program.cs类,有了Main函数,控制台应用程序就可以运行了。
DSC0003.png

  继续看,构造并启动了一个WebHost. 疑问来了,WebHost是什么机制?如果构造的?
  WebHost.CreateDefaultBuilder是在ASP.NET Core 2.0中新增的,在Microsoft.AspNetCore命名空间下。我们看一下CreateDefaultBuilder的源码:
DSC0004.png

  整个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。
  三、调试运行
DSC0005.png

  ValuesController中的Action实现:
DSC0006.png

  四、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项目:
DSC0007.jpg

DSC0008.png

  2. 迁移Controller和Model
  在新建的工程中复刻已有的Controller和Model的,例如:
DSC0009.png

  3. 迁移各类Attribute,属性标签,例如:本例中的自定义异常处理标签
DSC00010.png

  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
DSC00011.png

  配置读取示例:
DSC00012.png

  5. WebApi自定义路由重写
  在很多WebApi项目中,采用了自定义路由,例如我们的CommonController,自定义路由在ASP.NET Core2.0中如何支持的呢?
  在StartUp类中,提供Configure方法:
DSC00013.png

  在这里,我们加入自定义路由配置,对应我们刚才的CommonController:
DSC00014.png

  6. IHttpModule扩展迁移ASP.NET Core2.0
  在ASP.NET Core2.0中提供了中间件的概念,支持请求和响应之间的链式扩展:
DSC00015.png

  具体可以参考微软官方资料:
  https://docs.microsoft.com/en-us/aspnet/core/fundamentals/middleware
  https://docs.microsoft.com/en-us/aspnet/core/migration/http-modules
  这里,示例一下我们自己写的自定义中间件:
DSC00016.png

  这里巧妙的通过扩展方法的方式,扩展了接口IApplicationBuilder,
  同时在StartUp的Configure方法中加载扩展的自定义中间件:
DSC00017.png

  以上就是我们在将WebApi站点迁移到ASP.NET Core2.0中用到的点滴技术,分享给大家。
  周国庆
  2017/9/28

运维网声明 1、欢迎大家加入本站运维交流群:群②:261659950 群⑤:202807635 群⑦870801961 群⑧679858003
2、本站所有主题由该帖子作者发表,该帖子作者与运维网享有帖子相关版权
3、所有作品的著作权均归原作者享有,请您和我们一样尊重他人的著作权等合法权益。如果您对作品感到满意,请购买正版
4、禁止制作、复制、发布和传播具有反动、淫秽、色情、暴力、凶杀等内容的信息,一经发现立即删除。若您因此触犯法律,一切后果自负,我们对此不承担任何责任
5、所有资源均系网友上传或者通过网络收集,我们仅提供一个展示、介绍、观摩学习的平台,我们不对其内容的准确性、可靠性、正当性、安全性、合法性等负责,亦不承担任何法律责任
6、所有作品仅供您个人学习、研究或欣赏,不得用于商业或者其他用途,否则,一切后果均由您自己承担,我们对此不承担任何法律责任
7、如涉及侵犯版权等问题,请您及时通知我们,我们将立即采取措施予以解决
8、联系人Email:admin@iyunv.com 网址:www.yunweiku.com

所有资源均系网友上传或者通过网络收集,我们仅提供一个展示、介绍、观摩学习的平台,我们不对其承担任何法律责任,如涉及侵犯版权等问题,请您及时通知我们,我们将立即处理,联系人Email:kefu@iyunv.com,QQ:1061981298 本贴地址:https://www.yunweiku.com/thread-429075-1-1.html 上篇帖子: ASP.NET上传文件出现“404 下篇帖子: 模块和处理程序之通过HttpModule和HttpHandler拦截入站HTTP请求执行指定托管代码模块
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

扫码加入运维网微信交流群X

扫码加入运维网微信交流群

扫描二维码加入运维网微信交流群,最新一手资源尽在官方微信交流群!快快加入我们吧...

扫描微信二维码查看详情

客服E-mail:kefu@iyunv.com 客服QQ:1061981298


QQ群⑦:运维网交流群⑦ QQ群⑧:运维网交流群⑧ k8s群:运维网kubernetes交流群


提醒:禁止发布任何违反国家法律、法规的言论与图片等内容;本站内容均来自个人观点与网络等信息,非本站认同之观点.


本站大部分资源是网友从网上搜集分享而来,其版权均归原作者及其网站所有,我们尊重他人的合法权益,如有内容侵犯您的合法权益,请及时与我们联系进行核实删除!



合作伙伴: 青云cloud

快速回复 返回顶部 返回列表