kentxxq Blog
Blog Categories Tags About
kentxxq Blog

AspNetCore的初步了解

kentxxq  收录于  类别 笔记
     约 3255 字   预计阅读 7 分钟 

应用无论实现了怎样的效果，总是需要展示的。而web是最方便的展示方法。让我来搭建一个web项目。那我肯定采用前后端分离。
如果要选择用什么语言来进行后端开发。快速开发我一定选择python。而需要性能且服务器数量少的时候，静态语言我会选c#。
所以就选择来初步了解一下net core以及一些语法特性。
文章中很多都只是给到了文档的链接，是因为官方文档非常详细。自己抄过来没有意义，同时链接到的地址也会有最新变化。要学好编程，官方文档是必看的。哪怕是英文版

Visual Studio是宇宙第一ide这句话，大家也多多少少有过了解了。安装好以后，开发环境就弄好了。

看官方文档的Web API就ok。

  1. models模块直接自动生成！直接可以配合linq使用。
  2. 新增控制器，直接把增删改查都做好了。只需要加入一丢丢的业务逻辑即可！
  3. 如果使用的是Azure云服务，还可以一键上云，也太方便了。。

上面的几点，让我觉得比python开发速度还要快。

根据一点基础的了解。我认为委托让C#有了把函数作为参数传递的解决方案。

C#的匿名函数其实是委托的一种简写。

C#的箭头函数其实就是匿名函数的另一种表达方式。

C#的linq语法可以完全等价转换到箭头函数，也可以说是基于委托实现的。

C#的事件是特殊的委托。

1

Scaffold-DbContext "Data Source=(DESCRIPTION =(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST = db_host)(PORT = 1521)))(CONNECT_DATA =(SERVICE_NAME = orcl)));User ID=kentxxq;Password=123456;" Oracle.EntityFrameworkCore -OutputDir Models

如果上面的命令无法识别，执行下面的操作

1

Install-Package Microsoft.EntityFrameworkCore.Tools

一直用postman来对后端测试。老是切换来切换去。还得自己一个一个路径来写文档。

然后发现有Swagger。神器啊！

用Nuget安装依赖Swashbuckle.AspNetCore后，在Startup.cs的ConfigureServices加入代码

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

services.AddSwaggerGen(c =>
{
    c.SwaggerDoc("v1", new Info { Title = "My API", Version = "v1" });
    // 还可以给openapi添加xml注释
    // 什么是xml注释？就是函数的中文名、每个参数的含义等等。PS: 1591忽略没有写xml注释的警告
    // 编辑< project_name>.csproj , 在PropertyGroup添加<GenerateDocumentationFile>true</GenerateDocumentationFile><NoWarn>$(NoWarn);1591</NoWarn>
    // 放开下面的代码注释：
    // var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
    // var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
    // c.IncludeXmlComments(xmlPath);
});

Configure的app.UseMvc()前加入代码

1
2
3
4
5
6

app.UseSwagger();
app.UseSwaggerUI(c =>
{
    c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
});
app.UseMvc();

之后访问https://localhost:5001/swagger就能看到惊喜了！

按照官方文档，我的Models文件夹是通过Scaffold-DbContext命令生成的。之后移除掉

在appsettings.json中加入连接字符串

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

{
  "Logging": {
    "LogLevel": {
      "Default": "Warning"
    }
  },
  "AllowedHosts": "*",
  "ConnectionStrings": {
    "BloggingDatabase": "Data Source=your_server_ip;Database=your_database_name;User ID=your_username;Min Pool Size=10;Password=your_password;Connect Timeout=30;Encrypt=False;TrustServerCertificate=False;ApplicationIntent=ReadWrite;MultiSubnetFailover=False"
  }
}

在Startup.cs的ConfigureServices中移除AddDbContext，加入代码

1
2
3

services.AddDbContextPool<BloggingContext>(
    options => { options.UseSqlServer(Configuration.GetConnectionString("BloggingDatabase")); },poolSize:64
) ;

请求https://localhost:5001/api/blogs,报错

An unhandled exception occurred while processing the request.

InvalidOperationException: The DbContext of type ‘BloggingContext’ cannot be pooled because it does not have a single public constructor accepting a single parameter of type DbContextOptions.

Microsoft.EntityFrameworkCore.Internal.DbContextPool..ctor(DbContextOptions options)

百思不得其解。解决办法是

在BloggingContext的代码中，BloggingContext有两个构造函数。

1
2
3
4
5
6
7
8
9

//删掉我
public BloggingContext()
{
}
//其他的都不要动哦
public BloggingContext(DbContextOptions<BloggingContext> options)
    : base(options)
{
}

只需要删除掉无参构造函数即可!

在使用的时候要注意netCore的2.2版本有ef命令，但是3开始就会分离出来。

如果web项目无法运行(存在报错)，极有可能无法成功执行！

1
2
3
4
5
6
7
8
9

# sqlite
dotnet ef dbcontext  scaffold "Data Source=test.db" -o Models Microsoft.EntityFrameworkCore.Sqlite -c "TestDbContext" -f
# mysql
dotnet ef dbcontext scaffold "server=localhost;port=3306;user=root;password=mypass;database=sakila" MySql.Data.EntityFrameworkCore -o sakila -f
# 或者
Scaffold-DbContext "server=localhost;port=3306;user=root;password=mypass;database=sakila" MySql.Data.EntityFrameworkCore -OutputDir sakila -f

# oracle 
Scaffold-DbContext "Data Source=(DESCRIPTION =(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST = 192.168.0.220)(PORT = 1521)))(CONNECT_DATA =(SERVICE_NAME = orcl)));User ID=kentxxq;Password=java321;" Oracle.EntityFrameworkCore -OutputDir Models

cli

1
2

dotnet ef migrations add InitialCreate
dotnet ef database update

vs的pm包管理控制台

1
2

Add-Migration InitialCreate
Update-Database

EF Core是c#的orm框架。支持查询语法和linq。非常好用！

在我所了解到的语言中，我认为是完善度和易用性最高的了！几乎杜绝了我使用裸sql语句的可能！

在我的web api中，我试着写了这么一段linq代码

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

[HttpGet]
public async Task<ActionResult<IEnumerable<dynamic>>> GetUsers()
{
    var a = from user1 in _testDbContext.Users
            join user2 in _testDbContext.TUsers
            on new { username = user1.Username, password = user1.Password }
            equals new { username = user2.Username, password = user2.Password }
            select new
            {
                user1.Username,
                user2.Password
            };
    // return await a.ToAsyncEnumerable(); 错误示例
    // return await a.ToAsyncEnumerable().ToList(); 纠正
    return await a.ToListAsync();
}

先说明几点:

  1. 由于返回的数据是select new出来的对象，所以我的返回值使用了dynamic。方便以后更改字段。也不用再新建字段。
  2. async方法代表异步，后面必须要跟Task。而ActionResult代表返回特定的类型。而对比指定的类型返回有什么好处呢？它可以通过IActionResult简化操作。并且可以返回多个类型。比如存在数据则返回200，不存在则返回404错误，很明显它们两个的结构类型不一致。

而我在编写这段代码的时候，产生了疑惑。我最开始是按照上面的注释代码写的。发现报错，怎么都不对。

这里需要注意的是。我的返回类型是IEnumerable<dynamic>,所以我就写了ToAsyncEnumerable。而Enumerable的用法是循环取出数据。无法直接await后去返回。

参考这一篇博客，总结一下使用方法。

  1. public interface IEnumerable<out T> : IEnumerable只能遍历使用
  2. public interface ICollection<T> : IEnumerable<T>, IEnumerable你关心它的大小,添加，删除，清空操作
  3. public interface IList<T> : ICollection<T>, IEnumerable<T>, IEnumerable你要修改它并且需要排序，例如插入指定位置，查找指定下标数据。
  4. List<>则是一个实现。

List是继承于接口IEnumerable的，所以返回List是可以的。

特定类型没什么好说的。要返回啥就返回啥。 IActionResult如果你通过int类型的id查询一个数据。如果存在就返回实体。但是用户输入的是string，则验证错误。需要手动返回一个500错误之类的提示。它是一个接口，可以返回所有实现类，例如view是视图，notfound是404.主要用于多种不同返回状态。 ActionResult<T>对比IActionResult优势在于简化了使用。例如在IActionResult中需要返回return new ObjectResult(T)，而ActionResult隐式转换则直接简化为了return T。

在看asp.net core的文档。准备详细了解一下大概的东西。文档还是有点生涩的。准备用一句话来理解所有的概念。

Program是main方法的所在，从这里启动程序。

Startup里的ConfigureServices是用来注册服务的。例如你要用到数据库，那么数据库就在这里注册到app。

Startup里的Configure则主要是用来配置app的。例如在处理进入到你的业务逻辑代码前，要经过什么样的处理。是否启动静态文件代理等等。

Startup里的IStartupFilter则让你在进入管道之前或之后进行处理逻辑。请求先进入到这里，再进入中间件处理，再进入控制器。控制器是具体的业务代码。而中间件则也会存在有部分的业务逻辑代码。IStartupFilter则让你把业务无关的逻辑隔离出来。

新请求大概的运作流程，IStartupFilter=>中间件=>filter=>mvc

现在学习一下netcore，以后net5统一平台后，估计我就要全面深入使用了。

最近蛮堕落的。。没有写什么代码，也没有更新什么文章。就连电影都没怎么看。赶紧写完去撸我的app。

20190713 00:32: 添加ef core内容

20190716 00:00: 添加asp.net core的部分

20190802 14:03：添加添加oracle的models生成

20201112 02:23: 添加mysql的models生成

20210225 16:21：添加openapi的xml注释

20210227 18:34: 感觉文章写得是AspNetCore，所以改一下文章

更新于 2021-08-23
 csharp, AspNetCore
返回 | 主页