🦒안드로이드 컨벤션🦒

Kotlin

---

Package Path

경로는 꼭 소문자로 작성되어야 한다.

언더 바가 포함되어서는 안되며, 필요한 경우 camelCase로 작성한다.

// Do 
com.wapp.app.food
// Don't
com.wapp.app.food_ingredient
// Do
com.wapp.app.foodIngredient

프로퍼티

뷰모델, 어댑터의 프로퍼티 명은 풀네임을 사용

val addTaskViewModel: AddTaskViewModel by viewModels()
val addTaskAdapter = AddTaskAdapter()

클래스 내부 단락 배치 순서

1. 프로퍼티
2. 생성자
3. init
4. onCreate
5. onCreateView
6. Function
   • 추상화 레벨에 맞게 높은 순서대로 배치한다.
7. onDestroy
8. companion object

조건문

else if 사용 금지 -> when으로 변환 else도 지양 고려

if (true) {
    foo()
} else {
    bar()
}
// else 지양
bar()
if (true) {
foo()
}
-> 참이 아닌 것을 먼저 return으로 빼버림.
if (false){
//toDoElse
return
}

when

• 한 줄에 들어가는 when 분기는 중괄호를 사용하지 않는다.

when (value) {
    0 -> return
    // ...
}

• 여러개의 조건을 동시에 사용하는 경우 >를 포함한 블록은 내려서 작성한다.

when (value) {
    foo -> // ...
    bar,
    baz
    -> return
}

함수명 prefix

비동기 함수

• fetch: Read
• post : Write view(viewModel.fetchData) -> viewModel(repo.fetchData) -> repo(source.fetchData)

추가

• add: list 안에 넣을 때
• create: 새로 생성

조회

• get: any
• find: nullable any
• is, has: boolean

화면전환

• show[Dialog]
• start[Activity]
• navigate[Fragment]

화면 갱신

• show
• invalidate

상수

대문자 + SnakeCase로 작성한다.

참고 레퍼런스

https://kotlinlang.org/docs/coding-conventions.html

https://developer.android.com/kotlin/style-guide?hl=ko

Architecture

---

Model class naming Rule

Data Layer에서 통신을 위한 모델인 경우, [명사] + Response로 작성한다.

class UserResponse { }

Data Layer에서 내부 DB를 위한 모델인 경우, [명사] + Entity로 작성한다.

class UserEntity { }

Domain Layer에서 도메인 모델인 경우, [명사]로 작성한다.

class User { }

Presentation Layer에서 Ui를 위한 모델인 경우, [명사] + Model로 작성한다.

class UserModel { }

Mapper Rule

출발지 Model에서 Extension을 통해 구현한다.

이름은 to + [도착지 계층]으로 구성한다.

class UserResponse {
   fun toDomain(): User = User(...)
}

UseCase Rule

UseCase는 [명사] + UseCase로 작성한다.

UseCase 클래스는 단 하나의 invoke UseCase 함수를 가진다.

UseCase는 Functional Naming Rule을 사용하되, 함수와의 혼동을 피하기 위해 다음과 같은 규칙을 따른다.

• 복수형인 경우, s → List를 사용한다.

Xml / Resource

---

뷰 ID 네이밍

• 기본 형식: [what]\\_[where]\\_[des] ex) tv_addCalendar_titleHeader
  • 섹션을 확실하게 구분할 수 있다.
  • 언더바로 구분되어 원하는 정보를 골라 읽기 편하다.
  • des를 읽을 때에는 구분해서 읽을 일이 없다.
• 각 절에서 두 단어 이상이 혼용될 때는 camel case로 작성.
• 카멜 케이스로 구분되지 않는 뷰(switch, toolbar, ...)는 풀 네임을 사용.
• 접두사는 simple style(textView -> tv)

tv	TextView
iv	ImageView
cb	CheckBox
rv	RecyclerView
et	EditText
nsv	NestedScrollView
switch	Switch
btn	Button

레이아웃 prefix

• item_<what>: 리사이클러 뷰 아이템 레이아웃에 사용
• view_<what>: 커스텀 뷰 레이아웃에 사용

리소스 네이밍

Color

<!--color 리소스 정리-->
<color name="light_gray">#E4E4E4</color>
<color name="gray">#8D8D8D</color>
<color name="gray_alpha_30">#30000000</color>
<!--색 변수 wHeRe_wHAt. 여러 곳에서 사용된다면 where 생략 가능.-->
<color name="saveSchedule_titleText">@color/light_gray</color>
<color name="yearCalendarView_titleText">@color/gray</color>
<color name="close_background">@color/gray_alpha_30</color>

description은 테마 속성으로 분리. ex) <item name="titleTextColor">@color/yellow_500</item>

Test

---

함수 네이밍 : 백틱과 공백을 사용하여 구성하기

기타

---

Utils

utils 패키지는 최대한 지양하며, 공통으로 사용하는 곳이 같은 레이어, 다른 클래스 세 개 이상일때, 해당 레이어에서 구성한다.

Line

• 1줄에 100자를 넘지 않도록 작성한다.
• 코드간의 간격은 2줄이상 간격이 발생하지 않도록 한다.(최대 1줄 줄바꿈)
• 파라미터 개수와 상관없이 100자 이상이면 개행한다.

Parameter

• 파라미터가 2개 이상이면 이름을 명시한다.
• 줄바꿈이 필요하면 모든 파라미터를 줄바꿈한다.

Method chain

• Builder등 여러 함수를 chaining으로 사용하면서 줄바꿈이 필요한 경우, .전에 줄바꿈한다.

ImageLoader.load(user.getProfileUrl())
        .placeholder(R.drawable.img_user_placeholder)
        .fitCenter()
        .into(binding.ivUser)

참고 레퍼런스

https://techblog.woowahan.com/2706/

https://developer.android.com/kotlin/style-guide?hl=ko

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

https://github.com/PRNDcompany/android-style-guide

https://github.com/woowacourse-teams/2023-festa-go/wiki/