PHP程式碼自動檢測（git/svn整合PHP_CodeSniffer）

hizengzeng發表於2019-02-16
PHPGit

背景

在公司開發的時候，每次不管svn還是git提交程式碼的時候都會對程式碼進行簡單的自動檢測。檢查不了程式碼邏輯，但是最起碼能保證整體的編碼格式保持一致。這個功能還是挺有用的，一直想了解下是怎麼實現的，直到最近想起來才開始瞭解這個自動檢測是怎麼回事。

研究途徑

  1. 一般公司的doc文件上會記錄各種系統的某個功能的具體實現，而且很可能不止一個文件，在公司的doc文件上各種關鍵字搜尋都找不到相關資料
  2. 找到對應部門的同事詢問是如何實現的。同事給了答覆是PHP_CodeSniffer並且告知了github連結。並且明確告知：文件？不可能的。然後加了一句，網上什麼都有
  3. 最後就自己在Baidu/Google了幾篇文章，差不多就瞭解了

實踐部分

PHP_CodeSniffer的安裝 參考資料

pear install PHP_CodeSniffer

我直接使用了pear方式安裝，簡單方便很多。使用pear安裝的擴充套件庫基本上預設在php的安裝目錄下，比如我的：/opt/php-7.1.9/lib/php/PHP/CodeSniffer。大家可以參考下自己的安裝目錄。
命令列直接使用PHP_CodeSniffer如下：

phpcs test.php

設定PHP_CodeSniffer的程式碼規範格式。

# /opt/php-7.1.9/lib/php/PHP/CodeSniffer/src/Standards 
# 這個目錄下列出了所有可以設定的格式（PSR1，PSR2，PSR12，Zend，Squiz等）
phpcs --config-set default_standard Zend

svn/git安裝

這裡不展開描述了，由於我在虛擬機器上安裝也花了一些時間，都是參考網上的資料。

將PHP_CodeSniffer整合到git/svn中
每部署一個svn專案，都會對應的配置檔案，其中有個hooks資料夾，其中有pre-commit，在這個檔案中加上phpcs 的命令就好了。
git的原理是一樣的，都是有個hooks的資料夾，其中都有pre-commit。
差別：我們公司svn是在commit的過程中進行的自動檢測，git是在git push的時候進行檢測操作的。猜想應該自動程式碼檢測肯定是整合在工程程式碼所在的服務端是最好的。svn commit的時候就直接訪問的遠端主機。但是git commit的時候是將程式碼儲存在本地分支，只有git push的時候才是提交到遠端主機，所以git就是在git push的時候進行的自動檢測操作。

寫在最後

通過了解PHP程式碼的自動檢測，發現了很多問題。

  1. 自己沒有主動去思考問題，最開始的時候就是想去doc上查詢資料，而不是先想想這個功能是如何做到的。再到在doc上沒找到資料直接去找了同事
  2. 一直在做業務需求的時候，常常忘記了繼續學習，思考其他東西。比如linux命令很多都已經忘記了，還有就是PHP_CodeSniffer這個擴充套件庫很不錯，之後有時間再研究下具體實現。需要經常思考問題
  3. 通過這次的程式碼自動檢測發現自己什麼都不懂，pear，PSR，svn/git，yum/apt-get等等很多都不懂，即使之前用過，但是沒有深入研究過，也沒有做對應的記錄，所以很快就忘記了。看的稍微多一點就會意識到自己瞭解的太少太少了
  4. 感謝這個過程中使用的幾個資料

參考文件
PHP_CodeSniffer安裝

相關文章