序文

何年も働いた後、私は多くのコードを見てきました。優れたコードとは、コードを読みやすく、保守しやすく、拡張しやすくすることに他なりません。言うのは難しいことではありませんし、簡単だと言うのも簡単ではありません。この記事では、何年にもわたって取り組んできたきれいなコードを書く方法について、いくつかの実践をまとめます。

個人の公開アカウント[JAVA Xuyang]の交換と学習に注意を払うことを歓迎します

1. 明確で意味のある名前を使用する

クリーンなコードの最も重要な原則の 1 つは、明確で意味のある名前を使用することです。これにより、他の開発者がコードの動作を理解しやすくなり、エラーの可能性が減少します。たとえば、距離に「d」という名前の変数を使用する代わりに、「距離」という名前の変数を使用します。

// Bad
int d = getDistance();

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

2. 適切なデータ型またはデータ構造を使用する

クリーンコードのもう 1 つの重要な原則は、適切なデータ型を使用することです。これにより、コードが適切に機能し、エラーの可能性が減少します。たとえば、文字列を使用して年齢を表す代わりに、整数を使用します。

// Bad
String age = "25";

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

3. 方法は短く要点を押さえる

クリーンなコードとは、メソッドを短く簡潔に保つことでもあります。メソッドは 1 つのことだけを行う必要があり、コードのテストと保守が容易になるように理解しやすくする必要があります。たとえば、注文を処理するすべてのコードを 1 つのメソッドに入れる代わりに、検証、計算、および保存のための小さなメソッドに分割できます。

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

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

4. 明確で意味のあるメモを書く

クリーンコードのもう 1 つの重要な原則は、明確で意味のあるコメントを書くことです。コメントは、コードがどのようにそれを行うかではなく、そのコードが行う理由を説明する必要があります。これにより、他の開発者がコードを理解しやすくなります。

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

高品質なコードを書くための12の提案をまとめました

序文