前言

作业这么多年，见过许许多多的代码，有的写的好，有的写的很糟糕。好的代码不外乎要做到你的代码可阅览、可保护、可扩展。说难不难，说简单也不简单，那么本文我将总结作业这么多年该如何写出整洁代码的一些实践。

欢迎关注个人公众号【JAVA旭阳】交流学习

1.运用明晰且有含义的命名

洁净代码最重要的准则之一是运用明晰且有含义的命名。这使其他开发人员可以轻松了解您的代码在做什么，并减少呈现错误的可能性。例如，不运用名为“d”的变量来表示间隔，而是运用名为“distance”的变量。

// Bad
int d = getDistance();
// Good
int distance = getDistance();

2.运用适宜的数据类型或许数据结构

洁净代码的另一个重要准则是运用适当的数据类型， 这可确保您的代码可以正常作业并减少呈现错误的可能性。例如，不运用字符串来表示年纪，而是运用整数。

// Bad
String age = "25";
// Good
int age = 25;

3.坚持办法简略且要点突出

洁净的代码还与坚持办法简略和要点突出有关，一个办法应该只做一件事而且应该易于了解，这使得测验和保护代码变得愈加简单。例如，与其将处理订单的一切代码放在一个办法中，不如将其分解为更小的办法来进行验证、计算和保存。

// Bad
public void processOrder(Order order) {
    // lots of code
    }
    // Good
    public void processOrder(Order order) {
        validateOrder(order);
        calculateTotal(order);
        saveOrder(order);
    }

4.编撰明晰且有含义的注释

洁净代码的另一个重要准则是编写明晰且有含义的注释。注释应该解说这段代码做的事情的原因，而不是它是如何做的。这使其他开发人员更简单了解您的代码。

// Bad， 只阐明是递加
// increments count 
count++;
// Good，阐明事务需求每次加1
// Increment the count by 1
count++;

5.运用空格和缩进进步可读性

洁净的代码还意味着使其易于阅览，运用空格和缩进来进步代码的可读性。这使其他开发人员更简单了解您的代码在做什么。

// Bad
if(a==b){c=d;}
// Good
if (a == b) {
    c = d;
}

6.以正确的方法运用异常处理

洁净的代码要求 以正确的方法处理异常。您应该只捕获您可以处理的异常，并以特定的方法处理它们，防止包罗万象的异常处理程序。

// Bad
try {
    // some code
} catch (Exception e) {
    // handle exception
}
// Good
try {
    // some code
} catch (IllegalArgumentException e) {
    // handle specific exception
} catch (Exception e) {
    // handle general exception
}

7.运用封装来躲藏完成细节

封装是一种有助于躲藏类的完成细节并使其愈加灵敏和可扩展的技能。经过运用封装，您可以更改类的完成而不影响其他代码。

// Bad
public class BankAccount {
    public double balance;
    // other methods
}
// Good
public class BankAccount {
    private double balance;
    // other methods
}

8.运用承继和多态来编写可重用的代码

承继和多态性是面向对象编程的强大功能，可让您编写可重用的代码。经过运用承继，您可以创立一个包含公共代码的基类，然后创立承继该代码的子类。经过运用多态性，您可以编写以通用方法处理不同类对象的代码。

// Bad
public class Square {
    // code specific to squares
}
public class Circle {
    // code specific to circles
}
// Good
public class Shape {
    // common code for all shapes
}
public class Square extends Shape {
    // code specific to squares
}
public class Circle extends Shape {
    // code specific to circles
}

9.运用设计形式解决常见问题

经过运用设计形式，您可以编写易于了解、保护和扩展的代码。例如，战略形式是一种设计形式，可让您编写灵敏且易于扩展的代码。

// Bad
public class OrderProcessor {
    public void processOrder(Order order) {
        // lots of code
    }
}
// Good
public class OrderProcessor {
    public void processOrder(Order order) {
        OrderStrategy strategy = new OrderStrategy(order);
        strategy.process();
    }
}

10.运用单元测验确保代码按预期作业

洁净的代码也与测验有关。经过编写单元测验，您可以确保您的代码按预期作业而且易于保护。单元测验是测验单个代码单元的自动化测验。

public class BankAccountTest {
    @Test
    public void testDeposit() {
        BankAccount account = new BankAccount();
        account.deposit(100);
        assertEquals(100, account.getBalance());
    }
}

11.运用代码审查来进步代码质量

洁净的代码也与协作有关。经过运用代码审查、结对编程和辅导，您可以进步代码质量并使其更易于了解和保护。

12.运用东西来进步代码质量

开发东西装置 checkstyle 这样的代码格式化东西来检查代码，同样，sonarQube 也可以协助检查代码中的问题。

总结

总而言之，代码不是写给自己看的，而是写给他人看的。你得想办法让你的代码能让他人简单看的懂、简单保护、可以很好的扩展，那么你才是一个合格的程序员，本文介绍了一些最佳实践和示例，期望对你有协助。

欢迎关注个人公众号【JAVA旭阳】交流学习