Event Bus🚌의 버스 좀 받아볼까?

이번에 FCM이 오면 특정 페이지를 보고 있다면 그 페이지에서 refresh를 해야하는 일이 생겼다.

바로 구현하려고 하다보니 Listener를 달아야하나 하는 생각을 하면 뭔가 사이드 이펙트가 많이 생길 것 같고 귀찮은 작업이 되겠다 싶어서 구글링을 해보니 Event Bus 라는 라이브러리를 사용하라는 추천 글을 보게 됐다.

 

Event Bus가 뭐야? 🚌버스에서 🎉이벤트🎉 하나? (죄송합니다)

 

라는 생각에 관련 글을 찾아보니 버스 네트워크의 동작 방식과 유사하게 하나의 이벤트를 동일 채널에 연결된 모든 노드(Subscriber)들에게 보내는 방식 이라는데 간단하게 나의 용어로 설명하자면 A 채널을 구독하는 모든 사용자에게 알림(evnet)을 보낸다.

Github에 해당 이미지도 같이 있다. (사실 처음 봤을 땐 이해가 잘 안 됐다 😫)

 

 

Event Bus에서 여러가지 장점을 설명하고 있다.

번역하면

EventBus는

• 구성 요소 간의 통신을 단순화합니다.
  • 이벤트 송신자와 수신자를 분리합니다.
  • Activity, Fragment 및 Background thread에서 우수한 성능을 발휘합니다.
  • 복잡하고 오류가 발생하기 쉬운 종속성 및 수명 주기 문제를 방지합니다.
• 코드가 더욱 간단해집니다.
• 빠릅니다.
• 아주 작다( ~ 60k jar)
• 실제로 10억개 이상의 설치 프로그램을 통해 입증되었습니다.
• 배달 스레드, 가입자 우선 순위 등과 같은 고급 기능이 있습니다.

안드로이드의 경우 액티비티와 액티비티의 통신은 intent를 통해, fragment와 activity의 경우는 bundle이나 콜백을 이용해서 제작할 수 있습니다.

그러나 이는 결합도를 높이고 재사용성을 줄이지만 코드를 복잡하게 만드는 단점을 지니고 있습니다

물론 여러가지 디자인 패턴을 적용하고 라이브러리를 이용한다면 충분히 다양한 방법으로 해결할 수 있습니다. Event Bus 역시 그 중 하나입니다.

이러한 결합도를 낮추면서 각 UI끼리의 데이터 통신을 좀 더 원활하게 하고자 하는 것이 이벤트 버스의 개념입니다.

구현하기 쉽고 가볍지만 단점도 있다

• 하나의 이벤트를 모든 구독자들이 받기 때문에 메모리 사용이 증가할 수 있다
• 각 구독자들이 스스로 필터링해줘야함
• 데이터를 못 받을 때 보장 ❎

모든 방식에는 장단점이 존재하기 때문에 사용을 하기 전에는 충분히 적용할 프로젝트에 알맞은 라이브러리인지에 대한 확인은 필수지만, 여러가지 프로젝트에서 Event Bus 라이브러리의 장점 덕분에 차용하고 있습니다.

서론은 길었고 이제 적용하는 방법을 설명하겠습니다!

1. gradle에 적용

implementation 'org.greenrobot:eventbus:3.2.0'

2-1.

class MessageEvent { 
  /* 필요한 경우 추가 */ 
}

2-2. 구독자 준비: 구독 메서드를 선언하고 주석을 달고 선택적으로 스레드 모드를 지정합니다.

@Subscribe(threadMode = ThreadMode.MAIN)
fun onMessageEvent(MessageEvent event) {
    // 이벤트 발생시 코드 실행
}

2-3. 가입자를 등록하고 등록 취소합니다. 예를 들어 Android에서 Activity 및 Fragment는 일반적으로 수명 주기에 따라 등록되어야 합니다.

// this는 activity와 fragment를 의미
override fun onStart() {
   super.onStart()
   EventBus.getDefault().register(this)
}
​
override fun onStop() {
    super.onStop()
    EventBus.getDefault().unregister(this)
}
// onResume과 onPause에서 적용해도 되지만 공식 문서에서는 onStart()와 onStop()에서 사용하길 권장함.

1. 이벤트 게시

EventBus.getDefault().post(MessageEvent())

하면 끝이다. 정말 간단하지 않나요? 하하하하

하지만 Exception이 발생하는 경우가 있습니다.

Caused by: org.greenrobot.eventbus.EventBusException: Subscriber class MainFragment and its super classes have no public methods with the @Subscribe annotation

@Subscribe 주석이 없고 이벤트 버스만 등록하는 경우, 프래그먼트가 생성될 때, 이벤트가 없다는 익셉션을 발생 시킵니다.

이는 쓰지 않는 곳에서 Event Bus를 등록하고 해제하는 관리를 하지 말라는 의미로 발생시키는 것으로 보입니다.

No subscribers registered for event class org.greenrobot.eventbus.NoSubscriberEvent 

Exception 보다는 Event Bus가 왜 실행되지 않았는지에 대해 라이브러리에서 직접 정의해놓은 부분이라고 볼 수 있습니다.

이는 Event가 등록된 class에서 Event가 발생한 시점에 Event Bus가 등록되어 있지 않아서 찾을 수 없다고 알려주는 겁니다.

만약 Event가 발생하지 않고 이런 Log를 발견한다면 lifecycle이 제대로 되어 있는지, 혹은 아예 이벤트 자체를 걸어두지 않은게 아닌지 확인해야 합니다.

Event Bus는 쉽게 사용이 가능하고 간단한 작업인데 결합도가 높은 bundle과 intent를 사용하는 것보다 더 낫다고 생각이 들어서 사용하게 되었습니다.

나중에 까먹을 것 같기도 하고 사용하는 라이브러리가 어떻게 돌아가는지 장점, 단점을 알고 사용하면 좋을 것 같아 많이는 아니지만 서칭 후 정리를 해둡니다.