Bottender 开源项目使用教程

1. 项目目录结构及介绍

Bottender 是一个用于构建对话式用户界面（Conversational UI）的框架，它简化了在不同通讯渠道上创建应用的过程，确保用户体验原生且一致。以下是Bottender项目的基本目录结构及其简介：

bottender-project/
├── src                      # 应用的主要源代码目录
│   ├── app.js               # 主应用程序逻辑所在，定义bot的行为和响应
│   └── ...                  # 可能包括更多的功能模块或中间件
├── config.js                # 配置文件，设置bot的运行环境和渠道参数
├── package.json             # 项目元数据，包括依赖项和脚本命令
├── yarn.lock OR npm.lock    # 包版本锁定文件
├── .env                     # 环境变量配置，可选，存储敏感信息如令牌
└── README.md                # 项目说明文档

• src/app.js 或相应命名的应用文件是启动点，定义了Bot如何响应不同的事件。
• config.js 包含了所有需要配置的信息，如频道接入设置等。
• package.json 记录项目依赖、脚本等，对于启动和管理项目至关重要。

2. 项目的启动文件介绍

启动文件通常位于 src/app.js （或者根据你的项目结构可能有所不同），它是控制Bot行为的核心。在这个文件中，您将定义如何处理接收到的消息和其他事件。例如，通过引入路由 (router) 和定义不同的响应函数来处理文本消息、按钮点击等交互。基本架构可能如下：

const { Router } = require('bottender/router');

async function sayHello(context) {
    await context.sendText('你好！');
}

module.exports = function App(context) {
    return Router()
        .text('你好', sayHello)
        // 处理其他情况...
};

这段代码展示了如何基于用户输入的文字触发特定的动作，这里是回复用户“你好”。

3. 项目的配置文件介绍

配置文件，通常是 config.js，负责设置应用的关键配置项，比如渠道的接入信息、服务器监听端口、Webhook的URL、签名验证机制等。这使得Bot能够适应各种部署需求，并与不同的消息平台进行有效的集成。示例配置可能包括：

module.exports = {
    endpoints: [
        {
            path: '/webhook',
            connector: 'line', // 假设使用Line作为通讯渠道
            verifyToken: 'YOUR_VERIFY_TOKEN',
        },
    ],
    // 其他配置项...
};

这里的配置指示Bottender在指定路径 /webhook 上监听 Line 渠道的请求，verifyToken 用于验证Webhook的合法连接。

---

请注意，实际的配置和目录结构可能会因项目版本更新而有所变化，上述内容提供了一个基础的概览。在开始新的项目之前，推荐查看Bottender的官方文档获取最新的指南和最佳实践。