🧑🏻‍💻 Conventions

안드로이드 컨벤션

데이터 바인딩

• Fragment 또는 Activity 코드 최소화를 위한 데이터바인딩 지향
• 리사이클러 뷰 아이템의 데이터 클래스는 XxxItem, xml의 바인딩 변수는 item 사용
• xml viewModel 바인딩 변수는 viewModel

뷰 ID 네이밍

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

Prefix	풀네임
layout	LinearLayout, ConstraintLayout,include ...
custom	CustomView
tv	TextView
btn	Button
img	ImageView
rv	RecyclerView
cb	CheckBox
cg	CheckGroup
switch	Switch
view	View
toolbar	Toolbar
그 외	CamelCase 앞글자 따서 짓기

Drawable

참고: 헤이딜러 drawable 가이드

• <WHAT>(_<WHERE>)_<DESCRIPTION>(_<SIZE>)
• 이미지가 여러군데에서 활용될 경우, <WHERE>는 생략 가능하다.
• 이미지의 크기가 1개밖에 없는 경우, <SIZE>는 생략 가능하다.

What

Prefix	설명
btn_	버튼으로 쓰이는 이미지
ic_	아이콘, 벡터에 사용하는 이미지
bg_	버튼이 아닌 화면에 보여지는 이미지
img_	실제사진이거나 아이콘형태가 아닌 일러스트형태의 이미지
div_	divider로 활용되는 이미지
color_	color selector

Selector

• 배경이나 버튼에서 View의 상태에 따라서 drawable이 변해야 하는 경우에 대한 이름은 아래와 같다.

상태	Suffix
Normal	_normal
Pressed	_pressed
Focused	_focused
Disabled	_disabled
Selected	_selected
Activated	_activated

Background

• 배경색이 pressed상태에 따라서 white -> sky_blue로 변하는 경우는 bg_white_to_sky_blue.xml로 한다.
• 배경이 white색의 24dp로 테두리를 그리는 경우는 bg_white_radius_24dp.xml로 한다.
• 배경이 투명하며 배경의 선만을 sky_blue색의 8dp로 테두리를 그리는 경우는 bg_stroke_sky_blue_radius_8dp.xml로 한다.
• 예시
  • btn_call_normal.png: 전화걸기 버튼 이미지
  • btn_call_pressed.png: 전화걸기 버튼 눌렸을때의 이미지
  • btn_call.xml: 전화걸기 버튼 이미지의 selector xml
  • ic_dealer_gift.png: 딜러가 보내준 기프티콘을 보여줄때 표시되는 이미지
  • img_splash_chart.png: 스플래시 화면에서 보여지는 차트 이미지

레이아웃 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은 테마 속성으로 분리

<item name="titleTextColor">@color/yellow_500</item>

레이아웃에서 사용은 테마 속성을 참조

 style="@style/Theme.titleTextColor"

Dimensions 컨벤션

Mnemonic 사용

가장 일반적인 margin/padding 16dp = ‘일반 치수 크기의 100% 사용’

<dimen name="small_25">2dp</dimen>
<dimen name="small_50">4dp</dimen>
<dimen name="small_100">8dp</dimen>   <!-- 50% of normal = 8dp -->
<dimen name="normal_100">16dp</dimen> <!-- 100% of normal = 16dp -->
<dimen name="normal_125">20dp</dimen> <!-- 125% of normal = 16dp + 4dp = 20dp -->
<dimen name="normal_150">24dp</dimen>
<dimen name="normal_175">28dp</dimen>
<dimen name="large_100">32dp</dimen>  <!-- large_100 = 2 x normal_100 -->
<dimen name="large_125">40dp</dimen>
<dimen name="large_150">48dp</dimen>
<dimen name="large_175">56dp</dimen>
<dimen name="large_200">64dp</dimen>

일반 치수에 비해 훨씬 큰 dimensions의 경우

• 기본 형식 : [what]_[where]_[des]_[size] ex) keyline_all_text

<dimen name="size_selectVideo_player">500dp</dimen>

<WHAT>

Prefix	Usage
width	width in dp
height	height in dp
size	if width == height
margin	margin in dp
padding	padding in dp
elevation	elevation in dp
keyline	absolute keyline measured from view edge in dp
textsize	size of text in sp

Android - Dimensions by Conventions

Style 네이밍

• 카멜케이스
• 기본 형식: [des][View] ex) customText

<style name="selectVideoOptionImage" parent="Widget.AppCompat.ImageButton">
    <item name="android:layout_width">@dimen/large_125</item>
    <item name="android:layout_height">@dimen/large_125</item>
    <item name="elevation">@dimen/small_25</item>
    <item name="android:padding">@dimen/small_100</item>
</style>

Style resource | Android Developers

코틀린 컨벤션

클래스 명

단어의 첫 글자만 upper case

class Person
class User

프로퍼티

1 대 1 관계면 viewModel

1대1 다 관계면 풀네임

val viewModel: AddTaskViewModel by viewModels()
val activityViewModel: MainViewModel by viewModels()
val addTakAdapter = AddTaskAdapter()

함수 명

코틀린 공식 메소드 네이밍

첫 단어를 제외한 단어부터 단어의 첫 글자만 upper case

동사 혹은 동사구(동사로 시작)

fun getPersonId() {}
fun getUserId() {}

클래스 내부 함수 배치 순서

• 프로퍼티
• 생성자
• init
• onCreate
• onCreateView
• 함수
• onDestroy
• companion object

interface Example{
    // 띄기
    fun A()
    
    fun B()
    
    fun C()
    // 띄기
}

class D(
    a,
    b,
    c // 140 space 맞춰서 (Arrange Option 변경하기)
) : B {
    // 띄기
    private val _binding
    private val binding = get() = _binding
    
    private val viewModel by viewModels{}
    
    private lateinit var
    
    private val a = 3
    
    init {
        
    }
    
    override onCreate()
    
    private fun()
    
    override onDestroy()
    
    inner class C() {
        
    }
    
    companion object {
        
    }
}

함수 파라미터

//single Event
class Adapter(val onClick : (String) -> Unit)

//Multiple Event
class Adapter(val onClick : MinSeokOnClickListener)

fun interface MinSeokOnCLickListener {
    
    fun onClick(str : String)
    
    fun onLongClick(str : String)
    
}

val onclickListener = object: MinSeokOnCLickListener {
    fun onClick(str : String) {
    
    }
    
    fun onLongClick(str : String) {
    
    }
}

Adapter(onclickListener)

Adapter(::onClick) // 3줄 이상 분리
Adapter {
    Log.d("asd", it)
} // 2줄 이내 사용

Enum

[What]Type

Sealed

NetworkState(= retrofit Result) MultipleViewType

scope 함수

apply, also, with, let, run

• Scope 중첩 지양(최대 2중첩)
• it 지양 (다른 이름으로 선언해서 쓰기)

함수명 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

if문

else if 사용 금지 -> when으로 변환 else도 지양 고려 중괄호 무조건 쓰기

// 중괄호 확실히 사용하기
if (true) {
    foo()
} else {
    bar()
}

// else 지양 
⬇️
bar()
if (true) {
    foo()
}

when문

// 자동 정렬 사용하기
when {
    aaa -> {
        
    }
    
    bbb -> {
        
    }
}

// 2줄 이상은 중괄호 내에서, 1줄은 중괄호 x
when {
    aaa -> foo()
    bbb -> bar()
}

// early return
// else 문을 미리 when 위에 빼서 return 시키기 (else block에서 처리할 것이 없을 때)
val xxx = ... ?: return
when(target) {
		aaa -> {}
		bbb -> {}
}

navigate

ShoppingFragment -> ShoppingDetailFragment 
// 1. ShoppingFragment with Safe Args
override fun navigateToShoppingDetail(shoppingItemInfo: ShoppingItemInfo) {
        val navAction = ShoppingFragmentDirections.actionShoppingFragmentToDetailFragment(shoppingItemInfo)
        findNavController().navigate(navAction)
    }

// 2 ShoppingDetailFragment 
class ShoppingDetailFragment : Fragment(), ShoppingItemOnClickListener {
    private val args: ShoppingDetailFragmentArgs by navArgs()
    private val shoppingItemInfo : ShoppingItemInfo by lazy { args.shoppingItemInfo }

override fun onCreateView(...){...}

override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
     super.onViewCreated(view, savedInstanceState)
	   Log.d("shoppingItemInfo",shoppingItemInfo.toString()) // 사용
    }

상수

resource -> 화면에 보이는가를 기준으로 string.xml에 분리 결정

• ex: EXTRA_TITLE_ID = "title_id" 상수 네이밍은 upper snake case

의미 있는 숫자, 문자열은 companion에 const val 선언

• ex: LOOP_COUNT = 10

네트워크 response 객체 Entity 매핑 방식

• from ⭐

테스트 함수 네이밍

• 한국어, snake case

instrument ok
fun `일정을_잘못_가져올_때`()

Git 컨벤션

Feature 브랜치 네이밍

Issue #<number> type: subject

body(option)

footer(option)

Type

• feat: 새로운 기능
• fix: 버그 수정
• docs: README, gitignore 주석 수정
• refactor: 코드 리팩터링
• test: 테스트 코드가 추가되거나 리팩터링 시 사용하며 프로덕션 코드는 변경되지 않는다.
• chore: 프로젝트 환경설정 변경, 빌드 구성 변경 등에 사용되며 프로덕션 코드는 변경되지 않는다.
• res

→ 소문자:

Subject

• 50자 이내
• 구어체/문장형 X, 명령형으로 작성
• 마침표 사용 불가

Body(Option)

• 생략 가능
• 72자 이내
• 어떤(What) 작업인지, 작업의 목적(Why)에 대해 작성. 작업을 해결한 방식(How)은 작성 X

Footer(Option)

Push/PR Issue 연결

• Issue Tracker ID 표시
• Issue Tracker 유
  • Fixes: 이슈 수정중 (아직 해결되지 않은 경우)
  • Resolves: 이슈를 해결했을 때 사용
  • Ref: 참고할 이슈가 있을 때 사용
  • Related to: 해당 커밋에 관련된 이슈번호 (아직 해결되지 않은 경우)

Issue & PR 공통 사항

라벨 달기(chore, bug, fix, feature, docs, help wanted, wrong, question)
- project달기
- Milestone 달기
- asignees 지정

PR 템플릿

# PR 내용

...작업 내용...

Issue 템플릿

# 진행 상황

...체크포인트...

참고 url

• 헤이딜러
• Kotlin 스타일 가이드
• 혼자서 안드로이드 App 개발하기
• xml 네이밍