[java] JSR 305을 이용한 자바 코드 네이밍 규칙
자바 코드의 가독성은 개발자와 유지보수를 위해 매우 중요합니다. 적절한 코드 네이밍은 이해하기 쉽고 유지보수가 용이한 코드를 작성하는 데 도움이 됩니다.
JSR 305은 자바 어노테이션을 활용하여 코드 네이밍 규칙을 지정하는 표준 사양입니다. 이를 사용하여 코드의 의미를 명확하게 전달하고 일관성을 유지할 수 있습니다.
1. 변수와 메서드 네이밍
- 변수와 메서드의 이름은 의미를 명확히 전달해야 합니다.
- 변수와 메서드의 이름은 첫 문자를 소문자로 시작하고, 카멜 표기법(Camel Case)을 따라야 합니다.
- 변수와 메서드의 이름은 해당 기능과 목적을 나타내야 합니다.
public class ExampleClass {
private int exampleVariable;
public void exampleMethod() {
// 코드 구현
}
}
2. 상수 네이밍
- 상수는 모두 대문자로 작성하며, 단어 사이는 밑줄(
_)로 구분합니다. - 상수는 의미를 명확히 전달하도록 네이밍되어야 합니다.
public class ExampleClass {
public static final int MAX_COUNT = 10;
public static final String ERROR_MESSAGE = "An error occurred";
}
3. 클래스와 인터페이스 네이밍
- 클래스와 인터페이스의 이름은 첫 문자를 대문자로 시작하고, 카멜 표기법(Camel Case)을 따라야 합니다.
- 클래스와 인터페이스의 이름은 해당 기능과 목적을 나타내야 합니다.
public class ExampleClass {
// 클래스 구현
}
public interface ExampleInterface {
// 인터페이스 구현
}
4. 패키지 네이밍
- 패키지의 이름은 모두 소문자로 작성하며, 단어 사이는 마침표(
.)로 구분합니다. - 패키지의 이름은 해당 기능과 목적을 명확히 나타내어야 합니다.
package com.example.project.util;
5. 예외 클래스 네이밍
- 예외 클래스의 이름은 “Exception”으로 끝나야 합니다.
- 예외 클래스의 이름은 해당 예외의 역할과 의미를 나타내야 합니다.
public class CustomValidationException extends RuntimeException {
// 예외 처리 로직
}
JSR 305을 활용하여 자바 코드의 네이밍 규칙을 따라 가독성과 유지보수성을 높이는 것이 좋습니다. 이를 통해 개발자들 간의 협업이 원활해지고, 코드의 이해와 유지보수가 편리해집니다.