<aside> 💡

변수명, 메서드명은 풀네임으로 작성하기

</aside>

캠퍼스 핵데이 Java 코딩 컨벤션

Java

패키지명

• 소문자
  • 단어별 구문을 위해 언더스코어(_)나 대문자를 섞지 않는다.

클래스명

• Pascal Case

• controller

  • 관련기능 + Controller로 작성해주세요.
  • ex) MemberController

• entity

  • 테이블명

• xml

  • 화면 : 키워드 + 페이지 + View
  • 팝업 : 키워드 + 페이지 + popup
  • ex) matchingListView
  • ex) matchingDetailPopup

• dto

  • Entity이름 + DTO

  • ex) MatcingDTO

  • 요청 Dto는 API함수이름 + Request로 작성해주세요. (프론트에서 서버로 요청할때)

  • 응답 Dto는 API함수이름 + Response로 작성해주세요. (서버에서 프론트로 응답할때)

  • ex) CreateMemberRequest / FindMemberResponse

    

• mapper

  • Entity이름 + Mapper
  • ex) ExchangeMapper

함수명

• 모든 함수는 소문자 Camel Case를 원칙으로 합니다.
• 함수의 이름은 동사/전치사로 시작됩니다.
• CRUD함수
  • Rest API의 CRUD와 관련된 함수는 Controller, Service에서 동일한 이름을 사용합니다.
  • Create
    • create + 생성하려는 서비스
    • ex) createMember
  • Read
    • find + 읽을려는 서비스
    • 쿼리에 형태에 맞게 사용하는 JPA의 함수 명명과 동일하게 사용
    • ex) findMemberByMemberId / findMemberList
  • Update
    • update + 수정하려는 서비스
    • ex) updateMemberName
  • Delete
    • delete + 삭제하려는 서비스
    • ex) deleteMember
• ETC
  • 해당 로직에 적합한 함수명을 만들어 사용합니다.
    • 버튼 클릭 : ex) onClick...Btn
    • 화면 보기 : ex) onShow...Popup/onShow…View
  • PR에 해당 내용을 작성하여 개발진에게 검토를 받아주세요.

변수명

• 모든 변수명은 소문자 Camel Case를 원칙으로 합니다.