深入研究軟件開(kāi)發(fā)最佳實(shí)踐：對(duì)干凈代碼的反思

當(dāng)開(kāi)始研究良好的軟件開(kāi)發(fā)實(shí)踐時(shí)，我將“干凈代碼”（干凈代碼）想象為一組簡(jiǎn)單的規(guī)則，以確保代碼可讀。 在某種程度上，這種看法是正確的。然而，這些規(guī)則并不總是適用于所有類型的代碼，并且僅僅通過(guò)閱讀書籍當(dāng)然無(wú)法完全理解。

干凈的代碼：持續(xù)的旅程

最近，我重讀了 Robert C. Martin 的經(jīng)典著作干凈的代碼，我的理解與六年前的第一次閱讀有很大不同。 作為當(dāng)時(shí)的一名大學(xué)生，提出的許多問(wèn)題和解決方案并不完全清楚。 這是一個(gè)很大的誤解：干凈的代碼不適合初學(xué)者。

“……如果你是一名醫(yī)生，而一名病人僅僅因?yàn)闀r(shí)間太長(zhǎng)而要求你停止洗手以準(zhǔn)備手術(shù)怎么辦？[...]程序員屈服于這種做法是不專業(yè)的偉大的管理者不了解生成混亂代碼的風(fēng)險(xiǎn)。”

這篇文章重點(diǎn)介紹了我閱讀中的相關(guān)要點(diǎn)，并分享了實(shí)踐經(jīng)驗(yàn)。

函數(shù)：?jiǎn)我宦氊?zé)

一個(gè)編寫良好的函數(shù)應(yīng)該有一個(gè)單一的職責(zé)：做一件事，做好它，僅此而已。 將多個(gè)職責(zé)分組為一個(gè)角色會(huì)使代碼難以閱讀、測(cè)試和維護(hù)。

具有多重職責(zé)的角色示例（保存并通知用戶）：

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

重構(gòu)后，每個(gè)職責(zé)都有特定的角色：

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

現(xiàn)在每個(gè)函數(shù)都有一個(gè)職責(zé)，使代碼更具可讀性且更易于維護(hù)。

評(píng)論：優(yōu)先考慮不言自明的名稱

注釋很有用，但優(yōu)先考慮不言自明的名稱以避免冗余。 明顯的注釋會(huì)污染代碼。

不必要的評(píng)論示例：

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

改進(jìn)了名稱更清晰且沒(méi)有注釋：

<code>private number diaDoMesAtual;</code>

對(duì)象和數(shù)據(jù)結(jié)構(gòu)：封裝和清晰度

良好的面向?qū)ο笤O(shè)計(jì)側(cè)重于公開(kāi)操作和隱藏實(shí)現(xiàn)細(xì)節(jié)。 這樣可以促進(jìn)封裝，減少耦合，方便維護(hù)。

封裝在類中的示例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>

避免出于不同目的在不同范圍內(nèi)重復(fù)使用變量。 使用不同的變量可以提高清晰度。

錯(cuò)誤處理：異常而不是多重檢查

過(guò)去，錯(cuò)誤處理是有限的。 如今，使用異常使代碼更簡(jiǎn)潔、更具可讀性。

具有多重驗(yàn)證的詳細(xì)代碼示例：

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

使用異常進(jìn)行重構(gòu)：

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

單元測(cè)試：清晰度和焦點(diǎn)

干凈的測(cè)試必須清晰、簡(jiǎn)單且一致。 用很少的表達(dá)方式傳達(dá)大量的信息。

測(cè)試的一般結(jié)構(gòu)：構(gòu)建、操作、驗(yàn)證。

課程：SRP（單一職責(zé)原則）

類的名稱應(yīng)該反映其職責(zé)。 班級(jí)規(guī)模應(yīng)該小，目標(biāo)單一。 SRP 確保每個(gè)類只有一個(gè)職責(zé)。

結(jié)論：干凈的代碼是一段旅程

干凈的代碼不是一下子就能學(xué)會(huì)的。這是一個(gè)持續(xù)的旅程，需要實(shí)踐、反思和進(jìn)化。 真正的技能來(lái)自于經(jīng)驗(yàn)和看到改進(jìn)的能力。 Kent Beck 的規(guī)則（測(cè)試、避免重復(fù)、清晰、最小化類和方法）是一個(gè)很有價(jià)值的指南。

以上是我對(duì)干凈代碼的理解是什么？的詳細(xì)內(nèi)容。更多信息請(qǐng)關(guān)注PHP中文網(wǎng)其他相關(guān)文章！