[Android] Resource 네이밍 규칙

han·2021년 7월 8일
2

안드로이드를 개발하면서 혐업이나, 같은 프로젝트를 공유하면서 작업을 진행하는 상황이 생길수 있다.

이런 경우에 리소스명을 규칙없이 무분별하게 생성하는 상황이 발생될 것이다.
따라서 이 리소스들에 대해서 효율적으로 관리하는 방법에 대해서 알아보고자 한다.

리소스들로 보자면 res폴더 안에 drawble(이미지 파일 등)이 있고, layout(레이아웃)이 있는게 보일 것이다.

이 리소스들에 대해서 어떠한 규칙을 이용하여 한눈에 봐도 알아보기 쉽게 만들고 효율적으로 관리하려는 것이 목적이다.
이 규칙이란 것이 회사마다 다를수 있을 것이고 어느게 맞다고 딱 잘라서 말하기는 어렵다. 자신이 속한 회사나 팀에 맞게 사용하길 권한다.

그러면 리소스 네이밍 규칙에 대해서 알아보자.

Basic Principle

[what]-[where]-[description]-[size]

  • what : activity, fragment, item ..
  • where : main, user, settings ..
  • description : title, content, profile ..
  • size : 24dp, small .. (option)

Layout

[what_where].xml OR [what_where_description].xml

  • 예시) activity_main.xml , activity_main_search.xml

Drawables

이미지는 경우에 따라서 더 세세하게 분류할 수 있다.

[what_where_description_size].png

  • what : ic, bg, img, logo ..
  • where : launcher, navi, tab ..
  • description : radio_btn, star, check ..
  • size : 24dp, small ..
  • 예시) ic_launcher_background.png, ic_check_white.png

또는 이렇게도 표현할 수 있다.

[what_where_description_suffix].png

suffix 란 (최대 6단계로 표현가능)

[direction_shape_outline_status_color_size]

  • direction : left, right, down ..
  • shape : circle, square ..
  • outline : outline, border ..
  • status : normal, mute, off ..
  • color : black, white ..
  • size : 24dp, small ..
  • 예시) ic_launcher_volume_off_white_36dp.png, bg_paris_120h.png

Ids

액티비티에 대한 모든 컴포넌트는 액티비티이름으로 시작해야 한다. 또한 모든 컴포넌트는 Button[Btn]과 같이 접두사를 사용한다.

[what_where_description]

  • 예시) activity_login_btnLogout, activity_main_btn
  • 예시) activity_login_btnLogin, activity_login_etUsername, activity_login_etPassword

레이아웃 주요 구성요소 이름들

Button - btn
EditText - et
TextView - tv
ProgressBar - pb
Checkbox - chk
RadioButton - rb
ToggleButton - tb
Spinner - spn
Menu - mnu
ListView - lv
GalleryView - gv
LinearLayout -ll
RelativeLayout - rl

참고 : https://jeroenmols.com/blog/2016/03/07/resourcenaming/

profile
개인 공부 및 기록겸 벨로그 시작

0개의 댓글