He resumido 12 sugerencias para escribir código de alta calidad.

prefacio

Después de trabajar durante tantos años, he visto muchos códigos, algunos están bien escritos y otros están mal escritos. Un buen código no es más que hacer que su código sea legible, mantenible y extensible. No es difícil decirlo, y no es fácil decirlo simple, así que en este artículo resumiré algunas prácticas sobre cómo escribir código limpio después de tantos años de trabajo.

Bienvenido a prestar atención al intercambio y estudio de la cuenta pública personal [JAVA Xuyang]

1. Use nombres claros y significativos

Uno de los principios más importantes del código limpio es usar nombres claros y significativos. Esto facilita que otros desarrolladores entiendan lo que está haciendo su código y reduce la posibilidad de errores. Por ejemplo, en lugar de usar una variable llamada "d" para la distancia, use una variable llamada "distancia".

// Bad
int d = getDistance();

// Good
int distance = getDistance();
复制代码

2. Utilice el tipo de datos o la estructura de datos adecuados

Otro principio importante del código limpio es usar tipos de datos adecuados, esto asegura que su código funcionará correctamente y reduce la posibilidad de errores. Por ejemplo, en lugar de usar una cadena para representar la edad, use un número entero.

// Bad
String age = "25";

// Good
int age = 25;
复制代码

3. Mantén el método corto y directo

El código limpio también se trata de mantener los métodos breves y directos, un método debe hacer solo una cosa y debe ser fácil de entender, lo que facilita la prueba y el mantenimiento del código. Por ejemplo, en lugar de poner todo el código que maneja un pedido en un solo método, se puede dividir en métodos más pequeños para validarlos, calcularlos y guardarlos.

// Bad
public void processOrder(Order order) {
    // lots of code
    }

    // Good
    public void processOrder(Order order) {
        validateOrder(order);
        calculateTotal(order);
        saveOrder(order);
    }
复制代码

4. Escribe notas claras y significativas

Otro principio importante del código limpio es escribir comentarios claros y significativos. Los comentarios deben explicar por qué el código hace lo que hace, no cómo lo hace. Esto hace que su código sea más fácil de entender para otros desarrolladores.

// Bad， 只说明是递增
// increments count 
count++;

// Good，说明业务需要每次加1
// Increment the count by 1
count++;
复制代码

5. Use espacios en blanco y sangría para mejorar la legibilidad

Código limpio también significa hacerlo fácil de leer, utilizando espacios y sangría para mejorar la legibilidad del código. Esto facilita que otros desarrolladores entiendan lo que está haciendo su código.

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

// Good
if (a == b) {
    c = d;
}
复制代码

6. Utilice el manejo de excepciones de la manera correcta

El código limpio requiere que las excepciones se manejen de manera correcta. Solo debe capturar las excepciones que puede manejar y manejarlas de una manera específica, evitando los controladores de excepciones catch-all.

// 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. Use la encapsulación para ocultar los detalles de implementación

La encapsulación es una técnica que ayuda a ocultar los detalles de implementación de una clase y la hace más flexible y extensible. Al usar la encapsulación, puede cambiar la implementación de una clase sin afectar el resto del código.

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

// Good
public class BankAccount {
    private double balance;
    // other methods
}
复制代码

8. Usa la herencia y el polimorfismo para escribir código reutilizable

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

// 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旭阳】交流学习