[Go] fx: DI 도구

fx는 uber에서 오픈소스로 제공하는 의존성 주입(DI: Dependency Injection) 도구다.

설치

설치는 간단하다. 하나만 깔아주면 된다.

go get go.uber.org/fx@v1

기본구조

fx를 쓰려면 진입점 단계에서부터 fx로 래핑을 해줘야 한다.

package main

import "go.uber.org/fx"

func main() {
	fx.New().Run()
}

fx 객체를 만든 다음에, 실행을 한다.

그러면 이렇게 로그도 뜨고

실행이 될 것이다.

하지만 이대로는 아무것도 돌지 않는다.
아무것도 없기 때문이다.

Invoke

Invoke는 실제로 실행될 로직에 대한 부분이다.

라이플사이클 값을 하나 전달받는 함수를 만들고, 거기에 실행될 로직을 집어넣으면 된다.

여기서는 로그만 찍고 말았지만, 보통은 루프를 돌리면서 폴링을 하거나 서버를 띄우거나 할 것이다.

그리고 실행하면

실행이 될 것이다.

Invoke: 동시성

Invoke에는 여러개의 프로세스를 등록할 수 있다.

하지만 그게 별도로 동시에 돈다는 말은 아니다.
Invoke는 완전히 동기적으로 하나씩만 실행되며, 인자로 전달된 순서대로 동작한다.

그래서 위의 코드는 둘다 무한루프를 돌기 때문에, 먼저 먼달된 프로세스 Hello만 끝없이 실행된다.

그래서 비동기적인 무언가를 필요로 한다면 고루틴을 돌리거나 해야 하고,
그런게 필요한게 아니라면 무한루프가 존재하는 최종 프로세스를 맨 뒤로 빼고 그 앞에 작은 사전작업들을 분리하면 적절할 것이다.

Provide

Invoke가 각각의 독립된 프로세스라면, Provide는 모듈화 단위라고 할 수 있다. 이게 핵심이다.

가령, 위의 Hello Invoke의 경우에도, 로그를 찍는 부분이 비즈니스 로직이라고 한다면 그걸 분리하는게 모듈화 측면에서 좋을 수 있다.

그걸 먼저 별도의 타입으로 분리해서 구현하고

그걸 포인터로 반환하는 생성 함수를 하나 구현한다.

그리고 그걸 fx.Provide를 통해 프로바이더로 등록한다.

그러면 저 HelloProcessor라는 객체는 fx의 컨텍스트 내에서는 언제든 DI로 주입될 수 있다.

이게 무슨 소린가 하면은

이렇게 다른 Provide 함수나 Invoke 함수의 파라미터에 정의를 해두면 fx 컨텍스트가 들고있던 Provider들을 자동으로 주입해주는 것이다.
이런걸 DI라고 한다.

그리고 실행하면

잘 동작할 것이다.

서버 구성하기 (with echo)

echo에서 fx를 활용해서 레이어를 분리하고 DI를 적용하는 예를 들어보겠다.
echo 이외의 다른 프레임워크들도 비슷한 방식으로 접근할 수 있을 것이다.

일단 서비스 레이어와 컨트롤러 레이어만 추가하겠다고 가정한다. 레포지토리를 추가하는 법도 서비스와 별 차이가 없을 것이다.

아래와 같이 서비스에 대한 인터페이스와 그 구현체를 구현한다.

별로 특별할 것은 없다.
그리고 Provide에 제공할 생성 함수도 하나 만들어준다. 추상화를 위해서 인터페이스를 분리했기 때문에, 생성 함수도 인터페이스로 박싱해서 반환한다.

그리고 컨트롤러도 인터페이스와 구현체를 구현한다.

컨트롤러는 서비스를 종속성으로 가지는데, 생성 함수에서 DI된 서비스 객체를 받아와서 인터페이스로 들고있는다.
인터페이스를 통해 구성이 되어있고, DI를 통해 모듈들이 주입되기 때문에, 테스트 등을 위해서 fx context에 주입하는 객체만 Real에서 Fake 버전으로 교체해서 사용해도 완전하게 동작하게 만들 수 있다.

그리고 메인 진입점에서는 컨트롤러를 DI받아서 라우팅을 해준다.

컨트롤러도 서비스와 마찬가지로 추상화가 되어있다.

그리고 fx 컨텍스트에는 필요한 생성 함수들을 넣어주면 끝이다.

그럼 잘 동작할 것이다.

참조
https://uber-go.github.io/fx/get-started/