[CS] 의존성 주입(Dependency Injection)이란? (feat. 써야하는 이유)

 

 

안녕하세요 Foma 💻 입니다!

 

오늘은 의존성 주입이 무엇이고 써야하는 이유에 대해서 알아보도록 하겠습니다.

 

SOLID원칙의 하나이기도 하고 최근 RIBs 아키텍처를 공부하고 있는데 UIViewController도 직접 채택하지 않고

 

ViewControllable로 프로토콜을 만들어서 주입하더라구요..

 

뭔가 추상적으로는 알겠는데 구체적으로 명확하게 이게 뭐고 이게 왜 필요한가에 대해서 알지 못해서

 

글을 정리하려고 합니다!

 

바로 시작할게요~

---

의존성을 갖는다는 것은 무엇일까? 🤔

 

만약 배터리가 일체형인 자동차 장난감 🚗 이 있다고 가정할게요.

 

이 자동차 장난감은 배터리가 다 닳게 되면 더 이상 사용할 수 없습니다.

 

이 경우 자동차 장난감은 배터리에 의존하고 있는 것입니다.

 

코드로 설명을 하면 아래와 같습니다.

 

class ToyCar {
    var battery:Battery = Battery()
}

class Battery {
    var energy:Int = 100
}

 

ToyCar 클래스의 battery는 배터리 클래스를 내부에서 직접 생성하여 가지고 있습니다.

 

이렇게 되면 내부에 생성된 Battery 클래스의 energy가 다 닳게 되면 ToyCar 클래스를 사용할 수 없기 때문에

 

ToyCar 클래스가 Battery 클래스에 의존하고 있는 것입니다.

---

의존성 주입이란?

 

"소프트웨어 엔지니어링에서 의존성 주입(dependency injection)은 하나의 객체가 다른 객체의 의존성을 제공하는 테크닉이다. "의존성"은 예를 들어 서비스로 사용할 수 있는 객체이다. 클라이언트가 어떤 서비스를 사용할 것인지 지정하는 대신, 클라이언트에게 무슨 서비스를 사용할 것인지를 말해주는 것이다. "주입"은 의존성(서비스)을 사용하려는 객체(클라이언트)로 전달하는 것을 의미한다. 서비스는 클라이언트 상태의 일부이다. 클라이언트가 서비스를 구축하거나 찾는 것을 허용하는 대신 클라이언트에게 서비스를 전달하는 것이 패턴의 기본 요건이다." - 위키 백과 -

 

즉, 클래스 내부에서 생성하는 것이 아니라 외부에서 클래스를 주입해주는 것이죠.

 

이렇게 말하면 이해하기 힘드실거에요.

 

예제를 통해서 알아보겠습니다.

---

의존성 주입해보기

 

위에서 설명한 자동차 장난감을 예시로 들겠습니다.

 

battery를 내부에서 생성했기 때문에 배터리에 의존하고 있는게 문제라고 했었죠?

 

아래와 같이 battery를 ToyCar 초기화 함수의 파라미터에 battery를 외부에서 적용받을 수 있게 해줍니다.

 

이렇게 하면 배터리를 외부에서 받게 되고 배터리가 다 닳아져도

 

다른 배터리를 외부에서 받아서 적용하면 되기 때문에 의존성이 낮아집니다.

 

class ToyCar {
    var battery:Battery
    
    init(battery:Battery) {
        self.battery = battery
    }
    
    func setBattery(battery:Battery) {
        self.battery = battery
    }
}
//ToyCar(battery: Battery())

 

하지만 여기서 문제가 또 발생합니다.

 

만약 배터리가 아닌 코드로 충전하는 자동차 장난감이 있다면 어떻게 해야할까요?

 

아래와 같이 배터리로 된 자동차 장난감 클래스와 코드로된 자동차 장난감 클래스를 따로 만들어줘야겠죠?

 

class BatteryToyCar {
    var battery:Battery
    
    init(battery:Battery) {
        self.battery = battery
    }
}

class CodeToyCar {
    var code:Code
    
    init(code:Code) {
        self.code = code
    }
}

 

고로 공통적인 부분이 있는 Charger 프로토콜을 따로 생성하여 배터리와 코드 클래스에 주입해줍니다.

 

이렇게 하면 Battery,Code 클래스 모두 Charger 프로토콜을 따르는 클래스가 됩니다.

 

그 다음 ToyCar battery를 charger로 모두 바꿔주면 ToyCar는 배터리로 충전하든 코드로 충전하든 상관이 없게됩니다.

 

 

protocol Charger {
}

class ToyCar {
    var charger:Charger
    
    init(charger:Charger) {
        self.charger = charger
    }
    
    func setCharger(charger:Charger) {
        self.charger = charger
    }
}


class Battery:Charger {
    var energy:Int = 100
}

class Code:Charger {
    var volt:Int = 220
}

 

만약 여기서 충전기에 충전하는 함수와 충전을 멈추는 함수를 미리 구현해놓으면 

 

protocol Charger {
    func charge()
    func stopCharge()
}

 

Charger에 필요한 코드가 자동으로 생성되어 코드를 재활용할 수 있게됩니다.

 

class Battery:Charger {

    var energy:Int = 100
    
    func charge() {
    }
    
    func stopCharge() {
    }
}

class Code:Charger {
    
    var volt:Int = 220
    
    func charge() {
    }
    
    func stopCharge() {
    }
}

---

의존성 주입을 하면 왜 테스트가 편해질까? 🧐

 

우선 테스트를 할 때는 필수적으로 가짜(Mock) 데이터,서비스,밸리데이터 등을 만들어야 합니다.

 

회원가입을 할 때 웹서비스를 의존성 주입없이 만들었다고 가정하겠습니다.

 

class SignUpWebService {
    
    private var urlSession:URLSession
    private var urlString:String
    
    init(urlString:String,urlSession:URLSession = .shared) {
        self.urlString = urlString
        self.urlSession = urlSession
    }
    
    func signUp(with requestModel:SignUpRequestModel,completion:@escaping(SignUpResponseModel?,SignUpError?)-> Void) {
        guard let url = URL(string: urlString) else {
            completion(nil,SignUpError.invalidRequestURLString)
            return
        }
        
        ...
}

 

그 다음 테스트를 진행하려고 가짜회원가입 웹서비스를 만드려고 할 때 직접 회원가입 웹서비스에 어떤 프로퍼티가 있는지 

 

어떤 메소드가 있는지 직접 작성해주어야 합니다. 

 

또한 메소드를 빼먹을 경우 테스트를 빼먹을 수 있는 가능성도 존재합니다.

 

class MockSignUpWebService {
    
    var isSignUpMethodCalled:Bool  = false
    var shouldReturnError:Bool = false
    
   ...
}

 

하지만 아래와 같이 회원가입웹서비스 프로토콜으로 필요한 메소드를 미리 정의해두고

 

protocol SignUpWebServiceProtocol {
    func signUp(with requestModel:SignUpRequestModel,completion:@escaping(SignUpResponseModel?,SignUpError?)-> Void)
}

 

가짜 웹서비스에 채택하게 되면 어떤 메소드가 필요한지 자동으로 세팅되어 빼먹을 가능성이 없고 직접 코드를 작성하지 않아도 됩니다.

 

class MockSignUpWebService:SignUpWebServiceProtocol {
    
    var isSignUpMethodCalled:Bool  = false
    var shouldReturnError:Bool = false
    
    func signUp(with requestModel: SignUpRequestModel, completion: @escaping (SignUpResponseModel?, SignUpError?) -> Void) {
        isSignUpMethodCalled = true
        
        if shouldReturnError {
            completion(nil,SignUpError.failedRequest(description: "SignUp request was not successful"))
        }else {
            let response = SignUpResponseModel(status: "ok")
            completion(response,nil)
        }
    
    }
}

---

정리

 

의존성 주입은 클래스 내부에 객체를 생성하지 않고 외부에서 주입받는 것이다.

 

의존성 주입을 해야하는 이유는 각 클래스간 의존하지 않게 하여 한 클래스에서 문제가 생기더라도 

 

해당 클래스만 고치면 되도록 하기 위함이다.

 

공통적인 부분을 프로토콜로 미리 정의해두고 각 클래스에 채택하여 사용하게 되면 코드를 재사용할 수 있고

 

다른 클래스를 확장하더라도 프토코콜만 채택해주면 간편하게 주입해줄 수 있다.

 

또한 테스트 시 Mock 클래스를 만들 때 의존성을 주입하여 코드를 쉽게 실수없이 작성하게 하여 

 

테스트를 간편하게 할 수 있게 한다.

---

Reference

 

https://devlog-wjdrbs96.tistory.com/165

 

https://lsh424.tistory.com/86