Cara menyemak spesifikasi dan kualiti kod menggunakan PHP dan PHPUnit

Dalam pembangunan perisian moden, kualiti dan spesifikasi kod adalah faktor yang sangat penting. Ia bukan sahaja boleh menjadikan kod lebih bersih dan lebih mudah diselenggara, ia juga boleh meningkatkan kebolehbacaan dan kebolehskalaan kod. Tetapi bagaimana anda menyemak kualiti dan spesifikasi kod anda? Artikel ini akan menerangkan cara menggunakan PHP dan PHPUnit untuk mencapai matlamat ini.

Langkah pertama: Semak spesifikasi kod

Dalam pembangunan PHP, terdapat spesifikasi kod yang sangat popular, yang dipanggil PSR (Spesifikasi Standard PHP). Tujuan spesifikasi PSR adalah untuk menjadikan kod PHP lebih mudah dibaca dan diselenggara. Yang paling terkenal ialah PSR-1 dan PSR-2.

Apabila menggunakan PHP dan PHPUnit untuk menyemak spesifikasi kod, kita perlu memasang alat yang dipanggil "PHP_CodeSniffer". Ia adalah penyemak spesifikasi kod PHP yang boleh menyemak sama ada kod tersebut mematuhi spesifikasi PSR.

Menggunakan PHP_CodeSniffer adalah sangat mudah. Kami boleh memasangnya sebagai arahan global (dipasang melalui Komposer) dan kemudian menggunakan arahan berikut dalam terminal untuk menyemak spesifikasi kod:

phpcs --standard=PSR2 path/to/code

Di mana "path/to/code" harus digantikan dengan direktori kod atau laluan fail yang anda mahu untuk menyemak. Selepas melaksanakan arahan ini, bilangan baris yang melanggar spesifikasi dan butiran ralat akan dikeluarkan. Anda boleh mengubah suai kod berdasarkan output untuk mematuhi spesifikasi PSR.

Selain spesifikasi PSR, PHP_CodeSniffer juga menyokong spesifikasi lain, seperti Zend, PEAR, Squiz, dll. Anda boleh menentukan spesifikasi untuk digunakan pada baris arahan menggunakan pilihan --standard.

Langkah 2: Semak kualiti kod

Dari segi spesifikasi kod, kami telah menggunakan PHP_CodeSniffer untuk menyemak. Walau bagaimanapun, alat ini tidak boleh menyemak kualiti kod. Untuk menyemak kualiti kod, kita perlu menggunakan alat lain yang dipanggil "PHPMD".

PHPMD ialah penganalisis kod statik yang boleh menyemak sama ada kod tersebut mematuhi beberapa isu kualiti kod biasa. Ia menyokong menyemak reka bentuk yang buruk, kod yang terlalu kompleks, kod yang tidak digunakan dan banyak lagi.

Seperti PHP_CodeSniffer, kami juga boleh menggunakan Composer untuk memasang PHPMD secara global, dan kemudian menggunakan alat baris arahan untuk menyemak kualiti kod. Perintah berikut boleh menyemak isu kualiti kod dalam kod:

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

Arahan ini akan menyemak semua fail PHP dalam direktori kod "path/to/code". Parameter "teks" menentukan format keputusan yang akan dikeluarkan. PHPMD menyokong berbilang format hasil, seperti HTML, XML, JSON, dll. Parameter terakhir "kod bersih, saiz kod, kontroversi, reka bentuk, penamaan, kod tidak digunakan" menentukan set peraturan untuk digunakan. Mereka merangkumi banyak isu kualiti kod biasa.

Selepas melaksanakan arahan ini, fail yang melanggar peraturan kualiti, bilangan baris dan jenis peraturan yang dilanggar akan dikeluarkan. Anda boleh membetulkan kod berdasarkan keputusan untuk mencapai kualiti kod yang lebih tinggi.

Langkah Tiga: Semakan Integrasi

Jika anda ingin mengautomasikan proses ini, anda boleh menyepadukan PHP_CodeSniffer dan PHPMD ke dalam proses binaan. Kedua-dua PHP_CodeSniffer dan PHPMD diperiksa menggunakan alat baris arahan, jadi kami boleh menjalankannya sebagai sebahagian daripada skrip binaan.

Sebagai contoh, jika anda menggunakan PHPUnit sebagai rangka kerja ujian, anda boleh menambah kod berikut dalam fail konfigurasi phpunit.xml:

<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>

Dalam contoh ini, kami telah menentukan dua sasaran binaan: phpcs dan phpmd. Sasaran ini akan melakukan pemeriksaan kod PHP_CodeSniffer dan PHPMD masing-masing. Pada akhir binaan, kami akan mengeluarkan mesej yang menunjukkan bahawa binaan itu berjaya.

Contoh ini mudah, tetapi anda boleh memanjangkannya ke dalam proses binaan yang lebih kompleks. Sebagai contoh, anda boleh menghalang proses binaan daripada diteruskan jika kualiti kod dan pemeriksaan spesifikasi gagal.

Kesimpulan

Dalam artikel ini, kami membincangkan cara menggunakan PHP dan PHPUnit untuk menyemak spesifikasi dan kualiti kod. Alat ini boleh meningkatkan kualiti dan kebolehselenggaraan kod anda. Ia sangat mudah digunakan dan anda boleh menyepadukannya ke dalam proses binaan anda untuk mengautomasikan semakan. Sama ada anda menulis aplikasi kecil atau projek besar, kualiti dan spesifikasi kod harus menjadi salah satu keutamaan anda.

Atas ialah kandungan terperinci Cara menyemak spesifikasi dan kualiti kod menggunakan PHP dan PHPUnit. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!