BotFramework v4 嵌套Dialog避免重复传递状态的方法咨询
Bot Framework v4 多层Dialog状态重复传参的替代实现方案
方案1:依托内置DI容器自动解析依赖,消除手动透传链路
这种方式是官方默认推荐的最佳实践,核心思路是完全绕开手动new子Dialog、逐层级塞参数的写法,把所有层级的Dialog全部交给DI容器统一管理,所有依赖(状态对象、嵌套子Dialog)都通过构造函数自动注入,不需要上层层级帮忙传递。
- 第一步:在
Startup.cs的服务注册环节,把所有层级的Dialog(不管嵌套多少层)全部注册为瞬态服务,不需要在注册RootDialog的时候手动传入状态参数 - 第二步:每个Dialog的构造函数直接声明自身需要的状态对象、需要嵌套的子Dialog实例,DI容器会在解析每个Dialog实例的时候自动把依赖注入完成
- 第三步:在RootDialog中添加子Dialog时,直接使用注入完成的实例,不需要手动实例化子Dialog、手动传递状态参数
改造后的Startup.cs注册逻辑
public void ConfigureServices(IServiceCollection services) { IStorage storage = new MemoryStorage(); services.AddSingleton(new UserState(storage)); services.AddSingleton(new ConversationState(storage)); services.AddSingleton<IBotFrameworkHttpAdapter, AdapterWithErrorHandler>(); // 所有层级的Dialog全部注册为瞬态,不受嵌套深度影响 services.AddTransient<RootDialog>(); services.AddTransient<CustomDialog_1>(); services.AddTransient<CustomDialog_2>(); services.AddTransient<CustomDialog_N>(); // 哪怕是CustomDialog_1内部嵌套的孙级Dialog,也直接注册即可 services.AddTransient<GrandChildDialog>(); services.AddTransient<IBot, Bot<RootDialog>>(); }
改造后的RootDialog实现
public class RootDialog : ComponentDialog { public RootDialog( UserState userState, ConversationState conversationState, CustomDialog_1 customDialog1, CustomDialog_2 customDialog2, CustomDialog_N customDialogN) : base(nameof(RootDialog)) { // 自身需要使用状态时直接用注入的实例即可 // 添加子Dialog时直接使用已注入的实例,无需手动new、无需传状态参数 AddDialog(customDialog1); AddDialog(customDialog2); AddDialog(customDialogN); // 初始化基础Waterfall流程 InitialDialogId = nameof(WaterfallDialog); AddDialog(new WaterfallDialog(nameof(WaterfallDialog), new WaterfallStep[] { /* 流程步骤 */ })); } }
改造后的嵌套子Dialog实现(以CustomDialog_1为例)
public class CustomDialog_1 : ComponentDialog { public CustomDialog_1( UserState userState, ConversationState conversationState, GrandChildDialog grandChildDialog) : base(nameof(CustomDialog_1)) { // 完全不需要RootDialog帮忙传递状态或子Dialog实例,DI自动完成解析 AddDialog(grandChildDialog); // 自身业务逻辑 } }
方案2:通过TurnContext全局状态槽位存取状态对象,零参数直接访问
Bot Framework的TurnContext本身内置了一个请求级的键值对存储(TurnState),生命周期和单轮请求完全绑定,只要在请求入口把状态对象存进去,任何Dialog在流程运行时都可以通过当前步骤的上下文直接取出状态对象,完全不需要靠构造函数传递。
- 第一步:在自定义适配器的请求处理入口,把
UserState、ConversationState等状态实例挂载到当前TurnContext的存储槽位中 - 第二步:任意Dialog的流程步骤中,通过
stepContext.Context.TurnState直接取出对应的状态对象使用,不需要在构造函数中声明状态依赖
适配器中挂载状态到TurnContext
public class AdapterWithErrorHandler : BotFrameworkHttpAdapter { public AdapterWithErrorHandler( IConfiguration configuration, ILogger<BotFrameworkHttpAdapter> logger, UserState userState, ConversationState conversationState) : base(configuration, logger) { OnTurnError = async (turnContext, exception) => { /* 统一错误处理 */ }; OnTurnAsync = async (turnContext, cancellationToken) => { // 把状态实例存入当前请求的上下文槽位 turnContext.TurnState.Add(userState); turnContext.TurnState.Add(conversationState); await base.OnTurnAsync(turnContext, cancellationToken); }; } }
Dialog中直接从TurnContext取状态
private async Task<DialogTurnResult> ProcessStepAsync(WaterfallStepContext stepContext, CancellationToken cancellationToken) { // 直接从上下文取状态,无需构造函数注入 var userState = stepContext.Context.TurnState.Get<UserState>(); var conversationState = stepContext.Context.TurnState.Get<ConversationState>(); // 正常完成状态读写逻辑 var userProfileProp = userState.CreateProperty<UserProfile>(nameof(UserProfile)); var userProfile = await userProfileProp.GetAsync(stepContext.Context, () => new UserProfile(), cancellationToken); return await stepContext.NextAsync(null, cancellationToken); }
实现注意事项
- Dialog类注册时选择Transient生命周期即可,不要注册为单例:Dialog本身持有流程上下文状态,单例模式会导致多用户对话之间出现状态串线的问题
- 不要为了简化传参单独抽公共Dialog基类,把状态属性定义在基类中:这种方式本质还是手动维护依赖传递链路,反而会增加类层级的耦合度
- 用
TurnState存实例时,保证同类型对象仅存储一次,避免重复存储导致取值时拿到非预期的实例对象
内容的提问来源于stack exchange,提问作者Andreas_Lng
相关产品推荐
相关产品推荐

