convention

• Java

  • Camel-Case 사용
  • 메서드는 동사나 동사구로 짓는다 append(), drawImage() 메서드명 정의시

  1. 왜 존재해야 하는가

  2. 무슨 작업을 하는가

  3. 어떻게 사용하는가 를 고려야하고 작성 아래 예시.

     public List<Piece> findPiecesByColor(Color color){}
     // 왜 존재해야 하는가 - color에 대해 존재하는 piece들을 알기 위해.
     // 무슨 작업을 하는가 - color에 맞는 piece들을 가져온다.
     // 어떻게 사용하는가 - 체스판에서 흑색(or 백색)의 piece들을 가져와서 점수를 계산.
     

  • 객체명의 의미를 메서드 이름에 넣지 않는다. X - circle.getCircleSize() / line.getLineLength()

  • boolean 형은 is 나 has 로 시작하고 명사나 형용사 사용 isEmpty(), isEnabled(), hasRole() 사용여부: isEnabled, isActive, isAvailable, isUse (현재상태), isUsed (이력)

    • 예시

  • 변수나 메서드명을 과도하게 줄이지 않는다. 길어도 됨

  • Google, Naver 가이드 라인

  • DAO 와 Mapper

    DAO: Data Access Object의 약어로 실질적으로 DB에 접근하여 데이터를 조회하거나 조작하는 기능을 전담하는 객체 Mapper: Mybatis 매핑XML에 기재된 SQL을 호출하기 위한 인터페이스

• JavaScript

  • Camel-Case 사용

• db

  • 테이블명, 컬럼명 Snake-Case 사용
  • tb_ 같은 접두사 사용 X
  • created_at / created_id / updated_at / updated_id 사용 권장

의존성 주입

필드 주입, 세터 주입, 생성자 주입 3가지 방법 중 생성자 주입이 자주 사용되는 추세이다.

생성자 주입 사용의 장점은

1. 단일 책임 원칙 관점
2. 필드에 final 키워드 사용
3. 순환 참조 방지
4. DI 컨테이너의 결합성과 테스트 용이성
5. NullPointerException 방지

사용 예시

@Controller
public class TestController() {

		private final TestService testService;

		public TestController(TestService testService) {
				this.testService = testService;
		}
}

Lombok