☑️ 코드 컨벤션

주석은 설명하려는 구문에 맞춰 들여쓰기 합니다.

// Good
function someFunction() {
  ...

  // statement에 관한 주석
  statements
}

---

☑️ 코드 컨벤션이 필요한 이유

• 팀원끼리 코드를 공유하기 때문에 일관성있는 코드를 작성하면 서로 이해하기 쉽다.
• 나중에 입사 지원 시 프로젝트를 하며 코드 컨벤션을 만들어 진행했다고 하면 협업 면에서 유리하게 작용할 수 있다.

참고

코딩컨벤션

📌 Spring boot Java Coding Standards

✨ 1. 기본 원칙

• 가독성 최우선
• 특별한 이유가 없는 경우 IntelliJ IDEA 자동 서식 준수
• 특별한 이유가 없는 경우 IntelliJ IDEA 경고 제거

---

🏷 2. 네이밍 규칙

🔹 클래스 (PascalCase)

• 클래스명은 파스칼 케이스(PascalCase) 사용

// ✅ 올바른 예시
public class UserAccount { }
public class OrderService { }

🔹 변수 및 메서드 (camelCase)

• 변수 및 메서드는 카멜 케이스(camelCase) 사용
• @Value를 사용한 프로퍼티 값도 카멜 케이스 적용

// ✅ 올바른 예시
private String userName;
public void processOrder() { }

🔹 축약어 (camelCase)

• 축약어도 카멜 케이스 적용

// ❌ 잘못된 예시
String HTTP;
String DTO;

// ✅ 올바른 예시
String Http;
String Dto;

🔹 상수 (UPPER_SNAKE_CASE)

• 상수는 대문자 스네이크 케이스(UPPER_SNAKE_CASE) 사용

// ✅ 올바른 예시
public static final int MAX_USER_COUNT = 100;
public static final String API_KEY = "1234";

🔹 패키지명 (소문자)

• 패키지명은 전부 소문자 사용

// ✅ 올바른 예시
com.example.service;
org.myproject.utils;

🔹 줄임말 사용 금지

• 논의된 경우를 제외하고 줄임말 사용 금지

// ❌ 잘못된 예시
String msg;
String err;

// ✅ 올바른 예시
String message;
String error;

🔹 CRUD method 명명 규칙

기능	Controller 메서드명	Service 메서드명	Repository 메서드명
Create (POST)	createUser(UserForm userForm)	createUser(UserForm userForm)	save(User user) (JPA 기본)
Read (단일 조회) (GET)	getUserById(Long id)	getUserById(Long id)	findById(Long id) (JPA 기본)
Read (목록 조회) (GET)	getUserList()	getUserList()	findAll() (JPA 기본)
Update (PUT)	updateUser(Long id, UserForm userForm)	updateUser(Long id, UserForm userForm)	save(User user) (JPA 기본, ID 존재 시 업데이트)
Delete (DELETE)	deleteUserById(Long id)	deleteUserById(Long id)	deleteById(Long id) (JPA 기본)

✅ 일관성 유지:

• Controller & Service → get, create, update, delete
• Repository → find, save, deleteById
• DTO (UserDto) → 응답용, Form (UserForm) → 입력용

🔹 HTTP URL 명명 규칙

• prefix 로 api 를 갖음 (프로젝트 레벨에서 설정 완료, controller 에서 설정할 필요 없음)
• 동사는 사용하지 않고 http method 를 활용

// ❌ 잘못된 예시
/api/v1/order/create
/api/v1/order/delete

// ✅ 올바른 예시
(post) /api/v1/order
(delete) /api/v1/order

• 리소스는 항상 복수형 사용

// ❌ 잘못된 예시 (단수형 리소스)
GET /api/v1/user
POST /api/v1/order

// ✅ 올바른 예시 (복수형 리소스)
GET /api/v1/users
POST /api/v1/orders

• 비즈니스 로직이 들어간 **행위(Action)은 동사 포함 (approve, ban, login 등)

// ✅ 액션이 필요한 경우
POST /api/v1/auth/login
POST /api/v1/auth/logout
POST /api/v1/orders/123/approve  // 주문 승인
POST /api/v1/users/456/ban  // 유저 차단

🎨 3. 코드 스타일

🔹 중괄호 {} 사용

• 단일 라인 조건문에도 반드시 중괄호 {} 사용

// ❌ 잘못된 예시
if (a == 0) return a;

// ✅ 올바른 예시
if (a == 0) {
    return a;
}

🔹DTO

1. 도메인 DTO 말고 Entity를 공유

   @GetMapping("/{id}")
   public RsData<ExampleDetailResponse> get(@PathVariable("id") Long id) {
   	ExampleDetailResponse response = exampleService.getDetail(id);
   	return RsData.from(SUCCESS, response);
   }
   
   @Transactional(readOnly = true)
   public ExampleDetailResponse getDetail(Long id) {
   	Example example = getEntity(id);
   	return ExampleDetailResponse.from(example);
   }
   
   private Example getEntity(Long id) {
   	return exampleRepository.findById(id).orElseThrow(() -> new BusinessException(NOT_FOUND));
   }
   

   • PostDto, PostWithPerformanceDto 같은 엔티티와 대응되는 Dto를 별도로 생성하지 않는다.
   • 컨트롤러 메서드와 매핑되는 서비스 메서드 작성 (서비스에서 응답 DTO로 미리 변환하고 컨트롤러에 반환)
   • 추가로 필요한 서비스 메서드 작성(메서드끼리 데이터 공유가 필요하면 Entity 적극 사용)

2. Controller에서 반환할 DTO

   • ~~SimpleResponse ← 리스트 데이터(목록 페이지)
   • ~~DetailResponse ← 상세 데이터(상세 페이지)
   • PostSimpleResponse
   • PostDetailResponse

🔹ApiPath관련

• 하나일때는 {id}
• 하나이상일때는 {postId}와 같이 사용

공통객체

• RsData 형식

  • 성공: 상태, 메시지, 데이터

    성공(페이징)

    {
    	"code": 200,
    	"message": "요청이 성공했습니다.",
    	"data": {
    		"items": [
    			{
    				"id" : 1,
    				"title" : "게시글 제목",
    				"venue" : "공연 장소",
    				"startDate" : "2025-04-29T14:30:45",
    				"endDate" : "2025-04-30T14:30:45",
    				"poster" : "포스터 url"
    			},
    			{
    				"id" : 2,
    				"title" : "게시글 제목",
    				"venue" : "공연 장소",
    				"startDate" : "2025-04-29T14:30:45",
    				"endDate" : "2025-04-30T14:30:45",
    				"poster" : "포스터 url"
    			}
    		],
    		"page": 1,
    		"size": 10,
    		"totalPages": 1,
    		"totalElements": 2
    	}
    }
    

    성공(상세)

    {
    	"code": 200,
    	"message": "요청이 성공했습니다.",
    	"data": {
    		"items": [
    			{
    				"postId" : 1,
    				"title" : "게시글 제목",
    				"venue" : "공연 장소",
    				"startDate" : "2025-04-29T14:30:45",
    				"endDate" : "2025-04-30T14:30:45",
    				"poster" : "포스터 url"
    			},
    			{
    				"postId" : 2,
    				"title" : "게시글 제목",
    				"venue" : "공연 장소",
    				"startDate" : "2025-04-29T14:30:45",
    				"endDate" : "2025-04-30T14:30:45",
    				"poster" : "포스터 url"
    			}
    		],
    		"page": 1,
    		"size": 10,
    		"totalPages": 1,
    		"totalElements": 2
    	}
    }
    

  • 에러 response: 상태, 코드, 메시지

    실패

    {
    	"code" : 404,
    	"message" : "리소스가 존재하지 않습니다.",
    	"data" : null
    }
    

• PageDto

  • items
  • page
  • totalElements
  • totalPages
  • size