Coroutine

코루틴(Coroutine)이 뭔가요?

C 언어등에서 일반적으로 사용하는 함수는 시작할 때 진입하는 지점이 하나 존재하고 함수가 모두 실행되거나, return 구문에 의해서 종료되는 지점을 설정할 수 있습니다. 이러한 함수를 서브루틴(Subroutine)이라 부르는데, 코루틴은 이를 더 일반화한 개념으로 진입하는 지점까지 여러 개를 가질 수 있는 함수를 의미합니다. 개념적으로만 본다면 서브루틴도 코루틴의 한 종류라고 볼 수 있겠지요.

코루틴이 왜 필요한가요?

코루틴이 없어도 게임을 만드는데 지장은 없습니다. 하지만 유니티에서 코루틴을 잘 활용하면 높은 성능을 내는 스크립팅의 제작이 가능해지고, 읽기 쉬운 코드를 만들 수 있게 됩니다.

코루틴은 어떻게 사용하나요?

C# 언어를 기준으로, 코루틴은 언제나 아래와 같은 구문을 통해서 선언되어야 합니다.

IEnumerator 함수이름 (인자)

IEnumorator 는 우리말로 열거자라고 하는데, 데이터의 목록을 하나씩 넘겨줄 때 사용되는 인터페이스입니다. 이 열거자와 코루틴이 무슨 관계이길래 이를 활용하는지 설명드리면, 코루틴은 호출한 함수와 서로 상호작용하면서 진행하도록 설계되어 있습니다. ( 어느 분께서는 협동루틴이라고 번역하셨는데, 정말 적절한 번역입니다! ) 아래 그림과 같이 코루틴은 자신을 호출한 함수에 데이터를 하나 넘겨주고 쉽니다. 받은 측에서는 데이터를 받고 나서 처리한 후에 코루틴에게 다음 데이터를 달라고 깨웁니다. 쉬고 있던 코루틴은 일어나서 다시 데이터를 전달하고.. 이를 계속 반복하는 구조로 동작합니다. 이러한 작업에 적절한 인터페이스가 IEnumerator 이며, C#에서 코루틴을 사용할 때는 이를 사용하여야 합니다.

일반적으로 호출한 함수에게 데이터를 전달할 때, return 구문을 사용하게 되면 데이터를 전달하고 함수는 종료됩니다. 코루틴은 이와 다르게 데이터를 전달한 후에 자신은 대기하고 있어야 하는데, 이를 위해 C#에서는 yield return이라는 키워드를 제공하고 있으며 이를 사용하면 됩니다. 

yield return ... ;

유니티에서 코루틴과 상호작용하는 주체는 엔진입니다. 코루틴을 사용할 때는 C#의 언어적인 기능을 익혀서 모든 것을 해결한다라는 개념보다 스크립트에서 엔진이 가지는 기능을 활용하는 또 한가지의 방법이라는 관점으로 생각해주시면 더 잘 이해되지 않을까.. 생각해봅니다.  

아래 그림과 같이 스크립트에서 StartCoroutine 함수를 통해 코루틴을 구동하면 코루틴은 첫 번째 데이터를 엔진에 전달하고 이 데이터를 분석한 엔진은 내부 루프를 돌면서 필요한 때가 되면 다음 데이터를 전달하도록 코루틴을 다시 호출해줍니다.

이 때 엔진에 전달할 데이터가 정말 중요한데, 데이터들은 코루틴이 유니티 엔진에게 보내는 일종의 명령으로 생각하시면 조금 더 이해가 쉽습니다.  

엔진에게 전달하는 명령들의 공통된 성격은 “나는 쉬고 있을 테니, 유니티 너가 내 명령을 보고 알아서 처리하고 끝나면 나를 깨워달라.” 입니다. ( 스크립트가 완전 갑이 됬습니다...  ) 

엔진이 제공하는 데이터들과 이들이 수행하는 명령들은 다음과 같습니다. 

( 참고로 아래 표 이외의 데이터들은 엔진이 처리하지 않습니다. )

코루틴용 데이터	엔진이 수행하는 기능
yield return null	다음 프레임까지 대기
yield return new WaitForSeconds(float)	지정된 초 만큼 대기
yield return new WaitForFixedUpdate()	다음 물리 프레임까지 대기
yield return new WaitForEndOfFrame()	모든 렌더링작업이 끝날 때까지 대기
yield return StartCoRoutine(string)	다른 코루틴이 끝날 때까지 대기
yield return new WWW(string)	웹 통신 작업이 끝날 때까지 대기
yield return new AsyncOperation	비동기 작업이 끝날 때까지 대기 ( 씬로딩 )

코루틴은 왜 좋은가요?

첫 번째로 좋은 점은 성능입니다.

예를 들어 코루틴에서 yield return new WaitForSeconds(10)이라는 명령을 수행하면 코루틴은 유니티 엔진에게 WaitForSeconds(10)이라는 데이터를 보내고 쉬기 시작합니다. 유니티 엔진은 이를 받고 기록해두었다가 묵묵하게 자기 할 일을 진행 하면서 10초가 지나면 쉬고 있는 코루틴을 깨웁니다. 

코루틴이 없이 일반적으로 이를 구현 한다면 Update 구문에서 Time.deltaTime을 사용하여 매 프레임마다 시간을 더해서 10초가 지났는지 감지해야 하는데, 프레임의 평균 소요 시간이 0.01초라고 한다면, 아이러니하게 10초 동안 대기하기 위해 스크립트는 Update 함수를 1000번 호출해야 합니다. 코루틴을 사용하면 10초 동안 스크립트가 쉬는데 말이지요~ 

이러한 점 때문에 특히 모바일 기기에서 코루틴의 활용은 성능 향상에 큰 영향을 미칩니다.

두 번째로 좋은 점은 가독성입니다. 

코루틴을 사용하면 읽기 좋은 코드가 만들어집니다. 아래 예를 보면 1초를 대기한 후에 2초를 대기하는 작업을 수행하는 두 코드의 가독성에서 확연한 차이를 볼 수 있습니다.

( 참고로 Start 함수를 IEnumerator로 선언해주면 엔진이 자동으로 코루틴으로 실행해줍니다. )

public class UpdateTimer : MonoBehaviour {
    float accumulator = 0.0f;
    bool wait1Finished = false;
    bool wait2Finished = false;
    float waitTime1 = 1.0f;
    float waitTime2 = 2.0f;
    void Start() {
        Debug.Log ("Action Start!");
    }
    void Update () {
        accumulator += Time.deltaTime;
        if(!wait1Finished && !wait2Finished) {
            if(accumulator >= waitTime1) {
                Debug.Log ("Action1 End");
                wait1Finished = true;
                accumulator = 0.0f;  
            }
        } else if(wait1Finished) {
            if(accumulator >= waitTime2) {
                Debug.Log ("Action2 End");
                wait2Finished = true;
                accumulator = 0.0f;  
            }
        }
    }
}
 

public class CoRoutineTimer : MonoBehaviour {
    float waitTime1 = 1.0f;
    float waitTime2 = 2.0f;
   
    IEnumerator Start () {
        Debug.Log ("Action Start");
        yield return new WaitForSeconds(waitTime1);
        Debug.Log ("Action1 End");
        yield return new WaitForSeconds(waitTime2);
        Debug.Log ("Action2 End");
    }    
}

코루틴의 특징 및 활용

코루틴의 활용 방법은 아주 다양할 수 있지만, 저는 세 가지로 구분해봤습니다. 

가장 많이 사용되는 빈도 순으로 정리해봤습니다.

첫 번째로 코루틴에서 가장 많이 사용되는 데이터는 WaitForSeconds 명령 입니다. 

앞서서 살펴본 예제처럼 마치 멀티 쓰레드 프로그래밍의 Thread.Sleep 함수 처럼 원하는 시간만큼 잠들어 있을 수 있습니다. 하지만 더욱 좋은 점은 엔진과 동일한 싱글 쓰레드로 돌아가기 때문에, 멀티 쓰레드 프로그래밍의 여러운 부분인 자원 관리 및 컨텍스트 스위칭(Context Switching)과 같은 다양한 고려 사항들을 신경쓸 필요가 없습니다.

두 번째로 많이 사용하는 부분은 비동기 작업인데, 웹에서의 데이터 수신, 씬 로딩과 같은 오래 걸리는 작업을 엔진에게 넘기고, 자신은 진행상황을 점검하면서 UI 처리만 수행하는 형태로 사용합니다. 

아래와 같은 WWW 클래스가 대표적인 비동기 작업인데, 웹에서 데이터를 다운로드 받기 위해 스크립트는 엔진에게 www 클래스를 만들어 데이터를 받아올 URL과 함께 넘기고 자신은 쉽니다. 

이를 받은 엔진은 비동기 처리를 위한 쓰레드를 생성하고 네이티브 라이브러리를 사용하여 웹에 접속한 후 데이터를 다운로드하면서 스크립트로부터 넘겨 받은 www 객체에 직장 상사에게 보고하듯 현재 진행상황을 저장해둡니다. ( 이 때 클래스의 레퍼런스를 넘겼기 때문에 다른 스크립트에서 진행상황을 읽어들이는 것이 가능합니다. )

엔진에서 다운로드가 끝나면 www 객체에는 완료 상황보고와 함께 받은 데이터가 저장되며, 엔진은 스크립트를 깨웁니다. 스크립트에서는 곤히 자고 일어나 눈비비면서 이를 사용하면 됩니다. 

아래는 코루틴이 쉬는 동안 엔진은 열심히 다운로드 받고, Update 함수는 이를 보면서 열심히 진행상황을 로그로 남기는 예제입니다. 

public class WebBasic : MonoBehaviour {
 
    public string url;
    WWW www;
   
    bool isDownloading = false;
   
    IEnumerator Start()
    {
        www = new WWW(url);
        isDownloading = true;
        yield return www;
        isDownloading = false;
        Debug.Log ("Download Completed!");
    }
   
    void Update()
    {
        if(isDownloading)
            Debug.Log (www.progress);
    }
 
}

매 프레임마다 진행상황을 그리거나, Update 함수 자체를 쓰는게 부담스러우면 아래와 같이 UI만을 그리는 코루틴을 하나 더 발생시키는 것도 좋은 방법이 되겠지요. 

public class WebAdvanced : MonoBehaviour {
   
    public string url;
    WWW www;
   
    IEnumerator Start()
    {
        www = new WWW(url);
        StartCoroutine("CheckProgress");
        yield return www;
        Debug.Log ("Download Completed!");
    }
   
    IEnumerator CheckProgress()
    {
        Debug.Log (www.progress);
        while(!www.isDone)
        {
            yield return new WaitForSeconds(0.5f);
            Debug.Log (www.progress);
        }
    }
       
}

마지막으로 코루틴을 사용하여 작업을 원하는대로 순차적으로 수행할 수 있습니다. 

이 기능은 C#과 같은 고급 언어(Hight Level Language)에서 지원하는 리플렉션(Reflection)기능과 코루틴 기능이 혼합된 활용성에 있어서 백미(白眉)라고 할 수 있겠습니다. 

이의 활용 예를 위해, RPG 게임등에서 흔히 보이는 패턴인 A와 B와 중 하나를 선택하게 하는 다이얼로그를 띄운 후, 사용자의 결정에 따라 A를 선택하면 ActionA를 수행하고 B를 선택하면 ActionB를 수행하는 구문을 프로그래밍 한다고 가정해봅시다. 이의 순서도는 아래와 같겠지요. 

이를 코루틴으로 구현하기 위해, 먼저 모든 행동을 각각 코루틴으로 정의해줍시다. 

그리고 각 행동들의 순서를 제어하는 코루틴을 만들어주고, 코루틴 안에서 행동들이 순차적으로 실행되도록 yield return new StartCoroutine 구문으로 차례대로 지정해줍니다. 첫 번째 코루틴의 결과에 따라 다음 행동이 A가 될지 B가 될지 결정되므로, 첫 번째 결과값을 string 변수로 지정하고, 변수 값을 StartCoRoutine에 넣으면 실시간으로 결과에 따른 해당 코루틴이 실시간으로 실행됩니다. 

아래는 이를 구현한 예제 입니다. 

public class DialogExample : MonoBehaviour {
   
    bool showDialog = false;
    string answer = "";
   
    IEnumerator Start()
    {
        yield return StartCoroutine("ShowDialog");
        yield return StartCoroutine(answer);
    }
   
    IEnumerator ShowDialog()
    {
        showDialog = true;
        do
        {
            yield return null;
        } while(answer == "");
       
        showDialog = false;
    }
   
    IEnumerator ActionA()
    {
        Debug.Log ("Action A");
        yield return new WaitForSeconds(1f);
    }
 
    IEnumerator ActionB()
    {
        Debug.Log ("Action B");
        yield return new WaitForSeconds(2f);
    }
   
    void OnGUI()
    {
        if(showDialog)
        {
            if(GUI.Button(new Rect(10f, 10f, 100f, 20f), "A"))
            {
                answer = "ActionA";  
            } else if(GUI.Button(new Rect(10f, 50f, 100f, 20f), "B")) {
                answer = "ActionB";
            }
        }
    }
   
}

결과 값의 유효성을 강화하고 싶다면 아래와 같이 enum을 보조적으로 사용하는 것도 좋은 방법이 될 수 있습니다.

using UnityEngine;
using System.Collections;
 
public class DialogExampleEnum : MonoBehaviour {
 
    enum DialogActions {
        ShowDialog,
        ActionA,
        ActionB
    };
   
    bool showDialog = false;
    DialogActions action = DialogActions.ShowDialog;
   
    IEnumerator Start()
    {
        yield return StartCoroutine(action.ToString());
        yield return StartCoroutine(action.ToString());
    }
   
    IEnumerator ShowDialog()
    {
        showDialog = true;
        do
        {
            yield return null;
        } while(action == DialogActions.ShowDialog);
       
        showDialog = false;
    }
   
    IEnumerator ActionA()
    {
        Debug.Log ("Action A");
        yield return new WaitForSeconds(1f);
    }
 
    IEnumerator ActionB()
    {
        Debug.Log ("Action B");
        yield return new WaitForSeconds(2f);
    }
   
    void OnGUI()
    {
        if(showDialog)
        {
            if(GUI.Button(new Rect(10f, 10f, 100f, 20f), "A"))
            {
                action = DialogActions.ActionA;        
            } else if(GUI.Button(new Rect(10f, 50f, 100f, 20f), "B")) {
                action = DialogActions.ActionB;
            }
        }
    }
 
}

이러한 특징을 잘 활용하면 AI를 위한 유한상태기계(Finite State Machine)를 구현할 때에도 별도의 클래스를 만들지 않고 쉽게 코딩이 가능해집니다.

결론

코루틴의 기본적인 동작원리에서 부터 활용법까지 살펴봤는데, 여기서 언급한 이외에도 다른 유용한 활용 예제가 있을 것으로 생각됩니다. 궁금한 점이나 더 좋은 활용 방법에 대해서 댓글 달아주시면 감사하겠습니다. 

---

출처 - http://www.unitystudy.net/bbs/board.php?bo_table=writings&wr_id=43