Share
Modularity & Dependency Injection at Scale
How do we break down a large JVM monolith without incurring runtime costs? How do we scale dependency injection in such an application running in a constrained environment like mobile? Does it play well with a modularized Android app? How do you visualize and navigate the graph as complexity grows?
In this session we will describe the mechanisms that we use at Twitter to facilitate modularization and decoupling utilizing dependency injection. We will also cover why Dagger is our tool of choice along with the shortcomings we encountered, and share some practical advice on how to address them. Finally, we’ll offer a sneak peek of the extensions that we built on top of Dagger to facilitate dependency injection that we plan to open source in 2020.
Saud Khan
Transcript
141 slides
-
@mrmans0n Nacho López Software Engineer Android Foundation Architecture @CesarDielo César
Puerta Technical Lead Twitter for Android @bidyut Saud Khan Software Engineer Android Performance -
Author: Ben Sandofsky Date: Mon Jun 21 23:24:55 2010 -0700
Initial import. -
Periscope @PeriscopeCo You might have heard some news: It involves
a blue bird. #YouCanGuessTheRest #WeJoinedTheFlockInJanuary 13 Mar 2015 629 761 -
Description: [Dagger/MissingBinding] com.twitter.ui.util.UiArchLayoutContentViewProvider cannot be provided without an @Inject constructor
or an @Provides-annotated method. Description: [Dagger/DuplicateBindings] com.twitter.ui.util.UiArchLayoutContentViewProvider is bound multiple times. -
val inflater = LayoutInflater.from(context) val renderer = Renderer(inflater) val database
= Database() val timeline = Timeline(database, renderer) class Renderer (database: Database, renderer: Renderer) class Timeline class Database() (inflater: LayoutInflater) -
class Renderer (database: Database, renderer: Renderer) class Timeline class Database
() (inflater: LayoutInflater) @Inject constructor @Inject constructor @Inject constructor -
Graph Architecture Scoped object graphs mapping to the app lifecycle
@Component @Subcomponent -
{ fun featureRetainedBuilder(): FeatureRetainedObjectGraph.Builder } @Subcomponent(modules = [UserModule::class]) @UserScope interface
UserObjectGraph @Component(modules = [ApplicationModule::class]) @ApplicationScope interface ApplicationObjectGraph { fun userObjectGraphBuilder(): UserObjectGraph.Builder } -
{ fun featureRetainedBuilder(): FeatureRetainedObjectGraph.Builder } @Subcomponent(modules = [UserModule::class]) @UserScope interface
UserObjectGraph @ApplicationScope interface ApplicationObjectGraph { fun userObjectGraphBuilder(): UserObjectGraph.Builder } @Subcomponent(modules = [FeatureRetainedModule::class]) @RetainedScope interface FeatureRetainedObjectGraph { fun featureViewGraphBuilder(): FeatureViewObjectGraph.Builder } -
{ fun featureRetainedBuilder(): FeatureRetainedObjectGraph.Builder } @UserScope interface UserObjectGraph @Subcomponent(modules =
[FeatureRetainedModule::class]) @RetainedScope interface FeatureRetainedObjectGraph { fun featureViewGraphBuilder(): FeatureViewObjectGraph.Builder } @Subcomponent(modules = [FeatureViewModule::class]) @ViewScope interface FeatureViewObjectGraph -
{ fun featureRetainedBuilder(): FeatureRetainedObjectGraph.Builder } @UserScope interface UserObjectGraph Components or
? Subcomponents @ApplicationScope @UserScope @RetainedScope @ViewScope -
Components for the root graph for the nested graphs Subcomponents
@ApplicationScope @UserScope @RetainedScope @ViewScope -
component = .application(this) .build() class MyApplication : Application { private
lateinit var component: ApplicationObjectGraph override fun onCreate() { } super.onCreate() } DaggerApplicationObjectGraph.builder() -
Dagger.getObjectGraphBuilder<ApplicationObjectGraph>() component = .application(this) .build() class MyApplication : Application {
private lateinit var component: ApplicationObjectGraph override fun onCreate() { } super.onCreate() } -
fun <B : Any> getObjectGraphBuilder(builderClass: Class<B>): B } } class
Dagger { companion object { inline fun <reified B : Any> getObjectGraphBuilder(): B = getObjectGraphBuilder(B::class.java) } { -
if (!builderClass.isAnnotationPresent(Component.Builder::class.java)) { throw IllegalArgumentException("Not a component builder class: $builderClass")
} val componentClass = builderClass.enclosingClass ?: throw IllegalStateException("Component builder is not enclosed in a component.") val generatedDaggerClassName = getDaggerComponentImplementationClassName(componentClass) val generatedObjectGraphClass = ReflectionUtils.loadClass<Any>(generatedDaggerClassName) ?: throw IllegalStateException("Generated Dagger class can't be found: $generatedDagge val builderMethod = ReflectionUtils.getMethod(generatedObjectGraphClass, "builder") ?: throw IllegalStateException("The Dagger component generated class does not contain return ReflectionUtils.invokeMethod<B>(builderMethod, null) ?: throw IllegalStateException("The builder() method returned null.") fun <B : Any> getObjectGraphBuilder(builderClass: Class<B>): B } } class Dagger { companion object { inline fun <reified B : Any> getObjectGraphBuilder(): B = getObjectGraphBuilder(B::class.java) } TL;DR Use reflection once to find and instantiate the graph’s Component.Builder { -
if (!builderClass.isAnnotationPresent(Component.Builder::class.java)) { throw IllegalArgumentException("Not a component builder class: $builderClass")
} val componentClass = builderClass.enclosingClass ?: throw IllegalStateException("Component builder is not enclosed in a component.") val generatedDaggerClassName = getDaggerComponentImplementationClassName(componentClass) val generatedObjectGraphClass = ReflectionUtils.loadClass<Any>(generatedDaggerClassName) ?: throw IllegalStateException("Generated Dagger class can't be found: $generatedDagge val builderMethod = ReflectionUtils.getMethod(generatedObjectGraphClass, "builder") ?: throw IllegalStateException("The Dagger component generated class does not contain return ReflectionUtils.invokeMethod<B>(builderMethod, null) ?: throw IllegalStateException("The builder() method returned null.") fun <B : Any> getObjectGraphBuilder(builderClass: Class<B>): B } } class Dagger { companion object { inline fun <reified B : Any> getObjectGraphBuilder(): B = getObjectGraphBuilder(B::class.java) } Don’t worry! We will share the code in GitHub! { -
if (!builderClass.isAnnotationPresent(Component.Builder::class.java)) { throw IllegalArgumentException("Not a component builder class: $builderClass")
} val componentClass = builderClass.enclosingClass ?: throw IllegalStateException("Component builder is not enclosed in a component.") val generatedDaggerClassName = getDaggerComponentImplementationClassName(componentClass) val generatedObjectGraphClass = ReflectionUtils.loadClass<Any>(generatedDaggerClassName) ?: throw IllegalStateException("Generated Dagger class can't be found: $generatedDagge val builderMethod = ReflectionUtils.getMethod(generatedObjectGraphClass, "builder") ?: throw IllegalStateException("The Dagger component generated class does not contain return ReflectionUtils.invokeMethod<B>(builderMethod, null) ?: throw IllegalStateException("The builder() method returned null.") fun <B : Any> getObjectGraphBuilder(builderClass: Class<B>): B } } class Dagger { companion object { inline fun <reified B : Any> getObjectGraphBuilder(): B = getObjectGraphBuilder(B::class.java) } Follow Us! github.com/twitter { -
Referencing generated code Use reflection once to grab the root
object graph builder. Dagger.getObjectGraphBuilder<ApplicationObjectGraph>() DaggerApplicationObjectGraph.builder() -
App wide graphs definitions belong in the top gradle module.
Ideal Location -
component = Dagger.getObjectGraphBuilder<ApplicationObjectGraph>() .application(this) .build() class MyApplication : Application {
private lateinit var component: ApplicationObjectGraph override fun onCreate() { } super.onCreate() } -
object ApplicationObjectGraphProvider { } fun <T> getSubgraph(clazz: Class<T>): T var
graphProvider: Any? { return clazz.cast(graphProvider) } -
fun imageUploader(): ImageUploader interface MediaAppSubgraph { } companion object {
fun get(): MediaAppSubgraph { return ApplicationObjectGraphProvider.graphProvider .getSubgraph(MediaAppSubgraph::class.java) } -
val uploader = MediaAppSubgraph.get().imageUploader() fun imageUploader(): ImageUploader interface MediaAppSubgraph {
} companion object { fun get(): MediaAppSubgraph { return ApplicationObjectGraphProvider.graphProvider .getSubgraph(MediaAppSubgraph::class.java) } -
Grabbing objects from Dagger w/o visibility Wrap your Application and
User graphs in providers that can be statically obtained, and add a way to extract subgraphs from them. ApplicationObjectGraphProvider UserObjectGraphProvider MediaAppSubgraph L LegacyActivity -
fun okHttpClient(): OkHttpClient fun twitterApiService(): TwitterApiService @Component @ApplicationScope interface ApplicationObjectGraph
fun composerLauncher(): ComposerLauncher fun composerNotificationHandler(): ComposerNotifHandler fun tweetsRepository(): TweetsRepository fun tweetsDataSource(): TweetsDataSource fun imageLoader(): ImageLoader { fun loginController(): LoginController fun loginAssistController(): LoginAssistController fun appEventTracker(): AppEventTracker fun installationReferrer(): InstallationReferrer fun jobManager(): JobManager fun playServicesUtil(): PlayServicesUtil fun httpRequestController(): HttpRequestController fun registrableHeadsetPlugReceiver(): RegistrableHeadsetPlugReceiver , TweetRepositoryAppModule::cl (modules = [ComposerAppModule::class -
fun okHttpClient(): OkHttpClient fun twitterApiService(): TwitterApiService @Component @ApplicationScope interface ApplicationObjectGraph
fun composerLauncher(): ComposerLauncher fun composerNotificationHandler(): ComposerNotifHandler fun tweetsRepository(): TweetsRepository fun tweetsDataSource(): TweetsDataSource fun imageLoader(): ImageLoader { fun loginController(): LoginController fun loginAssistController(): LoginAssistController fun appEventTracker(): AppEventTracker fun installationReferrer(): InstallationReferrer fun jobManager(): JobManager fun playServicesUtil(): PlayServicesUtil fun httpRequestController(): HttpRequestController fun registrableHeadsetPlugReceiver(): RegistrableHeadsetPlugReceiver , TweetRepositoryAppModule::cl (modules = [ComposerAppModule::class -
@Component @ApplicationScope interface ApplicationObjectGraph { } fun okHttpClient(): OkHttpClient fun
twitterApiService(): TwitterApiService fun composerLauncher(): ComposerLauncher fun composerNotificationHandler(): ComposerNotifHandler fun tweetsRepository(): TweetsRepository fun tweetsDataSource(): TweetsDataSource fun imageLoader(): ImageLoader :app:twitter -
: @Component @ApplicationScope interface ApplicationObjectGraph { } fun okHttpClient(): OkHttpClient
fun twitterApiService(): TwitterApiService fun composerLauncher(): ComposerLauncher fun composerNotificationHandler(): ComposerNotifHandler fun tweetsRepository(): TweetsRepository fun tweetsDataSource(): TweetsDataSource fun imageLoader(): ImageLoader ComposerAppSubgraph interface ComposerAppSubgraph { } :app:twitter :features:composer -
@Component @ApplicationScope interface ApplicationObjectGraph , : { } fun okHttpClient():
OkHttpClient fun twitterApiService(): TwitterApiService fun tweetsRepository(): TweetsRepository fun tweetsDataSource(): TweetsDataSource fun imageLoader(): ImageLoader ComposerAppSubgraph interface TweetRepositoryAppSubgraph { } TweetRepositoryAppSubgraph :app:twitter :subsystems:tweets -
@Component @ApplicationScope interface ApplicationObjectGraph , : { } fun okHttpClient():
OkHttpClient fun twitterApiService(): TwitterApiService fun imageLoader(): ImageLoader ComposerAppSubgraph TweetRepositoryAppSubgraph interface MediaAppSubgraph { } MediaAppSubgraph , :app:twitter :twitter:media -
@Component @ApplicationScope interface ApplicationObjectGraph , : fun okHttpClient(): OkHttpClient fun
twitterApiService(): TwitterApiService ComposerAppSubgraph TweetRepositoryAppSubgraph MediaAppSubgraph , interface CoreNetworkAppSubgraph { } CoreNetworkAppSubgraph , :core:network :app:twitter -
Big monolithic graphs Scatter the definitions of the object graphs
into subgraphs that can live in the gradle modules where the bindings are actually defined. -
object ApplicationObjectGraphProvider { } var graphProvider: Any? private val mapping:
Map<Class<*>, Any> = mutableMapOf() fun <T> overrideSubgraph(clazz: Class<T>, subgraph: T) { mapping[clazz] = subgraph } fun <T> getSubgraph(clazz: Class<T>): T { if (mapping.containsKey(clazz)) return clazz.cast(mapping[clazz]) return clazz.cast(graphProvider) } -
object ApplicationObjectGraphProvider { } var graphProvider: Any? private val mapping:
Map<Class<*>, Any> = mutableMapOf() fun <T> overrideSubgraph(clazz: Class<T>, subgraph: T) { mapping[clazz] = subgraph } fun <T> getSubgraph(clazz: Class<T>): T { if (mapping.containsKey(clazz)) return clazz.cast(mapping[clazz]) return clazz.cast(graphProvider) } -
ComposerActivity MainActivity TweetDetailActivity C D M TD DMActivity :subsystems:navigation Intent
factories ActivityArgs TD C D M -
override fun toIntent(context: Context, clazz: Class<out Activity>): { .apply {
putExtra("user_id", uid) putExtra("text", text) } } interface ActivityArgs { fun toIntent(context: Context, clazz: Class<out Activity>): Intent } data class ComposerArgs(val uid: Long, val text: String): ActivityArgs { } return Intent(context, clazz) -
C D TD ComposerArgs TweetDetailArgs DMArgs :features:tweetdetail :features:dm :features:composer Map<Class<out
ActivityArgs>, Class<out Activity>> C D TD ComposerActivity DMActivity TweetDetailActivity -
@Module object ComposerModule { @Provides @ApplicationScope fun provideActivityClass: Class<out Activity>
{ } } :features:composer @ActivityArgsKey(ComposerArgs::class) @IntoMap return ComposerActivity::class.java -
@ApplicationScope class ActivityStarter @Inject constructor( ) private val activityMap: Map<Class<out
ActivityArgs>, Class<out Activity>> -
{ fun startActivity(context: Context, args: ActivityArgs) { } } @ApplicationScope
class ActivityStarter @Inject constructor( ) val intent = args.toIntent(context, activityMap[args.javaClass]) context.startActivity(intent) private val activityMap: Map<Class<out ActivityArgs>, Class<out Activity>> -
C D TD C D TD Start an Activity we
can’t see at compile time At compile time you might not see everything, but at runtime it is all there. Let’s use Multibindings to aggregate references at compile time and resolve them at runtime. -
S ApplicationObjectGraph M S M S M S M S
M S M S M S M -
S ApplicationObjectGraph M S M S M S M S
S M S M S M @Component(modules = [ ComposerAppModule::class, TweetDetailAppModule::class, HomeAppModule::class, ExploreAppModule::class, CoreAppModule::class, CoreNetworkAppModule::class, MediaAppModule::class, VideoAppModule::class, NavigationAppModule::class, LoggingAppModule::class, TimelineAppModule::class, … and on and on and on ]) @ApplicationScope interface ApplicationObjectGraph: M -
ApplicationObjectGraph M M M M M M M M TimelineAppModule::class,
… and on and on and on ]) @ApplicationScope interface ApplicationObjectGraph: InitializationSubgraph, ComposerAppSubgraph, TweetDetailAppSubgraph, HomeAppSubgraph, ExploreAppSubgraph, CoreAppSubgraph, CoreNetworkAppSubgraph, MediaAppSubgraph, VideoAppSubgraph, NavigationAppSubgraph, … and on and on and on S S S S S S S S -
@Component(modules = [ BroadcastAppModule::class, … and on and on and
on ]) @ApplicationScope interface ApplicationObjectGraph: InitializationSubgraph, BroadcastAppSubgraph, TweetDetailAppSubgraph, @Component(modules = [ BroadcastAppModule::class, … and on and on and on ]) @ApplicationScope interface ApplicationObjectGraph: InitializationSubgraph, BroadcastAppSubgraph, MapSubgraph, S M -
{ fun broadcastController(): BroadcastController } @Module { @Binds @ApplicationScope fun
bindBcastController(impl: BroadcastControllerImpl): BroadcastController } object BroadcastAppModule interface BroadcastAppSubgraph -
@ApplicationScope interface BroadcastAppSubgraph { fun broadcastController(): BroadcastController } @Subgraph @Subgraph(modules
= [BroadcastAppModule::class]) @Module { @Binds @ApplicationScope fun bindBcastController(impl: BroadcastControllerImpl): BroadcastController } object BroadcastAppModule interface BroadcastAppSubgraph -
@UserScope interface UserObjectGraph : UserManagerSubgraph, TweetRepository, ... (modules = [UserManagerModule::class,
...]) @ApplicationScope interface ApplicationObjectGraph : BroadcastAppSubgraph, InitializationSubgraph, ... @ObjectGraph @Subcomponent -
@UserScope interface UserObjectGraph : UserManagerSubgraph, TweetRepository, ... @ApplicationScope interface ApplicationObjectGraph
: BroadcastAppSubgraph, InitializationSubgraph, ... @ObjectGraph @ObjectGraph -
S @ApplicationScope interface BroadcastAppSubgraph { fun broadcastController(): BroadcastController } @Subgraph(modules
= [BroadcastAppModule::class]) -
@Subgraph( subgraphDependencies = [ CoreNetworkSubgraph::class, VideoPlayerSubgraph::class ]) S @ApplicationScope interface
BroadcastAppSubgraph { fun broadcastController(): BroadcastController } @Subgraph @Subgraph(modules = [BroadcastAppModule::class], -
interface DatabaseSubgraph { fun migrationManager(): MigrationManager } fun schema(): Schema
@Subgraph @Abstract @Abstract @Subgraph interface TwitterDatabaseSubgraph : DatabaseSubgraph { @Binds fun schema(bound: TwitterSchema): Schema } -
@ObjectGraph @ApplicationScope interface ApplicationObjectGraph: InitializationSubgraph, BroadcastAppSubgraph, TweetDetailAppSubgraph, HomeAppSubgraph, ExploreAppSubgraph, CoreAppSubgraph,
CoreNetworkAppSubgraph, MediaAppSubgraph, VideoPlayerSubgraph, NavigationAppSubgraph, TweetUploadAppSubgraph, PerformanceMetricsAppSubgraph, DMAppSubgraph, JSONModelsAppSubgraph, DynamicModulesAppSubgraph, NotificationsAppSubgraph, This is actually insane -
Annotation Processor @ObjectGraph @ApplicationScope interface ApplicationObjectGraph: InitializationSubgraph, BroadcastAppSubgraph, TweetDetailAppSubgraph, HomeAppSubgraph,
ExploreAppSubgraph, CoreAppSubgraph, CoreNetworkAppSubgraph, MediaAppSubgraph, VideoPlayerSubgraph, NavigationAppSubgraph, TweetUploadAppSubgraph, PerformanceMetricsAppSubgraph, DMAppSubgraph, JSONModelsAppSubgraph, DynamicModulesAppSubgraph, NotificationsAppSubgraph, -
Scythe OOP concepts for DI IDE support Better build times
Binding overrides Modular scalability Self documentation Reusability Automatic discovery Completeness validation Factory bindings Assisted Injection Compatible with Dagger -
@mrmans0n Nacho @CesarDielo César @bidyut Saud Thank you! More questions?
Follow ups from this talk? Hit us up on Twitter!