Memahami PSR- Panduan Gaya Pengekodan PHP

Jika anda telah lama membangunkan dengan PHP, anda mungkin pernah menemui istilah PSR-12. Ia adalah salah satu piawaian pengekodan yang paling diterima secara meluas dalam komuniti PHP dan bertujuan untuk memastikan konsistensi dalam pangkalan kod PHP merentas projek yang berbeza. Sama ada anda bekerja secara solo atau sebagai sebahagian daripada pasukan, mengikuti PSR-12 boleh menjadikan kod anda lebih bersih, lebih mudah dibaca dan lebih mudah diselenggara. Dalam blog ini, kami akan menghurai apa itu PSR-12, sebab ia penting dan cara anda boleh mengaplikasikannya dalam projek anda.

Jadual Kandungan

1. Apakah itu PSR-12?
2. Mengapa PSR-12 Penting?
3. Peraturan Utama PSR-12
   • Struktur Fail
   • Ruang nama dan Pengisytiharan Penggunaan
   • Kelas dan Kaedah
   • Struktur Kawalan
   • Ulasan dan Dokumentasi
4. Cara Memohon PSR-12 dalam Projek PHP Anda
5. Alat untuk Membantu Anda Mengikuti PSR-12
6. Pemikiran Akhir

Apakah PSR-12?

PSR-12 ialah panduan gaya pengekodan untuk PHP, dibangunkan oleh PHP-FIG (Kumpulan Kebolehoperasian Rangka Kerja). Ia dibina berdasarkan piawaian PSR-2 sebelumnya, menyediakan set peraturan yang dikemas kini yang mencerminkan amalan PHP moden dan meningkatkan ketekalan merentas pangkalan kod.

Fikirkan PSR-12 sebagai pelan tindakan untuk menulis kod PHP yang bersih, boleh dibaca dan boleh diselenggara. Dengan mengikuti PSR-12, pembangun boleh memastikan bahawa kod mereka mematuhi struktur piawai, menjadikannya lebih mudah untuk bekerjasama dengan orang lain dan bekerja pada projek sumber terbuka.

Mengapa PSR-12 Penting?

Piawaian pengekodan seperti PSR-12 bukan hanya tentang memilih ruang dan tab. Inilah sebabnya ia penting:

• Kebolehbacaan: Kod yang mengikut gaya standard lebih mudah dibaca, terutamanya untuk pembangun yang baru mengenali sesuatu projek.
• Kerjasama: Jika semua orang mengikut peraturan yang sama, kerja bersama menjadi lebih lancar dan lebih cekap.
• Kebolehselenggaraan: Kod yang bersih dan konsisten lebih mudah untuk dinyahpepijat, diuji dan dilanjutkan dari semasa ke semasa.
• Saling kendali: Dalam projek sumber terbuka atau apabila menyepadukan perpustakaan pihak ketiga, mengikut piawaian biasa memastikan keserasian merentas pangkalan kod yang berbeza.

Peraturan Utama PSR-12

Mari kita mendalami beberapa peraturan utama yang ditetapkan oleh PSR-12. Walaupun terdapat banyak garis panduan yang lebih kecil, berikut adalah garis panduan yang paling menonjol.

1. Struktur Fail

• Teg Pembukaan: Fail PHP mesti menggunakan teg
• Pengekodan: Fail mesti dikodkan dalam UTF-8 tanpa BOM (Byte Order Mark).
• Panjang Baris: Baris tidak boleh lebih daripada 120 aksara, tetapi baris sehingga 80 aksara lebih diutamakan.
• Barisan Kosong: Seharusnya tiada baris kosong selepas teg PHP pembukaan atau sebelum teg penutup. Selain itu, mesti ada satu baris kosong sebelum penyataan kembali dan antara takrifan kaedah.

2. Ruang nama dan Pengisytiharan Penggunaan

PSR-12 memerlukan ruang nama dan penggunaan pengisytiharan mengikut susunan tertentu untuk meningkatkan kejelasan:

• Pengisytiharan Ruang Nama: Pengisytiharan ruang nama mestilah baris pertama selepas teg PHP pembukaan. Mesti ada satu baris kosong selepas ruang nama.
• Pengisytiharan Guna: Semua pengisytiharan penggunaan mesti dikumpulkan bersama selepas pengisytiharan ruang nama dan dipisahkan dengan baris kosong. Selain itu, mesti ada satu baris kosong selepas pernyataan penggunaan terakhir.

Contoh:

<?php

namespace App\Controllers;

use App\Models\User;
use App\Repositories\UserRepository;

class UserController {
    // Class implementation
}

3. Kelas dan Kaedah

PSR-12 menguatkuasakan beberapa peraturan ketat tentang cara kelas, sifat dan kaedah harus diisytiharkan:

• Pengisytiharan Kelas: Kata kunci kelas mesti diikuti dengan ruang, kemudian nama kelas. Pendakap kerinting terbuka { mesti diletakkan pada baris yang sama dengan pengisytiharan kelas, dengan pendakap penutup } pada baris mereka sendiri.
• Hartanah: Keterlihatan (awam, dilindungi, peribadi) mesti diisytiharkan untuk semua hartanah.
• Kaedah: Sama seperti pengisytiharan kelas, kata kunci fungsi mesti diikuti dengan ruang, kemudian nama kaedah. Keterlihatan mesti diisytiharkan untuk semua kaedah.

class UserController {
    private $userRepository;

    public function __construct(UserRepository $userRepository) {
        $this->userRepository = $userRepository;
    }
}




<h4>
  
  
  4. Struktur Kawalan
</h4>

<p>Struktur kawalan seperti jika, untuk, dan suis mesti mengikut peraturan tertentu:</p>

<ul>
<li>
<strong>Struktur</strong>: Mesti ada satu ruang antara kata kunci kawalan dan kurungan pembukaan. Pendakap kerinting {} mesti sentiasa digunakan, walaupun untuk pernyataan satu baris.</li>
<li>
<strong>Lekukan</strong>: Semua blok di dalam struktur kawalan mesti diinden oleh satu aras (biasanya empat ruang).
</li>
</ul>

<pre class="brush:php;toolbar:false">if ($user->isAdmin()) {
    echo "User is an admin";
} else {
    echo "User is not an admin";
}

5. Komen dan Dokumentasi

Ulasan adalah penting untuk menerangkan sebab bahagian tertentu kod wujud. PSR-12 menekankan keperluan untuk komen yang betul dan jelas.

• Sekat Ulasan: Gunakan /* */ untuk ulasan berbilang baris dan letakkan baris kosong sebelum ulasan.
• Ulasan Baris Tunggal: Gunakan // untuk ulasan sebaris dan pastikan ulasan itu bermakna.

<?php

namespace App\Controllers;

use App\Models\User;
use App\Repositories\UserRepository;

class UserController {
    // Class implementation
}

Cara Memohon PSR-12 dalam Projek PHP Anda

Untuk mengikuti PSR-12 dalam projek anda, anda boleh mematuhi garis panduan secara manual semasa menulis kod, tetapi cara terbaik untuk memastikan pematuhan adalah dengan menggunakan alatan automatik.

Mula-mula, biasakan diri dengan amalan umum ini:

• Gunakan lekukan yang konsisten: Empat ruang diperlukan untuk lekukan.
• Hadkan panjang baris: Cuba pastikan baris anda di bawah 120 aksara, walaupun 80 aksara lebih disukai untuk kebolehbacaan yang lebih baik.
• Susun struktur kod: Ikut peraturan untuk pengisytiharan kelas, keterlihatan dan struktur kawalan.

Alat untuk Membantu Anda Mengikuti PSR-12

Memastikan kod anda mengikut PSR-12 secara manual boleh memakan masa, tetapi terdapat alatan yang boleh membantu anda mengautomasikan proses ini.

1. PHP_CodeSniffer

Salah satu alatan paling popular untuk memastikan kod PHP anda mengikut PSR-12 ialah PHP_CodeSniffer. Ia menganalisis kod anda dan menunjukkan tempat anda menyimpang daripada standard.

Untuk memasang dan menggunakannya:

class UserController {
    private $userRepository;

    public function __construct(UserRepository $userRepository) {
        $this->userRepository = $userRepository;
    }
}

Kemudian, jalankan pada kod anda:

if ($user->isAdmin()) {
    echo "User is an admin";
} else {
    echo "User is not an admin";
}

2. Pembetulkan PHP CS

Satu lagi alatan berguna ialah PHP CS Fixer. Ia bukan sahaja mengesan isu tetapi juga boleh membetulkan kod anda untuk mematuhi PSR-12 secara automatik.

// Fetch user from the repository
$user = $userRepository->find($id);

/*
 * If user is not found, throw an exception.
 * This helps in handling invalid user IDs.
 */
if (!$user) {
    throw new NotFoundException();
}

Jalankan pembetul dengan:

composer require "squizlabs/php_codesniffer=*"

3. Ribut PHP

Jika anda menggunakan PHPStorm, anda boleh mengkonfigurasinya untuk mengikuti PSR-12. Pergi ke Tetapan -> Editor -> Gaya Kod -> PHP dan tetapkan standard kepada PSR-12.

Fikiran Akhir

Mengikuti PSR-12 dalam projek PHP anda adalah lebih daripada sekadar mematuhi peraturan sewenang-wenangnya. Ini tentang menjadikan kod anda lebih bersih, lebih mudah dibaca dan lebih mudah diselenggara—sama ada anda bekerja bersendirian atau bersama pasukan. Dengan mengikuti PSR-12, anda bukan sahaja menulis kod untuk diri sendiri tetapi untuk seluruh komuniti PHP.

Mengguna pakai standard ini ialah satu langkah ke arah menulis kod PHP yang profesional, konsisten dan boleh diselenggara. Gunakan alatan yang dinyatakan untuk memudahkan proses dan lihat sejauh mana projek anda menjadi bersih dan teratur!

Selamat pengekodan!

Atas ialah kandungan terperinci Memahami PSR- Panduan Gaya Pengekodan PHP. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!