hi-folks/lara-lens

Laravel 诊断命令,用于配置、数据库连接、HTTP 请求

v1.0.0 2024-03-13 21:52 UTC

README

CI/CD Github Actions GitHub last commit GitHub Release Date Packagist PHP Version

LaraLens

是什么

LaraLens 是一个 Laravel artisan 命令,用于显示您应用程序的当前配置。它非常有用,可以在您的终端中显示以下状态:

  • 一些有用的配置变量;
  • 数据库连接;
  • 数据库中的表;
  • 通过 HTTP 请求的连接;
  • 服务器要求(PHP 版本、所需的 PHP 模块和已安装的 Laravel 版本等)。

LaraLens - diagnostic package for Laravel

为什么

当我将新的 Laravel 应用程序部署到目标服务器时,通常我会执行一系列命令以检查配置、数据库连接、检查一些表以及 Web 服务器的响应。我尝试在一个命令中显示更多信息。当您的 Laravel 应用程序安装在本地上,并且有人负责配置时,这也非常有用。在这种情况下,通常作为开发者,您的第一个问题是:“应用程序是如何配置的?”

安装

您可以通过 composer 安装此包

composer require hi-folks/lara-lens

包的 Packagist 页面是: https://packagist.org.cn/packages/hi-folks/lara-lens

使用方法

php artisan laralens:diagnostic

使用方法:控制数据库连接

您可以看到数据库连接信息,并且可以选择要检查的表以及用于“按顺序”的列(默认为 created_at)

php artisan laralens:diagnostic --table=migrations --column-sort=id

获取最后 创建 的用户

php artisan laralens:diagnostic --table=users --column-sort=created_at

获取最后 更新 的用户

php artisan laralens:diagnostic --table=users --column-sort=updated_at

使用方法:控制输出

您可以通过 show 选项来控制输出。您可以定义

  • config
  • connection
  • database
  • runtime
  • migration
  • php-ext
  • php-ini
  • all

--show 选项的默认值(如果您未指定 --show)是显示:config, connection, database, runtime, migration。

php artisan laralens:diagnostic --show=config --show=connection --show=database --show=runtime --show=migration

如果您只想查看数据库信息

php artisan laralens:diagnostic --show=database

如果您想查看详细信息输出(包括 PHP 扩展和 PHP INI 值)

php artisan laralens:diagnostic --show=all

或者更好的是

php artisan laralens:diagnostic --all

如果您只想查看 PHP 扩展

php artisan laralens:diagnostic --show=php-ext

如果您只想查看 PHP INI 值

php artisan laralens:diagnostic --show=php-ini

使用方法:跳过数据库连接和数据库诊断

如果您的 Laravel 应用程序不使用数据库,您可以使用 --skip-database 选项跳过数据库检查。

php artisan laralens:diagnostic --skip-database

使用方法:显示一些操作系统信息

您可以显示一些操作系统信息,例如

  • PHP 脚本所有者的 UID
  • 当前用户
  • 操作系统
  • 主机名
  • 版本名称
  • 机器名称
  • 版本信息

使用 "--show os" 选项或 "--show all" 选项

php artisan laralens:diagnostic  --show os

使用方法:更改输出表格的样式

您可以通过 --style= 选项选择以下样式之一

  • default
  • borderless
  • compact
  • symfony-style-guide
  • box
  • box-double

例如

php artisan laralens:diagnostic --style=borderless

使用方法:更改输出表格的宽度

要使用 120 个字符(宽终端),您可以使用 --large 选项

php artisan laralens:diagnostic --large

测试

composer test

变更日志

请参阅 CHANGELOG 以获取有关最近更改的更多信息。

作为网页使用

LaraLens通过终端提供信息,如上所示。您也有机会通过您的网页浏览器查看信息。您可以通过配置启用网页视图。

在您的Laravel应用程序中发布LaraLens的默认配置

php artisan vendor:publish --provider="HiFolks\LaraLens\LaraLensServiceProvider" --tag="config"

之后,您将在config目录下获得一个新的配置文件。文件名为:config/lara-lens.php

LARALENS_WEB_ENABLED=on选项添加到您的.env文件中。您还可以覆盖LARALENS_PREFIXLARALENS_MIDDLEWARE的默认参数

# Wether Web Report should be enabled or not
LARALENS_WEB_ENABLED=on
# Path prefix in order to acess the Web Report via browser
LARALENS_PREFIX="laralens"
# Which middleware should be used when acessing the Web Report, separete more with ;
LARALENS_MIDDLEWARE="web;auth.basic"

例如,根据上述配置,您将在/laralens_test/路径下启用网页视图(web-enabled参数),并使用webauth.basic中间件

return [
    'prefix' => env('LARALENS_PREFIX', 'laralens'), // URL prefix (default=laralens)
    'middleware' => explode(';', env('LARALENS_MIDDLEWARE', 'web')), // middleware (default=web) more separate with ;
    'web-enabled' => env('LARALENS_WEB_ENABLED', 'off') // Activate web view (default=off)
];

网页视图配置提示

LaraLens会显示您Laravel应用程序的一些内部配置,因此我建议您在生产环境中禁用它。要禁用LaraLens网页视图,请确保从.env文件中删除LARALENS_WEB_ENABLED配置,或将其设置为off

LARALENS_WEB_ENABLED=off

贡献

请参阅贡献指南以获取详细信息。

提交想法、功能请求或问题

鸣谢

谁在谈论LaraLens

许可证

MIT许可证(MIT)。有关更多信息,请参阅许可证文件