Laravel Slower 安装与使用指南

Laravel Slower 安装与使用指南

laravel-slower ★ Laravel Slower: Optimize Your DB Queries with AI 项目地址: https://gitcode.com/gh_mirrors/la/laravel-slower

1. 目录结构及介绍

laravel-slower 是一个专为 Laravel 开发者设计的包，旨在通过人工智能优化数据库查询性能。以下是其基本目录结构及其简介：

- config                # 配置文件夹，存储着与该包相关的配置
    - slower.php         # 主配置文件，允许自定义AI推荐设置等
- database              # 数据库相关文件夹
    - migrations         # 移植文件，用于创建慢查询日志表
- src                   # 包的核心代码，包含了处理逻辑和服务提供者
- tests                 # 单元测试文件夹，确保包功能正常
- editorconfig          # 编辑器配置文件，帮助保持代码风格一致
- gitattributes         # Git属性文件，影响文件如何被Git处理
- gitignore             # .gitignore文件，列出不应加入版本控制的文件类型或文件名
- composer.json         # 项目依赖管理文件
- phpstan-baseline.neon # PHPStan的基线配置，用于代码质量检查
- phpstan.neon.dist     # PHPStan标准配置
- phpunit.xml.dist      # 单元测试的配置文件
- README.md             # 项目的主要说明文档
- CHANGELOG.md          # 版本更新记录
- LICENSE.md            # 许可证文件
- SECURITY.md           # 安全相关信息

2. 启动文件介绍

在 laravel-slower 中，并没有明确的“启动文件”概念，因为这个包是作为 Laravel 应用的一个扩展来使用的。安装并配置完成后，它的核心功能会在你的应用运行过程中自动触发，特别是当有慢查询发生时。

但是，有两个关键命令可以视作“启动”特定功能的点：

• 分析慢查询命令 (artisan slower:analyze)：用来分析已记录的慢查询，尝试提出优化建议。
• 清理旧记录命令 (artisan slower:clean)：定期执行以删除旧的慢查询记录，保持数据库整洁。

这两个命令的注册和调度通常在 Laravel 的任务调度中完成，例如，在 app\Console\Kernel.php 中的 schedule() 方法内添加定时执行命令的逻辑。

3. 项目的配置文件介绍

配置文件位于 config/slower.php，通过 Composer 安装后并运行发布命令 (php artisan vendor:publish --tag="slower-config") 自动产生。此配置文件提供了多个选项来自定义 laravel-slower 的行为，主要包括：

• 启用状态 (enabled)：通过 .env 文件控制包是否启用。
• 阈值 (threshold)：定义查询时间超过多少毫秒被视为慢查询。
• 资源设置：指定记录慢查询的日志模型和表。
• AI推荐 (ai_recommendation)：启用或禁用AI提供的优化建议，涉及与OpenAI的交互。
• OpenAI配置：包括API密钥和组织ID，仅在启用AI推荐时需要。
• 推荐提示 (prompt)：定制发送给AI的请求信息，指导AI如何分析和提供建议。

通过调整这些配置项，你可以精细地控制这个包如何监控和优化你的数据库查询性能，以及是否利用AI技术进行智能优化建议。务必根据实际应用场景调整这些参数以获得最佳效果。

laravel-slower ★ Laravel Slower: Optimize Your DB Queries with AI 项目地址: https://gitcode.com/gh_mirrors/la/laravel-slower