본 게시물은 MyACADEMY 프로젝트를 위해 작성한 것입니다.
코드 컨벤션
📌 줄바꿈, 공백, (콤마· 조건문 혹은 메서드 괄호 위치) 등등
띄어쓰기, 들여쓰기 등등
ctrl + alt + l
팀원 모두가 IntelliJ의, 위 단축키를 활용해서 통일성을 지킨다.
. 을 사용하는 메서드의 경우 줄바꿈
.으로 이어지는, 메서드의 경우 . 을 기준으로 줄바꿈을 한다.
// Good Examples
Post post = Post.builder()
.title(request.getTitle())
.build();
//Bad Examples
Post post = Post.builder().title(request.getTitle()).build();
// Good Examples
when(postRepository.save(any()))
.thenReturn(mockPost);
//Bad Examples
when(postRepository.save(any())).thenReturn(mockPost);
변수 선언
- 모든 변수 선언은 한줄에 한개만 선언한다.
// Good Examples
int a;
int b;
// Bad Examples
int a, b;
- 지역 변수는 습관적으로 블록의 시작 부분에 선언되는 경향이 있다. 하지만, 지역 변수의 범위를 최소화 하기 위해 처음 사용되는 지점에 가깝게 선언한다 → 지역변수 : 메소드나 생성자, 초기화 블록 내에 위치한 변수
📌 명명 규칙
- 한국어 발음대로의 표기를 금지한다.
// Good Examples
public class Hello {
}
// Bad Examples
public class Annyeong {
}
- 글자의 길이는 20자 이내로 제한한다. 4 단어 이상이 들어가거나, 부득이하게 20자 이상이 되는 경우 팀원과의 상의를 거친다.
패키지 이름은 소문자로 구성한다.
- 언더 스코어나 대문자를 섞지 않는다.
// Good Examples
package com.project.restcontroller
// Bad Examples
package com.project.restController
package com.project.rest_controller
DTO 클래스 명
- Request Dto 의 경우 [동사]+[도메인]+[Request] 로 작성한다.
- Response Dto 의 경우 [동사]+[도메인]+[Response] 로 작성한다.
// Good Examples
public class CreateCommentRequest;
public class CreateCommentResponse;
// parameter로 사용시 request, response 로 명명해서 사용한다.
(CreateCommentRequest request)
(CreateCommentResponse response)
// Bad Examples
public class CreateCommentReq;
public class CreateCommentRes;
클래스, 인터페이스 이름
- UpperCamelCase를 적용하고, 명사를 사용한다.
// Good Examples
public class Reservation;
public class AccessToken;
// Bad Examples
public class reservation;
public class Accesstoken;
테스트 클래스의 이름은 [테스트할 클래스 이름 + ‘Test’] 으로 짓는다.
// PostController 테스트 파일 Good Examples
public class PostControllerTest {
변수명
- 복합 단어일 경우 소문자로 시작한다. (lowerCamelCase를 적용한다.)
//변수 이름 Good Examples
String userAccount
String userName
//변수 이름 Bad Examples
String UserAccount
String username
- 일반적인 변수의 이름은 타입의 이름과 동일하게 지정한다.
// Good Examples
void setTopic (Topic topic)
// Bad Examples
void setTopic (Topic value) 이 아님
void setTopic (Topic aTopic) 이 아님
// Good Examples
void connect (Database database)
// Bad Examples
void connect (Database db) 가 아님
void connect (Database oracleDB) 가 아님
- 컬렉션의 이름은 반드시 복수형으로 작성한다.
// Good Examples
List<> students
Page<> posts
- boolean 변수 혹은 메서드에
is접두사를 붙이고 동사가 사용된다면, 과거형으로 작성한다. (has혹은can접두사가 더 어울리는 변수명이면 적합한 것으로 사용한다.) - 부정적인 이름을 사용하지 않는다.
// Good Examples
boolean isDeleted
// 위 경우에 삭제되었으면 true를 반환해야 한다.
boolean isFound
boolean hasLicense
// Bad Examples
boolean isDelete
boolean deleted
boolean isNotDeleted
boolean isNotFound
메서드명
- 메서드 이름은 반드시 동사로 시작한다.
- controller 메서드 이름의 경우 동작을 대표할 수 있는 복합어를 사용하고, service 메소드 이름은 domain을 controller 메소드 이름 뒤에 붙인다.
- 조회 관련 메소드의 경우 find 가 아닌 read를 사용한다.
/* 예시 1 */
// Post Controller 메소드 이름
create()
// Post Service 메소드 이름
createPost()
/* 예시 2 */
// User Controller 메소드 이름
changeRole()
// User Service 메소드 이름
changeRoleUser()
// 조회 관련 메서드명
// 컨트롤러에서
readAll() (여러건 조회인경우)
readOne() (단건 조회인 경우)
//서비스에서
readAll도메인() (여러건 조회인 경우)
readOne도메인() (단건 조회인 경우)
상수명
- 상수(인스턴스가 절대 변화하지 않는) 이름은 대문자로 작성한다.
// Constants
static final int NUMBER = 5;
데이터 베이스 명명 규칙
- 테이블 명의 구성은 최대 3 단어까지 사용하고 단수형을 사용한다.
-
테이블임을 표시하기 위해서
_TB라는 구분을 사용한다.→
@Table어노테이션으로_TB를 추가한 이름을 붙여준다.
@Entity
@NoArgsConstructor(access = AccessLevel.PROTECTED)
@Table(name = "Example_TB")
public class Example{
}
- 기본키는 다음과 같이
@Column어노테이션을 사용해서테이블명_id로 속성명을 지정해주고,Long타입을 사용한다.
public class Example{
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
@Column(name = "Example_id")
private Long id;
}
- 특이사항
boolean 관련 속성 일때 _flag
date 관련 속성 일때, _date
count 조회수 등 속성일 때 _count
//examples
// 값이 true 일때, 삭제 되어있는 데이터
@Column(name = "delete_flag")
private boolean isDeleted;
@Column(name = "deleted_date")
private Timestamp deletedAt;
@Column(name = "view_count")
private Long views;
그외, 속성명은 자바에서 camelCase로 작성하면, JPA auto DDL 시, snake로 변경해서 적용해주는대로 사용한다.
📌 주석 처리
- 프로그램의 이해를 도와 향후 유지보수가 용이하게 한다.
- 각 Method 앞에 Method의 Parameter, Return Value의 의미와 Method의 간략한 설명을 기술한다.
- 메소드 전체 기능에 대한 설명은 아래와 같은 주석으로 설명한다.
/**로 시작해서*/로 종결되는 주석을 사용한다. - 메소드 내부 로직에 대한 보충 설명은 설명이 필요한 구문 위쪽에
//주석을 활용한다.-
예시 (인텔리제이 window 기준, 메서드 위에서
/**를 입력하고 crtl+shift+enter 입력시 레이아웃이 자동완성된다.)
-
📌 그 외 규칙
- 엔티티 클래스
Setter사용 금지 → 단, Dto 클래스에서는 사용해도 무관하다.
- 브랜치 이름은
<이슈번호>-feat/<기능>으로 한다.
📌 커밋 규칙
- [feat] : 새로운 기능의 추가
- [fix] : 버그 수정 , 기능관련 수정 (안 쓰는 변수 추가)
- [docs] : 문서 수정 (e.g readme.md, file)
- [style] : 스타일 관련 기능
- 코드 포맷팅
- 세미콜론 누락
- 코드 자체의 변경이 없는 경우
- 주석수정
- 안쓰는 import정리
- [refactor] : 코드 리펙토링
- 변수명
- [test] : 테스트 코트, 리펙토링 테스트 코드 추가
- [chore] : 빌드 업무 수정, 패키지 매니저 수정 (e.g .gitignore, application.yml)
- [build] : 빌드 관련 수정 (e.g build.gradle)
- [ci] : CI 관련 설정 수정 (e.g .gitlab-ci.yml)
- [ui] : ui의 기능, 수정
// 예시
[feat]<공백>:<공백>알아보기 편한 내용으로 작성
<한칸띄우기>
1. 커밋 설명
<한칸띄우기>
2. 커밋 설명
....
커밋 규칙 관련
- 브랜치따서 기능을 구현하고 Main Merge Request 할 때, Git Squash 기능을 사용한다.
- 각자 브랜치에서 기능을 구현할 땐, 디테일하게 커밋내역을 남긴다.
Main 에 푸시하기 전!! ⭐ Check✔
-
내가 작업하고 있는 브랜치로 잘 작업했는지 확인한다. (혹시 main에서 작업한건 아니었는지, 다른 사람 브랜치에 있는 것은 아닌지…)
-
main 에 변동사항이 있을 수 있으므로 pull을 한다.
-
push 하고 깃허브 pull request 화면으로 가서 팀원들을 reviewer 로 등록한다.
-
팀원들이 이모지 체크 혹은 코멘트로 확인한다.
-
팀원들의 확인이 모두 끝나면, merge 시, 커밋 기록에
[merge] :를 붙인다. -
merge가 되면 모든 팀원들은 main 을 pull 한다.
Leave a comment