PAYATHON 2026

如何在 ASP.NET Core Web API 的一次请求中共享业务对象?

数据小陈

可以。将承载业务对象的上下文注册为 Scoped,在 controller 收到并验证请求参数后初始化,再让需要该对象的 service 注入上下文。在常规 ASP.NET Core Web API 请求处理中,同一个请求作用域内会复用该上下文实例,不同请求使用各自的实例。

请求参数在运行时才知道,但这不妨碍注册依赖。DI 注册的是上下文服务及其生命周期,依赖 UserName 的业务数据可以在参数绑定完成后构建。

为什么仅使用 AddScoped 还不够

AddScoped 控制实例的复用范围,不会自动将 POST 请求体中的 UserName 传给服务构造函数。

需要分别处理实例复用和初始化:

  • 用 Scoped 让同一请求作用域内的 service 访问同一个上下文。
  • 读取请求参数后,初始化上下文,再调用依赖它的业务方法。

这个场景可以在 controller action 中初始化,因为请求体在执行到这里时已经完成模型绑定。

实现请求级业务上下文

以 IReadOnlyDictionary<string, string> 为例,字典里的内容仅用于展示共享方式。实际项目应将其替换为根据 UserName 构建字典的业务逻辑。

using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;

public sealed class RequestBusinessContext
{
    private IReadOnlyDictionary<string, string>? _values;

    public IReadOnlyDictionary<string, string> Values =>
        _values ?? throw new InvalidOperationException(
            "RequestBusinessContext has not been initialized.");

    public void Initialize(string userName)
    {
        if (_values != null)
        {
            throw new InvalidOperationException(
                "RequestBusinessContext has already been initialized.");
        }

        if (string.IsNullOrWhiteSpace(userName))
        {
            throw new ArgumentException(
                "UserName is required.", nameof(userName));
        }

        // 示例逻辑:在这里替换为实际的业务字典构建规则。
        var values = new Dictionary<string, string>
        {
            ["UserName"] = userName
        };

        _values = new ReadOnlyDictionary<string, string>(values);
    }
}

尚未初始化就读取上下文,或在同一次请求中重复初始化,都会抛出明确的异常。调用方需要遵守初始化顺序;上下文本身不提供并发初始化保护。

如果构建规则变得复杂,可以把规则移到单独的 factory 中,由 controller 调用 factory,再将结果交给上下文保存。

注册服务并在 controller 中初始化

在应用现有的服务注册位置添加:

builder.Services.AddScoped<RequestBusinessContext>();
builder.Services.AddScoped<BusinessService>();

业务 service 通过构造函数获取上下文,无须让每个方法都接收 dictionary:

public sealed class BusinessService
{
    private readonly RequestBusinessContext _context;

    public BusinessService(RequestBusinessContext context)
    {
        _context = context;
    }

    public string ReadUserName()
    {
        return _context.Values["UserName"];
    }
}

controller 在调用业务方法之前完成初始化:

using System.ComponentModel.DataAnnotations;
using Microsoft.AspNetCore.Mvc;

public sealed class CreateRequest
{
    [Required]
    public string UserName { get; set; } = string.Empty;
}

[ApiController]
[Route("api/business")]
public sealed class BusinessController : ControllerBase
{
    private readonly RequestBusinessContext _context;
    private readonly BusinessService _service;

    public BusinessController(
        RequestBusinessContext context,
        BusinessService service)
    {
        _context = context;
        _service = service;
    }

    [HttpPost]
    public IActionResult Post([FromBody] CreateRequest request)
    {
        _context.Initialize(request.UserName);

        return Ok(new
        {
            UserName = _service.ReadUserName()
        });
    }
}

其他 service 也可以注入 RequestBusinessContext。只要它们由同一个请求作用域解析,就会访问同一个上下文实例。

BusinessService 的构造函数可能在 action 执行前就已运行,因此构造函数中应只保存上下文引用。读取 Values 的操作应放在初始化之后执行的业务方法中。

何时继续使用方法参数

在 controller 中构建对象并通过参数传递,也是合理的做法。如果只有少数调用需要该对象,显式参数更容易展示每个方法的实际输入,单元测试也比较直接。

如果该对象是整次请求共享的业务上下文,多个 service 都需要读取它,使用 Scoped 上下文可以减少重复传参。测试这些 service 时,先创建并初始化上下文,再传入被测试的 service 即可。

HttpContext.Items 也能保存单次 HTTP 请求中的共享数据,适合在 middleware 等 HTTP 管道组件之间传递信息。对于已经按业务职责拆分的 service,强类型上下文通常更方便表达依赖,也便于脱离 HTTP 环境测试。

使用时的边界

不要将这类上下文注册为 Singleton 或存到 static 字段中,否则可能让不同请求共享数据。也不要在每个 service 中自行创建 DI scope,因为新作用域会得到另外的上下文实例。

Scoped 只决定实例的生命周期,不保证线程安全。示例在进入业务方法前完成一次初始化,之后通过只读字典提供数据。如果后续改为多个并行任务共同修改对象,需要另行设计同步机制。字典中的值如果是可变对象,只读字典也不会让这些值自动变成不可变对象。

不要让脱离请求的后台任务继续依赖该上下文。后台任务应接收明确的数据,并按任务自身的生命周期创建所需服务。

备注:内容仅供参考。