FSM(Finite State Machine) 패턴 with Go

#패턴

FSM(Finite State Machine:유한 상태 머신)은 다각적으로 변화할 수 있는 상태 관리에 초점을 둔 구성 패턴이다.

이게 어떨 때 필요할까?

배송상태를 예로 들어보겠다.

배송은 얼핏 보면 1차원적으로만 진행되는 것 같지만, 그렇지도 않다.
"구매 완료"에서 "구매 취소"로 갈 수도 있고,
"구매 완료"에서 "배송 중"으로 갈 수도 있으며,
"구매 완료"에서 "상품 준비중"으로 갈 수도 있다.
그리고 "상품 준비중"에서 "구매 취소"로 갈 수도 있을 것이다.

이런 로직은 상태가 많아지고 전이할 수 있는 경우의 수가 많아짐에 따라 관리하기가 매우 어려워지고, 스파게티가 만들어지기가 쉽다.

FSM은 상태 전이에 대한 복잡한 if-else 떡칠 로직을 약간 추상화하고, 이벤트 매핑을 통해 전이 로직을 조금 더 깔끔하게 관리할 수 있게 해주는 구현 패턴이다.

Go에서 구현해보기

상당수에 언어들에는 FSM을 구현하기 위한 서드파티 라이브러리가 존재한다.
여기서는 looplab이라는 데서 만든걸 써서 FSM을 사용해보겠다.

"open"과 "closed"의 2개의 상태가 있고, 서로서로 이동할 수 있는 구조라고 가정해보자.
그럼 다음과 같이 상태머신을 정의할 수 있다.

package main

import (
	"context"
	"fmt"

	"github.com/looplab/fsm"
)

func main() {
	fsm := fsm.NewFSM(
		"closed", // 초기 상태
		fsm.Events{ // 이벤트 정의
			{Name: "open", Src: []string{"closed"}, Dst: "open"},  // 현재 상태가 closed 일때 open 이벤트가 발생하면 open 상태로 변경
			{Name: "close", Src: []string{"open"}, Dst: "closed"}, // 현재 상태가 open 일때 close 이벤트가 발생하면 closed 상태로 변경
		},
		fsm.Callbacks{},
	)

	fmt.Println(fsm.Current())

	// open 이벤트를 날림
	err := fsm.Event(context.Background(), "open")
	if err != nil {
		fmt.Println(err)
	}

	fmt.Println(fsm.Current())

	// close 이벤트를 날림
	err = fsm.Event(context.Background(), "close")
	if err != nil {
		fmt.Println(err)
	}

	fmt.Println(fsm.Current())
}

fsm.Event로 이벤트 목록을 정의하는데, 각 배열의 Name은 이벤트명이고, Src는 시작 상태, Dst는 도착 상태다.
"closed" 상태에서 "open"이라는 이벤트가 들어오면 "open"이라는 상태로 전이시킨다는 내용이다.

저대로 실행해보면

시대한대로 동작할 것이다.

콜백

그냥 상태만 돌리고 말거라면 이걸 쓰는 이유가 없을 것이다.
Callback을 정의하면 각 이벤트가 호출될때마다 사용할 콜백함수를 정의할 수 있다. 그리고 파라미터로 전달되는 이벤트 객체를 통해 전이 상태를 확인할 수도 있다.

이런 식이다.
일단 로그만 찍어주도록 했다.

package main

import (
	"context"
	"fmt"

	"github.com/looplab/fsm"
)

func main() {
	fsm := fsm.NewFSM(
		"closed", // 초기 상태
		fsm.Events{ // 이벤트 정의
			{Name: "open", Src: []string{"closed"}, Dst: "open"},  // 현재 상태가 closed 일때 open 이벤트가 발생하면 open 상태로 변경
			{Name: "close", Src: []string{"open"}, Dst: "closed"}, // 현재 상태가 open 일때 close 이벤트가 발생하면 closed 상태로 변경
		},
		fsm.Callbacks{
			"open": func(c context.Context, e *fsm.Event) {
				fmt.Println(e.Src + " -> " + e.Dst)
			},
			"close": func(c context.Context, e *fsm.Event) {
				fmt.Println(e.Src + " -> " + e.Dst)
			},
		},
	)

	// open 이벤트를 날림
	err := fsm.Event(context.Background(), "open")
	if err != nil {
		fmt.Println(err)
	}

	// close 이벤트를 날림
	err = fsm.Event(context.Background(), "close")
	if err != nil {
		fmt.Println(err)
	}
}