Tweet
Tweet

Slide 1

Slide 1 text

Dynamic Feature Module in Practice DroidKaigi 2020 2020/02/21 - 実践 Dynamic Feature Module -

Slide 2

Slide 2 text

About me •Kenji Abe •Cookpad Inc. •Google Developers Expert for Android •Twitter: @STAR_ZERO

Slide 3

Slide 3 text

Talk about •What's Dynamic Feature Module •How to create Dynamic Feature Module •How to test Dynamic Feature Module •etc...

Slide 4

Slide 4 text

What's Dynamic Feature Module

Slide 5

Slide 5 text

Dynamic Feature Module •Dynamic delivery of modules using App Bundle •Modules can be installed and removed later •Can reduce app size

Slide 6

Slide 6 text

Delivery option •On-demand delivery ‣ Modules are not included at install time ‣ Install modules later as needed •At-install delivery ‣ Modules are included at install time ‣ Can be removed later

Slide 7

Slide 7 text

Delivery option •Conditional delivery ‣ Install modules only on devices that match the conditions ‣ Device features, User country, API Level •Google Play Instant ‣ "Try Now" button on the Google Play Store ‣ I will not talk about it this time

Slide 8

Slide 8 text

Use cases •Installing features that are not used by the majority of users as needed ‣ Posting feature in the app that most user only browse ‣ Help and support features •Remove no longer needed feature ‣ Register user account ‣ Onboarding flow •etc...

Slide 9

Slide 9 text

Create Dynamic Feature Module

Slide 10

Slide 10 text

File → New → New Module...

Slide 11

Slide 11 text

No content

Slide 12

Slide 12 text

No content

Slide 13

Slide 13 text

No content

Slide 14

Slide 14 text

No content

Slide 15

Slide 15 text

No content

Slide 16

Slide 16 text

No content

Slide 17

Slide 17 text

Dynamic Feature Module

Slide 18

Slide 18 text

apply plugin: 'com.android.dynamic-feature' android { compileSdkVersion 29 defaultConfig { minSdkVersion 21 targetSdkVersion 29 } } dependencies { implementation project(':app') }

Slide 19

Slide 19 text

apply plugin: 'com.android.application' android { // ... dynamicFeatures = [":feature"] }

Slide 20

Slide 20 text

Slide 21

Slide 21 text

On demand delivery

Slide 22

Slide 22 text

Include at install time

Slide 23

Slide 23 text

Modules dependencies

Slide 24

Slide 24 text

app feature_one feature_two Library module implementation project(':feature_one') implementation project(':feature_two')

Slide 25

Slide 25 text

app feature_one feature_two Using Dynamic Feature Module dynamicFeatures = [":feature_one", ":feature_two"] implementation project(':app') implementation project(':app')

Slide 26

Slide 26 text

Install / Remove

Slide 27

Slide 27 text

// app/build.gradle dependencies { api "com.google.android.play:core:1.6.4" }

Slide 28

Slide 28 text

Slide 29

Slide 29 text

// Application class class App : SplitCompatApplication() { // ... } OR

Slide 30

Slide 30 text

// in dynamic feature module class FeatureActivity : AppCompatActivity() { override fun attachBaseContext(base: Context) { super.attachBaseContext(base) SplitCompat.installActivity(this) } // ... }

Slide 31

Slide 31 text

// in app module class MainActivity : AppCompatActivity() { override fun attachBaseContext(base: Context) { super.attachBaseContext(base) SplitCompat.installActivity(this) } // ... }

Slide 32

Slide 32 text

val manager = SplitInstallManagerFactory.create(context) if (manager.installedModules.contains("feature")) { // Already Installed } val request = SplitInstallRequest.newBuilder() .addModule("feature") .build() manager.startInstall(request) .addOnSuccessListener { /* Success install request */ } .addOnFailureListener { /* Failure install request */ }

Slide 33

Slide 33 text

val manager = SplitInstallManagerFactory.create(context) if (manager.installedModules.contains("feature")) { // Already Installed } val request = SplitInstallRequest.newBuilder() .addModule("feature") .build() manager.startInstall(request) .addOnSuccessListener { /* Success install request */ } .addOnFailureListener { /* Failure install request */ } SplitInstallManager

Slide 34

Slide 34 text

val manager = SplitInstallManagerFactory.create(context) if (manager.installedModules.contains("feature")) { // Already Installed } val request = SplitInstallRequest.newBuilder() .addModule("feature") .build() manager.startInstall(request) .addOnSuccessListener { /* Success install request */ } .addOnFailureListener { /* Failure install request */ } Check if module is already Installed

Slide 35

Slide 35 text

val manager = SplitInstallManagerFactory.create(context) if (manager.installedModules.contains("feature")) { // Already Installed } val request = SplitInstallRequest.newBuilder() .addModule("feature") .build() manager.startInstall(request) .addOnSuccessListener { /* Success install request */ } .addOnFailureListener { /* Failure install request */ } Specify module name to install

Slide 36

Slide 36 text

val manager = SplitInstallManagerFactory.create(context) if (manager.installedModules.contains("feature")) { // Already Installed } val request = SplitInstallRequest.newBuilder() .addModule("feature") .build() manager.startInstall(request) .addOnSuccessListener { /* Success start install */ } .addOnFailureListener { /* Failure start install */ } Start to install

Slide 37

Slide 37 text

private val listener = SplitInstallStateUpdatedListener { state -> when (state.status()) { SplitInstallSessionStatus.INSTALLED -> // ... // ... } } override fun onStart() { super.onStart() manager.registerListener(listener) } override fun onStop() { super.onStop() manager.unregisterListener(listener) }

Slide 38

Slide 38 text

private val listener = SplitInstallStateUpdatedListener { state -> when (state.status()) { SplitInstallSessionStatus.INSTALLED -> // ... // ... } } override fun onStart() { super.onStart() manager.registerListener(listener) } override fun onStop() { super.onStop() manager.unregisterListener(listener) } Observe installation state (SplitInstallSessionState#status)

Slide 39

Slide 39 text

private val listener = SplitInstallStateUpdatedListener { state -> when (state.status()) { SplitInstallSessionStatus.INSTALLED -> // ... // ... } } override fun onStart() { super.onStart() manager.registerListener(listener) } override fun onStop() { super.onStop() manager.unregisterListener(listener) }

Slide 40

Slide 40 text

private val listener = SplitInstallStateUpdatedListener { state -> when (state.status()) { SplitInstallSessionStatus.INSTALLED -> // ... // ... } } override fun onStart() { super.onStart() manager.registerListener(listener) } override fun onStop() { super.onStop() manager.unregisterListener(listener) }

Slide 41

Slide 41 text

•PENDING •REQUIRES_USER_CONFIRMATION •DOWNLOADING •DOWNLOADED •INSTALLING •INSTALLED •FAILED •CANCELING •CANCELED

Slide 42

Slide 42 text

•PENDING •REQUIRES_USER_CONFIRMATION •DOWNLOADING •DOWNLOADED •INSTALLING •INSTALLED •FAILED •CANCELING •CANCELED SplitInstallStateUpdatedListener { state -> when (state.status()) { SplitInstallSessionStatus.DOWNLOADING -> { val total = state.totalBytesToDownload() val downloaded = state.bytesDownloaded() // Show progress } } }

Slide 43

Slide 43 text

•PENDING •REQUIRES_USER_CONFIRMATION •DOWNLOADING •DOWNLOADED •INSTALLING •INSTALLED •FAILED •CANCELING •CANCELED Requires user's confirmation if module size exceeds 10MB

Slide 44

Slide 44 text

•PENDING •REQUIRES_USER_CONFIRMATION •DOWNLOADING •DOWNLOADED •INSTALLING •INSTALLED •FAILED •CANCELING •CANCELED SplitInstallStateUpdatedListener { state -> when (state.status()) { SplitInstallSessionStatus.REQUIRES_USER_CONFIRMATION -> { manager.startConfirmationDialogForResult( state, activity, REQUEST_CODE ) } } }

Slide 45

Slide 45 text

•PENDING •REQUIRES_USER_CONFIRMATION •DOWNLOADING •DOWNLOADED •INSTALLING •INSTALLED •FAILED •CANCELING •CANCELED

Slide 46

Slide 46 text

Module title

Slide 47

Slide 47 text

No content

Slide 48

Slide 48 text

Slide 49

Slide 49 text

•PENDING •REQUIRES_USER_CONFIRMATION •DOWNLOADING •DOWNLOADED •INSTALLING •INSTALLED •FAILED •CANCELING •CANCELED

Slide 50

Slide 50 text

•PENDING •REQUIRES_USER_CONFIRMATION •DOWNLOADING •DOWNLOADED •INSTALLING •INSTALLED •FAILED •CANCELING •CANCELED Module Installation completed Can use module resources

Slide 51

Slide 51 text

manager.deferredInstall(listOf("feature")) Deferred install

Slide 52

Slide 52 text

manager.deferredUninstall(listOf("feature")) Remove

Slide 53

Slide 53 text

play:core-ktx

Slide 54

Slide 54 text

lifecycleScope.launch { try { manager.requestInstall(listOf("feature")) } catch (e: SplitInstallException) { // ... } } Request for installation using Coroutines

Slide 55

Slide 55 text

private val listener = SplitInstallStateUpdatedListener( onRequiresConfirmation = { state -> // ... }, onInstalled = { state -> // ... } ) Observe installation state

Slide 56

Slide 56 text

lifecycleScope.launch { manager.requestProgressFlow().collect { state -> when (state.status()) { SplitInstallSessionStatus.INSTALLED -> { Timber.d("SplitInstallSessionStatus.INSTALLED") } // ... } } } Observe installation state using Flow

Slide 57

Slide 57 text

Conditional delivery

Slide 58

Slide 58 text

Conditional delivery •Install modules only on devices that match the conditions ‣ Hardware and software features ‣ User country ‣ API Level •Can be installed later even if conditions do not match

Slide 59

Slide 59 text

No content

Slide 60

Slide 60 text

Slide 61

Slide 61 text

Require NFC feature

Slide 62

Slide 62 text

Slide 63

Slide 63 text

Exclude Japan

Slide 64

Slide 64 text

API Level 24 or more

Slide 65

Slide 65 text

Test / Debug

Slide 66

Slide 66 text

Test / Debug •Google Play internal test •Internal App Sharing •FakeSplitInstallManager

Slide 67

Slide 67 text

Google Play internal test •Release build aab file is required ‣ Needs release signing and correct VersionCode •It takes time and effort •Can not debug

Slide 68

Slide 68 text

Internal App Sharing •Can upload debug build aab ‣ Debug signing, any VersionCode •Debugger can be attached •Easy and quick

Slide 69

Slide 69 text

No content

Slide 70

Slide 70 text

Drag and drop .aab file

Slide 71

Slide 71 text

Download URL

Slide 72

Slide 72 text

No content

Slide 73

Slide 73 text

No content

Slide 74

Slide 74 text

No content

Slide 75

Slide 75 text

List of installed modules

Slide 76

Slide 76 text

deferredInstall deferredUninstall Run immediately

Slide 77

Slide 77 text

Internal App Sharing •Triple-T/gradle-play-publisher ‣ https://github.com/Triple-T/gradle-play-publisher ‣ Upload and launch to Play Store by gradle command

Slide 78

Slide 78 text

FakeSplitInstallManager •Offline testing of module installation •Use FakeSplitInstallManager instead of SplitInstallManager •https://link.medium.com/J0eOwvXds4

Slide 79

Slide 79 text

Navigation Component Dynamic Feature Module

Slide 80

Slide 80 text

Navigation Component DFM •Implement screen transitions effortlessly ‣ It also installs the module •Customizable •Still alpha version only •http://goo.gle/dynamic-feature-nav

Slide 81

Slide 81 text

dependencies { implementation "androidx.navigation:navigation-dynamic-features-fragment:2.3.0-alpha01" }

Slide 82

Slide 82 text

Slide 83

Slide 83 text

Slide 84

Slide 84 text

Slide 85

Slide 85 text

Slide 86

Slide 86 text

findNavController().navigate(R.id.action_on_demand)

Slide 87

Slide 87 text

No content

Slide 88

Slide 88 text

Customize installation screen

Slide 89

Slide 89 text

class DynamicProgressFragment : AbstractProgressFragment() { override fun onCancelled() { } override fun onFailed(errorCode: Int) { } override fun onProgress(status: Int, bytesDownloaded: Long, bytesTotal: Long) { } }

Slide 90

Slide 90 text

findNavController().apply { val fragmentNavigator = navigatorProvider[DynamicFragmentNavigator::class] val graphNavigator = navigatorProvider[DynamicGraphNavigator::class] graphNavigator.installDefaultProgressDestination { fragmentNavigator.createDestination().apply { className = DynamicProgressFragment::class.java.name id = R.id.dfn_progress_fragment } } navigate(R.id.action_on_demand) }

Slide 91

Slide 91 text

Customize installation flow

Slide 92

Slide 92 text

val installMonitor = DynamicInstallMonitor() findNavController().navigate( R.id.action_on_demand, null, null, DynamicExtras.Builder().setInstallMonitor(installMonitor).build() )

Slide 93

Slide 93 text

val installMonitor = DynamicInstallMonitor() findNavController().navigate( R.id.action_on_demand, null, null, DynamicExtras.Builder().setInstallMonitor(installMonitor).build() )

Slide 94

Slide 94 text

if (installMonitor.isInstallRequired) { installMonitor.status.observe( lifecycleOwner, object: Observer { override fun onChanged(sessionState: SplitInstallSessionState) { when (sessionState.status()) { SplitInstallSessionStatus.INSTALLED -> { findNavController().navigate(R.id.action_on_demand) } // ... } if (sessionState.hasTerminalStatus()) { installMonitor.status.removeObserver(this) } } } ) }

Slide 95

Slide 95 text

if (installMonitor.isInstallRequired) { installMonitor.status.observe( lifecycleOwner, object: Observer { override fun onChanged(sessionState: SplitInstallSessionState) { when (sessionState.status()) { SplitInstallSessionStatus.INSTALLED -> { findNavController().navigate(R.id.action_on_demand) } // ... } if (sessionState.hasTerminalStatus()) { installMonitor.status.removeObserver(this) } } } ) } ture if need to install module

Slide 96

Slide 96 text

if (installMonitor.isInstallRequired) { installMonitor.status.observe( lifecycleOwner, object: Observer { override fun onChanged(sessionState: SplitInstallSessionState) { when (sessionState.status()) { SplitInstallSessionStatus.INSTALLED -> { findNavController().navigate(R.id.action_on_demand) } // ... } if (sessionState.hasTerminalStatus()) { installMonitor.status.removeObserver(this) } } } ) } Observe installation state LiveData

Slide 97

Slide 97 text

if (installMonitor.isInstallRequired) { installMonitor.status.observe( lifecycleOwner, object: Observer { override fun onChanged(sessionState: SplitInstallSessionState) { when (sessionState.status()) { SplitInstallSessionStatus.INSTALLED -> { findNavController().navigate(R.id.action_on_demand) } // ... } if (sessionState.hasTerminalStatus()) { installMonitor.status.removeObserver(this) } } } ) } Navigate when installed

Slide 98

Slide 98 text

if (installMonitor.isInstallRequired) { installMonitor.status.observe( lifecycleOwner, object: Observer { override fun onChanged(sessionState: SplitInstallSessionState) { when (sessionState.status()) { SplitInstallSessionStatus.INSTALLED -> { findNavController().navigate(R.id.action_on_demand) } // ... } if (sessionState.hasTerminalStatus()) { installMonitor.status.removeObserver(this) } } } ) } Remove observer when installation completes

Slide 99

Slide 99 text

Development Tips

Slide 100

Slide 100 text

Screen navigation •app module cannot directly refer to classes in dynamic feature modules •Needs use reflection ‣ Be cautious when using Proguard / R8 •Navigation Component helps

Slide 101

Slide 101 text

Specify module name •Only the module name is needed •For example: features:sample ‣ Specify only "sample" val request = SplitInstallRequest.newBuilder() .addModule("sample").build()

Slide 102

Slide 102 text

R classes •R classes are not merged, so packages are different •Be careful of the packages when importing R classes

Slide 103

Slide 103 text

Base app com.example.app feature com.example.app.feature Dynamic com.example.app.feature.R com.example.app.R

Slide 104

Slide 104 text

import com.example.app.feature.R val dynamic = getString(R.string.dynamic_string) val base = getString(R.string.base_string)

Slide 105

Slide 105 text

import com.example.app.feature.R val dynamic = getString(R.string.dynamic_string) val base = getString(R.string.base_string) ❌ Unresolved reference

Slide 106

Slide 106 text

import com.example.app.feature.R val dynamic = getString(R.string.dynamic_string) val base = getString(R.string.base_string) import com.example.app.feature.R val dynamic = getString(R.string.dynamic_string) val base = getString(com.example.app.R.string.base_string) ⭕ OK

Slide 107

Slide 107 text

// in app module typealias appString = com.example.app.R.string // in feature module import com.example.app.feature.R import com.example.app.appString val dynamic = getString(R.string.dynamic_string) val base = getString(appString.base_string)

Slide 108

Slide 108 text

Conclusion

Slide 109

Slide 109 text

Conclusion •Dynamic Feature Module is not so hard •Useful tools for Testing/Debugging are available •Dynamic Navigation Component is so useful •There are still bugs that you may encounter

Slide 110

Slide 110 text

Let's try Dynamic Feature Module

Slide 111

Slide 111 text

Thank You!