Panduan Penting untuk Kod Pemfaktoran Semula untuk Reka Bentuk Yang Lebih Bersih dan Digilap

Dalam dunia pembangunan perisian yang pantas, menulis kod yang bersih dan boleh diselenggara adalah penting. Diilhamkan oleh "Kod Bersih" Uncle Bob, kami akan menyelidiki lima prinsip pemfaktoran semula yang penting untuk meningkatkan pangkalan kod anda. Setiap prinsip disertakan dengan contoh kod TypeScript yang menunjukkan cara melaksanakan penambahbaikan ini. Mari kita perhalusi kod kita bersama-sama!

1️⃣ Katakan Tidak kepada Fungsi Besar

Penjelasan: Uncle Bob menasihatkan agar fungsi tetap ringkas, idealnya di bawah 20 baris. Fungsi besar boleh menjadi mencabar untuk memahami, menguji dan mengekalkan. Dengan memecahkan fungsi kepada bahagian yang lebih kecil dan lebih mudah diurus, anda meningkatkan kebolehbacaan dan mengurangkan kerumitan.

Sebelum Pemfaktoran Semula:

import fs from 'fs';

function processData(data: string[]): void {
    // Step 1: Validate data
    if (!Array.isArray(data)) {
        throw new Error("Input must be an array");
    }

    // Step 2: Clean data
    const cleanedData = data.map(item => item.trim()).filter(item => item !== '');

    // Step 3: Process data
    const result: string[] = [];
    for (const item of cleanedData) {
        if (item.length > 5) {
            result.push(item.toUpperCase());
        } else {
            result.push(item.toLowerCase());
        }
    }

    // Step 4: Save results
    fs.writeFileSync('results.txt', result.join('\n'));
}

Selepas Pemfaktoran Semula:

import fs from 'fs';

function validateData(data: any): void {
    if (!Array.isArray(data)) {
        throw new Error("Input must be an array");
    }
}

function cleanData(data: string[]): string[] {
    return data.map(item => item.trim()).filter(item => item !== '');
}

function processItem(item: string): string {
    return item.length > 5 ? item.toUpperCase() : item.toLowerCase();
}

function saveResults(results: string[], filename: string = 'results.txt'): void {
    fs.writeFileSync(filename, results.join('\n'));
}

function processData(data: string[]): void {
    validateData(data);
    const cleanedData = cleanData(data);
    const results = cleanedData.map(processItem);
    saveResults(results);
}

2️⃣ Merangkul Tanggungjawab Tunggal

Penjelasan: Setiap kelas atau kaedah harus mempunyai satu tanggungjawab. Ini bermakna setiap kelas atau kaedah harus melakukan satu perkara dan melakukannya dengan baik. Mematuhi prinsip ini menjadikan kod anda lebih modular, lebih mudah untuk diuji dan lebih fleksibel untuk diubah.

Sebelum Pemfaktoran Semula:

class User {
    constructor(public username: string, public email: string) {}

    sendEmail(message: string): void {
        // Code to send an email
        console.log(`Sending email to ${this.email}: ${message}`);
    }

    saveToDatabase(): void {
        // Code to save user to the database
        console.log(`Saving ${this.username} to the database`);
    }
}

Selepas Pemfaktoran Semula:

class User {
    constructor(public username: string, public email: string) {}
}

class EmailService {
    sendEmail(email: string, message: string): void {
        // Code to send an email
        console.log(`Sending email to ${email}: ${message}`);
    }
}

class UserRepository {
    save(user: User): void {
        // Code to save user to the database
        console.log(`Saving ${user.username} to the database`);
    }
}

3️⃣ Permudahkan Hantaran Parameter

Penjelasan: Mengehadkan bilangan parameter yang diterima fungsi menjadikannya lebih mudah untuk difahami dan digunakan. Fungsi kompleks dengan banyak parameter boleh mengelirukan dan terdedah kepada ralat. Dengan menggunakan objek atau struktur data, anda boleh mengumpulkan parameter berkaitan bersama-sama.

Sebelum Pemfaktoran Semula:

function createUser(username: string, email: string, password: string, age: number, address: string): void {
    // Code to create a user
    console.log(`Creating user: ${username}, ${email}, ${password}, ${age}, ${address}`);
}

Selepas Pemfaktoran Semula:

interface User {
    username: string;
    email: string;
    password: string;
    age: number;
    address: string;
}

function createUser(user: User): void {
    // Code to create a user
    console.log(`Creating user: ${user.username}, ${user.email}, ${user.password}, ${user.age}, ${user.address}`);
}

4️⃣ Elakkan Nombor Ajaib

Penjelasan: Nombor ajaib ialah nombor literal yang digunakan terus dalam kod tanpa penjelasan. Mereka boleh membuat kod lebih sukar untuk difahami dan diselenggara. Menggantikan nombor ajaib dengan pemalar bernama meningkatkan kebolehbacaan dan menjadikan perubahan masa depan lebih mudah.

Sebelum Pemfaktoran Semula:

function calculateDiscountedPrice(price: number): number {
    // Apply a discount of 15%
    return price * 0.85;
}

function calculateShippingCost(weight: number): number {
    // Shipping cost per kilogram
    return weight * 5;
}

Selepas Pemfaktoran Semula:

const DISCOUNT_RATE = 0.15;
const SHIPPING_COST_PER_KG = 5;

function calculateDiscountedPrice(price: number): number {
    // Apply a discount
    return price * (1 - DISCOUNT_RATE);
}

function calculateShippingCost(weight: number): number {
    // Shipping cost per kilogram
    return weight * SHIPPING_COST_PER_KG;
}

5️⃣ Nama Pembolehubah dengan Maksud

Penjelasan: Menggunakan nama pembolehubah yang bermakna menjadikan kod anda mendokumentasikan diri dan lebih mudah difahami. Elakkan nama huruf tunggal atau samar; sebaliknya, pilih nama yang menyampaikan tujuan dan penggunaan pembolehubah dengan jelas.

Sebelum Pemfaktoran Semula:

function calculate(u: number, v: number): number {
    const r = u + v;
    const p = r * 2;
    return p;
}

Selepas Pemfaktoran Semula:

function calculateTotalCost(baseCost: number, additionalFees: number): number {
    const totalCost = baseCost + additionalFees;
    return totalCost;
}

Kesimpulan

Menggunakan prinsip pemfaktoran semula ini pada kod TypeScript anda akan meningkatkan kejelasan, kebolehselenggaraan dan kualiti keseluruhannya dengan ketara. Amalan kod bersih adalah penting untuk pembangunan dan kerjasama yang berkesan.

Apakah strategi pemfaktoran semula yang paling berkesan untuk anda? Kongsi pengalaman anda atau sebarang cabaran yang anda hadapi di bawah! ?

Atas ialah kandungan terperinci Panduan Penting untuk Kod Pemfaktoran Semula untuk Reka Bentuk Yang Lebih Bersih dan Digilap. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!