So überprüfen Sie die Codekonvention und -qualität mit PHP und PHPUnit

In der modernen Softwareentwicklung sind Codequalität und Spezifikationen äußerst wichtige Faktoren. Dadurch kann der Code nicht nur sauberer und einfacher zu warten sein, sondern auch die Lesbarkeit und Skalierbarkeit des Codes verbessert werden. Aber wie überprüfen Sie die Qualität und Spezifikation Ihres Codes? In diesem Artikel wird erläutert, wie Sie PHP und PHPUnit verwenden, um dieses Ziel zu erreichen.

Schritt eins: Überprüfen Sie die Codespezifikation

In der PHP-Entwicklung gibt es eine sehr beliebte Codespezifikation, die PSR (PHP Standard Specification) heißt. Der Zweck der PSR-Spezifikation besteht darin, PHP-Code lesbarer und wartbarer zu machen. Die bekanntesten davon sind PSR-1 und PSR-2.

Wenn wir PHP und PHPUnit zum Überprüfen von Codespezifikationen verwenden, müssen wir ein Tool namens „PHP_CodeSniffer“ installieren. Es handelt sich um einen PHP-Code-Spezifikationsprüfer, der prüfen kann, ob der Code den PSR-Spezifikationen entspricht.

Die Verwendung von PHP_CodeSniffer ist sehr einfach. Wir können es als globalen Befehl installieren (über Composer installiert) und dann den folgenden Befehl im Terminal verwenden, um die Codespezifikationen zu überprüfen:

phpcs --standard=PSR2 path/to/code

Wobei „Pfad/zu/Code“ durch das gewünschte Codeverzeichnis oder den gewünschten Dateipfad ersetzt werden sollte zu überprüfen. Nach Ausführung des Befehls werden die Anzahl der Zeilen, die gegen die Spezifikation verstoßen haben, und die Details des Fehlers ausgegeben. Sie können den Code basierend auf der Ausgabe ändern, um der PSR-Spezifikation zu entsprechen.

Neben der PSR-Spezifikation unterstützt PHP_CodeSniffer auch andere Spezifikationen wie Zend, PEAR, Squiz usw. Sie können die zu verwendende Spezifikation in der Befehlszeile mit der Option --standard angeben.

Schritt 2: Codequalität prüfen

In Bezug auf die Codespezifikationen haben wir PHP_CodeSniffer zur Überprüfung verwendet. Allerdings kann dieses Tool die Qualität des Codes nicht überprüfen. Um die Codequalität zu überprüfen, müssen wir ein anderes Tool namens „PHPMD“ verwenden.

PHPMD ist ein statischer Code-Analysator, der prüfen kann, ob der Code einigen häufigen Codequalitätsproblemen entspricht. Es unterstützt die Überprüfung auf schlechtes Design, übermäßig komplexen Code, ungenutzten Code und mehr.

Wie PHP_CodeSniffer können wir auch Composer verwenden, um PHPMD global zu installieren und dann Befehlszeilentools verwenden, um die Codequalität zu überprüfen. Der folgende Befehl kann die Codequalitätsprobleme im Code überprüfen:

phpmd path/to/code text cleancode,codesize,controversial,design,naming,unusedcode

Dieser Befehl überprüft alle PHP-Dateien im Codeverzeichnis „Pfad/zu/Code“. Der Parameter „text“ gibt das Format der auszugebenden Ergebnisse an. PHPMD unterstützt mehrere Ergebnisformate wie HTML, XML, JSON usw. Die letzten Parameter „cleancode,codesize,controversial,design,naming,unusedcode“ geben den zu verwendenden Regelsatz an. Sie decken viele häufig auftretende Probleme mit der Codequalität ab.

Nach der Ausführung dieses Befehls werden die Dateien, die gegen Qualitätsregeln verstoßen, die Anzahl der Zeilen und die Art der Regel, gegen die verstoßen wird, ausgegeben. Sie können den Code basierend auf den Ergebnissen korrigieren, um eine höhere Codequalität zu erreichen.

Schritt 3: Integrationsprüfung

Wenn Sie diesen Prozess automatisieren möchten, können Sie PHP_CodeSniffer und PHPMD in den Build-Prozess integrieren. Sowohl PHP_CodeSniffer als auch PHPMD werden mithilfe von Befehlszeilentools überprüft, sodass wir sie als Teil des Build-Skripts ausführen können.

Wenn Sie beispielsweise PHPUnit als Testframework verwenden, können Sie den folgenden Code in der Konfigurationsdatei phpunit.xml hinzufügen:

<target name="phpcs">
   <exec executable="phpcs">
      <arg value="--standard=PSR2"/>
      <arg value="./path/to/code"/>
   </exec>
</target>

<target name="phpmd">
   <exec executable="phpmd">
      <arg value="./path/to/code"/>
      <arg value="text"/>
      <arg value="cleancode,codesize,controversial,design,naming,unusedcode"/>
   </exec>
</target>

<target name="build" depends="phpcs,phpmd">
   <echo message="Build success!"/>
</target>

In diesem Beispiel haben wir zwei Build-Ziele definiert: phppcs und phpmd. Diese Ziele führen jeweils eine Codeprüfung von PHP_CodeSniffer und PHPMD durch. Am Ende des Builds geben wir eine Meldung aus, dass der Build erfolgreich war.

Dieses Beispiel ist einfach, aber Sie können es auf einen komplexeren Build-Prozess erweitern. Sie können beispielsweise verhindern, dass der Build-Prozess fortgesetzt wird, wenn Codequalitäts- und Spezifikationsprüfungen fehlschlagen.

Fazit

In diesem Artikel haben wir beschrieben, wie Sie PHP und PHPUnit verwenden, um die Codespezifikation und -qualität zu überprüfen. Diese Tools können die Qualität und Wartbarkeit Ihres Codes erheblich verbessern. Sie sind sehr einfach zu verwenden und können in Ihren Build-Prozess integriert werden, um Prüfungen zu automatisieren. Unabhängig davon, ob Sie eine kleine Anwendung oder ein großes Projekt schreiben, sollten Codequalität und -spezifikation eine Ihrer Prioritäten sein.

Das obige ist der detaillierte Inhalt vonSo überprüfen Sie die Codekonvention und -qualität mit PHP und PHPUnit. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!