Go-CQHTTP 快速入门教程-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00699/article/details/141011810

Go-CQHTTP 快速入门教程

go-cqhttpcqhttp的golang实现，轻量、原生跨平台.项目地址:https://gitcode.com/gh_mirrors/go/go-cqhttp

1. 项目目录结构及介绍

Go-CQHTTP 的源代码目录结构如下：

.
├── cmd          # 包含可执行程序的源码，如 go-cqhttp
├── coolq        # 针对酷Q接口的实现
├── db           # 数据存储相关代码
├── docs         # 文档资料
├── global       # 全局数据及配置
├── internal     # 内部使用的模块
├── modules      # 扩展插件或功能模块
├── pkg/onebot    # OneBot 相关的包
├── scripts      # 脚本或辅助工具
├── servers      # 服务器相关代码，例如 HTTP 和 WebSocket
├── winres       # Windows 平台资源文件
├── .dockerignore
├── .gitignore
├── .golangci.yml
├── .goreleaser.yml
├── CONTRIBUTING.md
├── Dockerfile
├──/LICENSE
├── README.md
└── ...

cmd: 主要的可执行文件，包括 go-cqhttp 的命令行入口。
coolq: 用于与酷Q (CQHTTP 插件) 进行交互的代码。
db: 存储用户数据和状态的数据库模块。
docs: 项目的文档内容。
global: 项目全局配置和数据。
internal: 提供内部使用的类和函数。
modules: 可以添加的模块，扩展Go-CQHTTP的功能。
pkg/onebot: 实现了OneBot标准的API接口。
scripts: 辅助脚本和工具。
servers: 提供HTTP API和WebSocket服务的代码。
winres: Windows下的资源文件。
其他文件如 .gitignore, .golangci.yml, Dockerfile 通常用于构建和持续集成。

2. 项目的启动文件介绍

启动文件通常是 cmd/go-cqhttp/main.go。这个文件包含了项目的主入口点，负责初始化配置，加载插件和启动服务器。在部署时，你可以通过编译 cmd/go-cqhttp 文件夹得到可执行文件，然后运行它来启动Go-CQHTTP。

在终端中，进入项目目录并编译go-cqhttp：

$ cd cmd/go-cqhttp
$ go build

完成后，在同级目录下会产生一个名为 go-cqhttp 的二进制文件，执行这个文件即可启动服务。

$ ./go-cqhttp

3. 项目的配置文件介绍

Go-CQHTTP 使用 JSON 格式的配置文件，一般命名为 config.json。这个文件位于项目根目录，包含了Go-CQHTTP的各项配置参数，比如监听端口、日志级别、连接到酷Q的方式等。

以下是一个基础的 config.json 示例：

{
    "cqhttp": {
        "mode": "ws",
        "host": "127.0.0.1",
        "port": 6700,
        "password": "your-password"
    },
    "logging": {
        "level": "info",
        "format": "text"
    },
    "http": {
        "host": "0.0.0.0",
        "port": 5700,
        "enableWebsocket": true,
        "wsHost": "localhost",
        "wsPort": 8080,
        "webPath": "/",
        "allowCrossOrigin": "*"
    }
}