Code smell

Code chạy đúng chưa chắc đã dễ sửa. Có những dấu hiệu báo trước lần sửa sau sẽ vất vả: cùng một con số chép ở ba nơi, method dài hai trăm dòng. Nhận ra chúng sớm thì sửa rẻ hơn nhiều so với lúc chúng đã gây lỗi.

Khái niệm

👃 Code smell: dấu hiệu trong code cho thấy code khó hiểu, khó sửa, dù chưa chắc đã là lỗi.

Ví dụ

Tổng tiền có VAT 10% được tính ở hai nơi:

Console.WriteLine(CartTotal(100000m));
Console.WriteLine(InvoiceTotal(100000m));

decimal CartTotal(decimal subtotal)
{
    return subtotal * 1.1m;
}

decimal InvoiceTotal(decimal subtotal)
{
    return subtotal * 1.1m;
}

Có hai smell cùng lúc: 1.1m là số trần, không cho biết nó là gì, và công thức bị trùng ở hai method. Sửa bằng một hằng và một method dùng chung:

const decimal VatRate = 0.1m;

decimal WithVat(decimal subtotal)
{
    return subtotal * (1 + VatRate);
}

decimal CartTotal(decimal subtotal)
{
    return WithVat(subtotal);
}

decimal InvoiceTotal(decimal subtotal)
{
    return WithVat(subtotal);
}

• const khai báo hằng số: gán một lần khi viết code, không đổi được lúc chạy.
• Tên VatRate nói rõ con số là gì. VAT đổi thì sửa đúng một dòng.
• Hai method gọi chung WithVat, công thức chỉ còn một chỗ.

Thử ngay

Nhà nước giảm VAT còn 8%. Với bản chưa sửa, lập trình viên chỉ nhớ đổi CartTotal thành subtotal * 1.08m, quên InvoiceTotal. Chạy lại.

Đoán trước khi chạy: số tiền ở giỏ hàng và trên hoá đơn có khớp nhau không?

108000.00
110000.0

Lỗi hay gặp

Sửa mọi smell cùng một lúc. Viết lại cả file trong một lần thì khó biết thay đổi nào làm hỏng gì. Mỗi lần sửa một smell, chạy test, rồi commit.

# SAI — một commit viết lại cả OrderService
git commit -am "Dọn code"

# ĐÚNG — mỗi commit một bước nhỏ, test xanh sau mỗi bước
git commit -am "Đặt hằng VatRate"
git commit -am "Tách method WithVat"

Tóm tắt

• Code smell là dấu hiệu code khó sửa, chưa chắc là lỗi.
• Bốn smell hay gặp: trùng lặp, method dài, số trần, tham số dài.
• Số trần thay bằng const có tên. Công thức trùng gom về một method.
• Sửa từng smell một, test và commit sau mỗi bước.