👨‍💻 코드 컨벤션 개론 (세션 진행용)

🧐 JAVA 코드 컨벤션 개론

🙋 코드 컨벤션이 뭐야?

🙋 꼭 해야 됨?

-> 1인 개발의 경우는 상관이 없어요
-> 하지만 우리는 보통 협업을 통해 개발을 진행하기 때문에, 남이 짠 코드를 내가 읽어야 할 때나 그 반대의 경우 정해진 컨벤션이 없다면 추가적인 의사소통, 소요 시간의 증가 등 많은 낭비가 발생할 수 있음

한번 직접 봅시다

⚠️ 줄바꿈, 들여쓰기, 중괄호 양식 등 IDE가 자동으로 잘 해주는 부분은 생략

1. 식별자에는 영문/숫자/언더스코어만 허용

변수명, 클래스명, 메서드명 등에는 영어와 숫자만을 사용한다. 상수에는 단어 사이의 구분을 위하여 언더스코어(_)를 사용한다.

// 올바른 예:
// camelCase 적용했다고 가정
public class CodingMinsoo { } 
public void doSomethingMethod() { }
int userAge = 25;
String firstName = "Kim";
public static final int MAX_USER_COUNT = 100;
public static final String KINGGOD_URL = "www.google.com"

// 잘못된 예:
public class missileLaunch시스테무 { }  // 한글 사용
int 몇살 = 25; // 한글 사용
String 거어데김씹니꺼 = "Kim";  // 한글 사용
public static final int MaxUserCount = 100;  // 언더스코어 미사용 (PascalCase 사용)
public static final String kingGodUrl = "www.google.com" // 카멜 케이스 사용

2. 한국어 발음대로의 표기 금지

식별자의 이름을 한글 발음을 영어로 옮겨서 표기하지 않는다. 한국어 고유명사는 예외이다.

// 올바른 예
String address = "충청남도 천안시"

// 잘못된 예
String zipzuso = "충청남도 천안시"

3. 패키지 이름은 소문자로 구성

package com.example.board
package com.example.member

4. 클래스/인터페이스 이름에는 파스칼 케이스 적용

5. 클래스 이름에 명사 사용

클래스 이름은 파스칼 케이스를 적용한다, 그리고 명사나 명사절로 짓는다.

public class MemberService {}

public class MemberReport {}

6. 메서드 이름에 카멜케이스 적용

메서드의 이름에는 첫 번째 단어를 소문자로 작성하고, 이어지는 단어의 첫 글자를 대문자로 작성하는 소문자 카멜표기법(Lower camel case)를 사용한다.
테스트 클래스의 메서드 이름에서는 언더스코어를 허용한다

isValidToken()

is_valid_token_test()

7. 메서드 이름은 동사/전치사로 시작

메서드명은 기본적으로는 동사로 시작한다.

다른 타입으로 전환하는 메서드나 빌더 패턴을 구현한 클래스의 메서드에는 전치사를 쓸 수 있다.

bringMyMoney()
toString()

// 빌더 패턴 예시
public class CarBuilder {
    private String model;
    private String color;

    // 모델을 설정하는 메서드
    public CarBuilder withModel(String model) {
        this.model = model;
        return this;
    }

    // 색상을 설정하는 메서드
    public CarBuilder withColor(String color) {
        this.color = color;
        return this;
    }

    // 자동차를 생성하는 메서드
    public Car build() {
        return new Car(model, color);
    }
}

8. 상수는 대문자와 언더스코어로 구성

상태를 가지지 않는 자료형이면서 static final로 선언되어 있는 필드일 때를 상수로 간주한다.

상수 이름은 대문자로 작성하며, 복합어는 언더스코어(_)를 사용하여 단어를 구분한다.

public final String SUCCESS_LOGIN = "로그인에 성공하였습니다.";

9. 변수에 카멜케이스를 적용하는 경우

보통 변수를 선언할 땐 전체 소문자로 선언한다.

int phonenumber = 01012345678

하지만 상수가 아닌 클래스의 멤버변수/지역변수/메서드 파라미터에는 소문자 카멜표기법(Lower camel case)을 사용한다.

public class Car {
    private String carModel;  
    private int carYear;  

10. 임시 변수 외에는 1글자 이름 사용 금지

메서드 블럭 범위 이상의 생명 주기를 가지는 변수에는 1글자로 된 이름을 쓰지 않는다.

반복문의 인덱스나 람다 표현식의 파라미터 등 짧은 범위의 임시 변수에는 관례적으로 1글자 변수명을 사용할 수 있다.

public class UserManager {
    private String userName;  
    // 블럭 범위 이상의 변수이므로 명확한 이름 사용
    private int userAge;

    public void setUserName(String userName) {  
    // 메서드 파라미터도 명확한 이름 사용
        this.userName = userName;
    }

    public void setUserAge(int userAge) {
        this.userAge = userAge;
    }
}

public void printNumbers() {
    for (int i = 0; i < 10; i++) {  
    // 반복문의 인덱스는 관례적으로 'i'를 사용
        System.out.println(i);
    }
}

List<Integer> numbers = Arrays.asList(1, 2, 3, 4, 5);
numbers.forEach(n -> System.out.println(n));  
// 람다 표현식의 파라미터는 'n'과 같은 간단한 이름 사용

11. static import에만 와일드 카드 허용

클래스를 import할때는 와일드카드(*) 없이 모든 클래스명을 다 쓴다.

static import에서는 와일드카드를 허용한다.

-> 보통 클래스를 먼저 입력하고 InteliJ의 Import Class 단축키를 사용하는 것이 일반적이기 때문에 잘 지켜지는 편

// 나쁜 예
import java.util.*;

// 좋은 예
import java.util.List;
import java.util.ArrayList;

12. 어노테이션 선언 후 새 줄 사용

클래스, 인터페이스, 메서드, 생성자에 붙는 어노테이션은 선언 후 새줄을 사용한다.

이 위치에서도 파라미터가 없는 어노테이션 1개는 같은 줄에 선언할 수 있다.
-> 근데 그냥 무조건 어노테이션 선언했으면 줄바꿈하는게 국룰임 ㅅㄱ

@GetMapping("/api/board")
public void findById() {}

13. 디렉토리 구조

프로젝트의 디렉토리 구조 또한 컨벤션의 일종이다.

크게 계층형(Layered) 디렉토리 구조와 패키지형(Feature-based) 디렉토리 구조가 있다.

// 계층형
com
└── projectname
    ├── controller         
    │   └── UserController.java
    │   └── ProductController.java
    ├── service             
    │   └── UserService.java
    │   └── ProductService.java
    ├── repository         
    │   └── UserRepository.java
    │   └── ProductRepository.java
    ├── domain              
    │   └── User.java
    │   └── Product.java
    └── config              
        └── WebConfig.java
        └── AppConfig.java

계층형은 하나의 프로젝트를 "역할에 따라 나눈 것" 이라고 생각하면 된다.
controller 패키지에는 프로젝트 내부 도메인의 모든 컨트롤러를 모아놓고, service 패키지에는 모든 서비스를 모아놓고,
repository 패키지에는 ...

// 패키지형
com
└── projectname
    ├── user
    │   ├── UserController.java
    │   ├── UserService.java
    │   ├── UserRepository.java
    │   └── User.java
    ├── product
    │   ├── ProductController.java
    │   ├── ProductService.java
    │   ├── ProductRepository.java
    │   └── Product.java
    └── order
        ├── OrderController.java
        ├── OrderService.java
        ├── OrderRepository.java
        └── Order.java

패키지형은 하나의 프로젝트를 "도메인(혹은 엔티티)에 따라 나눈 것" 이라고 생각하면 된다.
프로젝트 구성 요소들을 패키지로 만들고 그 안에 기능을 넣어 놓는다.

디렉토리 구조의 선택 기준은 프로젝트의 규모, 팀 선호도, 유지보수 용이성 등이 있다. 보통 계층형은 대규모 플젝에 적합하고, 패키지형은 중소규모나 마이크로 아키텍쳐에 적합하다.

14. 정리

코드 컨벤션은 협업에서 선택이 아닌 필수이다~~
글로 정리해놓으니 너무 많고 복잡해보이지만 코드를 많이 작성하다보면 저절로 몸에 배게 되어 있으니 그렇게 걱정하지 말자~!😁

참고:
대기업, 대규모 프로젝트의 코드 컨벤션들
네이버
오라클

컨벤션 준수를 도와주는 extension들
Prettier <- 익숙하다 그쵸
Linter