{"id":17998432,"url":"https://github.com/kosaka-bun/qqrobot-sdk","last_synced_at":"2025-04-04T08:07:13.572Z","repository":{"id":59131859,"uuid":"312600167","full_name":"kosaka-bun/qqrobot-sdk","owner":"kosaka-bun","description":"QQ机器人一站式开发框架","archived":false,"fork":false,"pushed_at":"2025-02-14T14:41:27.000Z","size":2763,"stargazers_count":258,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-28T07:06:34.544Z","etag":null,"topics":["dependency","maven","qqbot","qqbot-framework","spring-boot"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kosaka-bun.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-11-13T14:37:50.000Z","updated_at":"2025-01-13T07:34:06.000Z","dependencies_parsed_at":"2024-01-01T10:22:51.488Z","dependency_job_id":"c6c30011-1c01-4de0-9de9-cd1468ca39de","html_url":"https://github.com/kosaka-bun/qqrobot-sdk","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kosaka-bun%2Fqqrobot-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kosaka-bun%2Fqqrobot-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kosaka-bun%2Fqqrobot-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kosaka-bun%2Fqqrobot-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kosaka-bun","download_url":"https://codeload.github.com/kosaka-bun/qqrobot-sdk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247142065,"owners_count":20890652,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dependency","maven","qqbot","qqbot-framework","spring-boot"],"created_at":"2024-10-29T21:25:20.298Z","updated_at":"2025-04-04T08:07:13.544Z","avatar_url":"https://github.com/kosaka-bun.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# QQ Robot SDK\n![Java](./docs/img/Java-17-brightgreen.svg)\n![Spring Boot](https://img.shields.io/badge/Spring%20Boot-3.2.5-brightgreen?logo=Spring)\n![Kotlin](https://img.shields.io/badge/Kotlin-1.8.10-brightgreen?logo=Kotlin)\u003cbr /\u003e\n[![License](https://img.shields.io/github/license/kosaka-bun/qqrobot-sdk?label=License\u0026color=blue\u0026logo=GitHub)](./LICENSE)\n![GitHub Stars](https://img.shields.io/github/stars/kosaka-bun/qqrobot-sdk?label=Stars\u0026logo=GitHub\u0026style=flat)\n[![Release](https://img.shields.io/github/release/kosaka-bun/qqrobot-sdk?label=Release\u0026logo=GitHub)](../../releases)\n\n## 简介\n本项目是一款Spring Boot平台一站式QQ机器人开发框架，其对QQ机器人开发过程中遇到的许多常见问题提供了便利的解决方案，能够快速、高效、便捷地搭建基于Spring Boot平台的QQ机器人。\n\n项目分为两个模块，分别是qqrobot-framework-api和qqrobot-spring-boot-starter。qqrobot-framework-api规定了一个QQ机器人框架需要遵循的规范，qqrobot-spring-boot-starter为基于qqrobot-framework-api实现的一站式QQ机器人应用开发框架，其特性包含自动化命令匹配、命令权限校验、命令参数提取、便利的持续会话实现、调用日志与异常日志等。同时还包含了便捷的测试框架以及后台管理界面。\n\n本项目采用Apache-2.0 License，使用本项目时，请遵守此开源许可证的相关规定。\n\n请参阅：[开发文档](./docs/development.md)\u0026emsp;[更新日志](./docs/changelog.md)\u0026emsp;[Tester框架说明文档](./docs/tester-framework.md)\n\n## 使用\n本项目部署于：\n\n[![maven-repo](https://github-readme-stats.vercel.app/api/pin/?username=kosaka-bun\u0026repo=maven-repo)](https://github.com/kosaka-bun/maven-repo)\n\n使用前请先阅读此仓库的文档，为你的Maven或Gradle添加依赖仓库。\n\n各模块版本号请前往[Releases](../../releases)查看。\n\n### Maven\n```xml\n\u003cdependencies\u003e\n    \u003cdependency\u003e\n        \u003cgroupId\u003ede.honoka.qqrobot\u003c/groupId\u003e\n        \u003cartifactId\u003eqqrobot-spring-boot-starter\u003c/artifactId\u003e\n        \u003cversion\u003e版本号\u003c/version\u003e\n    \u003c/dependency\u003e\n\u003c/dependencies\u003e\n```\n\n### Gradle\n```groovy\ndependencies {\n    implementation 'de.honoka.qqrobot:qqrobot-spring-boot-starter:版本号'\n}\n```\n\n## 快速开始\n[qqrobot-demo](https://github.com/kosaka-bun/demo-projects/tree/master/qqrobot-demo)是基于本框架搭建的一个示例程序，其包含了本框架的所有基本用法示例。请先按步骤分别尝试在测试环境与正式环境中尝试运行此Demo应用。\n\n### 测试环境\n1. clone [demo-projects仓库](https://github.com/kosaka-bun/demo-projects)。\n2. 使用IDE打开仓库中的qqrobot-demo目录（非仓库根目录）。\n3. 运行qqrobot-demo的Spring Boot主类[QqRobotDemo](https://github.com/kosaka-bun/demo-projects/tree/master/qqrobot-demo/src/main/java/de/honoka/qqrobot/demo/QqRobotDemo.java)。\n4. 等待应用启动完成，打开测试框架界面，默认为[http://localhost:8081/qqrobot-demo/tester-framework/index.html](http://localhost:8081/qqrobot-demo/tester-framework/index.html)。\n\n![](./docs/img/1.png)\n\n![](./docs/img/2.png)\n5. 点击“连接”，然后在群聊消息对应的输入框中输入“%菜单”，若得到回复，则测试环境运行成功。\n\n![](./docs/img/3.png)\n\n### 正式环境\n1. 在qqrobot-demo目录下，执行`gradlew bootJar`命令，等待构建完成。\n2. 将[qqrobot-demo/src/main/resources/config/application-prod.yml](https://github.com/kosaka-bun/demo-projects/tree/master/qqrobot-demo/src/main/resources/config/application-prod.yml)文件，复制到qqrobot-demo/build/libs目录下。\n3. 打开libs目录下的application-prod.yml文件，修改`honoka.qqrobot`项下的`qq`、`password`、`admin-qq`、`developing-group`四个配置项，指定机器人要使用的QQ账号、密码、可调用管理员命令的用户的QQ账号，以及开发群的群号。\n4. 在libs目录下创建`startup.bat`（Windows）或`startup.sh`（Linux）文件，插入以下内容。\n```shell\njavaw -jar -Dfile.encoding=UTF-8 -Dspring.profiles.active=prod [jar包的名称]\n```\n5. 执行`startup.bat`或`startup.sh`文件，等待应用启动完成，注意留意jar包是否启用了prod配置文件。\n\n![](./docs/img/4.png)\n\n6. 通过任何方式向机器人所登录QQ账户发送`%菜单`命令，若收到回复，则应用在正式环境中启动成功。\n\n### 注意事项\n- 本文中所有操作均以Windows图形界面为默认环境，默认在图形界面下进行部署，如需在控制台中运行和部署，请将步骤中的`javaw`命令替换为`java`命令。\n\n## 开发\n请参阅[开发文档](./docs/development.md)，通过其中的说明了解如何基于此框架开发QQ机器人应用。\n\n有关此框架附带的测试框架（Tester Framework）的相关信息，请参阅[Tester框架说明文档](./docs/tester-framework.md)。\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkosaka-bun%2Fqqrobot-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkosaka-bun%2Fqqrobot-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkosaka-bun%2Fqqrobot-sdk/lists"}