정적 팩토리 메소드, 빌더패턴 튜터님과 상의 후 결정

Java Project 이름 명명법

분류 명명법 예시 기타
패키지명 전부 소문자
명사로 정의 com.sparta.~
org.sparta.~
클래스 PascalCase
: 첫글자 대문자, 이어지는 단어의 첫글자를 공백없이 대문자 TodoController
변수명, 메서드명 camelCase
: 첫글자 소문자, 이어지는 단어의 첫글자를 공백없이 대문자 saveTodo() Boolean 타입의 변수,메서드 명은 접두사에 is붙이기
: isSaveCheck
JPA Auditing created_At
update_At
deleted_At
DTO 명 엔티티명 + 행동 동사 + Request/Response + Dto ⇒ PascalCase TodoSaveRequestDto
TodoDeleteRequestDto
TodoSearchRequestDto
상수, ErrorCode 전체대문자를 사용하고, 언더바로 공백구분 USER_NOT_FOUND

Method 명명법

분류 메서드 명명법 예시 기타
생성 save + 엔티티 saveTodo()
단건 조회 get + 엔티티
get + 엔티티 + 조회항목 getTodo()
getTodoTitle()
다건 조회 get + 엔티티 + s
get + 엔티티 + 조회항목 + s getTodos()
getTodoTitles()
수정 update + 엔티티
update + 엔티티 + 수정항목 updateTodo()
updateTodoTitle()
삭제 delete + 엔티티 deleteTodo()

ERD Database 이름 명명법

분류 명명법 예시 기타
Table 이름 p_테이블명
snake_case
: 소문자 단어와 단어 사이의 공백을 _(언더바) 사용해여서 명명 p_user
p_todo created_at
updated_at
deleted_at
Column 이름 snake_case
: 소문자 단어와 단어 사이의 공백을 _(언더바) 사용해여서 명명 user_id

SpringBoot Entity 생성해주실때 @Table(name=”명명된 테이블명”) 과 @Column(name=”명명된 칼럼명”)

으로 Database 이름 명명법에 맞게 DB가 생성될 수 있도록 지정 필수!!!

API 명세서 작성시 URI 명명법

분류 명명법 예시 기타
REST API kebab-case (공백에-하이픈-사용)
하이픈을 사용한 복수형 명사로 명명하기
계층화 하기 restful-services
JSON snake_case
: 소문자 단어와 단어 사이의 공백을 _(언더바) 사용해서 명명 {
”user_name” : String
}

REST API