本文将详细介绍如何在 c# 后端项目中集成 codebuddy cli,实现 ai 编程助手能力的完整方案。
背景
在现代 ai 代码助手开发中,单一 ai provider 往往无法满足复杂多变的开发场景。这就像,人生路远,总不能只认一个方向吧?hagicode 作为一款多功能 ai 编程助手,需要支持多种 ai provider 以提供更好的用户体验。毕竟,用户的选择权还是要给够的。在 2026 年初,项目面临一个关键决策:如何在 c# 后端中恢复 codebuddy 的 acp(agent communication protocol)集成能力。
此前项目中曾实现过 codebuddy 对接,但相关代码在一次重构中被移除了。其实也没什么好抱怨的,代码迭代嘛,总有东西要被遗忘。本次技术方案的目标是完整恢复这一能力,并优化架构使其更加健壮和可维护。
如果你也在考虑为自己的项目接入多种 ai 编程助手,下面的方案或许能给你一些启发——这可是我们踩了无数坑之后总结出来的经验。或许能让你少走点弯路,也算是我做过的一点好事吧。
关于 hagicode
本文分享的方案来自我们在 hagicode 项目中的实践经验。hagicode 是一个开源的 ai 代码助手项目,支持多种 ai provider 和跨平台运行。为了满足不同用户的偏好,我们需要能够灵活切换各种 ai 编程助手,这就有了本文要介绍的 codebuddy 集成方案。
hagicode 采用模块化设计,ai provider 作为可插拔的组件,这种架构让我们可以轻松添加新的 ai 支持,而不影响现有功能。这也罢了,设计这种东西,当初做得好,后面省心不少。如果你对我们的技术架构感兴趣,可以在 github 上查看完整源码。
架构设计
分层架构概览
c# 与 codebuddy 的对接采用清晰的分层架构,这种设计让代码职责分明,后期维护起来也更加方便:
┌─────────────────────────────────────────────┐ │ provider 契约层 │ │ aiprovidertype 枚举 + 扩展方法 │ ├─────────────────────────────────────────────┤ │ provider 工厂层 │ │ aiproviderfactory 依赖注入工厂 │ ├─────────────────────────────────────────────┤ │ provider 实现层 │ │ codebuddycliprovider 具体实现 │ ├─────────────────────────────────────────────┤ │ acp 基础设施层 │ │ acpsessionmanager / stdioacptransport │ │ acprpcclient / acpagentclient │ └─────────────────────────────────────────────┘
这种分层的好处是什么呢?简单说就是各层之间互不打扰。假设以后要换一种通信方式(比如从 stdio 改成 websocket),你只需要改最下面那一层,上面的业务代码完全不用动。毕竟,谁也不想牵一发而动全身,改个通信方式还要改半天业务代码,那也太惨了。
核心组件解析
provider 契约层 是整个架构的基石。我们定义了 aiprovidertype 枚举,其中 codebuddycli = 3 作为枚举值,通过扩展方法实现字符串与枚举的双向映射。这样配置文件中的字符串可以很方便地转成枚举,调试时枚举也能转成字符串输出。这也罢了,其实就是个映射关系,但做好了就是省心。
provider 工厂层 负责根据配置创建对应的 provider 实例。这里使用了 .net 的依赖注入机制,配合 activatorutilities.createinstance 实现动态创建。工厂模式的好处在于,新增一个 provider 时只需要添加创建逻辑,不用修改已有的代码。这和写文章差不多,想加个新章节,就加个新章节,不用把前面的都重写一遍。
provider 实现层 是真正干活的地方。codebuddycliprovider 实现了 iaiprovider 接口,提供 executeasync(非流式)和 streamasync(流式)两种调用方式。
acp 基础设施层 则是通信的底层支撑。这一层处理所有的协议细节,包括进程管理、消息序列化、响应解析等。就像房子的地基,上面盖得再漂亮,底下的东西得稳才行。
通信机制
stdio 传输模式
codebuddy 使用 stdio(标准输入输出) 方式与外部进程通信。启动命令很简单:
codebuddy --acp
然后通过标准输入输出进行 json-rpc 消息交换。这种方式的优势在于:
- 启动迅速:本地进程通信没有网络延迟
- 配置简单:只需要指定可执行文件路径
- 环境隔离:每个会话独立进程,互不影响
通信过程中支持环境变量注入,常用的包括:
codebuddy_api_key:api 密钥认证codebuddy_internet_environment:网络环境配置
这就像,人与人之间的沟通,找个方便的方式,才能说得上话。
消息协议
acp 基于 json-rpc 2.0 协议,消息格式大概是酱紫的:
// 请求消息
{
"jsonrpc": "2.0",
"id": 1,
"method": "agent/prompt",
"params": {
"prompt": "帮我写一个排序算法",
"sessionid": "session-123"
}
}
// 响应消息
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"content": "这里是 ai 的回复..."
}
}实际实现中,我们把这些协议细节都封装好了,上层业务代码只需要关注 prompt 和 response 就行。这也罢了,封装得好,后面的人用起来就舒服点。
核心实现
1. provider 契约恢复
首先在枚举文件中恢复 codebuddy 类型:
// pcode.models/aiprovidertype.cs
public enum aiprovidertype
{
claudecodecli = 0,
codexcli = 1,
githubcopilot = 2,
codebuddycli = 3, // 恢复这个枚举值
opencodecli = 4,
iflowcli = 5,
}然后在扩展方法中添加字符串映射,这样配置文件就可以用字符串指定 provider:
// aiprovidertypeextensions.cs
private static readonly dictionary<string, aiprovidertype> _typemap = new(
stringcomparer.ordinalignorecase)
{
["codebuddycli"] = aiprovidertype.codebuddycli,
["codebuddy"] = aiprovidertype.codebuddycli,
["codebuddy"] = aiprovidertype.codebuddycli,
// ... 其他 provider 的映射
};2. provider 工厂集成
在工厂类中添加 codebuddy 的创建分支:
// aiproviderfactory.cs
private iaiprovider? createprovider(aiprovidertype providertype, providerconfiguration config)
{
return providertype switch
{
aiprovidertype.codebuddycli =>
activatorutilities.createinstance<codebuddycliprovider>(
_serviceprovider,
options.create(config)),
// ... 其他 provider
_ => throw new notsupportedexception($"provider {providertype} not supported")
};
}这里用了依赖注入的 activatorutilities,它会自动处理构造函数的参数注入,非常方便。这也罢了,.net 的东西,用对了就是省心。
3. 完整的 provider 实现
下面是 codebuddycliprovider 的核心实现,包含了流式和非流式两种调用方式:
public class codebuddycliprovider : iaiprovider
{
private readonly ilogger<codebuddycliprovider> _logger;
private readonly iacpsessionmanager _sessionmanager;
private readonly providerconfiguration _config;
public string name => "codebuddycli";
public bool supportsstreaming => true;
public providercapabilities capabilities { get; }
public codebuddycliprovider(
ilogger<codebuddycliprovider> logger,
iacpsessionmanager sessionmanager,
ioptions<providerconfiguration> config)
{
_logger = logger;
_sessionmanager = sessionmanager;
_config = config.value;
// 定义当前 provider 的能力
capabilities = new providercapabilities
{
supportsstreaming = true,
supportstools = true,
supportssystemmessages = true,
supportsartifacts = false,
maxtokens = 8192
};
}
// 非流式调用:等所有结果一起返回
public async task<airesponse> executeasync(
airequest request,
cancellationtoken cancellationtoken = default)
{
// 为请求创建独立会话
var session = await _sessionmanager.createsessionasync(
"codebuddycli",
request.workingdirectory,
cancellationtoken,
request.sessionid);
try
{
var fullprompt = buildprompt(request);
await session.sendpromptasync(fullprompt, cancellationtoken);
var responsebuilder = new stringbuilder();
var toolcalls = new list<aitoolcall>();
// 收集所有响应块
await foreach (var chunk in streamfromsession(session, cancellationtoken))
{
if (!string.isnullorempty(chunk.content))
{
responsebuilder.append(chunk.content);
}
// 处理工具调用...
}
return new airesponse
{
content = airesultcontentsanitizer.sanitizeresultcontent(
responsebuilder.tostring()),
toolcalls = toolcalls,
provider = name,
model = string.empty
};
}
finally
{
// 释放会话资源
await session.disposeasync();
}
}
// 流式调用:实时返回响应块
public async iasyncenumerable<aistreamingchunk> streamasync(
airequest request,
[enumeratorcancellation] cancellationtoken cancellationtoken = default)
{
var session = await _sessionmanager.createsessionasync(
"codebuddycli",
request.workingdirectory,
cancellationtoken);
try
{
var fullprompt = buildprompt(request);
await session.sendpromptasync(fullprompt, cancellationtoken);
await foreach (var chunk in streamfromsession(session, cancellationtoken))
{
yield return chunk;
}
}
finally
{
await session.disposeasync();
}
}
private async iasyncenumerable<aistreamingchunk> streamfromsession(
iacpsession session,
[enumeratorcancellation] cancellationtoken cancellationtoken)
{
// 遍历会话中的所有更新
await foreach (var notification in session.receiveupdatesasync(cancellationtoken))
{
switch (notification.update)
{
case agentmessagechunksessionupdate agentmessage:
// 处理文本内容块
if (agentmessage.content is acpimp.textcontentblock textcontent)
{
yield return new aistreamingchunk
{
content = textcontent.text,
type = streamingchunktype.contentdelta,
iscomplete = false
};
}
break;
case toolcallsessionupdate toolcall:
// 处理工具调用
yield return new aistreamingchunk
{
content = string.empty,
type = streamingchunktype.toolcalldelta,
toolcalldelta = new aitoolcalldelta
{
id = toolcall.toolcallid,
name = toolcall.kind.tostring(),
arguments = toolcall.rawinput?.tostring()
}
};
break;
case acpimp.promptcompletedsessionupdate:
// 响应完成
yield break;
}
}
}
// 构建完整的提示词
private string buildprompt(airequest request, string? embeddedcommandprompt = null)
{
var sb = new stringbuilder();
// 嵌入命令提示词(如果有)
if (!string.isnullorempty(embeddedcommandprompt))
{
sb.appendline(embeddedcommandprompt);
sb.appendline();
}
// 系统消息
if (!string.isnullorempty(request.systemmessage))
{
sb.appendline(request.systemmessage);
sb.appendline();
}
// 用户 prompt
sb.append(request.prompt);
return sb.tostring();
}
}
这段代码有几个关键点:
- 会话管理:每个请求创建独立会话,请求完成后释放资源。这是坑踩出来的经验——如果会话复用做得不好,很容易出现状态污染的问题。毕竟,用过就得收拾干净,不然下次用的人就麻烦了。
- 流式处理:
iasyncenumerable让响应可以边生成边返回,不用等全部内容生成完。这对于长文本场景特别重要,用户体验会好很多。就像,等结果的人也不想一直干等着不是。 - 工具调用:codebuddy 支持工具调用(function calling),通过
toolcallsessionupdate处理。这个能力对于复杂的代码编辑任务很关键。 - 内容过滤:使用
airesultcontentsanitizer过滤 think 块内容,保持输出干净。
4. 依赖注入配置
在模块注册中添加相关服务:
// pcodeclaudehelpermodule.cs
public void configuremodule(iservicecollection context)
{
// 注册 provider
context.services.addtransient<codebuddycliprovider>();
// 注册 acp 基础设施
context.services.addsingleton<iacpsessionmanager, acpsessionmanager>();
context.services.addsingleton<iacpplatformconfigurationresolver, acpplatformconfigurationresolver>();
context.services.addsingleton<iairequesttoacpmapper, airequesttoacpmapper>();
context.services.addsingleton<iacptoairesponsemapper, acptoairesponsemapper>();
}
配置示例
配置文件
在 appsettings.json 中添加 codebuddy 相关配置:
ai:
# 默认使用的 provider
defaultprovider: "codebuddycli"
# provider 配置
providers:
codebuddycli:
type: "codebuddycli"
workingdirectory: "c:/projects/my-app"
executablepath: "c:/tools/codebuddy.cmd"
# 平台相关配置
platformconfigurations:
codebuddycli:
executablepath: "c:/tools/codebuddy.cmd"
arguments: "--acp"
startuptimeoutms: 5000
environmentvariables:
codebuddy_api_key: "${codebuddy_api_key}"
codebuddy_internet_environment: "production"配置模型
对应的配置模型定义:
public class codebuddyplatformconfiguration : iacpplatformconfiguration
{
public string providername => "codebuddycli";
public acptransporttype transporttype => acptransporttype.stdio;
public string executablepath { get; set; } = "codebuddy";
public string arguments { get; set; } = "--acp";
public int startuptimeoutms { get; set; } = 5000;
public dictionary<string, string?>? environmentvariables { get; set; }
}实践经验总结
踩坑记录
我们在实现过程中遇到了几个典型的坑,分享出来让大家少走弯路。毕竟,别人的坑,自己能避开就是好事:
- 会话泄漏问题:一开始没有正确释放会话,导致进程资源耗尽。解决方法是使用
try-finally确保每次请求都会释放资源。这也罢了,用过的东西得放回去,不然后面的人用什么。 - 环境变量传递:windows 和 linux 的环境变量语法不同,后来统一使用
dictionary<string, string?>来处理。跨平台这种事,一开始就统一规范,后面就省心。 - 超时配置:cli 启动需要时间,设置了 5 秒的启动超时,避免快速请求失败。凡事都得有个度,太急了反而办不成事。
- 编码问题:windows 上默认编码可能导致中文乱码,在启动进程时显式指定 utf-8 编码。中文显示不出来,那多难受。
性能优化
- 会话池:对于频繁的短请求,可以考虑实现会话池来复用进程
- 连接缓存:工厂类已经支持 provider 实例缓存
- 异步优先:全程使用异步编程,避免阻塞线程
性能这种事,能优化就优化,毕竟用户等的越久,体验就越差。
总结
本文详细介绍了 c# 后端集成 codebuddy cli 的完整方案,涵盖了从架构设计到具体实现的全过程。通过分层架构设计,我们将协议细节与业务逻辑分离,使得代码更加清晰和可维护。
核心要点回顾:
- 采用 provider 契约层、工厂层、实现层、基础设施层的分层架构
- 使用 json-rpc over stdio 方式进行进程间通信
- 通过依赖注入实现灵活的配置和扩展
- 提供流式和非流式两种调用方式
这套方案不仅适用于 codebuddy,添加新的 ai provider 也遵循同样的模式。如果你也在做类似的多 ai provider 集成,希望这篇文章能给你一些参考。其实,写文章和写代码一样,分享出来,能帮到别人就算没白写。
以上就是c#后端集成codebuddy cli的完整方案的详细内容,更多关于c#集成codebuddy cli的资料请关注代码网其它相关文章!
发表评论