# DependencyContainer

이 패키지는 **AFToastView**, **SwiftSimpleAlertController**, **AFUserSession**과 같이 아직 모듈화 되어있지 않아서 AfreecaTV 프로젝트에 코드 의존성을 가져야 하는 상황을 해결하기 위해 생성한 패키지입니다.

기본적인 구조는 [링크](https://minsone.github.io/programming/swift-solved-circular-dependency-from-dependency-injection-container)를 참고하였습니다.


해당 패키지를 사용할 시 의존성 구조는 위와 같이 그려집니다.

# 내부 구성

DependencyContainer에는 주입될 기능이 Conform해야 할 Injectable 프로토콜과 이러한 기능들을 Dictionary로 관리하는 Container가 존재합니다.

### Injectable

public protocol Injectable {
    init()
    var id: String { get }
    func resolve() -> AnyObject
}

Injectable 프로토콜 내부는 위와 같은 코드로 구성되어 있습니다.

- 전달받은 타입을 생성할 수 있는 **init**
- 각 기능을 구별할 수 있는 **id**
- 실질적으로 기능이 구현되어있는 기능 Implement를 반환하는 **resolve** 메서드

### Container

public protocol ContainerAPI {
    func regist(injectType: Injectable.Type)
    func load(for injectID: String) -> Injectable?
}

public class Container: NSObject, ContainerAPI {
    private var injections: [String: Injectable] = [:]
    public static let shared: Container = Container()
    
    public func regist(injectType: Injectable.Type) {
        let injection = injectType.init()
        injections[injection.id] = injection
    }
    
    public func load(for injectID: String) -> Injectable? {
        injections[injectID]
    }
}

Container의 코드는 위와 같이 구성되어 있습니다.

해당 모듈이 여러 모듈사이에서 쓰일 수 있고 각 모듈에서 주입받아야 하는 기능들을 한번에 관리해야하기 때문에 **싱글턴** 패턴을 이용하였습니다.

- **injections** 프로퍼티를 통해 외부에 의존하는 기능들을 Dictionary로 관리합니다.
💡key로 Injectable 프로토콜에서 정의한 **id 프로퍼티를** 사용합니다.
- **regist** 메서드를 이용하여 기능을 주입하는데, 파라미터에 Injectable 프로토콜을 conform하는 타입을 전달하고, 이를 init하여 injections 딕셔너리에 저장합니다.
- injections 프로퍼티에 저장된 기능을 **load** 메서드를 통해 불러옵니다.

# 사용 예시

1. 의존성을 주입할 기능에 대한 inject Protocol과 해당 기능을 유니크하게 식별할 수 있는 ID 값을 생성합니다. **(DependencyContainer 패키지)**

    // FileName : ToastInject
    
    public let toastInjectID = "ToastInjectID"
    
    public protocol ToastInject {
        func request(message: String, timeInterval: TimeInterval)
    }

2. 해당 기능이 구현되어있는 프로젝트**(AfreecaTV 프로젝트)**에서 위 프로토콜을 conform 하는 타입을 생성한 뒤 메소드 내부를 구현해줍니다.

    // FileName : ToastImplement
    
    final class ToastImplement: ToastInject {
        public func request(message: String, timeInterval: TimeInterval) {
            AFToastView.showToast(delay: timeInterval, message: message)
        }
    }

3. Container에 기능을 주입할 수 있도록 Injectable 프로토콜을 준수하는 아이템을 생성합니다. **(AfreecaTV 프로젝트)**
id 프로퍼티에 아까 생성한 기능의 ID를 저장하고, resolve 메서드에서 위에 생성한 inject 프로토콜을 구현한 타입을 반환합니다.

    // FileName : ToastImplement
    
    final class ToastInjectItem: Injectable {
        var id: String = toastInjectID
        required init() { }
        func resolve() -> AnyObject {
            ToastImplement()
        }
    }

4. **주입된 기능을 사용하려는 모듈**에서 Container에 담긴 기능을 빼내어 호출할 수 있도록 코드를 구성합니다.
여기서 아까 Container에서 구현한 load와 각 item에 정의된 resolve를 호출합니다.
이를 사용하고자 하는 inject 프로토콜로 변환하여 반환합니다.

    protocol ToastService {
        func showToast(message: String, timeInterval: TimeInterval)
    }
    
    struct DefaultToastService: ToastService {
        let toastService: ToastInject
        
        func showToast(message: String, timeInterval: TimeInterval) {
            toastService.request(message: message, timeInterval: timeInterval)
        }
    }
    
    struct ToastBuilder {
        static func build() -> ToastService? {
            guard let inject = Container.shared.load(for: toastInjectID)?.resolve() as? ToastInject else {
                return nil
            }
            
            return DefaultToastService(toastService: inject)
        }
    }

> 현재 LivePlayer는 Clean Architecture 구조를 사용중이므로 위와같이 Service로 빼내어 사용합니다.

### 위 코드로 만들어진 주입된 기능을 사용하려면 사용하려는 모듈에서

protocol ToastService {
    func showToast(message: String, timeInterval: TimeInterval)
}

struct DefaultToastService: ToastService {
    let toastService: ToastInject
    
    func showToast(message: String, timeInterval: TimeInterval) {
        toastService.request(message: message, timeInterval: timeInterval)
    }
}

struct ToastBuilder {
    static func build() -> ToastService? {
        guard let inject = Container.shared.load(for: toastInjectID)?.resolve() as? ToastInject else {
            return nil
        }
        
        return DefaultToastService(toastService: inject)
    }
}

// in Use
ToastBuilder.build()?.showToast(message: "test", timeInterval: 3)

Container의 **load** 메서드를 이용하여 원하는 기능을 추출한 뒤, 이를 구조에 맞게 사용하면 됩니다.