Apakah yang saya faham tentang Kod Bersih?

Menyelami Amalan Terbaik Pembangunan Perisian: Refleksi tentang Kod Bersih

Apabila memulakan pengajian dalam amalan pembangunan perisian yang baik, saya membayangkan "Kod Bersih" (Kod Bersih) sebagai satu set peraturan mudah untuk memastikan kod boleh dibaca. Sebahagiannya, persepsi ini betul. Walau bagaimanapun, peraturan ini tidak selalu digunakan untuk semua jenis kod dan pastinya tidak difahami sepenuhnya hanya dengan membaca buku.

Kod Bersih: Perjalanan Berterusan

Baru-baru ini, saya membaca semula Kod Bersih klasik, oleh Robert C. Martin, dan pemahaman saya sangat berbeza daripada bacaan pertama, enam tahun lalu. Sebagai pelajar kolej pada masa itu, banyak masalah dan penyelesaian yang dikemukakan tidak sepenuhnya jelas. Ini adalah salah tanggapan besar: Kod Bersih bukan untuk pemula.

"...bagaimana jika anda seorang doktor dan pesakit meminta anda menghentikan semua mencuci tangan sebagai persediaan untuk pembedahan hanya kerana ia mengambil masa terlalu lama? [...] adalah tidak profesional untuk pengaturcara untuk menyerah kepada kehendak pengurus hebat yang tidak memahami risiko menjana kod yang mengelirukan."

Artikel ini menyerlahkan perkara yang berkaitan daripada pembacaan saya dan berkongsi pengalaman praktikal.

Fungsi: Tanggungjawab Tunggal

Fungsi yang ditulis dengan baik harus mempunyai satu tanggungjawab: lakukan satu perkara, lakukan dengan baik, dan hanya itu sahaja. Mengumpulkan pelbagai tanggungjawab ke dalam satu peranan menjadikan kod sukar dibaca, diuji dan dikekalkan.

Contoh peranan dengan pelbagai tanggungjawab (menyelamatkan dan memberitahu pengguna):

<code>function salvarUsuarioENotificar(usuario) {
    // Valida os dados do usuário
    if (!usuario.nome || !usuario.email) {
        throw new Error('Dados do usuário incompletos.')
    }

    // Salva no banco de dados
    bancoDeDados.salvar(usuario)

    // Envia um e-mail de boas-vindas
    emailService.enviarEmail(usuario.email, 'Bem-vindo!', 'Obrigado por se cadastrar!')
}</code>

Selepas pemfaktoran semula, setiap tanggungjawab dalam peranan tertentu:

<code>function validarUsuario(usuario) {
    if (!usuario.nome || !usuario.email) {
        throw new Error('Dados do usuário incompletos.')
    }
}

function salvarUsuario(usuario) {
    bancoDeDados.salvar(usuario)
}

function enviarEmailDeBoasVindas(usuario) {
    emailService.enviarEmail(usuario.email, 'Bem-vindo!', 'Obrigado por se cadastrar!')
}

function processarCadastroDeUsuario(usuario) {
    validarUsuario(usuario)
    salvarUsuario(usuario)
    enviarEmailDeBoasVindas(usuario)
}</code>

Kini setiap fungsi mempunyai satu tanggungjawab, menjadikan kod lebih mudah dibaca dan lebih mudah diselenggara.

Komen: Utamakan Nama Yang Jelas Sendiri

Komen berguna, tetapi utamakan nama yang menerangkan sendiri untuk mengelakkan lebihan. Komen yang jelas mencemarkan kod.

Contoh ulasan yang tidak perlu:

<code>/** Dia do mês **/
private number diaDoMes;</code>

Meningkatkan dengan nama yang lebih jelas dan tiada ulasan:

<code>private number diaDoMesAtual;</code>

Objek dan Struktur Data: Enkapsulasi dan Kejelasan

Reka bentuk berorientasikan objek yang baik memfokuskan pada mendedahkan operasi dan menyembunyikan butiran pelaksanaan. Ini menggalakkan enkapsulasi, mengurangkan gandingan dan memudahkan penyelenggaraan.

Contoh enkapsulasi dalam kelas Circulo:

<code>class Circulo implements Forma {
    private Ponto centro;
    private number raio;
    private number PI = 3.14159;

    public number calcularArea() {
        return PI * raio * raio;
    }
}</code>

Elakkan menggunakan semula pembolehubah dalam skop yang berbeza untuk tujuan yang berbeza. Gunakan pembolehubah yang berbeza untuk lebih jelas.

Pengendalian Ralat: Pengecualian Daripada Berbilang Pemeriksaan

Pada masa lalu, pengendalian ralat adalah terhad. Hari ini, penggunaan pengecualian menjadikan kod lebih bersih dan lebih mudah dibaca.

Contoh kod verbose dengan berbilang pengesahan:

<code>function salvarUsuarioENotificar(usuario) {
    // Valida os dados do usuário
    if (!usuario.nome || !usuario.email) {
        throw new Error('Dados do usuário incompletos.')
    }

    // Salva no banco de dados
    bancoDeDados.salvar(usuario)

    // Envia um e-mail de boas-vindas
    emailService.enviarEmail(usuario.email, 'Bem-vindo!', 'Obrigado por se cadastrar!')
}</code>

Memfaktorkan semula menggunakan pengecualian:

<code>function validarUsuario(usuario) {
    if (!usuario.nome || !usuario.email) {
        throw new Error('Dados do usuário incompletos.')
    }
}

function salvarUsuario(usuario) {
    bancoDeDados.salvar(usuario)
}

function enviarEmailDeBoasVindas(usuario) {
    emailService.enviarEmail(usuario.email, 'Bem-vindo!', 'Obrigado por se cadastrar!')
}

function processarCadastroDeUsuario(usuario) {
    validarUsuario(usuario)
    salvarUsuario(usuario)
    enviarEmailDeBoasVindas(usuario)
}</code>

Ujian Unit: Kejelasan dan Fokus

Ujian bersih mestilah jelas, mudah dan konsisten. Sampaikan banyak maklumat dengan sedikit ungkapan.

Struktur am ujian: Bina, Kendalikan, Sahkan.

Kelas: SRP (Prinsip Tanggungjawab Tunggal)

Nama kelas harus mencerminkan tanggungjawabnya. Kelas hendaklah kecil, dengan satu tujuan. SRP memastikan setiap kelas hanya mempunyai satu tanggungjawab.

Kesimpulan: Kod Bersih ialah Perjalanan

Kod Bersih tidak boleh dipelajari sekaligus. Ia adalah perjalanan berterusan yang memerlukan latihan, refleksi dan evolusi. Kemahiran sebenar datang dengan pengalaman dan keupayaan untuk melihat peningkatan. Peraturan Kent Beck (menguji, mengelakkan pertindihan, kejelasan, meminimumkan kelas dan kaedah) ialah panduan yang berharga.

Atas ialah kandungan terperinci Apakah yang saya faham tentang Kod Bersih?. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!