[Android/Kotlin] 인앱 업데이트 In-App Update (AppUpdateManager)

 

 

 

인앱 업데이트는 어플 내에서 사용자에게 앱을 업데이트하라고 메시지를 표시하는 Google Play Core 라이브러리 기능입니다.

이는 Developers의 문장이고, 조금 더 쉽게 말하자면 어플 내에서 업데이트 가능 여부를 체크하고, 바로 업데이트를 진행할 수 있는 기능이라고 할 수 있습니다.

 

 

 

인앱 업데이트에는 두 가지 흐름으로 진행됩니다.

 

유연한 업데이트 (Flexible Update)

즉시 업데이트 (Immediate Update)

 

 

Flexible Update는 백그라운드 다운로드로 진행되어 업데이트가 설치되는 동안 사용자가 앱을 사용할 수 있는 업데이트 방식입니다.

Immediate Update는 포그라운드에서 다운로드가 진행되기 때문에, 업데이트를 실행하면 사용자는 업데이트의 설치와 재실행되기까지의 과정을 기다린 후에 앱을 사용할 수 있습니다.

 

 

 

인앱 업데이트는 업데이트 여부를 묻는 팝업창과 설치 progress 화면 모두 Google Play Core에서 보여주는 화면이 띄워집니다.

 

 

https://developer.android.com/guide/playcore/in-app-updates/kotlin-java?hl=ko#kts 

인앱 업데이트 지원(Kotlin 또는 자바)  |  Android 개발자  |  Android Developers

 

1. 개발 환경 설정

// In your app’s build.gradle.kts file:

dependencies {
    implementation("com.google.android.play:app-update:2.0.0")
    implementation("com.google.android.play:app-update-ktx:2.0.0")
}

 

2. 업데이트 사용 가능 여부 확인

val appUpdateManager = AppUpdateManagerFactory.create(context)

val appUpdateInfo = appUpdateManager.appUpdateInfo

appUpdateInfo.addOnSuccessListener { _appUpdateInfo ->
    if (_appUpdateInfo.updateAvailability() == UpdateAvailability.UPDATE_AVAILABLE
        && _appUpdateInfo.isUpdateTypeAllowed(AppUpdateType.IMMEDIATE)
    ) {
        // TODO 업데이트가 가능할 때
    }
}

위 코드는 현재 설치되어 있는 앱이 플레이스토어에 올라간 앱과 비교해서 업데이트가 필요한지 여부를 확인할 수 있는 코드입니다.

아래 조건문안에 appUpdateInfo.isUpdateTypeAllowed(AppUpdateType.IMMEDIATE)에는 IMMEDIATE대신 FLEXIBLE을 넣어줄 수 있습니다.

업데이트가 가능할 때 코드로는 바로 업데이트를 실행해주거나, 업데이트가 가능하다는 UI를 변경시켜주는 코드를 넣어주면 될 것 같습니다.

 

 

 

3. 업데이트 시작

appUpdateManager.startUpdateFlowForResult(
    appUpdateInfo,
    AppUpdateType.IMMEDIATE, // AppUpdateType.FLEXIBLE
    this, //activity
    MY_REQUEST_CODE // 해당 업데이트 요청을 모니터할 수 있는 상수 request code
    )

제일 중요한 게 각 AppUpdateInfo 값으로는 업데이트를 한 번만 시작할 수 있습니다.

AppUpdateManager와 AppUpdateInfo값을 전역적으로 저장해 두고 사용하면 편하지 않을까 했는데

AppUpdateInfo 값이 요청해서 받을 때마다 달라지기 때문에

업데이트를 실패한 경우 업데이트를 다시 시도하려면 새 AppUpdateInfo를 요청해서 업데이트 요청을 다시 보내야 합니다.

 

 

4. 업데이트 상태에 관한 콜백 가져오기

override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
    if (requestCode == MY_REQUEST_CODE) {
        if (resultCode != RESULT_OK) {
            /*
            RESULT_CANCELED
            업데이트를 거부했거나 취소했을 때 
            
            ActivityResult.RESULT_IN_APP_UPDATE_FAILED 
            기타 오류로 인해 사용자가 동의하지 못했거나 업데이트가 진행되지 못했을 때 
            */
        }
    }
}

업데이트가 취소되었을 때는 토스트 메시지를 띄워주거나 AppUpdateInfo 값을 새로 받아오도록 할 수 있습니다.

업데이트가 성공했을 때의 처리는 별도로 작성되니 거부했거나 취소했을 때, 혹은 기타 오류로 진행되지 않을 때의 처리만 작성해주면 됩니다.

 

 

5-1. Flexible Update 처리

// 설치 상태 모니터링 리스너
val listener = InstallStateUpdatedListener { state ->
    if (state.installStatus() == InstallStatus.DOWNLOADED) {
      // TODO 업데이트가 다운로드 완료되었을 때 처리
      popupSnackbarForCompleteUpdate()
    } else if (state.installStatus() == InstallStatus.INSTALLED) {
      // TODO 업데이트가 설치 완료되었을 때 처리
    }
}

// Displays the snackbar notification and call to action.
fun popupSnackbarForCompleteUpdate() {
    Snackbar.make(
        findViewById(R.id.activity_main_layout),
        "An update has just been downloaded.",
        Snackbar.LENGTH_INDEFINITE
    ).apply {
        setAction("RESTART") { appUpdateManager.completeUpdate() }
        setActionTextColor(resources.getColor(R.color.snackbar_action_text_color))
        show()
    }
}

// 업데이트를 시작하기 전에 appUpdateManager에 Listener 등록
appUpdateManager.registerListener(listener)

// 업데이트 시작

// 상태 업데이트가 더이상 불필요할 때 appUpdateManager에 listener 등록 해제
appUpdateManager.unregisterListener(listener)

업데이트가 완료되었을 때의 처리입니다.

위 코드는 스낵바를 보여주는 코드로 되어있지만, 다이얼로그를 띄워줄 수도 있고 자유롭게 바꿔줄 수 있는데,

appUpdateManager.completeUpdate()만 실행시켜주면 됩니다.

 

개인적으로 테스트 해보았을 때는 아래 코드가 정상동작 하지 않았습니다...

if (state.installStatus() == InstallStatus.DOWNLOADED) {
      // TODO 업데이트가 다운로드 완료되었을 때 처리
      appUpdateManager.completeUpdate()
}

이유를 아시는 분은 댓글 좀

딜레이 이슈인지 화면 그리는 부분의 이슈인지 잘 모르겠지만

다이얼로그나 스낵바같이 중간 단계를 한번 거치면 정상 동작하는 걸 확인할 수 있습니다.

 

 

5-2. Immediate Update 처리

override fun onResume() {
    super.onResume()

    appUpdateManager
        .appUpdateInfo
        .addOnSuccessListener { appUpdateInfo ->
            if (appUpdateInfo.updateAvailability()
                == UpdateAvailability.DEVELOPER_TRIGGERED_UPDATE_IN_PROGRESS
            ) {
                appUpdateManager.startUpdateFlowForResult(
                    appUpdateInfo,
                    IMMEDIATE,
                    this,
                    MY_REQUEST_CODE
                )
            }
        }
}

 

 

6. 업데이트 테스트

 

인앱 업데이트 코드 작성 후 테스트를 해보기 위해서는 세 가지 방법이 있습니다.

1) 플레이 콘솔 - 내부 테스트

2) FakeAppUpdate

3) 플레이스토어에 출시된 앱보다 버전이 낮은 릴리즈 apk를 추출

 

 

 

전체 코드

 

업데이트 가능 여부 파악과 동시에 즉시 업데이트를 실행하고자 한다면, 앱이 실행되고 바로 첫 화면에 노출되는 게 좋습니다.

그렇지만 SplashScreen이나  IntroActivity같이 짧게 넘어가는 화면에는 부적합합니다.

Splash가 띄워지고 업데이트 팝업이 띄워졌는데 MainActivity로 넘어가면서 업데이트 팝업이 사라질 수 있기 때문에

일반적인 MainActivity와 같이 짧게 넘어가는 화면 그 이후에 가장 첫 화면에서 노출되는 게 좋습니다.

 

//MainActivity.kt

class MainActivity : AppCompatActivity() {
	
    	private lateinit var appUpdateManager: AppUpdateManager
        private val REQUEST_CODE = 42
        
        override fun onCreate(savedInstanceState: Bundle?) {
        	super.onCreate(savedInstanceState)
            setContentView(R.layout.activity_main)
            
            checkForUpdates()
        }
        
        override fun onResume() {
        	super.onResume()
            appUpdateManager.appUpdateInfo.addOnSuccessListener { _appUpdateInfo ->
            	if (appUpdateInfo.updateAvailability() == UpdateAvailability.DEVELOPER_TRIGGERED_UPDATE_IN_PROGRESS) {
                		appUpdateManager.startUpdateFlowForResult(
                        	appUpdateInfo,
                            AppUpdateType.IMMEDIATE,
                            this@MainActivity,
                            REQUEST_CODE
                        )
                 }
        }
        
        
        private val stateUpdatedListener: InstallStateUpdatedListener =
        	InstallStateUpdatedListener { state ->	
            	state?.let {
                	if (it.installStatus == InstallStatus.DOWNLOADED) {
                    	Snackbar.make(
                        	findViewById(R.id.container),
                            "업데이트가 완료되었습니다.",
                            Snackbar.LENGTH_INDEFINITE
                            ).apply {
                            setAction("재실행하기") { appUpdateManager.completeUpdate() }
                            show()
                            }
                    }
                }
           }
       }
       
       private fun checkForUpdates() {
       		appUpdateManager = AppUpdateManagerFactory.create(applicationContext)
            appUpdateManager.appUpdateInfo.addOnSuccessListener { _appUpdateIntent ->
            	if (_appUpdateIntent.updateAvailability() == UpdateAvailability.UPDATE_AVAILABLE
                	&& appUpdateIntent.isUpdateTypeAllowed(IMMEDIATE)) {
                	appUpdateManager.registerListener(stateUpdatedListener)
                	appUpdateManager.startUpdateFlowForResult(
                    	_appUpdateIntent,
                    	IMMEDIATE,
                    	this,
                    	REQUEST_CODE
                	)
            	}
        	}
        }
        
        override fun onDestroy() {
        	super.onDestroy() 
            appUpdateManager.unregisterListener(stateUpdatedListener)
        }
 }

 

 

업데이트 가능 여부 파악은 앱이 실행되고 바로하되, 업데이트 팝업은 다른 화면에서 노출하고 싶다면 

AppUpdateManager와 AppUpdateInfo를 MainActivity에 저장해두고

다른 화면에서 업데이트 실행 코드를 넣어주면 됩니다.

AppUpdateManager를 MainActivity에 넣어주는 이유는 꼭 MainActivity에서 해야한다는 게 아니고

업데이트가 완료되고 앱이 재실행되어야 할 때 

업데이트가 완료되었다는 걸 가장 Base가 되는 화면에서 알고 있어야 다른 화면에 있다가도 알 수 있기 때문입니다.

 

 

 

---

그 이외의 잘못된 부분이 있으면 꼭 꼭 꼭 댓글로 알려주시길 바랍니다.

감사합니다.