데일리 잡(Job) 지식

백엔드, 알아두면 유용한 클래스 네이밍 규칙

개발하는 주디씨 2023. 10. 11. 00:40

 Controller 클래스 작성 규칙

- [메인테이블 명]+Controller.java 로 작성한다.

- 컨트롤러 클래스 안에서 메서드 명을 작성 할 때는 아래와 같이 접미사를 붙인다.

n  productList() – 목록 조회 유형의 서비스

n  productDetails() – 단 건 상세 조회 유형의 서비스

n  productSave() – 등록/수정/삭제 가 동시에 일어나는 유형의 서비스

n  productAdd() – 등록만 하는 유형의 서비스

n  productModify() – 수정만 하는 유형의 서비스

n  productRemove() – 삭제만 하는 유형의 서비스


Service 클래스 작성 규칙

- [메인테이블 명]+Service.java로 인터페이스를 작성한다.

- [메인테이블 명]+ServiceImpl.java 로 인터페이스를 구현하고 있는 클래스를 작성한다.

- 서비스 클래스 안에서 메서드 명을 작성 할 때는 아래와 같은 접두사를 붙인다.

n  findProduct() - 조회 유형의 서비스

n  addProduct() - 등록 유형의 서비스

n  modifyProduct() - 변경 유형의 서비스

n  removeProduct() - 삭제 유형의 서비스

n  saveProduct() – 등록/수정/삭제 가 동시에 일어나는 유형의 서비스


Mapper 클래스 작성 규칙

- [메인테이블 명]+Mapper.java로 클래스를 작성한다.

- Mapper 클래스 안에서 메서드 명을 작성 할 때는 아래와 같이 접두사를 붙인다.

n  selectProduct(); - 조회 유형의 서비스

n  insertProduct(); - 등록 유형의 서비스

n  updateProduct(); – 변경 유형의 서비스

n  deleteProduct(); - 삭제 유형의 서비스

 

VO 클래스 작성 규칙

- 기본적으로 biz 개발 시에는 VO 클래스를 작성하지 않는다.

- VO 클래스 대신 java.util.HashMap을 사용 하여 데이터베이스에 있는 필드명과 동일하게 사용 할 수 있게 한다.

- 단 VO를 반드시 만들어야 하는 경우 Jwork 트리 컴포넌트를 사용해서 화면에 데이터를 트리 구조로 가져오기 위한 연동을 위해서는 사용 할 때와 Jwork 컴포넌트에서 사용하는 기 구축된 서비스 모듈을 재 활용 시에도 VO 를 활용한다.


JSP 파일 명 작성 규칙

- JSP 경로와 파일 명은 Controller 클래스의 메서드 명을 그대로 활용 한다.

-  기능구분(해당되지 않는 경우에는 생략)

- Pop(팝업), Tab(탭)