Laravel Log Viewer 项目启动与配置教程

1. 项目目录结构及介绍

Laravel Log Viewer 是一个用于查看日志文件的 Laravel 扩展。以下是项目的目录结构及其简要介绍：

laravel-log-viewer/
├── composer.json           # Composer 配置文件，定义项目依赖
├── README.md               # 项目说明文件
├── src/                    # 源代码目录
│   ├── Config/             # 配置文件目录
│   │   └── log-viewer.php   # Log Viewer 配置文件
│   ├── Controllers/        # 控制器目录
│   │   └── LogViewerController.php # Log Viewer 控制器
│   ├── Middleware/         # 中间件目录
│   │   └── LogViewer.php    # Log Viewer 中间件
│   ├── Providers/          # 服务提供者目录
│   │   └── LogViewerProvider.php # Log Viewer 服务提供者
│   └── Views/              # 视图目录
│       └── log-viewer.blade.php # Log Viewer 视图文件
└── tests/                  # 测试目录

2. 项目的启动文件介绍

要启动 Laravel Log Viewer，首先需要将项目依赖安装完毕，然后执行以下步骤：

1. 使用 Composer 安装项目依赖：

   composer install
   

2. 发布配置文件和资源文件：

   php artisan vendor:publish --provider="rap2hpoutre\LaravelLogViewer\LogViewerServiceProvider"
   

3. 注册路由。在 app/Http/Kernel.php 文件中，将以下路由注册到 $router 实例：

   protected $routeMiddleware = [
       // 其他中间件
       'log-viewer' => \rap2hpoutre\LaravelLogViewer\Middleware\LogViewer::class,
   ];
   

   然后，在 routes/web.php 文件中添加路由：

   Route::middleware(['log-viewer'])->group(function () {
       Route::get('logs', 'rap2hpoutre\LaravelLogViewer\Controllers\LogViewerController@index');
   });
   

4. 确保日志文件有正确的权限，以便 Log Viewer 可以读取。

3. 项目的配置文件介绍

Laravel Log Viewer 的配置文件位于 config/log-viewer.php。以下是配置文件中的一些主要设置：

return [
    'enabled' => env('LOG_VIEWER_ENABLED', true), // 是否启用 Log Viewer
    'routes'  => [
        'prefix' => env('LOG_VIEWER_ROUTE_PREFIX', 'logs'), // Log Viewer 路由前缀
    ],
    'paths'   => [
        base_path('storage/logs/laravel.log'), // 日志文件路径
    ],
    'files'   => [
        'laravel.log', // 要查看的日志文件名称
    ],
    'max_file_size' => env('LOG_VIEWER_MAX_FILE_SIZE', 5242880), // 日志文件的最大大小（字节）
    'sort'    => env('LOG_VIEWER_SORT', 'desc'), // 日志排序方式
    'pattern' => env('LOG_VIEWER_PATTERN', Patterns::Laravel), // 日志格式
];

您可以根据需要调整以上配置，例如更改日志文件的路径、设置不同的路由前缀或调整日志文件的最大大小。调整后，确保重新运行 php artisan config:cache 命令以更新配置缓存。