[Android] Compose에서 BindService 사용하기

https://developer.android.com/develop/background-work/services/bound-services

바인딩된 서비스 개요  |  Background work  |  Android Developers

가끔씩 앱이 실행중이지 않을 때 앱이 백그라운드에서 무언가 작업이 실행되어야 하는 경우가 있습니다.
예를 들면 만보기, 파일 업로드/다운로드, 음악 플레이어 등과 같은 것들이 있습니다.
이런 것들은 보통 서비스를 활용해서 구현하게 됩니다.

음악 플레이어와 같은 경우, 앱이 실행되어 있을 때 음악을 멈추거나 앞뒤로 음악을 바꾸는 등의 기능이 필요합니다.
따라서 액티비티와 같은 UI와 실제 음악 실행을 처리하는 서비스의 통신이 필요합니다.
이 때 사용할 수 있는 컴포넌트가 BindService 입니다.

Compose의 도입 전에는 Activity/Fragment에서 서비스를 실행하고 바인딩해왔지만, Compose 이후로 Single Activity Application 아키텍처를 도입하거나, 또는 Compose에서 처리 하는 것을 원할때가 있습니다.
오늘은 Compose 함수에서 BindService를 다루는 방법을 포스팅합니다.

 

BindService 구현

먼저 임의의 BindService를 구현해봅시다.
BindService를 구현할 때에는, Service와 Binder를 상속하는 나만의 Binder 클래스가 필요합니다.

class MyBindService : Service() {
    private val myBinder: MyBinder by lazy {
        MyBinder()
    }
    
    override fun onBind(intent: Intent): IBinder {
        super.onBind(intent)
        return binder
    }
    
    fun call() {
        // 이 Binder에서 이 함수를 불러서 외부와 상호작용 할 수 있습니다.
    }

    inner class MyBinder : Binder() {
        fun callServiceFunction() {
            call()
        }
    }   
}

Binder 클래스를 상속하는 MyBinder를 구현한 뒤에, onBind 함수에서 인스턴스를 반환하도록 만들어주면 됩니다.

 

Compose에서 사용할 함수 구현

BindService를 실행하기 위해선 Context와 ServiceConnection, Intent 세 가지가 필요합니다.
이것들을 활용하여 BindService를 Composable 함수에서 실행할 수 있도록 구현해봅시다.

class BindServiceWrapper<out T : Binder>(
    private val context: Context,
    private val intentCreator: () -> Intent
) {
    private var _bound: T? by mutableStateOf(null)

    val bound: T?
        get() = _bound

    private val conn = object : ServiceConnection {
        override fun onServiceDisconnected(name: ComponentName?) {
            _bound = null
        }

        @Suppress("UNCHECKED_CAST")
        override fun onServiceConnected(name: ComponentName?, service: IBinder?) {
            _bound = service as? T
        }
    }

    fun bind() {
        context.bindService(intentCreator.invoke(), conn, Context.BIND_AUTO_CREATE)
    }

    fun unbind() {
        context.unbindService(conn)
    }
}

먼저, BindService를 실질적으로 실행하고 중단하며, Binder 객체를 관리하는 class를 하나 만듭니다.
BindService를 실행한 후에 연결에 성공하면 ServiceConnection의 콜백을 통해 알림을 받게 됩니다.

바인딩된 Binder 객체를 Compose의 상태로 관리하는 이유는, Composable 함수에서 리컴포지션 상황에서도 객체를 유지할 수 있게 하기 위함입니다.

@Composable
fun <T : Binder> rememberBindService(
    createIntent: (Context) -> Intent,
    dispose: (T?) -> Unit,
): BindServiceWrapper<T> {
    val context = LocalContext.current
    val wrapper = remember(context) {
        BindServiceWrapper<T>(context) {
            createIntent(context)
        }
    }

    DisposableEffect(context) {
    
        onDispose {
            dispose.invoke(wrapper.bound)
            wrapper.unbind()
        }
    }

    return wrapper
}

앞서 만든 BindServiceWrapper를 활용하는 Composable 함수를 만듭니다.
BindService를 실행하기 위해 Intent를 생성하는 람다와 Composable 함수가 dispose 되었을 때의 처리를 위한 람다를 받습니다.

Composable 함수가 dispose되면 더이상 Binder 객체와 상호작용할 UI가 없으므로, 불필요한 메모리의 낭비(또는 누수)를 방지하기 위해 DisposableEffect를 활용하여 리소스를 제거해줍시다.

자신의 프로젝트 스펙에 맞게 적절히 수정하여 사용하면 되겠습니다.

 

사용 예시

@Composable
fun MyScreen() {
    val context = LocalContext.current
    
    val bindService = rememberBindService<MyService.MyBinder>(
        createIntent = {
            Intent(context, MyService::class.java)
        },
        dispose = {
            // do something
        }
    )
    
    Column {
        Button {
            bindService.bind()
        }
        
        Button {
            bindService.bound?.callServiceFunction()
        }
    }
}

Composable 함수 내에서 rememberBindService<T> 함수를 사용해서 생성한 뒤, 필요한 시점에 따라 BindService를 실행하거나 함수를 호출하면 됩니다.