Java 코드 컨벤션

패키지/클래스/메서드/변수 명명 규칙

• 패키지명
  • 소문자 사용, 일반적으로 도메인 역순으로 구성.
  • 예: com.example.myapp
• 클래스/인터페이스명
  • 파스칼 케이스(PascalCase) 사용.
  • 명사 형태, 인터페이스는 ‘able’ 또는 ‘ible’로 끝나는 경우 많음(선택 사항).
  • 예: public class UserService, public interface Runnable
• 메서드명
  • 카멜 케이스(camelCase) 사용.
  • 동사 또는 동사구 형태, 역할을 명확히.
  • 예: getUserById(), calculateTotalPrice()
• 변수명
  • 카멜 케이스(camelCase) 사용.
  • 의미가 명확하도록 작성, 축약형 지양.
  • 예: int userCount, String firstName
• 상수명
  • 모든 문자를 대문자로, 단어 간 구분은 언더스코어(_) 사용.
  • 예: public static final int MAX_SIZE = 100;

들여쓰기/공백/중괄호

• 들여쓰기

  • IDE 설정 → 탭 스페이스 4개 또는 2개 설정

• 중괄호 위치

  • K&R 스타일(한 줄 위에 여는 중괄호):

    public void example() {
        // ...
    }
    

• 띄어쓰기

  • 연산자 주위에 공백 권장: int sum = a + b;
  • if, for 등의 키워드 뒤에 공백: if (condition) { ... }

주석

• Javadoc 주석

  • 클래스, 메서드, 필드에 대한 설명 사용:

    /**
     * 사용자 정보를 반환합니다.
     *
     * @param id 사용자 ID
     * @return 사용자 객체
     */
    public User getUserById(Long id) { ... }
    

• 라인 주석

  • 불분명한 로직 또는 주의가 필요한 부분:

    // 사용자 정보를 DB에서 조회
    User user = userRepository.findById(id);
    

기타 권장 사항

• 에러 처리: 충분히 의미 있는 예외를 던지고, try-catch 시 구체적인 메시지 로그.
• 컬렉션 타입: 제네릭(Generics)을 사용해 타입 안정성 보장.
• 코드 길이 제어: 메서드가 너무 길어지지 않도록 분리해서 작성.

Spring 코드 컨벤션

패키지 구조