[SpringBoot] 스프링 패키지 이름 규칙(작명 방법)

스프링프로젝트를 생성하게되면 처음으로 패키지이름을 작성하게 됩니다. 처음 공부할때는 별 생각없이 짓고 넘어가곤 했었는데 스프링에 익숙해 질수록 패키지이름을 어떻게 정하는게 좋을지에 대하여 궁금증을 가지게 되었고, 나름대로 확인해보니 어느정도 정형화된 규칙이 있었습니다. 이 포스팅에서는 이러한 규칙에 대하여 확인해 보도록 하겠습니다.

 

 

 

 

 

패키지명이란 무엇을 의미할까?

패키지 이름은 어플리케이션을 구분하는 고유의 값 입니다. 따라서 다른 앱들과 구분되기 위해서는 유니크한(유일한) 값을 가져야 합니다. 만약 내가 사용하는 라이브러리의 패키지와 생성된 SPRING어플리케이션 패키지명이 동일하다면 충돌이 발생 할 것 입니다.

 

 

 

 

 

패키지명 작성 방법

그렇다면 패키지명은 어떤 방법으로 작성하면 될까요? 아래 예시를 통해서 한 번 알아보겠습니다. 물론 아래 예시는 절대적인 것은 아니며 일반적으로 이렇게 많이 사용한다 라고 생각하시면 됩니다.

 

com.회사이름.프로그램이름 -> com.naver.cafe

com.회사이름.플랫폼.프로그램이름 -> com.naver.ios.cafe

 

예시를 통해서 확인해 보니 어느정도 이해가 되시나요? 저 또한 여러 스프링프로젝트를 다니면서 봐왔었던 패지명에 이런 규칙이 있었는지 몰랐었는데 패키지명 작성예시를 보고 생각해보니 나름대로의 의미가 있었던것 같습니다.

 

 

 

 

 

패키지명 규칙

위에서 패키지명 예시를 보고 어떻게 작성하는지는 대충 알았는데 세부적으로는 어떤 규칙이 있는지 정리해 보겠습니다.

 

- 명칭은 소문자를 사용한다 (권고사항)

- 회사 이름이나 도메인주소는 유니크한 값을 가지기 때문에 보통 이 두가지 값을 사용하여 PackageName을 작성한다.

 

 

 

 

 

마무리

최근에 프로잭트를 세팅할 일이 있어서 패키지명을 어떻게 할지 고민을 했었는데 이번 포스팅을 작성하면서 많은 고민이 해결되었습니다. 위에서 말씀드린 바와 같이 이러한 패키지명 작성 규칙이 강제성을 가지고 있는 부분이 아니기 때문에 절대적으로 지킬 필요는 없지만 나름대로의 체계를 원한다면 프로젝트 생성시 위의 규칙으로 작성하면 도움이 될 것 같습니다.