nagisa 0.2.0

快速上手 · 安装 · 协议与传输 · 示例 · 设计要点 · docs.rs ↗

nagisa 是 Rust QQ bot 框架库，把 OneBot v11 与 Milky 两套协议统一到一套强类型 API 之下：业务代码只看见 Event / Message / Segment / Peer / Uin / MessageId，不碰协议 JSON 与 retcode，切换协议端零业务改动。协议端（Lagrange / NapCat / LLOneBot 等真正登录 QQ 的外部程序）需自行部署，nagisa 负责连上它。

flowchart LR
    P["协议端<br/>Lagrange · NapCat · LLOneBot"]
    subgraph nagisa
        direction LR
        A["适配器<br/>onebot · milky"]
        E["统一域模型<br/>Event · Segment · Peer"]
        R["Router 三层分发<br/>门控 · 冷却 · 中间件"]
        H["你的 handler"]
        A -->|解码| E --> R --> H
        H -->|"Reply · bot 动作"| A
    end
    P <-->|"WS · HTTP · SSE"| A

安装

[dependencies]
nagisa = "0.2"                                     # 默认含 onebot + milky 两套适配器
# nagisa = { version = "0.2", features = ["log"] } # 额外开事件日志（控制台 / 文件渲染）

或一行 cargo add nagisa。另需一个已登录 QQ 的协议端（Lagrange / NapCat / LLOneBot 等）在外部运行，Nagisa 负责连上它。

快速上手

use nagisa::prelude::*;

// 「@bot echo 你好」 → 「echo: 你好」
#[command("echo", mention_me)]
async fn echo(reply: Reply, args: ArgText) -> HandlerResult {
    reply.text(format!("echo: {}", args.0)).await?;
    Ok(())
}

#[tokio::main]
async fn main() -> Result<()> {
    App::new()
        .run_onebot(
            OneBotConfig::new("ws://127.0.0.1:8080/onebot/v11/ws"),
            ctrl_c_shutdown(),
        )
        .await
}

• 换协议：run_onebot(OneBotConfig::new(..)) → run_milky(MilkyConfig::new(..))，handler 一字不改。
• 前提：一个已登录 QQ 的协议端（见 安装）。
• use nagisa::prelude::*; 是业务侧唯一需要的导入，不直接引用 nagisa-core / nagisa-types 等底层 crate。

命令

#[command(
    "转账", "transfer",                  // 命令词 = 前导位置参数(匹配器三选一,见下表)
    mention_me,                          // 要求 @bot
    gate = group_admin() | superuser(),  // 门控:任意 Rule 表达式
    cooldown = 30,                       // 冷却(秒);被 gate 拒掉的尝试不消耗
    description = "给别人转账",
    usage = "转账 @某人 <金额>",
)]
async fn transfer(reply: Reply, args: Args<Transfer>) -> HandlerResult {
    let Transfer { target, amount } = args.0;
    // ...
    Ok(())
}

#[command(..)] 属性键：

命令头写在属性里，参数声明在 handler 形参上（Args<T> / ArgText 等），就近落在同一个函数。

参数

#[derive(Args)]
struct Transfer {
    #[arg(at_or_id)] target: Uin,                    // @某人 或 裸 QQ 号
    amount: u64,                                     // 文本位置参数
    #[arg(long, short = 'm')] memo: Option<String>,  // --memo xx / -m xx
    #[arg(flag, short = 'f')] force: bool,           // -f / --force
}

#[arg(..)] 字段属性：

文本字段类型需实现 FromArg（String / 整数 / f64 / bool / Uin 内置）；元素字段类型固定：image/record/video → Media、at → Uin、reply → MessageId、face → String。受限选项用 #[derive(ArgEnum)]（变体名小写匹配，#[arg(rename = "原曲", alias = "origin")] 改名/加别名）。

另一套头匹配：#[derive(Slots)] 把「命令头 + 命名正则槽」结构体化——#[slots(full = "签到", usage = "..")] + 字段上 #[slot(re = r"(\d+)")] / #[slot(union = ["a", "b"])] / #[slot(tail)]，同一类型既当 #[command(slots = T)] 的头又当 Slots<T> 提取器；matcher!{} 是它的内联纯匹配器糖。

事件

#[event(MemberJoin, description = "新人入群欢迎")]
async fn welcome(reply: Reply, join: MemberJoin) -> HandlerResult {
    reply.msg().at(join.user).text(" 欢迎!").send().await?;
    Ok(())
}

#[event(<Kind>, ..)] 第一个位置参数是 EventKind 变体，其余键同 #[command]（top / priority / gate / cooldown / 元数据；无匹配器，usage 被显式拒绝）。可用 Kind：

• 消息：Message
• 群通知：MemberJoin MemberLeave Mute WholeMute AdminChange GroupNameChange GroupCardChange GroupTitleChange GroupDismiss Honor LuckyKing EssenceChange Recall Reaction GroupFileUpload
• 好友/杂项通知：FriendAdd FriendFileUpload Nudge PokeRecall PeerPin InputStatus ProfileLike GrayTip OnlineFile FlashFile
• 请求：FriendRequest GroupJoinRequest GroupInvitedJoin GroupInvite
• 生命周期：Connect Disconnect Ready（self_id 解析完成，启动逻辑写在这）Heartbeat BotOnline BotOffline
• 兜底：Raw

插件与开关

plugin! {
    name = "复读机",
    key = "echo",
    category = Fun,                 // Core | User | Tool | Fun | Push | Admin 之一
    description = "把你说的话再说一遍",
    usage = "echo <内容>",
    // 可选:version / can_disable / default_enable / hidden / maintain
}

同模块（及子模块）里的 #[command] / #[event] 按 module_path!() 最长前缀自动归属本插件，App::new() 经 inventory 一次性收集，main 里零登记代码。不在任何 plugin!{} 模块下的裸 #[command] 会落进按 module_path 合成的隐式插件——没有像样的身份和开关，别这么写。开关分两层：插件总开关 + 每触发器子开关（echo / echo.transfer），按会话覆盖 > 全局 > 默认；registered_plugins() / registered_triggers() 可枚举注册表。

注册可见性：inventory 靠链接器收集注册项。插件 crate 若没被 binary 源码引用，会被链接器整体丢弃——命令静默消失，零报错。务必 use my_plugins::*; 或调一次 force_link()，详见 App::new 文档。

门控与冷却

内置 Rule，用 & | ! 组合（左短路）：

注意 group_admin() / group_owner() 在私聊场景恒为否（fail-closed），跨场景管理命令写 gate = group_admin() | superuser()。

冷却三种用法：cooldown = 30（每用户全局桶）；cooldown = Cooldown::new(30).per_trigger().max_exec(3).bypass(superuser())（滑动窗口多次额度，.per_peer() / .global() 改作用域）；数据派生的条件冷却用 Cd 提取器命令式控制——cd.gate(key, dur)? 检查并盖章、cd.ready(key, dur) 只看不盖、cd.stamp(key, dur) 成功后才盖。全局限流用 RateLimit 中间件（App::layer）。

提取器

handler 形参按类型注入，类型提不出来时该 handler 自动跳过；Option<T> 把任一项变成可选。

自定义提取器：给类型实现 FromContext（impl 块标 #[nagisa::async_trait]）。

多轮会话

#[command("猜词")]
async fn start(reply: Reply, ep: EventPeer, session: Session) -> HandlerResult {
    let waiter = session.waiter().scope(Scope::peer(ep.0)).build(); // 整个群的下一条消息
    reply.text("开始猜词,直接发答案(发\"取消\"结束)").await?;
    while let Some(m) = waiter.recv::<GroupMessage>(Duration::from_secs(60)).await {
        // 看 m 决定回应、break 或继续等
    }
    Ok(())
}

• recv::<T>() 可等任意提取器类型——等图片就 recv::<Image>()，和读内联参数 #[arg(image)] 得到的是同一个 Media，「内联给参或事后追问」一处分支搞定。
• 高层封装：confirm(d, 谁, "是", "否")（只收指定用户的回复，认不出的输入自动追问）、recv_text(d, 取消词)、recv_parse(d, 取消词, 解析fn)——解析失败自动回贴追问。
• 嵌套会话深者优先，guard Drop 自动摘除；命中的 waiter 默认吞掉该事件（top 观察者不受影响，恒跑）。
• session.single_flight_user()：同一用户的多步流程加 single-flight 闸，防并发竞态。
• 跨会话配对用 Rendezvous<K, V>（带 TTL 的「一处发码、另一处认领」，如群里贴 token、私聊认领绑定）。

发消息

reply.text("收到").await?;                          // 单段快捷:text / image / at / face
reply.reply("收到").await?;                         // 同上,但引用触发消息
reply.msg().at(u).text(" 欢迎!").image_path(p)      // 混排链式:text / at / at_all / face
    .send().await?;                                 //   / image_url / image_bytes / image_path
                                                    //   / reply_to_trigger / push(Segment)
let m = Msg::new().text("公告").image_url(url).build(); // 脱离 Reply 拼 Message
bot.send(peer, m).await?;                           //   交给 bot 发到任意会话

reply.send(&[Segment]) / reply.quote(..) 直接收段数组；链式收尾用 .send() 或 .quote()（带引用）。所有发送都返回 MessageId，可存下来供撤回/引用。

动作

bot.send(peer, msg).await?;               // 通用动作:Bot 上的 inherent 方法
bot.group(g).member(u).mute(600).await?;  // 类型化目标选择器
bot.actions().<vendor 专属方法>(..).await?; // 厂商/协议专属直达(OneBot 侧 145 个、Milky 侧 12 个)

当前端不支持的动作返回 Error::Unsupported（不会编译失败）：bot.supports(Capability::..) 运行时探测、err.is_unsupported() 降级。连上后框架读 get_version_info 判定 Vendor（Lagrange / NapCat / LLOneBot / Other）自动选 per-vendor 动作名别名；Milky 端经 ImplInfo 识别。逃生口：入站解不出的内容降级 Event::Raw / Segment::Raw 不丢数据，出站有 call_raw 直发任意动作。

App

协议与传输

协议端是真正登录 QQ、需你自行部署的外部程序；nagisa 连上它，并按其上报信息自动识别厂商、抹平各家动作名差异。已适配：

• OneBot v11：Lagrange.OneBot / NapCat / LLOneBot
• Milky：Lagrange.Milky / LLOneBot

连接这些协议端的传输方式：

OneBot 动作走同连接 echo 关联（WS），或把动作名接在 api_url 后 POST（{api_url}/<action>）；Milky 动作统一 POST 到 /api/<action>。访问令牌 .with_token(..)。

feature 与日志

log feature 提供：init() 统一初始化（控制台 + 可选文件，返回的 LogGuard 须持有到退出；RUST_LOG 优先于配置）、EventLog 观察者（把事件渲染成可读日志行，含出站消息回显、名称缓存、撤回预览）、LogBus（log-as-event 广播）。

Workspace crate 地图

graph TD
    APP["你的 bot 应用"] --> FAC["nagisa · 门面<br/>App + prelude"]
    FAC --> CORE["nagisa-core · 引擎"]
    FAC --> MAC["nagisa-macros · 宏"]
    FAC -. feature onebot .-> OB["nagisa-onebot"]
    FAC -. feature milky .-> MK["nagisa-milky"]
    FAC -. feature log .-> LOG["nagisa-log"]
    CORE --> TY["nagisa-types · 域模型"]
    OB --> CORE
    MK --> CORE
    LOG --> CORE
    OB --> TY
    MK --> TY
    LOG --> TY

分层视角（自顶向下，依赖向内收敛到 nagisa-types）：

┌─ 你的 bot 应用 ── 数据 · 渲染 · 功能插件 ────────────────────┐
└──────────────────────────────┬───────────────────────────────┘
                               │ 依赖 nagisa（按需选 features）
┌──────────────────────────────▼──── nagisa（门面）─────────────────┐
│ App builder + prelude + re-export                                │
├──────────────────────────────────────────────────────────────────┤
│ nagisa-core  引擎：Ctx · 提取器 · Router · 门控 · Session/Waiter   │
│            · Cooldown · Rendezvous · Service · Bot/Actions        │
│            · 适配器共享基建（重连退避 / 读泵 / SSE / wire 日志）  │
│ nagisa-macros  #[command] / #[event] / plugin! / derive(Args/…)    │
│ nagisa-types   统一域模型（纯数据，无 async）                       │
│ nagisa-log     事件日志 + 名称缓存（feature "log"）                 │
├───────────────────────────┬──────────────────────────────────────┤
│ nagisa-onebot（OneBot v11）  │  nagisa-milky（Milky）                 │
│ 6 种传输                   │  WS / SSE / WebHook                  │
└───────────────────────────┴──────────────────────────────────────┘
        ↓ 外部进程                    ↓ 外部进程
   Lagrange.OneBot / NapCat      Lagrange.Milky / …
   / LLOneBot

设计要点

• 防御式反序列化（在适配器 wire 层）：serde(default) + Option + #[serde(other)]，从不 deny_unknown_fields；解不出的入站事件降级 Raw，不丢、不 panic。
• 错误口径：自有 Result / Error + Context trait（.context(..) / .with_context(..) 归一 sea-orm / reqwest 等任意外部错误），不依赖 anyhow；handler 内 bail!("..") 提前返回。handler 返回 Err 由框架捕获并记 warn 日志，分发继续、不自动回贴用户——要给用户反馈，返回前自行 reply。动作失败按 ActionErrorKind 粗分类，不要比对具体 retcode 数字（各端不一致）。
• 加固：动作 echo 超时（10s）+ 挂起槽回收、断线指数退避重连（500ms → 30s）、连接 90s idle 看门狗、handler panic 任务级隔离、关停时全任务收束。
• 不透明 MessageId：OneBot 的 i32 与 Milky 的三元组都装得下，业务永不做算术/比较。

示例

crates/nagisa/examples/，cargo run --example <名字>（需要在线协议端）：

完整真实工程见 abot-rs —— 一个基于 nagisa 搭建的多插件 QQ bot。

项目状态

早期项目，API 还会变。刻意零测试——门禁是 cargo build + cargo clippy -D warnings + cargo doc 零警告，正确性靠真实协议端连线实测。

最佳实践

• description / usage 当用户文案写——帮助菜单直接由 registered_plugins() 按 category 分组生成（跳过 hidden），这两个字段就是用户看到的话，新插件零改动上架。
• 参数宽进、handler 解释：Args 字段尽量 Option，缺了什么用人话回复，而不是让框架硬拒。
• 插件自有数据不破墙：复用 nagisa::inventory 搭自己的扩展点（插件自带数据库迁移、个人面板贡献槽，由核心统一收集），核心代码不引用任何具体插件。

可运行的最小用法见 crates/nagisa/examples/(命令/多轮会话/开关管理/事件处理各一例)。

License

MIT OR Apache-2.0