[MAF的Agent管道详解-08]依赖注入的应用

借助于MAF提供的这个极具扩展性的Agent管道我们可以利用它提供的众多扩展点来实现我们针对Agent执行的控制。具体来说它提供的扩展点主要体现在如下几个方面三大中间件Agent、ChatClient和AIFunction中间件运行我们将基于请求拦截的横切关注点注入应用到针对Agent、ChatClient和AIFunction的调用AIContextProvider通过在调用ChatClient管道前后对AIContext和响应结果响应消息或者异常处理的定制将输入和输出增强机制应用到Agent管道ChatHistoryProvider实现针对AIAgent的对话历史持久化。当我们在自定义上述组件的时候很多情况下都需要使用到注入的依赖服务。如何提取这些依赖服务对象以及这些服务对象来源于何处这就是这篇文章需要解答的问题。1. 获取当前AgentRunContext当AIAgent通过调用RunAsync或者RunStreamingAsync方法开始运行后会创建一个表示Agent运行上下文的AgentRunContext对象。此上下文会被设置到AIAgent类型的静态字段s_currentContex表示的AsyncLocalAgentRunContext?对象上我们可以通过调用静态属性CurrentRunContext得到它。publicabstractclassAIAgent{privatestaticreadonlyAsyncLocalAgentRunContext?s_currentContextnewAsyncLocalAgentRunContext();publicstaticAgentRunContext?CurrentRunContext{get{returns_currentContext.Value;}protectedset{s_currentContext.Valuevalue;}}}publicsealedclassAgentRunContext{publicAIAgentAgent{get;}publicAgentSession?Session{get;}publicIReadOnlyCollectionChatMessageRequestMessages{get;}publicAgentRunOptions?RunOptions{get;}}AgentRunContext通过四个属性提供了如下的上下文Agent 当前执行的Agent对象Session执行Agent所在的AgentSessionRequestMessages调用Agent输入的消息列表RunOptions 用于控制Agent运行的配置选项。2. 利用当前AIAgent提取服务对象在得到了当前运行的AIAgent对象后我们可以调用它的GetService或者GetServiceTService方法提取所需的依赖服务。我们知道AIAgent相关的很多组件类型和接口比如IChatClient、AIContextProvider和ChatHistoryProvider都定义了这两个方法这意味着可以将这些组件视为一个IServiceProvider。publicabstractclassAIAgent{publicvirtualobject?GetService(TypeserviceType,object?serviceKeynull)(serviceKeynullserviceType.IsInstanceOfType(this))?this:null;publicTService?GetServiceTService(object?serviceKeynull)(GetService(typeof(TService),serviceKey)isTServiceval)?val:default(TService);}定义在AIAgent中的GetService和GetServiceTService方法也体现了在其他组件基类中的标准定义只能把自己作为服务实例提供出去。如果需要对外提供依赖服务可以重写虚方法GetService。作为整个Agent管道核心的ChatClientAgent采用如下的方式重写了GetService方法。publicsealedclassChatClientAgent:AIAgent{publicoverrideobject?GetService(TypeserviceType,object?serviceKeynull)base.GetService(serviceType,serviceKey)??(serviceTypetypeof(AIAgentMetadata)?this._agentMetadata:serviceTypetypeof(IChatClient)?this.ChatClient:serviceTypetypeof(ChatOptions)?this._agentOptions?.ChatOptions:serviceTypetypeof(ChatClientAgentOptions)?this._agentOptions:this.AIContextProviders?.Select(providerprovider.GetService(serviceType,serviceKey)).FirstOrDefault(ssisnotnull)??this.ChatHistoryProvider?.GetService(serviceType,serviceKey)??this.ChatClient.GetService(serviceType,serviceKey));}重写的GetService方法采用如下的策略顺序提供指定类型的服务对象调用基类的同名方法意味着如果指定的服务类型为ChatClientAgent会返回当前这个ChatClientAgent对象否则返回null如果服务类型为AIAgentMetadata目前的提供的元数据只有提供商的名称返回_agentMetadata字段如果服务类型为IChatClient返回ChatClient属性该属性表示有注册的ChatClient中间件和连接LLM的IChatClient对象组成的ChatClient管道如果服务类型为ChatClientAgentOptions返回_agentOptions字段该字段表示自身的配置选项依次利用注册的AIContextProvider、ChatHistoryProvider和ChatClient管道来提供指定的服务对象。表示Agent中间件的DelegatingAIAgent以虚方法的形式实现了此方法如果类型为当前类型则返回自己否则调用内部AIAgent的同名方法。publicabstractclassDelegatingAIAgent:AIAgent{protectedAIAgentInnerAgent{get;}publicoverrideobject?GetService(TypeserviceType,object?serviceKeynull){return(serviceKeynullserviceType.IsInstanceOfType(this))?this:InnerAgent.GetService(serviceType,serviceKey);}}3. 作为服务提供者的AIContextProvider和ChatHistoryProvider正如上面所说AIContextProvider和ChatHistoryProvider这些基础组件和AIAgent一样定义了GetService和GetServiceTService方法并且它们的定义方式如出一辙只能把自己作为服务实例提供出去。publicabstractclassAIContextProvider{publicvirtualobject?GetService(TypeserviceType,object?serviceKeynull)(serviceKeynullserviceType.IsInstanceOfType(this))?this:null;publicTService?GetServiceTService(object?serviceKeynull)(GetService(typeof(TService),serviceKey)isTServiceval)?val:default(TService);}publicabstractclassChatHistoryProvider{publicvirtualobject?GetService(TypeserviceType,object?serviceKeynull)(serviceKeynullserviceType.IsInstanceOfType(this))?this:null;publicTService?GetServiceTService(object?serviceKeynull)(GetService(typeof(TService),serviceKey)isTServiceval)?val:default(TService);}我已经多次诟病MAF的设计我觉得这里的设计有违基本的设计原则。作为最外层组件的AIAgent将它设计成服务提供者我还能接受但是将这种设计应用到内部组件类型比如AIContextProvider和ChatHistoryProvider就说不过去了。作为一个独立的组件它只需要关注自身的功能实现就可以了意味着它只需要关注实现自身的功能需要依赖怎样的服务对象而不需要关心需要对外提供哪些服务对象。采用这样的设计单一职责被破坏基础组件既要完成自己的核心功能又要承担服务发现。封装性被削弱调用方不再通过明确依赖注入而是通过GetService动态解析。耦合性增强从头到尾都必须遵循同样的服务发现接口否则链条断裂。这样的设计有违依赖倒置的原则如果我们将Agent最为最终的产物正确的做法是框架在构建Agent的时候利用自身的服务注册来为具体的组件注入依赖服务而不是让Agent作为一个代理的服务提供者反过来向这些基础组件拉取依赖服务。可能有人依然无法理解这种反模式。我们具体个例子假设我们需要自定义一个ChatHistoryProvider原则上我们只需要实现基于AgentSession针对对话历史的读写就可以我们无法确定也没有必要对外提供额外的服务对象。所以你会发现MAF提供的系统预定义组件几乎没有一个会重写GetService方法。换句话说每个组件只能将自己作为服务对象提供出去实现在基类的GetService方法中。既然如此只需要将提供组件自身实例的逻辑实现在自身的GetService方法上就可以了完全没有必要将这个Service Location链条延申下去。4. 依赖在ChatClient管道构建上的应用从GetService方法在ChatClientAgent中的定义可知此方法同样定义在IChatClient接口上。表示ChatClient中间件的DelegatingChatClient以虚方法的形式实现了此方法如果类型为当前类型则返回自己否则调用内部IChatClient的同名方法。我认为在此接口上定义GetService方法依然是一种反模式设计理由同上。publicinterfaceIChatClient:IDisposable{...object?GetService(TypeserviceType,object?serviceKeynull);}publicclassDelegatingChatClient:IChatClient,IDisposable{...protectedIChatClientInnerClient{get;}publicvirtualobject?GetService(TypeserviceType,object?serviceKeynull){if(serviceKey!null||!serviceType.IsInstanceOfType(this)){returnInnerClient.GetService(serviceType,serviceKey);}returnthis;}}但是在实现在ChatClientBuilder上基于依赖注入的方式来构件ChatClient管道是没有问题的。如下面代码所示不论是针对内部IChatClient对象还是ChatClient中间件的创建都体现为一个FuncIServiceProvider, IChatClient委托并在Build方法中利用提供的IServiceProvider对象作为依赖注入容器为这些IChatClient对象含中间件的创建提供依赖服务。publicsealedclassChatClientBuilder{privatereadonlyFuncIServiceProvider,IChatClient_innerClientFactory;privateListFuncIChatClient,IServiceProvider,IChatClient?_clientFactories;publicChatClientBuilder(IChatClientinnerClient)_innerClientFactory(IServiceProvider_)innerClient;publicChatClientBuilder(FuncIServiceProvider,IChatClientinnerClientFactory)_innerClientFactoryinnerClientFactory;publicIChatClientBuild(IServiceProvider?servicesnull){if(servicesnull){servicesEmptyServiceProvider.Instance;}IChatClientchatClient_innerClientFactory(services);if(_clientFactories!null){for(intnum_clientFactories.Count-1;num0;num--){chatClient_clientFactories[num](chatClient,services);if(chatClientnull){Microsoft.Shared.Diagnostics.Throw.InvalidOperationException($The{ChatClientBuilder}entry at index{num}returned null. Ensure that the callbacks passed to{Use}return non-null{IChatClient}instances.);}}}returnchatClient;}}如果调用Build方法没有显示指定IServiceProvider对象或默认使用如下这个直接返回null的EmptyServiceProvider单例对象。privatesealedclassEmptyServiceProvider:IServiceProvider,IKeyedServiceProvider{publicstaticEmptyServiceProviderInstance{get;}newEmptyServiceProvider();publicobject?GetService(TypeserviceType)null;publicobject?GetKeyedService(TypeserviceType,object?serviceKey)null;publicobjectGetRequiredKeyedService(TypeserviceType,object?serviceKey)thrownewInvalidOperationException($No service for type {serviceType} has been registered.);}在ChatClientAgent如下这个构造函数中如果UseProvidedChatClientAsIs配置选项没有被显式设置成trueIServiceProvider会以参数的形式传入WithDefaultAgentMiddleware扩展方法用来注册一系列默认的ChatClient中间件。该方法内部会利用ChatClientBuilder来构建ChatClient管道并利用提供的IServiceProvider来提供这些中间件所需的依赖服务。目前WithDefaultAgentMiddleware方法在将中间件注册到ChatClientBuilder时根本没有使用到ISeriviceProvider意味着目前ChatClientAgent构造函数的services参数根本不需要传传了了没有用。虽然这种设计冗余没有意义不过考虑到services是一个可选的此参数也能接受。publicsealedclassChatClientAgent:AIAgent{publicChatClientAgent(IChatClientchatClient,ChatClientAgentOptions?options,,ILoggerFactory?loggerFactorynull,IServiceProvider?servicesnull){...ChatClient((options?.UseProvidedChatClientAsIs??false)?chatClient:chatClient.WithDefaultAgentMiddleware(options,services));}}5. AIAgent的GetService究竟可以提供什么回到最初的问题当我们自定义一个组件时可以从AIAgent的静态属性CurrentRunContext得到代表当前AgentRunContext上下文。有了此上下文我们就能得到当前运行的AIAgent自然就可以调用其GetService方法得到所需的依赖服务。根据上面对这个方法实现逻辑的介绍我们总结了一下指定的服务类型具体返回的服务对象具体的Agent中间件类型组成Agent管道的指定类型的Agent中间件。ChatClientAgent: 当前ChatClientAgent对象AIAgentMetadata: 承载供应上名称的AIAgentMetadata对象IChatClient当前ChatClient管道中间件连接LLM的IChatClient对象ChatClientAgentOptions 当前ChatClientAgent的配置选项具体的AIContextProvider类型注册的指定类型的AIContextProvider对象具体的ChatHistoryProvider注册的指定类型的ChatHistoryProviderChatClient中间件类型组成ChatClient管道的指定类型的ChatClient中间件。当然如果我们注册了自定义的AIContextProvider、ChatHistoryProvider或者Agent中间件和ChatClient中间件对应的类型重写了GetService方法提供的类型也可以通过当前AIAgent的GetService方法提取到。