# Bot

**Repository Path**: delete-memory/bot

## Basic Information

- **Project Name**: Bot
- **Description**: 使用Yaf框架实现，一个兼容OneBot标准的机器人接口。（Yaf是一个C语言编写的PHP框架）
- **Primary Language**: PHP
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: http://movie.iyuu.cn
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2022-10-23
- **Last Updated**: 2022-10-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 简介

兼容OneBot标准的机器人接口，使用Yaf框架实现（C语言编写的PHP框架）。





## 项目依赖

| 名称    | 说明                                                         | 版本   |
| ------- | ------------------------------------------------------------ | ------ |
| Nginx   | 高性能的HTTP和反向代理web服务器                              | 1.17.3 |
| PHP     | “超文本预处理器”，是在服务器端执行的脚本语言，尤其适用于Web开发并可嵌入HTML中。 | 7.4.21 |
| MySQL   | 最流行的关系型数据库管理系统。                               | 5.7.34 |
| Redis   | 一个开源的使用ANSI C语言编写、支持网络、可基于内存亦可持久化的日志型、Key-Value数据库，并提供多种语言的API。 | 6.2.4  |
| Yaf     | Yaf 是一个 C 语言编写的 PHP 框架。                           | 3.2.5  |
| SeasLog | 一个轻量，高效，便捷，规范的PHP日志扩展。                    | 2.2.0  |





## 运行状态

```text
框架部分
应用标识：go-cqhttp
应用版本：v1.0.0-beta5
应用完整名称：go-cqhttp-v1.0.0-beta5_linux_amd64-go1.16.2
OneBot标准版本：v11
运行时：linux / go1.16.2

接口部分
SDK版本：Author David v1.0.0
SDK时间：20210802100000
操作系统：Linux 3.10.0-1160.21.1.el7.x86_64 #1 SMP Tue Mar 16 18:28:22 UTC 2021
运行时：Nginx 1.17.3 -Tengine 2.3.2  / Redis 6.2.4 / MySQL 5.7.34 / PHP 7.4.21
PHP扩展：SeasLog 2.2.0 / Yaf 3.2.5
```






## 意义

通过本Demo，可以对Yaf框架整体提高认知，熟悉并掌握以下知识点：

1. Redis队列和延迟队列
2. 事件调度器、事件监听器
3. Yaf扩展安装与配置
4. php.ini配置
5. nginx重写规则
6. Yaf目录结构（多模块）
7. Bootstrap
8. 类的加载规则（PSR4）
9. 插件的6个Hook
10. 路由和路由协议（Rewrite、Regex）
11. Dispatcher分发器
12. 控制器、请求、响应、配置等内建类
13. 异常和错误机制






## 部署方法

1. 安装Yaf扩展、Seaslog扩展
2. 编辑php.ini，添加配置
3. 添加nginx伪静态
4. 安装依赖`composer install`
5. 导入接口的数据库
6. 配置go-cqhttp反向POST接口`http://127.0.0.1/index/Bot/index/qq/qq`
7. 运行机go-cqhttp进程 `cd ./conf/product/go-cqhttp && ./go-cqhttp -d -c ./config.yml`
8. 运行Redis队列进程 `cd ./conf/product/bin && ./queue -c ./queue.conf`
9. 完成，访问测试






## php.ini配置项

```
extension = yaf.so
yaf.environ = "product"
yaf.cache_config = 1
yaf.use_namespace = On
yaf.use_spl_autoload = On

extension = seaslog.so
seaslog.disting_type = 1
seaslog.disting_by_hour = 1
;默认log根目录
seaslog.default_basepath = "/www/wwwlogs"
```






## nginx伪静态
```
location / {
  if (!-e $request_filename) {
    rewrite ^/(.*)  /index.php/$1 last;
  }
}
```






## 访问测试

1. 豆瓣条目：http://movie.iyuu.cn/subject/35087699
2. 豆瓣全部演职员：http://movie.iyuu.cn/celebrities/35087699
3. IMDb条目：http://movie.iyuu.cn/title/tt13696296
4. 机器人上报接口：https://movie.iyuu.cn/index/Bot/index






## 目录结构

```
+ public
  |- index.php //入口文件
  |- .htaccess //重写规则    
  |+ css
  |+ img
  |+ js
+ conf
  |- application.ini //配置文件
  |- route.php		 //路由协议
+ application
  |+ controllers
     |- Index.php //默认控制器
  |+ views    
     |+ index   //控制器
        |- index.phtml //默认视图
  |+ modules //其他模块
  |+ library //本地类库
  |+ models  //model目录
  |+ plugins //插件目录
```






## 参考

PHP官方文档：https://www.php.net/manual/zh/intro.yaf.php

鸟哥官方文档：https://www.laruence.com/manual/index.html

配置文件：https://www.laruence.com/manual/yaf.config.optional.html

注册其他命名空间：https://www.laruence.com/manual/yaf.autoloader.html

类的加载方法：https://www.laruence.com/manual/yaf.autoloader.rule.html

路由协议：https://www.laruence.com/manual/yaf.routes.static.html

Seaslog扩展仓库：https://github.com/SeasX/SeasLog





------

## seaslog扩展的配置

```
[SeasLog]
;configuration for php SeasLog module
extension = seaslog.so

;默认log根目录
seaslog.default_basepath = "/var/log/www"

;默认logger目录
seaslog.default_logger = "default"

;日期格式配置 默认"Y-m-d H:i:s"
seaslog.default_datetime_format = "Y-m-d H:i:s"

;日志格式模板 默认"%T | %L | %P | %Q | %t | %M"
seaslog.default_template = "%T | %L | %P | %Q | %t | %M"

;是否以目录区分Logger 1是(默认) 0否
seaslog.disting_folder = 1

;是否以type分文件 1是 0否(默认)
seaslog.disting_type = 1

;是否每小时划分一个文件 1是 0否(默认)
seaslog.disting_by_hour = 1

;是否启用buffer 1是 0否(默认)
seaslog.use_buffer = 0

;buffer中缓冲数量 默认0(不使用buffer_size)
seaslog.buffer_size = 100

;cli运行时关闭buffer
;1是 0否(默认)
seaslog.buffer_disabled_in_cli = 0

;记录日志级别，数字越大，根据级别记的日志越多。
;0-EMERGENCY 1-ALERT 2-CRITICAL 3-ERROR 4-WARNING 5-NOTICE 6-INFO 7-DEBUG 8-ALL
;默认8(所有日志)
;
;   注意, 该配置项自1.7.0版本开始有变动。
;   在1.7.0版本之前, 该值数字越小，根据级别记的日志越多: 
;   0-all 1-debug 2-info 3-notice 4-warning 5-error 6-critical 7-alert 8-emergency
;   1.7.0 之前的版本，该值默认为0(所有日志);
seaslog.level = 5

;日志函数调用回溯层级
;影响预定义变量 %F 中的行数
;默认0
seaslog.recall_depth = 0

;自动记录notice 默认0(关闭)
seaslog.trace_notice = 0

;自动记录warning 默认0(关闭)
seaslog.trace_warning = 0

;自动记录错误 默认1(开启)
seaslog.trace_error = 1

;自动记录异常信息 默认0(关闭)
seaslog.trace_exception = 0

;日志存储介质 1File 2TCP 3UDP (默认为1)
seaslog.appender = 1

;写入重试次数
;默认0(不重试)
seaslog.appender_retry = 0

;接收ip 默认127.0.0.1 (当使用TCP或UDP时必填)
seaslog.remote_host = "127.0.0.1"

;接收端口 默认514 (当使用TCP或UDP时必填)
seaslog.remote_port = 514

;接收端口的超时时间 默认1秒
seaslog.remote_timeout = 1

;过滤日志中的回车和换行符 (默认为0)
seaslog.trim_wrap = 0

;是否开启抛出SeasLog自身异常  1开启(默认) 0关闭
seaslog.throw_exception = 1

;是否开启忽略SeasLog自身warning  1开启(默认) 0关闭
seaslog.ignore_warning = 1

;是否开启性能追踪 1开启 0关闭(默认)
seaslog.trace_performance = 0

;性能追踪时的千分比采样率
;默认10，即百分之一
seaslog.trace_performance_sample_rate = 10

;性能追踪时的开始层级 默认从第1层开始
seaslog.trace_performance_start_depth = 1

;性能追踪时深度层级 默认5层
seaslog.trace_performance_max_depth = 5

;性能追踪时每层的函数最大数 按wall_time降序排列top 默认top5
seaslog.trace_performance_max_functions_per_depth = 5

;性能追踪时当前请求执行时间的记录阈值 只有当请求执行时间大于该值时，才记录性能日志 默认1000ms
seaslog.trace_performance_min_wall_time = 1000

;性能追踪时每个方法执行时间的记录阈值 只有当方法执行时间大于该值时，才参与计算 默认10ms
seaslog.trace_performance_min_function_wall_time = 10
```