深入浅出Dotnet Core的项目结构变化

开发 项目管理
今天,就着这个点,写一下Dotnet Core的主要类型的项目结构,以及之间的转换和演化。

 [[375510]]

本文转载自微信公众号「老王Plus」,作者老王Plus的老王 。转载本文请联系老王Plus公众号。

前几天Review一个项目的代码,发现非常基础的内容,也会有人理解出错。

今天,就着这个点,写一下Dotnet Core的主要类型的项目结构,以及之间的转换和演化。

一、最基础的应用Console

控制台应用,是Dotnet Core乃至前边的Dotnet Framework中,最基础的项目。

我们来创建一个Console项目看一下:

  1. % dotnet new console -o demo 

创建完成后,打开工程。工程里只有一个文件Program.cs,里面只有一个方法Main:

  1. namespace demo 
  2.     class Program 
  3.     { 
  4.         static void Main(string[] args) 
  5.         { 
  6.             Console.WriteLine("Hello World!"); 
  7.         } 
  8.     } 

在Dotnet Core所有类型的项目中,Program.cs都是最开始的入口,main方法,也是最开始的入口方法。

这个工程中,还有一个文件也需要了解一下,demo.csproj,这是这个项目的定义文件:

  1. <Project Sdk="Microsoft.NET.Sdk"
  2.  
  3.   <PropertyGroup> 
  4.     <OutputType>Exe</OutputType> 
  5.     <TargetFramework>net5.0</TargetFramework> 
  6.   </PropertyGroup> 
  7.  
  8. </Project> 

这里面,OutputType告诉编辑器这个工程编译后可以直接执行,TargetFramework定义运行的框架。

注意,这个框架字串有个对照表:net5.0对应的是.Net 5.0;如果你想用Dotnet Core 3.1,对应的字符串是netcoreapp3.1,而不是net3.1。准确的说,3.1是.Net Core 3.1,而5.0是.Net 5.0。不用太纠结,微软的命名规则而已。

这就是控制台应用Console的初始状态。

下面,我们看看这个工程如何转变为Web应用。

二、转为Web应用

第一件事,我们需要改动demo.csproj项目定义文件。

Web应用跑在WebHost上面,而不是从直接执行。所以,我们需要把OutputType项去掉。

另外,SDK也需要改一下。Console我们用的是Microsoft.NET.Sdk,Web应用要改成Microsoft.NET.Sdk.Web:

  1. <Project Sdk="Microsoft.NET.Sdk.Web"
  2.  
  3.   <PropertyGroup> 
  4.     <TargetFramework>net5.0</TargetFramework> 
  5.   </PropertyGroup> 
  6.  
  7. </Project> 

改完保存。

这时候,应该可以注意到,项目的发生了变化:

  • 依赖的框架从Microsoft.NETCore.App变成了两个,多了一个Microsoft.AspNetCore.App,表明现在这是一个Asp.net Core的应用;
  • 项目中自动生成了一个目录Properties,下面多了一个文件launchSettings.json。这个文件大家应该很熟悉,就不解释了。

这时候,应用已经从Console转为了Web应用。

Asp.Net Core框架提供了Host供Web加载。我们需要做的,是把Host构建器加到程序中。通常,我们需要两个构建器:

  • 通用主机 Generic host builder
  • Web主机 Web host builder

1. 配置通用主机

通用主机在Microsoft.Extensions.Hosting.Host中,主要给Web应用提供以下功能:

  • 依赖注入
  • 日志
  • 配置 IConfiguration
  • IHostedService实现

加入通用主机很简单,就一个方法CreateDefaultBuilder:

  1. class Program 
  2.     static void Main(string[] args) 
  3.     { 
  4.         Host.CreateDefaultBuilder(args) 
  5.             .Build() 
  6.             .Run(); 
  7.     } 

2. 配置Web主机

Web主机才是真正与Web相关的内容,主要实现:

  • Http支持
  • 设置Kestrol服务器为Web服务器
  • 添加IIS支持

加入Web主机,也是一个方法ConfigureWebHostDefaults:

  1. class Program 
  2.     static void Main(string[] args) 
  3.     { 
  4.         Host.CreateDefaultBuilder(args) 
  5.             .ConfigureWebHostDefaults(webBuilder => 
  6.             { 
  7.             }) 
  8.             .Build() 
  9.             .Run(); 
  10.     } 

这个方法用来添加Http请求管道并注入我们需要的服务。而注入我们需要的服务,就是我们最常见的Startup.cs的内容。

下面,我们先创建Startup.cs,

  1. namespace demo 
  2.     public class Startup 
  3.     { 
  4.     } 

在前边ConfigureWebHostDefaults中,加入Startup,并补齐代码:

  1. class Program 
  2.     static void Main(string[] args) 
  3.     { 
  4.         Host.CreateDefaultBuilder(args) 
  5.             .ConfigureWebHostDefaults(webBuilder => 
  6.             { 
  7.                 webBuilder.UseStartup<Startup>(); 
  8.             }) 
  9.             .Build() 
  10.             .Run(); 
  11.     } 

这就是Program.cs中的完整代码了。整理一下,就是我们常见的样子:

  1. public class Program 
  2.     public static void Main(string[] args) 
  3.     { 
  4.         CreateHostBuilder(args).Build().Run(); 
  5.     } 
  6.  
  7.     public static IHostBuilder CreateHostBuilder(string[] args) => 
  8.         Host.CreateDefaultBuilder(args) 
  9.             .ConfigureWebHostDefaults(webBuilder => 
  10.             { 
  11.                 webBuilder.UseStartup<Startup>(); 
  12.             }); 

不过,到这儿还不能正常运行,因为Startup.cs现在还是空的。

3. 补齐Startup类

Startup类在Asp.net Core应用中有着重要的作用。这个类用于:

  • 使用DI容器注入服务
  • 设置Http Request管道以插入中间件

下面我们补齐所需的方法:

  1. namespace demo 
  2.     public class Startup 
  3.     { 
  4.         public void ConfigureServices(IServiceCollection services) 
  5.         { 
  6.         } 
  7.         public void Configure(IApplicationBuilder app, IWebHostEnvironment env) 
  8.         { 
  9.         } 
  10.     } 

运行,到这儿,Web应用已经可以正常启动了。

4. 给应用添加路由

Web应用启动了,但里面什么也没有,是空的。

要访问Web应用中的任何资源,需要配置路由。这儿的路由,基本上就是传入Http请求与资源之间的映射。

我们可以用下面的中间件来启动路由:

  • UseRouting
  • UseEndpoints

加一下试试:

  1. public void Configure(IApplicationBuilder app, IWebHostEnvironment env) 
  2.     app.UseRouting(); 
  3.     app.UseEndpoints(endpoint => { 
  4.         endpoint.MapGet("/", async context => 
  5.         { 
  6.             await context.Response.WriteAsync("Hello from Demo"); 
  7.         }); 
  8.     }); 

这次运行,浏览器中就看到正确的输出了。

我们可以用MapGet映射更多资源:

  1. public void Configure(IApplicationBuilder app, IWebHostEnvironment env) 
  2.     app.UseRouting(); 
  3.     app.UseEndpoints(endpoint => 
  4.     { 
  5.         endpoint.MapGet("/", async context => 
  6.         { 
  7.             await context.Response.WriteAsync("Hello from Demo"); 
  8.         }); 
  9.         endpoint.MapGet("/test", async context => 
  10.         { 
  11.             await context.Response.WriteAsync("Hello from Demo.Test"); 
  12.         }); 
  13.         endpoint.MapGet("/about", async context => 
  14.         { 
  15.             await context.Response.WriteAsync("Hello from Demo.About"); 
  16.         }); 
  17.     }); 

到这儿,我们成功地把Console应用转为了Web应用。

三、延伸内容

上面完成的Web应用,算是Web应用中的基础。基于这个内容,我们还可以扩展到别的项目结构。

1. 改为MVC应用

需要在ConfigureServices中注入AddControllersWithViews,并在Configure中添加MapDefaultControllerRoute:

  1. public class Startup 
  2.     public void ConfigureServices(IServiceCollection services) 
  3.     { 
  4.         services.AddControllersWithViews(); 
  5.     } 
  6.     public void Configure(IApplicationBuilder app, IWebHostEnvironment env) 
  7.     { 
  8.         app.UseRouting(); 
  9.         app.UseEndpoints(endpoint => 
  10.         { 
  11.             endpoint.MapDefaultControllerRoute(); 
  12.         }); 
  13.     } 

2. 改为WebAPI应用

需要注入AddControllers和MapControllers:

  1. public class Startup 
  2.     public void ConfigureServices(IServiceCollection services) 
  3.     { 
  4.         services.AddControllers(); 
  5.     } 
  6.     public void Configure(IApplicationBuilder app, IWebHostEnvironment env) 
  7.     { 
  8.         app.UseRouting(); 
  9.         app.UseEndpoints(endpoint => 
  10.         { 
  11.             endpoint.MapControllers(); 
  12.         }); 
  13.     } 

3. 改为Razor应用

需要注入AddRazorPages和MapRazorPages:

  1. public class Startup 
  2.     public void ConfigureServices(IServiceCollection services) 
  3.     { 
  4.         services.AddRazorPages(); 
  5.     } 
  6.     public void Configure(IApplicationBuilder app, IWebHostEnvironment env) 
  7.     { 
  8.         app.UseRouting(); 
  9.         app.UseEndpoints(endpoint => 
  10.         { 
  11.             endpoint.MapRazorPages(); 
  12.         }); 
  13.     } 

四、总结

看下来,其实过程很简单。通过这种方式,能更进一步理解Dotnet Core的项目结构以及应用的运行过程。

希望对大家能有所帮助。

?

本文的配套代码在:https://github.com/humornif/Demo-Code/tree/master/0038/demo

 

责任编辑:武晓燕 来源: 老王Plus
相关推荐

2021-03-16 08:54:35

AQSAbstractQueJava

2011-07-04 10:39:57

Web

2022-12-02 09:13:28

SeataAT模式

2009-11-30 16:46:29

学习Linux

2019-11-11 14:51:19

Java数据结构Properties

2019-01-07 15:29:07

HadoopYarn架构调度器

2012-05-21 10:06:26

FrameworkCocoa

2017-07-02 18:04:53

块加密算法AES算法

2021-07-20 15:20:02

FlatBuffers阿里云Java

2022-09-26 09:01:15

语言数据JavaScript

2022-01-13 09:38:25

Android架构设计

2023-03-20 09:48:23

ReactJSX

2009-12-25 15:49:43

Linux rescu

2019-11-14 09:53:30

Set集合存储

2021-04-27 08:54:43

ConcurrentH数据结构JDK8

2022-11-09 08:06:15

GreatSQLMGR模式

2012-02-21 13:55:45

JavaScript

2018-11-09 16:24:25

物联网云计算云系统

2022-01-11 07:52:22

CSS 技巧代码重构

2019-12-04 10:13:58

Kubernetes存储Docker
点赞
收藏

51CTO技术栈公众号