README

Laravel 辅助工具包，提供 SQL 日志、日志清理、缓存清理和常用调试函数。

要求

PHP >= 8.4
Laravel ^13.0

安装

composer require felo-z/laravel-helper -vvv

发布配置文件

php artisan vendor:publish --provider="FeloZ\LaravelHelper\HelperServiceProvider"

功能

SQL 日志

SQL 日志模块会在包启动时自动监听 DB::listen()，无需额外调用。

支持能力：

全量 SQL 与慢查询分流
HTTP / Console / Queue Job 来源识别
绑定值替换、请求方法过滤、连接过滤
按执行作用域分组输出

最小配置示例：

'sql_logger' => [
    'enabled' => env('FELO_HELPER_SQL_LOGGER_ENABLED', false),
]

详细配置、占位符、环境变量与生产建议见：docs/sql-logger.md

Artisan 命令

清理日志文件

php artisan felo:clear-logs

根据配置清理指定目录下的日志文件，支持自定义扩展名和排除文件。

清理缓存

php artisan felo:clear-cache

清理 Laravel 缓存和指定的 Redis 连接。

辅助函数

日志清理 / 缓存清理

clear_logs();   // 清理日志文件
clear_cache();  // 清理 Laravel 缓存和 Redis

调试输出

将变量 JSON 化写入 storage/logs 目录，方便排查问题：

pas($data);          // dump + 写入文件
das($data);          // dd + 写入文件
las($data);          // 仅写入文件（静默）
zas('filename', $data); // 写入指定文件名

文件名默认按时间生成，格式为 .json。

工具函数

now_tz_bj();         // 获取北京时区当前时间（Carbon 实例）
format_bytes(1024);  // "1 KB"
format_duration(65000); // "1 min 5 s"

配置说明

发布配置文件后，可在 config/felo-helper.php 中进行配置：

return [
    'clear_logs' => [
        'directories' => env('FELO_HELPER_LOG_DIRECTORIES', [storage_path('logs')]),
        'extensions' => env('FELO_HELPER_LOG_EXTENSIONS', 'log,sql,json'),
        'exclude' => env('FELO_HELPER_LOG_EXCLUDE', 'laravel.log'),
    ],
    'clear_cache' => [
        'clear_laravel_cache' => env('FELO_HELPER_CLEAR_LARAVEL_CACHE', true),
        'redis_connections' => env('FELO_HELPER_REDIS_CONNECTIONS', 'default'),
    ],
    'sql_logger' => [
        'enabled' => env('FELO_HELPER_SQL_LOGGER_ENABLED', false),
        'directory' => env('FELO_HELPER_SQL_LOGGER_DIRECTORY', storage_path('logs/sql')),
        'replace_bindings' => env('FELO_HELPER_SQL_LOGGER_REPLACE_BINDINGS', true),
    ],
];

SQL 日志完整配置见：docs/sql-logger.md

环境变量

FELO_HELPER_LOG_DIRECTORIES=/path/to/logs1,/path/to/logs2
FELO_HELPER_LOG_EXTENSIONS=log,json,txt
FELO_HELPER_LOG_EXCLUDE=laravel.log,important.log
FELO_HELPER_CLEAR_LARAVEL_CACHE=true
FELO_HELPER_REDIS_CONNECTIONS=default,cache
FELO_HELPER_SQL_LOGGER_ENABLED=false
FELO_HELPER_SQL_LOGGER_DIRECTORY=/path/to/storage/logs/sql
FELO_HELPER_SQL_LOGGER_REPLACE_BINDINGS=true

更多 SQL 日志环境变量见：docs/sql-logger.md

开发

composer run fix-style
composer run phpstan
composer run test

License

MIT

felo-z / laravel-helper

Maintainers

Package info

Fund package maintenance!

Statistics

Security