�ݺ�ߣ

Clean Code
Trở thành một Lập trình viên tốt hơn
Nguyễn Khắc Nhật

Bạn đã bao giờ?
• Đọc lại những dòng code của mình và tự hỏi:
• Đứa nào code vậy? Đoạn này nghĩa là thế nào đây?
• Code chỗ này nhưng lại phát sinh bug ở chỗ kia?
• Càng code thì hệ thống càng chậm?
• Thậm chí đến một lúc nó còn không chạy được
• Đọc mã nguồn của các hệ thống mã nguồn mở và không hiểu ��ì?
• Phải viết thêm nhiều câu chú thích trong code của mình?
• Bởi vì nếu không thì không ai hiểu chúng đang làm gì
• Cố gắng viết mã nguồn ngắn nhất có thể, bởi vì như thế mới là xịn?
• Mà không biết rằng chúng rất khó hiểu

Bạn có đang?
• Tự hào về những dòng code mà mình viết ra?
• Hay là chỉ muốn giấu diếm chúng, không muốn ai nhìn thấy?
• Cố gắng dành thời gian để trau chuốt những dòng code?
• Hay là code cho chúng chạy được là tốt rồi?
• Viết code một cách bài bản?
• Hay theo chiến thuật code-and-fix?

Những hình ảnh thường thấy

Clean code - Trở thành một lập trình viên tốt hơn

Bạn viết code như thế nào?

Quy trình thường thấy
Ban ��ầu

Hệ thống đẹp

Thêm tính năng mới

Thêm một tính năng mới

Thay đổi một tính năng

Thời gian trôi ��ܲ�…

Kết quả thường thấy
Bạn có thấy quen thuộc không?

Kết quả thường thấy
Làm thế
nào để
code tiếp?
Bạn có thấy quen thuộc không?

Cách làm đúng
Ban ��ầu

Cách làm đúng
Hệ thống đẹp

Cách làm đúng

Dọn dẹp sạch sẽ
Cách làm đúng

Cách làm đúng

Cách làm đúng
Dọn dẹp sạch sẽ

Kết quả cần có
Kiến trúc sạch

Về năng suất thì sao?
`
Thời gian
Năng suất
`
Code bẩn
Code sạch

• Clean Code là tiêu chuẩn của code “tốt”
• Code như thế nào thì được coi là tốt?

Grady Booch
Object Oriented Analysis
Dave Thomas
OTI, Eclipse
Michael Feathers
Working effectively with Legacy Code
Ron Jeffries
Extreme Programming Installed
Extreme Programing Adventures in C#

• Đơn giản
• Trực tiếp
• Dễ đọc hiểu
• Có ít phụ thuộc
• Không có code lặp
• Chạy tất cả các bài kiểm thử
• Không làm mờ đi ý định của người viết
• Giống một bài văn hay
• Giống như là được viết ra bởi một người rất có tâm
Clean Code

Smell Code
• Đặt tên vô nghĩa
• Phương thức quá dài
• Lớp quá dài
• Phương thức xử lý quá nhiều việc
• Phương thức có quá nhiều tham số
• Lạm ��ụng quá nhiều ghi chú (comment) trong mã nguồn
• Mã nguồn bị trùng lặp
• Sử ��ụng các giá trị magic

Clean Code ở đâu?
Định danh Hàm Ghi chú
Định dạng
Đối tượng & Lớp
Xử lý lỗi Kiểm thử
Kiến trúc

Clean Code thì được ��ì?
• Cộng tác dễ dàng hơn
• Debug dễ dàng hơn
• Ít rủi ro hơn
• Năng suất hơn
• Đi được đường dài hơn
• Hạnh phúc hơn

Làm sao để có Clean Code?
• Phải nắm tiêu chuẩn
• Phải biết mục đích
• Phải làm việc với tinh thần phục vụ
• Khác với làm cho xong việc
• Phải học các pattern (nhận diện code thối)
• Phải học các dọn dẹp code (refactor)

Đặt tên có ý nghĩa và đọc được (1)
• Không tốt:
• Tốt:
String yyyymmdstr = new SimpleDateFormat("YYYY/MM/DD").format(new Date());
String currentDate = new SimpleDateFormat("YYYY/MM/DD").format(new Date());

Đặt tên có ý nghĩa và đọc được (2)
• Không tốt • Tốt
public List<int[]> getThem() {
List<int[]> list1 = new ArrayList<int[]>();
for (int[] x : theList)
if (x[0] == 4)
list1.add(x);
return list1;
}
public List<int[]> getFlaggedCells() {
List<int[]> flaggedCells = new ArrayList<int[]>();
for (int[] cell : gameBoard)
if (cell[STATUS_VALUE] == FLAGGED)
flaggedCells.add(cell);
return flaggedCells;
}

Đặt tên đồng nhất khi có cùng ý nghĩa
• Không tốt:
• Tốt:
getUserInfo();
getClientData();
getCustomerRecord();
getUser();

Đặt tên để tìm kiếm được
• Không tốt:
• Tốt:
setTimeout(blastOff, 86400000);
public static final int MILLISECONDS_IN_A_DAY = 86400000;
setTimeout(blastOff, MILLISECONDS_IN_A_DAY);

Đặt tên để tự giải thích ý nghĩa
• Không tốt:
• Tốt:
Application application = new Application();
//...
if(application.getStatus() == "paid") {
//...
}
Application application = new Application();
//...
if(application.isPaid()) {
//...
}

Không thêm các ngữ cảnh thừa
• Không tốt: • Tốt:
class Car {
public String carMake = "Honda";
public String carModel = "Accord";
public String carColor = "Blue";
}
void paintCar(Car car) {
car.carColor = "Red";
}
class Car {
public String make = "Honda";
public String model = "Accord";
public String color = "Blue";
}
void paintCar(Car car) {
car.color = "Red";
}

Mỗi hàm chỉ nên làm một việc
public void emailClients(List<Client> clients) {
for (Client client : clients) {
Client clientRecord = repository.findOne(client.getId());
if (clientRecord.isActive()){
email(client);
}
}
}
public void emailClients(List<Client> clients) {
for (Client client : clients) {
if (isActiveClient(client)) {
email(client);
}
}
}
private boolean isActiveClient(Client client) {
Client clientRecord = repository.findOne(client.getId());
return clientRecord.isActive();
}

Tên hàm cần có ý nghĩa
private void addToDate(Date date, int month){
//..
}
Date date = new Date();
addToDate(date, 1);
private void addMonthToDate(Date date, int month){
//..
}
Date date = new Date();
addMonthToDate(1, date);

Bộ các kỹ thuật liên quan
• Clean Code
• Tiêu chuẩn chất lượng
• Code Refactoring
• Cách để có được Clean Code
• Automation Test
• Đảm bảo an toàn khi refactor
• Design Pattern
• Tiêu chuẩn chất lượng cao hơn

�ݺ�ߣ

Clean code - Trở thành một lập trình viên tốt hơn

More Related Content

Clean code - Trở thành một lập trình viên tốt hơn