【保守性抜群】Java コーディング規約 完全ガイド2024：15の重要ルールと実践例

初めに、なぜJavaプロジェクトでコーディング規約が重要なのか、その基本的な考え方から見ていきましょう。

　● レビュー基準の明確化

   // 良い例
   public class UserAuthentication { }
   public class PaymentProcessor { }

   // 悪い例
   public class userAuth { }
   public class payment_processor { }

　● 意味のある具体的な名前を選択

   // 良い例
   public void processPayment(Payment payment) { }
   public boolean isValid() { }

   // 悪い例
   public void Process() { }
   public boolean valid() { }

　● boolean型を返すメソッドは「is」「has」「can」で開始

   // 良い例
   private String userName;
   private static final int MAX_RETRY_COUNT = 3;

   // 悪い例
   private String UserName;
   private static final int retrycount = 3;

　● 一時変数でも意味のある名前を使用

   // 良い例
   public class Example {
       public void method() {
           if (condition) {
               doSomething();
           }
       }
   }

   // 悪い例
   public class Example {
   public void method() {
   if (condition) {
   doSomething();
   }}}

   // 良い例
   String message = StringUtils.join(
       "This is a very long string that needs",
       " to be split across multiple lines"
   );

   // 悪い例
   String message = StringUtils.join("This is a very long string that needs", " to be split across multiple lines");

   /**
    * ユーザーの認証を行うメソッド
    * @param username ユーザー名
    * @param password パスワード
    * @return 認証成功時はtrue、失敗時はfalse
    * @throws AuthenticationException 認証処理でエラーが発生した場合
    */
   public boolean authenticate(String username, String password) throws AuthenticationException {
       // 実装
   }

   public void processOrder() {
       // 在庫チェック
       if (!checkInventory()) {
           return;
       }

       // 支払い処理
       processPayment();

       // 配送手配
       arrangeShipment();
   }

   // 良い例
   try {
       fileProcessor.processFile();
   } catch (FileNotFoundException e) {
       logger.error("ファイルが見つかりません", e);
       throw new BusinessException("ファイル処理に失敗しました", e);
   } catch (IOException e) {
       logger.error("ファイル読み込みエラー", e);
       throw new BusinessException("ファイル処理に失敗しました", e);
   }

   // 良い例
   try (FileInputStream fis = new FileInputStream(file);
        BufferedReader reader = new BufferedReader(new InputStreamReader(fis))) {
       // ファイル処理
   }

// 良い例
List<String> list = new ArrayList<>();
Collections.sort(list);

// 悪い例（車輪の再発明）
String[] array = new String[10];
customSort(array);

// 良い例
if (StringUtils.isEmpty(value)) {
    return;
}

// 悪い例
if (value == null || value.trim().length() == 0) {
    return;
}

// 良い例
public final class ImmutableUser {
    private final String name;
    private final int age;
    
    public ImmutableUser(String name, int age) {
        this.name = name;
        this.age = age;
    }
    
    // getterのみ提供
}

// 良い例
public void processOrder() {
    validateOrder();
    calculateTotal();
    saveOrder();
    sendConfirmation();
}

public class Constants {
    public static final int MAX_RETRY_COUNT = 3;
    public static final String API_BASE_URL = "https://api.example.com";
    private Constants() {} // インスタンス化防止
}

com.company.project/
├── domain/
│   ├── model/
│   └── service/
├── infrastructure/
│   ├── repository/
│   └── config/
└── presentation/
    ├── controller/
    └── dto/

public class userManagement {
    private ArrayList user_list;

    public boolean Register(String n, String p, int a) {
        // データチェック
        if(n == null || n.length() == 0) return false;
        if(p == null || p.length() < 6) return false;
        if(a < 0) return false;

        try {
            User u = new User(n, p, a);
            user_list.add(u);
            return true;
        }
        catch(Exception e) {
            e.printStackTrace();
            return false;
        }
    }
}

public class UserManager {
    private static final int MINIMUM_PASSWORD_LENGTH = 6;
    private final List<User> userList;

    /**
     * ユーザー登録を行うメソッド
     * @param name ユーザー名
     * @param password パスワード
     * @param age 年齢
     * @return 登録成功時はtrue
     * @throws IllegalArgumentException 入力値が不正な場合
     * @throws RegistrationException 登録処理に失敗した場合
     */
    public boolean registerUser(String name, String password, int age) {
        validateRegistrationInput(name, password, age);

        try {
            User newUser = new User(name, password, age);
            return userList.add(newUser);
        } catch (Exception e) {
            logger.error("ユーザー登録に失敗しました", e);
            throw new RegistrationException("登録処理に失敗しました", e);
        }
    }

    private void validateRegistrationInput(String name, String password, int age) {
        if (StringUtils.isEmpty(name)) {
            throw new IllegalArgumentException("名前は必須です");
        }
        if (StringUtils.isEmpty(password) || password.length() < MINIMUM_PASSWORD_LENGTH) {
            throw new IllegalArgumentException("パスワードは6文字以上必要です");
        }
        if (age < 0) {
            throw new IllegalArgumentException("年齢は0以上である必要があります");
        }
    }
}

   // 違反例
   public class dataProcessor {
       private String Data_value;
       public void Process_data() {}
   }

   // 修正例
   public class DataProcessor {
       private String dataValue;
       public void processData() {}
   }

   // 違反例
   try {
       // 処理
   } catch (Exception e) {
       e.printStackTrace();
   }

   // 修正例
   try {
       // 処理
   } catch (IOException e) {
       logger.error("ファイル処理でエラーが発生しました", e);
       throw new BusinessException("処理に失敗しました", e);
   } catch (SQLException e) {
       logger.error("データベース処理でエラーが発生しました", e);
       throw new BusinessException("処理に失敗しました", e);
   }

   // 違反例
   public void processOrder(Order order) {
       // 在庫チェック
       if (inventory.check(order.getItems())) {
           // 支払い処理
           if (paymentGateway.process(order.getPayment())) {
               // メール送信
               mailSender.sendConfirmation(order);
               // DB保存
               orderRepository.save(order);
           }
       }
   }

   // 修正例
   public void processOrder(Order order) {
       validateInventory(order);
       processPayment(order);
       sendConfirmation(order);
       saveOrder(order);
   }

3.3 レビュー時に注目すべき5つのポイント

　● 将来の拡張性は考慮されているか

   // Google Style
   package com.example.project;  // 1行目はpackage文

   import java.util.Arrays;      // インポートは分類ごとにブロック化
   import java.util.List;

   import com.google.common.base.Preconditions;

   public class Example {        // クラス定義
       // 実装
   }

   // Google Style
   @Nullable public String getNameIfPresent() {  // 80文字制限
       if (condition()) {
           try {
               doSomething();
           } catch (ProblemException e) {
               return null;
           }
       }
       return "name";
   }

   com.example.project/
   ├── config/          // 設定クラス
   ├── controller/      // Web層
   ├── service/         // ビジネスロジック
   ├── repository/      // データアクセス
   └── model/           // ドメインモデル

   // Spring Style
   @Service
   public class UserService {
       private final UserRepository userRepository;

       public UserService(UserRepository userRepository) {  // コンストラクタ注入
           this.userRepository = userRepository;
       }
   }

   // checkstyle.xml
   <?xml version="1.0"?>
   <!DOCTYPE module PUBLIC
       "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
       "https://checkstyle.org/dtds/configuration_1_3.dtd">
   <module name="Checker">
       <!-- Google Checkstyleをベースに設定 -->
       <module name="TreeWalker">
           <!-- プロジェクト固有のカスタマイズ -->
           <module name="LineLength">
               <property name="max" value="120"/>  <!-- 行長制限を緩和 -->
           </module>
       </module>
   </module>

   // カスタマイズ例
   com.company.project/
   ├── common/          // 共通機能
   │   ├── config/     // 設定
   │   └── util/       // ユーティリティ
   ├── feature1/       // 機能単位での分割
   │   ├── api/
   │   ├── service/
   │   └── repository/
   └── feature2/
       ├── api/
       ├── service/
       └── repository/

   // プロジェクト固有の接頭辞規則
   public interface IUserRepository { }     // インターフェースにIを付与
   public class AbstractBaseController { }  // 抽象クラスにAbstractを付与
   public class UserServiceImpl { }         // 実装クラスにImplを付与

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-checkstyle-plugin</artifactId>
    <version>3.3.1</version>
    <configuration>
        <configLocation>google_checks.xml</configLocation>
        <encoding>UTF-8</encoding>
        <consoleOutput>true</consoleOutput>
        <failsOnError>true</failsOnError>
        <linkXRef>false</linkXRef>
    </configuration>
    <executions>
        <execution>
            <id>validate</id>
            <phase>validate</phase>
            <goals>
                <goal>check</goal>
            </goals>
        </execution>
    </executions>
</plugin>

<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
    "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
    "https://checkstyle.org/dtds/configuration_1_3.dtd">
<module name="Checker">
    <property name="charset" value="UTF-8"/>
    <property name="severity" value="warning"/>

    <module name="TreeWalker">
        <!-- 命名規則チェック -->
        <module name="TypeName"/>
        <module name="MemberName"/>
        <module name="MethodName"/>
        <module name="ParameterName"/>
        <module name="LocalVariableName"/>

        <!-- コードスタイルチェック -->
        <module name="LineLength">
            <property name="max" value="120"/>
        </module>
        <module name="LeftCurly"/>
        <module name="RightCurly"/>
        <module name="EmptyBlock"/>

        <!-- Javadocチェック -->
        <module name="JavadocMethod">
            <property name="scope" value="public"/>
        </module>
    </module>
</module>

version: "3"
services:
  sonarqube:
    image: sonarqube:latest
    ports:
      - "9000:9000"
    environment:
      - SONAR_JDBC_URL=jdbc:postgresql://db:5432/sonar
      - SONAR_JDBC_USERNAME=sonar
      - SONAR_JDBC_PASSWORD=sonar
    volumes:
      - sonarqube_data:/opt/sonarqube/data
      - sonarqube_extensions:/opt/sonarqube/extensions

  db:
    image: postgres:12
    environment:
      - POSTGRES_USER=sonar
      - POSTGRES_PASSWORD=sonar
    volumes:
      - postgresql:/var/lib/postgresql
      - postgresql_data:/var/lib/postgresql/data

volumes:
  sonarqube_data:
  sonarqube_extensions:
  postgresql:
  postgresql_data:

<plugin>
    <groupId>org.sonarsource.scanner.maven</groupId>
    <artifactId>sonar-maven-plugin</artifactId>
    <version>3.10.0.2594</version>
</plugin>

sonar.projectKey=my-project
sonar.projectName=My Project
sonar.projectVersion=1.0
sonar.sources=src/main/java
sonar.java.binaries=target/classes
sonar.coverage.jacoco.xmlReportPaths=target/site/jacoco/jacoco.xml

   {
     "quality_gates": {
       "conditions": [
         {
           "metric": "new_coverage",
           "op": "LT",
           "warning": "80",
           "error": "70"
         },
         {
           "metric": "new_duplicated_lines_density",
           "op": "GT",
           "error": "5"
         }
       ]
     }
   }

　　● リアルタイムフィードバックの活用

name: Java Code Quality Check

on:
  push:
    branches: [ main, develop ]
  pull_request:
    branches: [ main, develop ]

jobs:
  quality-check:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v2

    - name: Set up JDK 17
      uses: actions/setup-java@v2
      with:
        java-version: '17'
        distribution: 'adopt'

    - name: Cache Maven packages
      uses: actions/cache@v2
      with:
        path: ~/.m2
        key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
        restore-keys: ${{ runner.os }}-m2

    - name: Build and analyze
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
      run: |
        mvn clean verify
        mvn checkstyle:check
        mvn sonar:sonar

    - name: Upload quality report
      if: always()
      uses: actions/upload-artifact@v2
      with:
        name: quality-report
        path: target/site/

pipeline {
    agent any

    stages {
        stage('Quality Gate') {
            steps {
                script {
                    def qg = waitForQualityGate()
                    if (qg.status != 'OK') {
                        error "品質基準を満たしていません: ${qg.status}"
                    }
                }
            }
        }
    }
}

graph LR
    A[コード作成] --> B[自動チェック]
    B --> C[セルフレビュー]
    C --> D[ペアレビュー]
    D --> E[チームレビュー]
    E --> F[マージ]

   # チーム規約ガイド

   ## 1. 共通規約
   - Google Java Style Guide準拠
   - プロジェクト固有のカスタマイズ規約

   ## 2. レビュー基準
   - 必須チェック項目
   - 推奨項目

   ## 3. トラブルシューティング
   - よくある問題と解決方法
   - FAQ

// オンボーディングチェックリスト
class OnboardingChecklist {
    List<Task> requiredTasks = Arrays.asList(
        new Task("開発環境セットアップ", 1),
        new Task("規約ドキュメント確認", 2),
        new Task("チェックツール設定", 1),
        new Task("サンプルPR作成", 3),
        new Task("メンターレビュー", 2)
    );
}

　　● 改善提案の奨励

　● 規約を硬直的なルールではなく、進化する指針として扱う

本記事で紹介した内容は、あくまでも基本的なガイドラインです。これらを出発点として、あなたのチームに最適な規約とプロセスを見つけていってください。規約の導入によって、コードの品質向上だけでなく、チームの生産性と開発の楽しさも高まっていくはずです。