의존성 주입의 Koin🪙 한 닢을 - 1

의존성 주입이라.. 너무나도 익숙하지 않은 문장이다.

남에게 의존하지말고 주체적으로 살자 라는 말을 사용할 때만 썼던 단어를 개발할 때 사용하니 어색하고 단번에 이해가 되지 않는다.

의존성 주입(의존관계 주입)! Dependency Injection(DI)

디펜던시 인젝션, 의존성주입에 대해 간단하게 설명하고 싶은데 뭐라해야될지 모르겠다.

→ 표준을 정의 할 수 있고, 정의된 표준을 바탕으로 같은 설계를 하게 하여줍니다.(역시나 한 번에 이해가 되지 않는다.)

좀 더 가깝게 정의한다면,

”의존대상 B가 변하면, 그것이 A에 영향을 미친다 .” - 이일민, 토비의 스프링 3.1, 에이콘(2012), p113

B가 변경되거나 형식이 바뀌면 A에 영향이 간다.

 

(사진 : Jacob)

🥋 품새를 가르치는 태권도 사범님은 국기원에서 지정한 품새의 형식에 의존한다.

지정되었던 품새가 변화하게 되었을 때, 변화된 품새에 따라서 태권도 사범님은 아이들에게 바뀐 형식대로 가르쳐야한다.

품새의 변화가 사범님의 교육에 영향을 미쳤기 때문에 “사범님은 국기원에서 지정한 품새 형식에 의존한다.” 라고 말할 수 있다.

(모두 자기가 이해하는 방법이 다르기에 자신의 상황에 맞게 대입시켜보면 좋을 것 같다.)

DI 구현 방법

DI는 의존관계를 외부에서 결정하는 것이기 때문에, 클래스 변수를 결정하는 방법들이 곧 DI를 구현하는 방법이다. 런타임 시점의 의존관계를 외부에서 주입하여 DI 구현이 완성된다.

의존성 주입 전

// koin을 사용한 것이 아님.
class Poomsae {
    fun start() {
      ...
    }
}
​
class TaekwondoCoach {
    private val poomsae = Poomsae()
​
    fun start() {
        poomsae.start()
    }
}
​
fun main(args: Array) {
    val taekwondoCoach = TaekwondoCoach()
    taekwondoCoach.start()
}
​

의존성 주입 후

// koin을 사용한 것이 아님.
... 
​
class TaekwondoCoach(private val poomsae: Poomsae) { 
// 의존성 주입은
// 안에서 선언해서 사용하는지 / 사용하는 곳에서 선언해서 넣어주냐 차이 ⬆️
    fun start() {
        poomsae.start()
    }
}
​
fun main(args: Array) {
    val poomsae = Poomsae()
    val taekwondoCoach = TaekwondoCoach(poomsae)
    taekwondoCoach.start()
}

의존성 주입 장점

1. 재사용성 ⬆️.
2. 테스트에 용이
3. 코드 단순화
4. 종속적이던 코드의 수 ⬇️
5. 사용 이유 파악하기 수월. (코드를 읽기 쉬워짐)
6. 종속성이 감소(구성 요소의 종속성이 감소 → 변경에 민감 ❎.)
7. 결합도는 낮추면서 유연성과 확장성은 향상시킬 수 있음.
8. 객체간의 의존관계를 설정 가능(없애거나 줄일 수 있음)
9. 등등…

하지만 단점도 존재하죠.

1. 의존성 주입을 위한 선행작업이 필요함.
2. 코드를 추적하고 읽기가 어려워짐.( → 단순화 되면서)
3. 간단한 프로그램을 만들 때는 번거로움

잘 판단해서 사용하길 바람.

하지만 위 코드처럼 수동으로 일일히 DI(의존성 주입)하기엔 너무 귀찮다.. 라이브러리를 쓰자!!

라이브러리도 3가지 정도 알고있다

Hilt, Dagger2, Koin 이 있는데 간단하게 이것들의 차이점이라고 하면 아래에 정리해봤다.

	Hilt(Jetpack)	Dagger2	Koin
Java	O	O	X
Kotlin	O	O	O
러닝커브	낮음	높음	낮음
에러검출 시점	Compile Time	Compile Time	Runtime
실제 프로젝트 검증	beta버전(조금씩 보임)	많은 앱에서 검증됨	많은 앱에서 검증됨

 

그래서 지금 작은 프로젝트에 적용하고 검증이 되었고 조금 공부를 덜 해도 당장 적용시키면서 배우고 싶었기 때문에 Koin을 프로젝트에 적용을 결정했습니다~ (😵아이러니하게도 적용하기 가장 좋은 시기는 아직 프로젝트가 작은규모일 때 라고 들었어요)

(🕺🏼모든 라이브러리를 사용해본 것이 아니기 때문에 아직 뭐가 좋다 말할 수 없지만 경험을 쌓으면서 여러가지 공부 해볼 예정.)

 

1. gradle 추가

// build.gradle (project)
buildscript {
  ...
  ext.koin_version = '3.1.0'
​
  repositories { 
      jcenter()
  }
}
​
// build.gradle (app)
dependencies {
  ...
  implementation("io.insert-koin:koin-core:$koin_version")
  implementation("io.insert-koin:koin-android:$koin_version")
  implementation("io.insert-koin:koin-test:$koin_version")
  ...
}

 

2. Koin 사용!

설치가 끝나면 본격적으로 사용!

class SampleRepository() {
    val sampleData = "Sample Data!"
}
​
class SampleController(val repository: SampleRepository) {
    fun printSampleData() {
        Log.d("Print sample data", repository.sampleData)
    }
}
​
class SampleViewModel : ViewModel() {
    private var _isLoading = MutableLiveData<Boolean>()
    val isLoading: LiveData<Boolean> = _isLoading
}

val appModule = module {
    single { SampleRepository() }
    factory { SampleController(get()) }
}

• single : 앱이 실행되는 동안 계속 유지되는 싱글톤 객체를 생성합니다.
• factory : 요청할 때마다 매번 새로운 객체를 생성합니다.
• get() : 컴포넌트 내에서 알맞은 의존성을 주입 받습니다.
  • 위 예제에서는 SampleRepository 타입으로 선언되어 있으므로 이미 생성된 객체 중 SampleRepository 타입에 알맞은 객체를 Koin이 주입해줍니다.
  ViewModel의 경우 viewModel 키워드로 선언해야 합니다. 

val viewModelModule = module {
    viewModel { SampleViewModel() }
}

 

 

3. 모듈 등록

이제 Koin에 해당 모듈을 등록할 차례입니다.

Application 클래스의(프로젝트에 Application 클래스가 따로 없다면 새로 생성합니다) onCreate LifeCycle에서 startKoin을 호출하고 위에서 선언한 모듈 변수를 넘겨줍니다.

class MyApplication: Application() {
    override fun onCreate() {
        super.onCreate()
        initKoin()
    }
​
    private fun initKoin() {
        startKoin {
            androidLogger(Level.NONE)
            androidContext(this@MyApplication)
            modules(
                appModule,
                adapterModule,
                viewModelModule
            )
        }
    }
}

• androidLogger() : AndroidLogger를 Koin logger로 사용합니다.
• androidContext(...) : 해당 안드로이드 context를 사용합니다.
• modules(...) : 사용할 모듈을 등록합니다.

참고로 Application 클래스를 새로 생성하셨다면 manifest.xml에 등록해야 합니다.

<application
    android:name=".MyApplication"
    ...

 

 

4. 의존성 주입 받기

여기까지 잘 따라오셨다면 이제 위에서 등록한 모듈을 주입 받아 사용할 수 있습니다.

by inject()로 Koin에 등록된 객체를 lazy 하게 주입 받을 수 있습니다. 

사용하고자 하는 Activity 클래스에서 SampleController를 주입 받아 봅시다.

class SampleActivity : AppCompatActivity() {
​
    val controller: SampleController by inject()
​
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate()
    }
}

한 줄이면 됩니다. 아주 간단하죠?

ViewModel의 경우 by viewModel() 키워드를 사용합니다.

val viewModel: SampleViewModel by viewModel()

간단하다고 말하고 있지만 기존에 사용하던 것을 버리고 새로운 것을 배우는 것은 쉽지 않고 조금 더 나은 프로젝트와 개발자가 되기 위해서는 필요한 부분이 ‘삽질🛠’ 이라고 생각해요.

아직 많이 부족하고 작성하면서도 더 공부가 필요한 부분이 있다고 생각해서 다음 글에서는 적용하면서 겪었던 일들과 여러가지 적용시 필요한 것들을 적을 예정입니다.