将 PHP Insights 放入旧版 PJ 不是很好吗?谈论

   2023-03-08 学习力0
核心提示:介绍在最近的PHP系统开发中,感觉故事在理所当然包含静态分析工具的前提下进行。我的周围现有代码很脏,我很久以前安装了工具,但几乎没有检查已经观察到许多这样的案例。 (这是小说。而不是像 0 或 100 这样不允许单行错误的静态分析,一点一点,逐渐我想介

介绍

在最近的PHP系统开发中,感觉故事在理所当然包含静态分析工具的前提下进行。

我的周围现有代码很脏,我很久以前安装了工具,但几乎没有检查已经观察到许多这样的案例。 (这是小说。

而不是像 0 或 100 这样不允许单行错误的静态分析,一点一点,逐渐我想介绍静态分析。

我找到了一个解决这种想法的神器。

从这里开始,我将介绍 PHP Insights,同时将其与 PHPStan 等其他工具进行比较。

如何使用

环境信息

这一次,我们将假设使用 Laravel 进行开发。

$ php -v
PHP 8.1.12 (cli) (built: Oct 28 2022 18:32:20) (NTS)
Copyright (c) The PHP Group
Zend Engine v4.1.12, Copyright (c) Zend Technologies

$ php artisan -V
Laravel Framework 9.37.0

安装程序

这次我运行了以下命令:

$ composer require nunomaduro/phpinsights --dev
$ php artisan vendor:publish
$ provider="NunoMaduroPhpInsightsApplicationAdaptersLaravelInsightsServiceProvider"

PHPStan 的优点

易于引入,因为代码质量是通过分数来衡量的

用于常规静态分析

尝试运行 PHPStan 进行比较。

root@53c6b058d528:/workspace# vendor/bin/phpstan analyze ./app  --level=2
 23/23 [▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓] 100%

 ------ ------------------------------------------------------------------------------------------------------------- 
  Line   Http/Controllers/GenerateQuestionAction.php                                                                  
 ------ ------------------------------------------------------------------------------------------------------------- 
  29     PHPDoc tag @return with type IlluminateHttpResponse is incompatible with native type AppModelsQuestion.  
 ------ ------------------------------------------------------------------------------------------------------------- 

 ------ ------------------------------------------------------------------------------------------------------------------ 
  Line   Http/Middleware/Authenticate.php                                                                                  
 ------ ------------------------------------------------------------------------------------------------------------------ 
  17     Method AppHttpMiddlewareAuthenticate::redirectTo() should return string|null but return statement is missing.  
 ------ ------------------------------------------------------------------------------------------------------------------ 

                                                                                                                        
 [ERROR] Found 2 errors                                                                                                 
                                                                                             

这样,它检测到错误代码,但是当检测到错误时,返回错误代码并且CI下降。

因此,试图对一个巨大的遗留项目实施静态分析会导致大量错误和大量代码需要修复才能通过 CI。

是因为在遗留项目中,在开发过程中引入静态分析的成本往往很高。

对于 PHP 见解

当我运行 PHP Insights分数格式衡量代码质量。

レガシーなPJにはPHP Insightsをぶち込むのがいいんじゃない?って話

另外,除非用--min=quality等设置分数的下限,否则即使分数低也认为命令已正常完成。

违反了规则即使存在大量错误,也易于在 CI 中部署这是可以想象的。

当然,违反规则的代码很可能会导致错误和可读性差,因此需要在未来进行修复。

另外,如果将介绍时计算的分数设置为前面提到的--min=quality选项等作为下限,使用 CI 确保代码质量不会从引入时下降也能

使用一种工具可以从各种角度分析代码

常规案例

代码质量衡量的观点有很多种,比如风格、循环复杂度、容易出bug的写作风格等等,但是如果你尝试一一分析,PHP 斯坦,PhpMetrics,PHP CS 修复程序,通常需要使用多种工具。

此外,在初次导入时,写入每个设置文件将花费一定的费用。

对于 PHP 见解

PHP Insights 可以一次性分析圈复杂度、风格和容易出错的写作风格。

此外,设置被合并到一个文件中,因此如果您只是安装它,调整的地方很少,因此很容易立即将其合并到 CI 中。

如果您想尝试更严格的设置,请将insights.phpremove 参数中设置的规则注释掉。

见解.php
    'remove' => [
        AlphabeticallySortedUsesSniff::class,
        DeclareStrictTypesSniff::class,
        ...

如果您想进一步自定义设置,请参考官方文档的说明。

概括

到目前为止,我已经讨论了如何使用 PHP Insights 并从中受益。

当然,PHP Insights 也有其弱点,对于“我想快速适应更严格的规则集”等用例,我认为最好单独引入 PHPStan 之类的工具。

因此,在引入静态分析时,请根据您要解决的问题和项目的特点选择最合适的工具,并考虑将 PHP Insights 作为选项之一。

就这样。

宣传

本文是结合以下事件编写的:

请喜欢


原创声明:本文系作者授权爱码网发表,未经许可,不得转载;

原文地址:https://www.likecs.com/show-308632572.html

 
反对 0举报 0 评论 0
 

免责声明:本文仅代表作者个人观点,与乐学笔记(本网)无关。其原创性以及文中陈述文字和内容未经本站证实,对本文以及其中全部或者部分内容、文字的真实性、完整性、及时性本站不作任何保证或承诺,请读者仅作参考,并请自行核实相关内容。
    本网站有部分内容均转载自其它媒体,转载目的在于传递更多信息,并不代表本网赞同其观点和对其真实性负责,若因作品内容、知识产权、版权和其他问题,请及时提供相关证明等材料并与我们留言联系,本网站将在规定时间内给予删除等相关处理.

  • php-fpm进程管理的三种模式 phpfpm子进程
    php-fpm进程管理的三种模式 phpfpm子进程
    php-fpm解读-进程管理的三种模式—程序媛大丽标明转载以示尊重 感谢原作者的分享。php-fpm进程管理一共有三种模式:ondemand、static、dynamic,我们可以在同一个fpm的master配置三种模式,看下图1。php-fpm的工作模式和nginx类似,都是一个master,多个worke
    03-08
  • nginx和php-fpm 是使用 tcp socket 还是 unix s
    tcp socket允许通过网络进程之间的通信,也可以通过loopback进行本地进程之间通信。unix socket允许在本地运行的进程之间进行通信。分析从上面的图片可以看,unix socket减少了不必要的tcp开销,而tcp需要经过loopback,还要申请临时端口和tcp相关资源。但是
    03-08
  • [PHP8] 我参加了PHP8工程师认证初学者考试beta考试
    [PHP8] 我参加了PHP8工程师认证初学者考试beta
    前几天,2022/08/05,PHP工程师认证机构PHP8 技术员认证初级考试宣布实施考试将于 2023 年春季开始。和 beta 测试完成于 2022/09/11所以我收到了。一般社团法人BOSS-CON JAPAN(代表理事:Tadashi Yoshimasa,地点:东京都世田谷区,以下简称“BOSS-CON JAPAN
    03-08
  • PHP基于elasticsearch全文搜索引擎的开发 php使
    1.概述:全文搜索属于最常见的需求,开源的 Elasticsearch (以下简称 Elastic)是目前全文搜索引擎的首选。Elastic 的底层是开源库 Lucene。但是,你没法直接用 Lucene,必须自己写代码去调用它的接口。Elastic 是 Lucene 的封装,提供了 REST API 的操作接
    02-09
  • php视图操作
    一、视图的基本介绍         视图是虚拟的表。与包含数据的表不一样,视图只包含使用时动态检索数据的查询。        使用视图需要MySQL5及以后的版本支持。        下面是视图的一些常见应用:        重用SQL语句;        简化复杂的S
    02-09
  • php中图像处理的常用函数 php图形图像处理技术
    php中图像处理的常用函数 php图形图像处理技术
    1.imagecreate()函数imagecreate()函数是基于一个调色板的画布。?php $im = imagecreate(200,80);                //创建一个宽200,高80的画布。$white = imagecolorallocate($im,225,35,180);     //设置画布的背景颜色imagegif($im);
    02-09
  • PHP安全之webshell和后门检测
    PHP安全之webshell和后门检测
    基于PHP的应用面临着各种各样的攻击:XSS:对PHP的Web应用而言,跨站脚本是一个易受攻击的点。攻击者可以利用它盗取用户信息。你可以配置Apache,或是写更安全的PHP代码(验证所有用户输入)来防范XSS攻击SQL注入:这是PHP应用中,数据库层的易受攻击点。防范
    02-09
  • php使用时间戳保存时间的意义 PHP获取时间戳
    时间戳记录的是格林尼治时间,使用date格式化的时候会根据你程序设置的不同时区显示不同的时间。如果使用具体时间,则还需要进行多一步转换。
    02-09
  • PHP 获取提交表单数据方法
    PHP $_GET 和 $_POST变量是用来获取表单中的信息的,比如用户输入的信息。PHP表单操作在我们处理HTML表单和PHP表单时,我们要记住的重要一点是:HTML页面中的任何一个表单元素都可以自动的用于PHP脚本:表单举例: htmlbodyform action="welcome.php" method
    02-09
  • php中file_get_contents与curl的区别 php get f
    做微信开发的时候,项目中需要用PHP去请求微信相关接口。刚开始使用的是file_get_contents这个函数,后来听朋友说最好用curl。自己尝试了下,也能成功请求微信的接口。这两个有什么区别呢?抱着好奇心查阅了相关资料后,才知道他们之间确实有很大的不同。1.fo
    02-09
点击排行