Skip to content

6. 数据作用域

Web 应用程序同时为许多用户提供服务,而每个用户会发出大量请求。因此,数据可以在三个层级上共享,称为它的作用域:

  • 应用程序作用域:数据在服务器的整个生存期内由所有用户共享(例如医生列表);
  • 请求作用域:数据仅在请求期间存在(视图的模型);
  • 客户端作用域:数据专属于某个用户,并且必须在一个请求到下一个请求之间保持(所选语言、已登录的用户)。

最初的课程([ASP.NET MVC],2013 年)对最后这种作用域使用了会话:由服务器维护、专属于每个浏览器的一块内存空间。[ASP.NET Core] 仍然采用这种方式([AddSession]),但本文档与案例研究一样不使用它:客户端作用域的数据由浏览器存储在 Cookie 中。服务器不会在同一用户的各个请求之间保留任何数据:这称为无状态([stateless])。例如,这使得在负载均衡器后面运行多个相同的服务器成为可能。代价是:Cookie 受用户控制,用户可以读取和修改它。因此,只有非敏感数据——或者由服务器签名或加密、从而能够检测任何修改的数据——才存放在其中:[TempData] Cookie(示例 20)和身份验证令牌(第 8 章)就属于这种情况。

在服务器端,应用程序作用域和请求作用域对应于依赖注入服务的生存期(见示例 06)。[ASP.NET Core] 有三种:

注册
生存期
一个实例……
AddSingleton
应用程序
在应用程序的整个生存期内存在,由所有请求共享
AddScoped
请求
每个 HTTP 请求一个,在该请求期间由所有请求它的对象共享
AddTransient
无
每次注入都创建一个:两次请求,两个实例

6.1. 示例 23:三种作用域

文件 [Services/CounterService.cs]:

namespace Example23.Services;

// 应用程序作用域(AddSingleton):单个实例,由
// 所有用户的所有请求共享
public class CounterService
{
    private int total;

    // 多个请求可能同时运行:Interlocked
    // 保证两个同时发生的递增不会丢失
    public int Increment() => Interlocked.Increment(ref total);
}
  • 第 7 行:该服务将是单例(见 [Program.cs]):因此它的字段 [total] 具有应用程序作用域;
  • 第 11 行:Web 服务器在多个线程([threads])上同时处理多个请求。如果两个请求同时执行 [total++] ,它们可能读到同一个值,从而丢失一次递增。[Interlocked.Increment] 将读取、加法和写入作为一个不可分割的操作来完成。单例服务必须时刻提防这类同时访问。

文件 [Services/RequestService.cs]:

namespace Example23.Services;

// 请求作用域(AddScoped):每个 HTTP 请求一个新实例,
// 在该请求期间由所有索取它的对象共享
public class RequestService
{
    private static int createdInstances; // static:由所有实例共享的计数器

    public int Number { get; } = Interlocked.Increment(ref createdInstances);
}
  • 第 7 行:名为 [static] 的字段属于类而不属于实例;它由所有实例共享。它统计已创建的实例数量;
  • 第 9 行:每个实例在创建时分配一个编号。该服务将具有请求作用域:编号随每个请求而变化。

文件 [Services/ToolService.cs]:

namespace Example23.Services;

// 瞬时作用域(AddTransient):每次注入一个新实例,
// 即使在同一个请求中也是如此
public class ToolService
{
    private static int createdInstances;

    public int Number { get; } = Interlocked.Increment(ref createdInstances);
}

同样的实例计数器,用于 [transient] 服务。

文件 [Program.cs]:

using System.Text.Encodings.Web;
using System.Text.Unicode;
using Example23.Services;
using Microsoft.Extensions.FileProviders;

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddControllersWithViews();
builder.Services.AddSingleton(HtmlEncoder.Create(UnicodeRanges.All));
// 服务的三种生命周期
builder.Services.AddSingleton<CounterService>(); // 整个应用程序一个实例
builder.Services.AddScoped<RequestService>();    // 每个请求一个实例
builder.Services.AddTransient<ToolService>();    // 每次注入一个实例

var app = builder.Build();

app.UseStaticFiles(new StaticFileOptions
{
    FileProvider = new PhysicalFileProvider(Path.GetFullPath(Path.Combine(builder.Environment.ContentRootPath, "..", "common", "bootstrap"))),
    RequestPath = "/bootstrap",
});

// 请求作用域:HttpContext.Items 随请求而生,随请求而灭
app.Use(async (context, next) =>
{
    context.Items["start"] = DateTime.Now.ToString("HH:mm:ss.fff");
    await next(context);
});

app.MapControllers();
app.Run();
  • 第 10–12 行:三种生存期;
  • 第 23–26 行:一个中间件将请求的接收时间存储在 ***[HttpContext.Items] 中,这是一个随请求一起创建和销毁的字典。处理该请求的所有对象(过滤器、控制器、视图)都可以对它进行读写。它相当于 [res.locals]* 在 [Express] 中的对应物。

文件 [Controllers/ScopesController.cs]:

using Example23.Services;
using Microsoft.AspNetCore.Mvc;

namespace Example23.Controllers;

public record ScopesModel(int Total, int Instance, int Tool, int MyVisits);

public class ScopesController(CounterService counter, RequestService request, ToolService tool) : Controller
{
    [HttpGet("/")]
    public IActionResult Scopes()
    {
        // 客户端作用域:由浏览器保存的一份数据(Cookie),
        // 随每个请求发回服务器
        int.TryParse(Request.Cookies["myVisits"], out var myVisits);
        myVisits++;
        Response.Cookies.Append("myVisits", myVisits.ToString(),
            new CookieOptions { HttpOnly = true, SameSite = SameSiteMode.Lax });
        return View(new ScopesModel(counter.Increment(), request.Number, tool.Number, myVisits));
    }
}
  • 第 8 行:注入三个服务;
  • 第 15–18 行:客户端作用域:存储在 Cookie 中的计数器。[Request.Cookies["myVisits"]] 读取浏览器发送的 Cookie(首次访问时为 [null] )。[int.TryParse] 将其转换为整数;如果转换失败,则将 [myVisits] 设为 0。该操作将其递增并重新设置 Cookie;
  • 第 19 行:这些值被传递给视图。

文件 [Views/Scopes/Scopes.cshtml]:

@model ScopesModel
@* @inject: the view also asks for the services, during the SAME request *@
@inject RequestService RequestOfTheView
@inject ToolService ToolOfTheView
<h1 class="h3">The scopes of data</h1>
<ul>
  <li>application: @Model.Total visit(s) to the site, all browsers combined</li>
  <li>request: instance no. @Model.Instance of RequestService (no. @RequestOfTheView.Number in the view),
    request received at @Context.Items["start"]</li>
  <li>transient: instance no. @Model.Tool of ToolService (no. @ToolOfTheView.Number in the view)</li>
  <li>client: @Model.MyVisits visit(s) from this browser</li>
</ul>
  • 第 3–4 行:[@inject Type Name] 指令向依赖注入器请求一个服务,并将其存储在视图的属性中。视图与操作在同一个请求期间执行:我们将能够比较控制器和视图所收到的实例;
  • 第 9 行:请求作用域的值,由中间件设置。

一个页面,URL 为 http://localhost:5000/:

Image

让我们用 [curl] 和两个 Cookie 文件 [a.txt] 和 [b.txt] 来模拟两个浏览器。浏览器 A 发出两个请求,然后浏览器 B 发出一个,最后 A 再发出一个:

1
2
3
4
curl -c a.txt -b a.txt http://localhost:5000/
curl -c a.txt -b a.txt http://localhost:5000/
curl -c b.txt -b b.txt http://localhost:5000/
curl -c a.txt -b a.txt http://localhost:5000/
browser A:
application: 1 visit(s) to the site, all browsers combined
request: instance no. 1 of RequestService (no. 1 in the view), request received at 12:19:46.574
transient: instance no. 1 of ToolService (no. 2 in the view)
client: 1 visit(s) from this browser

browser A:
application: 2 visit(s) to the site, all browsers combined
request: instance no. 2 of RequestService (no. 2 in the view), request received at 12:19:46.671
transient: instance no. 3 of ToolService (no. 4 in the view)
client: 2 visit(s) from this browser

browser B:
application: 3 visit(s) to the site, all browsers combined
request: instance no. 3 of RequestService (no. 3 in the view), request received at 12:19:46.687
transient: instance no. 5 of ToolService (no. 6 in the view)
client: 1 visit(s) from this browser

browser A:
application: 4 visit(s) to the site, all browsers combined
request: instance no. 4 of RequestService (no. 4 in the view), request received at 12:19:46.696
transient: instance no. 7 of ToolService (no. 8 in the view)
client: 3 visit(s) from this browser

(只显示列表中的项)。我们观察到:

  • 应用程序计数器统计所有访问:1、2、3、4;
  • 每个请求都有自己的 [RequestService] 实例:1、2、3、4。在一个请求期间,控制器和视图收到的是同一个实例;
  • 每次注入 [ToolService] 都会创建一个实例:控制器和视图收到两个不同的实例,每个请求会创建两个新实例;
  • 客户端计数器专属于每个浏览器:A 有 3 次访问,B 有 1 次。

Cookie 由客户端控制,客户端可以发送任意值:

curl -i -b "myVisits=41" http://localhost:5000/
HTTP/1.1 200 OK
Content-Type: text/html; charset=utf-8
Set-Cookie: myVisits=42; path=/; samesite=lax; httponly

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>Scopes</title>
  <link rel="stylesheet" href="/bootstrap/css/bootstrap.min.css">
</head>
<body>
  <div class="container py-3">
    <h1 class="h3">The scopes of data</h1>
<ul>
  <li>application: 6 visit(s) to the site, all browsers combined</li>
  <li>request: instance no. 6 of RequestService (no. 6 in the view),
    request received at 12:19:47.374</li>
  <li>transient: instance no. 11 of ToolService (no. 12 in the view)</li>
  <li>client: 42 visit(s) from this browser</li>
</ul>

  </div>
</body>
</html>

对于访问计数器,这无关紧要。对于敏感数据(用户的身份、角色),服务器必须能够检测到篡改:第 8 章将展示如何做到。

这些生存期带来一条规则:服务不得依赖生存期更短的服务。如果单例接收了诸如 [Scoped] 之类的服务,它会无限期地保留该服务,远远超出创建该服务的请求。[ASP.NET Core] 在开发模式下于启动时检查是否遵守这条规则,如果违反则拒绝启动。在案例研究中:

作用域
数据
位置
应用程序
医生和客户列表、字典、待处理的 验证码、尝试次数计数器
单例服务([ListCache], [Translator]、[CaptchaService]……)
请求
数据库访问([DbContext])、仓库、业务层、公共视图模型;已登录的用户
[Scoped] 服务([RdvMedecinsDbContext]、[BusinessService]、[ApplicationModel]……);[HttpContext.User]、[HttpContext.Items]
客户端
身份验证令牌、语言、闪现消息
Cookie