7 Mẹo để viết Clean Code - Tạo ra Code sạch và tốt hơn

Trong bài viết này, chúng ta sẽ khám phá khái niệm code sạch, cách đánh giá chất lượng mã nguồn và những mẹo cũng như quy ước giúp bạn viết code sạch hơn.

Viết "Code Sạch" Có Nghĩa Là Gì Và Tại Sao Nó Quan Trọng?

Code sạch là thuật ngữ dùng để mô tả mã nguồn dễ đọc, dễ hiểu và dễ bảo trì. Code được viết một cách đơn giản, ngắn gọn và biểu đạt rõ ràng ý nghĩa của nó. Code sạch tuân theo các quy ước, tiêu chuẩn và thực tiễn giúp lập trình viên dễ dàng đọc, làm việc với mã nguồn.

Code sạch không chứa sự phức tạp không cần thiết, không lặp lại dư thừa và tránh những lỗi thiết kế (code smell) hoặc các anti-patterns gây khó khăn trong việc bảo trì, sửa lỗi và cập nhật.

Chúng ta sẽ không nói quá về tầm quan trọng của code sạch. Khi mã dễ đọc và dễ hiểu, các lập trình viên có thể làm việc hiệu quả hơn, giảm thiểu lỗi và nâng cao năng suất.

Hơn nữa, một mã nguồn dễ bảo trì giúp đảm bảo rằng hệ thống có thể tiếp tục được cải tiến và cập nhật theo thời gian. Điều này đặc biệt quan trọng đối với các dự án dài hạn, nơi mà code cần được duy trì và phát triển trong nhiều năm.

Làm Thế Nào Để Đánh Giá Một Mã Nguồn Có Sạch Hay Không?

Bạn có thể đánh giá code sạch bằng nhiều cách. Tài liệu rõ ràng, định dạng nhất quán và cấu trúc mã nguồn được tổ chức tốt đều là những dấu hiệu của một codebase sạch.

Review code cũng là một phương pháp hiệu quả để xác định các vấn đề tiềm ẩn và đảm bảo mã nguồn tuân thủ các quy tắc và thực tiễn tốt nhất.

Bên cạnh đó, kiểm thử (testing) đóng vai trò quan trọng trong việc duy trì code sạch. Nó giúp đảm bảo mã hoạt động đúng như mong đợi và phát hiện lỗi sớm.

Có nhiều công cụ, phương pháp và quy ước giúp bạn duy trì một codebase sạch. Việc áp dụng những công cụ và thực tiễn này giúp lập trình viên tạo ra mã nguồn dễ đọc, dễ hiểu và dễ bảo trì.

Tuy nhiên, cần lưu ý rằng tính "sạch" của code cũng mang tính chủ quan. Một đoạn mã có thể được coi là rõ ràng và tối ưu với một lập trình viên hoặc một dự án, nhưng chưa chắc phù hợp với người khác hoặc trong một bối cảnh khác.

Dù vậy, vẫn có những quy ước chung mà chúng ta có thể tuân theo để viết code sạch hơn. Hãy cùng tìm hiểu ngay sau đây.

Mẹo và quy ước để viết mã sạch hơn

Dưới đây là một số mẹo và quy ước quan trọng để viết mã sạch hơn:

Hiệu quả, Hiệu suất và Đơn giản

Khi viết mã, ba yếu tố quan trọng cần được ưu tiên là hiệu quả, tối ưu và đơn giản.

Hiệu quả (Effectiveness)

Đầu tiên, code của chúng ta phải hiệu quả, nghĩa là nó phải giải quyết được vấn đề mà nó cần giải quyết. Tất nhiên, đây sẽ là kỳ vọng cơ bản nhất mà chúng ta cần có đối với code của mình. Nếu code không hoạt động như mong đợi, mọi nỗ lực tối ưu hóa hay làm sạch code đều trở nên vô nghĩa.

Tối ưu (Efficiency)

Thứ hai, khi chúng ta biết mã của mình giải quyết được vấn đề, bước tiếp theo là kiểm tra tính tối ưu. Chương trình có sử dụng tài nguyên hợp lý không? Nó có thể chạy nhanh hơn hoặc tiêu tốn ít bộ nhớ hơn không?

Để đánh giá mức độ tối ưu, bạn cần quan tâm đến độ phức tạp thuật toán. Việc hiểu rõ thuật toán giúp bạn lựa chọn cách triển khai hiệu quả nhất.

Lựa chọn cách tiếp cận tốt hơn sẽ giúp code chạy nhanh hơn và tiêu tốn ít tài nguyên hơn.

Sự đơn giản

Cuối cùng là sự đơn giản – yếu tố khó đánh giá nhất vì nó mang tính chủ quan, tùy thuộc vào người đọc code. Tuy nhiên, chúng ta có thể tuân theo một số nguyên tắc sau để đảm bảo code đơn giản và dễ hiểu:

1. Bạn có thể dễ dàng hiểu được chương trình thực hiện những gì ở mỗi dòng không?

2. Tên biến và hàm có phản ánh rõ ràng trách nhiệm của chúng không?

3. Code có được thụt lề, căn chỉnh đúng chuẩn và thống nhất trong toàn bộ dự án không?

4. Có tài liệu hoặc chú thích giúp giải thích các phần phức tạp trong code không?

5. Bạn có thể nhanh chóng xác định một tính năng nằm ở đâu trong codebase không? Việc thêm/xóa tính năng có gây ảnh hưởng đến nhiều phần khác trong chương trình không?

6. Code có được thiết kế theo hướng module, tách biệt các chức năng riêng biệt không?

7. Có tận dụng tái sử dụng code khi cần thiết không?

8. Các quyết định về kiến trúc, thiết kế, và triển khai có được duy trì đồng nhất trong toàn bộ dự án không?

Bằng cách luôn ưu tiên hiệu quả (effectiveness), tối ưu (efficiency), và đơn giản (simplicity), chúng ta có thể thiết lập một tiêu chuẩn rõ ràng để hướng dẫn quá trình triển khai giải pháp. Bây giờ, hãy cùng tìm hiểu sâu hơn về một số quy tắc giúp làm cho việc viết code trở nên đơn giản hơn. 🚀

Định Dạng và Cú Pháp

Sử dụng định dạng và cú pháp nhất quán trong toàn bộ mã nguồn là một yếu tố quan trọng để viết clean code. Khi code có định dạng rõ ràng và thống nhất, nó trở nên dễ đọc hơn, giúp các lập trình viên nhanh chóng nhận diện các mẫu code, hiểu cách hoạt động của chương trình và dễ dàng bảo trì, gỡ lỗi hoặc cập nhật sau này.

Tính nhất quán trong cú pháp và định dạng cũng giúp giảm thiểu lỗi, đảm bảo mọi lập trình viên trong nhóm đều tuân theo cùng một tiêu chuẩn. Dưới đây là một số yếu tố quan trọng cần lưu ý:

Thụt lề và khoảng cách (Indentation & Spacing)

Một đoạn code được căn chỉnh đúng chuẩn sẽ dễ đọc và trực quan hơn rất nhiều.

Cú pháp nhất quán

Các hàm có thể được viết theo nhiều phong cách khác nhau. Dù phong cách nào cũng hoạt động tốt, điều quan trọng là duy trì sự nhất quán để mã nguồn dễ đọc hơn.
Linters và code formatters là công cụ hữu ích để tự động kiểm tra và áp dụng các quy tắc định dạng, giúp duy trì chuẩn mực nhất quán trong toàn bộ dự án.

Quy ước đặt tên nhất quán

Tương tự với cú pháp mà chúng ta chọn tuân theo. Tất cả đều hiệu quả, nhưng chúng ta nên hướng đến việc sử dụng nhất quán cùng một quy ước đặt tên trong suốt dự án của mình.

Đặt tên

Việc đặt tên biến và hàm một cách rõ ràng, mô tả đầy đủ là một khía cạnh quan trọng trong việc viết code sạch. Điều này giúp cải thiện khả năng đọc và bảo trì của toàn bộ mã nguồn. Khi các tên được chọn lựa một cách hợp lý, các lập trình viên khác có thể nhanh chóng hiểu được biến hoặc hàm đang thực hiện công việc gì, cũng như chúng liên quan như thế nào đến phần còn lại của code.

Sự Súc Tích vs Tính Rõ Ràng

Khi viết code sạch, việc tìm ra sự cân bằng giữa tính súc tích và tính rõ ràng là rất quan trọng. Mặc dù việc giữ cho code ngắn gọn giúp cải thiện khả năng đọc và bảo trì, nhưng đồng thời code cũng cần được trình bày một cách rõ ràng, dễ hiểu. Nếu viết code quá ngắn gọn, dễ dẫn đến nhầm lẫn và lỗi, còn có thể khiến cho các lập trình viên khác khó làm việc với code đó.

Khả năng tái sử dụng

Khả năng tái sử dụng mã là một khái niệm cơ bản trong kỹ thuật phần mềm, đề cập đến khả năng mã có thể được sử dụng nhiều lần mà không cần sửa đổi nhiều.

Tầm quan trọng của việc tái sử dụng code nằm ở chỗ nó có thể cải thiện đáng kể hiệu quả và năng suất phát triển phần mềm bằng cách giảm thiểu lượng code cần phải viết và thử nghiệm.

Bằng cách sử dụng lại các đoạn mã đã có, các lập trình viên có thể tiết kiệm thời gian, công sức, nâng cao chất lượng cũng như tính nhất quán của code, đồng thời giảm thiểu rủi ro khi phát sinh lỗi. Code có thể tái sử dụng cũng cho phép xây dựng các kiến trúc phần mềm có tính mô đun và khả năng mở rộng cao, giúp việc bảo trì, cập nhật code dễ dàng hơn theo thời gian.

Luồng thực hiện rõ ràng

Có một luồng thực thi rõ ràng là điều cần thiết để viết mã sạch vì nó làm cho mã dễ đọc, dễ hiểu và dễ bảo trì hơn. Mã tuân theo cấu trúc rõ ràng và hợp lý ít bị lỗi hơn, dễ sửa đổi và mở rộng hơn, hiệu quả hơn về mặt thời gian cũng như tài nguyên.

Ngược lại, "spaghetti code" là thuật ngữ dùng để chỉ mã phức tạp và khó theo dõi, thường có đặc điểm là các khối mã dài, rối rắm và thiếu tổ chức. Loại mã này có thể xuất phát từ các quyết định thiết kế kém, ghép nối quá mức hoặc thiếu tài liệu và chú thích phù hợp.

Nguyên tắc Trách nhiệm Duy nhất (Single Responsibility Principle)

Nguyên tắc Trách nhiệm Duy nhất (SRP) trong phát triển phần mềm quy định rằng mỗi lớp hoặc module chỉ nên có một lý do để thay đổi, hay nói cách khác, mỗi thành phần trong mã nguồn chỉ nên đảm nhận một trách nhiệm duy nhất.

Nguyên tắc này giúp tạo ra mã dễ hiểu, dễ bảo trì và dễ mở rộng.

Bằng cách áp dụng SRP, chúng ta có thể tạo ra mã dễ kiểm tra, tái sử dụng và tái cấu trúc hơn, vì mỗi mô-đun chỉ xử lý một trách nhiệm duy nhất. Điều này giảm thiểu nguy cơ xảy ra tác động phụ hoặc phụ thuộc làm cho mã phức tạp hơn.

Có một "Nguồn duy nhất"

Việc có một "nguồn duy nhất" nghĩa là một dữ liệu hoặc cấu hình cụ thể chỉ được lưu trữ tại một vị trí duy nhất trong mã nguồn, và mọi tham chiếu khác trong mã đều trỏ về nguồn này.

Điều này quan trọng vì nó đảm bảo tính nhất quán của dữ liệu, đồng thời tránh sự trùng lặp và không đồng bộ.

Chỉ Tiết Lộ và Sử Dụng Dữ Liệu Cần Thiết

Một nguyên tắc quan trọng khi viết mã sạch là chỉ tiết lộ và sử dụng những thông tin cần thiết cho một tác vụ cụ thể. Điều này giúp giảm độ phức tạp, tăng hiệu suất và tránh các lỗi phát sinh do sử dụng dữ liệu không cần thiết.

Việc tiết lộ hoặc sử dụng dữ liệu không cần thiết có thể gây ra vấn đề hiệu suất và làm cho mã trở nên khó hiểu, khó bảo trì hơn.

Giả sử bạn có một đối tượng với nhiều thuộc tính, nhưng chỉ cần dùng một vài thuộc tính trong số đó. Một cách tiếp cận là tham chiếu đến đối tượng và các thuộc tính cụ thể mỗi khi cần. Tuy nhiên, cách này có thể trở nên dài dòng và dễ sai sót, đặc biệt khi đối tượng có cấu trúc lồng ghép phức tạp. Giải pháp sạch và hiệu quả hơn là sử dụng cấu trúc object destructuring để chỉ hiển thị và sử dụng thông tin bạn cần.

Tính Module hóa

Tính module hóa là một khái niệm quan trọng trong việc viết mã sạch. Nó đề cập đến việc chia nhỏ mã lớn và phức tạp thành các module hoặc hàm nhỏ hơn, dễ quản lý hơn. Điều này giúp mã dễ hiểu, dễ kiểm thử và dễ bảo trì.

Việc áp dụng tính module hóa mang lại nhiều lợi ích như:

1. Khả năng tái sử dụng: Các module có thể được tái sử dụng ở nhiều phần khác nhau của ứng dụng hoặc trong các ứng dụng khác, giúp tiết kiệm thời gian và công sức phát triển.
2. Đóng gói (Encapsulation): Module cho phép ẩn đi các chi tiết nội bộ của một hàm hoặc đối tượng, chỉ tiết lộ giao diện cần thiết ra bên ngoài. Điều này giúp giảm sự phụ thuộc giữa các phần của mã và nâng cao chất lượng tổng thể.
3. Khả năng mở rộng: Bằng cách chia nhỏ mã thành các phần module, bạn có thể dễ dàng thêm hoặc gỡ bỏ tính năng mà không ảnh hưởng đến toàn bộ mã nguồn.

Cấu trúc thư mục

Lựa chọn cấu trúc thư mục tốt là một phần quan trọng trong việc viết mã sạch. Một cấu trúc dự án được tổ chức tốt giúp lập trình viên dễ dàng tìm kiếm, chỉnh sửa mã, giảm độ phức tạp, đồng thời cải thiện khả năng mở rộng và bảo trì dự án.

Ngược lại, cấu trúc thư mục kém có thể gây khó khăn trong việc hiểu kiến trúc dự án, điều hướng mã nguồn và dẫn đến nhầm lẫn hoặc lỗi.

Nhìn chung, cấu trúc thư mục tốt nên được tổ chức xoay quanh các tính năng, thay vì loại tệp, đồng thời giúp dễ dàng tìm kiếm và chỉnh sửa mã. Một cấu trúc rõ ràng và logic sẽ giúp dự án dễ bảo trì, hiểu và mở rộng hơn, trong khi cấu trúc rối rắm, không nhất quán sẽ gây ra lỗi và sự nhầm lẫn.

Tài liệu

Tài liệu là một phần thiết yếu của việc viết mã sạch. Việc tài liệu hóa đúng cách không chỉ giúp lập trình viên hiểu rõ hơn về mã của chính mình trong tương lai mà còn giúp các lập trình viên khác dễ dàng đọc và hiểu mã nguồn. Mã được tài liệu hóa tốt sẽ tiết kiệm thời gian và công sức khi gỡ lỗi, bảo trì.

Việc ghi chép tài liệu đặc biệt quan trọng trong những trường hợp:

• Khi không thể áp dụng giải pháp đơn giản, dễ hiểu.
• Những trường hợp logic kinh doanh khá phức tạp
• Khi những người không quen thuộc với mã nguồn cần làm việc với nó.

Một cách để ghi lại mã là sử dụng chú thích (Comments). Chú thích có thể cung cấp ngữ cảnh và giải thích mã đang làm gì. Nhưng điều quan trọng là sử dụng chú thích một cách khôn ngoan, chỉ chú thích khi cần thiết và tránh những chú thích thừa hoặc không cần thiết.

Một cách khác để ghi lại tài liệu mã là sử dụng tài liệu nội tuyến. Tài liệu nội tuyến được chèn trực tiếp trong chính mã và có thể được sử dụng để giải thích chức năng hoặc đoạn mã cụ thể thực hiện chức năng gì. Tài liệu nội tuyến thường được sử dụng kết hợp với các công cụ như JSDoc để chuẩn hóa tài liệu cho JavaScript.

Các công cụ như Typescript cũng có thể cung cấp tài liệu tự động cho codebase của chúng ta, điều này cực kỳ hữu ích.

Và cuối cùng, các công cụ như Swagger và Postman có thể được sử dụng để ghi lại tài liệu về API, giúp dễ dàng hiểu cách tương tác với chúng.

Kết luận

Viết "code sạch" không chỉ là một kỹ năng mà còn là yếu tố quyết định đến chất lượng phần mềm. Mong rằng những gì TechWorks chia sẻ trong blog có thể giúp bạn có thêm kiến thức.