Iniezione manuale di dipendenze

L'architettura dell'app consigliata da Android incoraggia a suddividere il codice in classi per trarre vantaggio dalla separazione degli aspetti, un principio in cui ogni classe della gerarchia ha un'unica responsabilità definita. Ciò comporta un aumento del numero di classi più piccole che devono essere collegate tra loro per soddisfare le dipendenze reciproche.

Le app per Android sono solitamente composte da molte classi e alcune di esse dipendono l'una dall'altra.
Figura 1. Un modello del grafo di applicazione di un'app Android

Le dipendenze tra le classi possono essere rappresentate come un grafo, in cui ogni classe è collegata alle classi da cui dipende. La rappresentazione di tutte le classi e le relative dipendenze costituisce il grafico dell'applicazione. Nella figura 1 puoi vedere un'astrazione del grafo dell'applicazione. Quando la classe A (ViewModel) dipende dalla classe B (Repository), c'è una linea che punta da A a B che rappresenta questa dipendenza.

L'iniezione di dipendenze consente di effettuare queste connessioni e di sostituire le implementazioni per i test. Ad esempio, quando testi un ViewModel che dipende da un repository, puoi passare implementazioni diverse di Repository con falsi o simulazioni per testare i diversi casi.

Nozioni di base sull'iniezione di dipendenze manuale

Questa sezione spiega come applicare l'iniezione di dipendenze manuale in uno scenario reale di app Android. Illustra un approccio iterativo su come iniziare a utilizzare l'iniezione di dipendenze nella tua app. L'approccio migliora fino a raggiungere un punto molto simile a quello che Dagger genererebbe automaticamente per te. Per ulteriori informazioni su Dagger, consulta la sezione Nozioni di base su Dagger.

Considera un flusso come un gruppo di schermate nella tua app che corrispondono a una funzionalità. Accesso, registrazione e pagamento sono tutti esempi di flussi.

Quando si esamina il flusso di accesso per una tipica app per Android, LoginActivity dipende da LoginViewModel, che a sua volta dipende da UserRepository. UserRepository dipende da UserLocalDataSource e UserRemoteDataSource, che a loro volta dipendono da un servizio Retrofit.

LoginActivity è l'entry point del flusso di accesso e l'utente interagisce con l'attività. Pertanto, LoginActivity deve creare LoginViewModel con tutte le sue dipendenze.

Le classi Repository e DataSource del flusso hanno il seguente aspetto:

Kotlin

class UserRepository(
    private val localDataSource: UserLocalDataSource,
    private val remoteDataSource: UserRemoteDataSource
) { ... }

class UserLocalDataSource { ... }
class UserRemoteDataSource(
    private val loginService: LoginRetrofitService
) { ... }

Java

class UserLocalDataSource {
    public UserLocalDataSource() { }
    ...
}

class UserRemoteDataSource {

    private final Retrofit retrofit;

    public UserRemoteDataSource(Retrofit retrofit) {
        this.retrofit = retrofit;
    }

    ...
}

class UserRepository {

    private final UserLocalDataSource userLocalDataSource;
    private final UserRemoteDataSource userRemoteDataSource;

    public UserRepository(UserLocalDataSource userLocalDataSource, UserRemoteDataSource userRemoteDataSource) {
        this.userLocalDataSource = userLocalDataSource;
        this.userRemoteDataSource = userRemoteDataSource;
    }

    ...
}

Ecco come si presenta LoginActivity:

Kotlin

class LoginActivity: Activity() {

    private lateinit var loginViewModel: LoginViewModel

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        // In order to satisfy the dependencies of LoginViewModel, you have to also
        // satisfy the dependencies of all of its dependencies recursively.
        // First, create retrofit which is the dependency of UserRemoteDataSource
        val retrofit = Retrofit.Builder()
            .baseUrl("https://example.com")
            .build()
            .create(LoginService::class.java)

        // Then, satisfy the dependencies of UserRepository
        val remoteDataSource = UserRemoteDataSource(retrofit)
        val localDataSource = UserLocalDataSource()

        // Now you can create an instance of UserRepository that LoginViewModel needs
        val userRepository = UserRepository(localDataSource, remoteDataSource)

        // Lastly, create an instance of LoginViewModel with userRepository
        loginViewModel = LoginViewModel(userRepository)
    }
}

Java

public class MainActivity extends Activity {

    private LoginViewModel loginViewModel;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        // In order to satisfy the dependencies of LoginViewModel, you have to also
        // satisfy the dependencies of all of its dependencies recursively.
        // First, create retrofit which is the dependency of UserRemoteDataSource
        Retrofit retrofit = new Retrofit.Builder()
                .baseUrl("https://example.com")
                .build()
                .create(LoginService.class);

        // Then, satisfy the dependencies of UserRepository
        UserRemoteDataSource remoteDataSource = new UserRemoteDataSource(retrofit);
        UserLocalDataSource localDataSource = new UserLocalDataSource();

        // Now you can create an instance of UserRepository that LoginViewModel needs
        UserRepository userRepository = new UserRepository(localDataSource, remoteDataSource);

        // Lastly, create an instance of LoginViewModel with userRepository
        loginViewModel = new LoginViewModel(userRepository);
    }
}

Questo approccio presenta alcuni problemi:

  1. Il codice boilerplate è molto lungo. Se volessi creare un'altra istanza di LoginViewModel in un'altra parte del codice, avresti una duplicazione del codice.

  2. Le dipendenze devono essere dichiarate in ordine. Per creare UserRepository, devi prima istanziare LoginViewModel.

  3. È difficile riutilizzare gli oggetti. Se vuoi riutilizzare UserRepository in più funzionalità, devi farlo seguire il pattern singleton. Il pattern singleton rende i test più difficili perché tutti i test condividono la stessa istanza singleton.

Gestione delle dipendenze con un contenitore

Per risolvere il problema del riutilizzo degli oggetti, puoi creare la tua classe container delle dipendenze da utilizzare per ottenere le dipendenze. Tutte le istanze fornite da questo contenitore possono essere pubbliche. Nell'esempio, poiché hai bisogno solo di un'istanza di UserRepository, puoi rendere private le relative dipendenze con la possibilità di renderle pubbliche in futuro, se devono essere fornite:

Kotlin

// Container of objects shared across the whole app
class AppContainer {

    // Since you want to expose userRepository out of the container, you need to satisfy
    // its dependencies as you did before
    private val retrofit = Retrofit.Builder()
                            .baseUrl("https://example.com")
                            .build()
                            .create(LoginService::class.java)

    private val remoteDataSource = UserRemoteDataSource(retrofit)
    private val localDataSource = UserLocalDataSource()

    // userRepository is not private; it'll be exposed
    val userRepository = UserRepository(localDataSource, remoteDataSource)
}

Java

// Container of objects shared across the whole app
public class AppContainer {

    // Since you want to expose userRepository out of the container, you need to satisfy
    // its dependencies as you did before
    private Retrofit retrofit = new Retrofit.Builder()
            .baseUrl("https://example.com")
            .build()
            .create(LoginService.class);

    private UserRemoteDataSource remoteDataSource = new UserRemoteDataSource(retrofit);
    private UserLocalDataSource localDataSource = new UserLocalDataSource();

    // userRepository is not private; it'll be exposed
    public UserRepository userRepository = new UserRepository(localDataSource, remoteDataSource);
}

Poiché queste dipendenze vengono utilizzate nell'intera applicazione, devono essere collocate in un luogo comune che tutte le attività possono utilizzare: la classe Application. Crea una classe personalizzata Application contenente un'istanza AppContainer.

Kotlin

// Custom Application class that needs to be specified
// in the AndroidManifest.xml file
class MyApplication : Application() {

    // Instance of AppContainer that will be used by all the Activities of the app
    val appContainer = AppContainer()
}

Java

// Custom Application class that needs to be specified
// in the AndroidManifest.xml file
public class MyApplication extends Application {

    // Instance of AppContainer that will be used by all the Activities of the app
    public AppContainer appContainer = new AppContainer();
}

Ora puoi recuperare l'istanza di AppContainer dall'applicazione e ottenere l'istanza di UserRepository condivisa:

Kotlin

class LoginActivity: Activity() {

    private lateinit var loginViewModel: LoginViewModel

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        // Gets userRepository from the instance of AppContainer in Application
        val appContainer = (application as MyApplication).appContainer
        loginViewModel = LoginViewModel(appContainer.userRepository)
    }
}

Java

public class MainActivity extends Activity {

    private LoginViewModel loginViewModel;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        // Gets userRepository from the instance of AppContainer in Application
        AppContainer appContainer = ((MyApplication) getApplication()).appContainer;
        loginViewModel = new LoginViewModel(appContainer.userRepository);
    }
}

In questo modo, non hai un UserRepository singleton. Hai invece un AppContainer condiviso tra tutte le attività che contiene oggetti del grafico e crea istanze di questi oggetti che altre classi possono utilizzare.

Se LoginViewModel è necessario in più punti dell'applicazione, è consigliabile avere un luogo centralizzato in cui creare istanze di LoginViewModel. Puoi spostare la creazione di LoginViewModel nel contenitore e fornire nuovi oggetti di questo tipo con una factory. Il codice di un LoginViewModelFactory è simile al seguente:

Kotlin

// Definition of a Factory interface with a function to create objects of a type
interface Factory<T> {
    fun create(): T
}

// Factory for LoginViewModel.
// Since LoginViewModel depends on UserRepository, in order to create instances of
// LoginViewModel, you need an instance of UserRepository that you pass as a parameter.
class LoginViewModelFactory(private val userRepository: UserRepository) : Factory {
    override fun create(): LoginViewModel {
        return LoginViewModel(userRepository)
    }
}

Java

// Definition of a Factory interface with a function to create objects of a type
public interface Factory<T> {
    T create();
}

// Factory for LoginViewModel.
// Since LoginViewModel depends on UserRepository, in order to create instances of
// LoginViewModel, you need an instance of UserRepository that you pass as a parameter.
class LoginViewModelFactory implements Factory {

    private final UserRepository userRepository;

    public LoginViewModelFactory(UserRepository userRepository) {
        this.userRepository = userRepository;
    }

    @Override
    public LoginViewModel create() {
        return new LoginViewModel(userRepository);
    }
}

Puoi includere il LoginViewModelFactory nel AppContainer e fare in modo che il LoginActivity lo consumi:

Kotlin

// AppContainer can now provide instances of LoginViewModel with LoginViewModelFactory
class AppContainer {
    ...
    val userRepository = UserRepository(localDataSource, remoteDataSource)

    val loginViewModelFactory = LoginViewModelFactory(userRepository)
}

class LoginActivity: Activity() {

    private lateinit var loginViewModel: LoginViewModel

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        // Gets LoginViewModelFactory from the application instance of AppContainer
        // to create a new LoginViewModel instance
        val appContainer = (application as MyApplication).appContainer
        loginViewModel = appContainer.loginViewModelFactory.create()
    }
}

Java

// AppContainer can now provide instances of LoginViewModel with LoginViewModelFactory
public class AppContainer {
    ...

    public UserRepository userRepository = new UserRepository(localDataSource, remoteDataSource);

    public LoginViewModelFactory loginViewModelFactory = new LoginViewModelFactory(userRepository);
}

public class MainActivity extends Activity {

    private LoginViewModel loginViewModel;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        // Gets LoginViewModelFactory from the application instance of AppContainer
        // to create a new LoginViewModel instance
        AppContainer appContainer = ((MyApplication) getApplication()).appContainer;
        loginViewModel = appContainer.loginViewModelFactory.create();
    }
}

Questo approccio è migliore del precedente, ma ci sono ancora alcune sfide da considerare:

  1. Devi gestire AppContainer autonomamente, creando manualmente le istanze per tutte le dipendenze.

  2. Esiste ancora molto codice boilerplate. Devi creare manualmente fabbriche o parametri a seconda che tu voglia o meno riutilizzare un oggetto.

Gestione delle dipendenze nei flussi di applicazioni

AppContainer diventa complicato quando vuoi includere più funzionalità nel progetto. Quando la tua app diventa più grande e inizi a introdurre diversiflussi di funzionalità, si verificano ancora più problemi:

  1. Quando hai flussi diversi, potresti volere che gli oggetti rimangano solo nell'ambito di quel flusso. Ad esempio, quando crei LoginUserData (che potrebbe essere costituito dal nome utente e dalla password utilizzati solo nel flusso di accesso), non vuoi conservare i dati di un vecchio flusso di accesso di un altro utente. Vuoi una nuova istanza per ogni nuovo flusso. Puoi farlo creando oggetti FlowContainer all'interno di AppContainer, come mostrato nell'esempio di codice seguente.

  2. Anche l'ottimizzazione dei contenitori del grafico e del flusso dell'applicazione può essere difficile. Devi ricordare di eliminare le istanze che non ti servono, a seconda del flusso in cui ti trovi.

Immagina di avere un flusso di accesso composto da un'attività (LoginActivity) e da più frammenti (LoginUsernameFragment e LoginPasswordFragment). Queste visualizzazioni vogliono:

  1. Accedi alla stessa istanza LoginUserData che deve essere condivisa fino al termine del flusso di accesso.

  2. Crea una nuova istanza di LoginUserData quando il flusso si avvia di nuovo.

Puoi farlo con un contenitore del flusso di accesso. Questo contenitore deve essere creato all'avvio del flusso di accesso e rimosso dalla memoria al termine del flusso.

Aggiungiamo un LoginContainer al codice di esempio. Vuoi poter creare più istanze di LoginContainer nell'app, quindi anziché creare un singolo oggetto, crea una classe con le dipendenze necessarie per il flusso di accesso da AppContainer.

Kotlin

class LoginContainer(val userRepository: UserRepository) {

    val loginData = LoginUserData()

    val loginViewModelFactory = LoginViewModelFactory(userRepository)
}

// AppContainer contains LoginContainer now
class AppContainer {
    ...
    val userRepository = UserRepository(localDataSource, remoteDataSource)

    // LoginContainer will be null when the user is NOT in the login flow
    var loginContainer: LoginContainer? = null
}

Java

// Container with Login-specific dependencies
class LoginContainer {

    private final UserRepository userRepository;

    public LoginContainer(UserRepository userRepository) {
        this.userRepository = userRepository;
        loginViewModelFactory = new LoginViewModelFactory(userRepository);
    }

    public LoginUserData loginData = new LoginUserData();

    public LoginViewModelFactory loginViewModelFactory;
}

// AppContainer contains LoginContainer now
public class AppContainer {
    ...
    public UserRepository userRepository = new UserRepository(localDataSource, remoteDataSource);

    // LoginContainer will be null when the user is NOT in the login flow
    public LoginContainer loginContainer;
}

Una volta creato un contenitore specifico per un flusso, devi decidere quando creare e eliminare l'istanza del contenitore. Poiché il flusso di accesso è autonomo in un'attività (LoginActivity), è l'attività a gestire il ciclo di vita del contenitore. LoginActivity può creare l'istanza in onCreate() e eliminarla in onDestroy().

Kotlin

class LoginActivity: Activity() {

    private lateinit var loginViewModel: LoginViewModel
    private lateinit var loginData: LoginUserData
    private lateinit var appContainer: AppContainer


    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        appContainer = (application as MyApplication).appContainer

        // Login flow has started. Populate loginContainer in AppContainer
        appContainer.loginContainer = LoginContainer(appContainer.userRepository)

        loginViewModel = appContainer.loginContainer.loginViewModelFactory.create()
        loginData = appContainer.loginContainer.loginData
    }

    override fun onDestroy() {
        // Login flow is finishing
        // Removing the instance of loginContainer in the AppContainer
        appContainer.loginContainer = null
        super.onDestroy()
    }
}

Java

public class LoginActivity extends Activity {

    private LoginViewModel loginViewModel;
    private LoginData loginData;
    private AppContainer appContainer;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        appContainer = ((MyApplication) getApplication()).appContainer;

        // Login flow has started. Populate loginContainer in AppContainer
        appContainer.loginContainer = new LoginContainer(appContainer.userRepository);

        loginViewModel = appContainer.loginContainer.loginViewModelFactory.create();
        loginData = appContainer.loginContainer.loginData;
    }

    @Override
    protected void onDestroy() {
        // Login flow is finishing
        // Removing the instance of loginContainer in the AppContainer
        appContainer.loginContainer = null;

        super.onDestroy();
    }
}

Come LoginActivity, i frammenti di accesso possono accedere a LoginContainer da AppContainer e utilizzare l'istanza LoginUserData condivisa.

Poiché in questo caso hai a che fare con la logica del ciclo di vita delle visualizzazioni, ha senso utilizzare l'osservazione del ciclo di vita.

Conclusione

L'iniezione di dipendenze è una buona tecnica per creare app Android scalabili e testabili. Utilizza i contenitori per condividere istanze di classi in diverse parti dell'app e come punto di riferimento centralizzato per creare istanze di classi utilizzando le fabbriche.

Quando l'applicazione diventa più grande, inizierai a scrivere molto codice boilerplate (come le factory), che può essere soggetto a errori. Devi anche gestire autonomamente l'ambito e il ciclo di vita dei contenitori, ottimizzando e eliminando quelli non più necessari per liberare memoria. Se non lo fai correttamente, potresti causare bug sottili e perdite di memoria nella tua app.

Nella sezione Dagger, scoprirai come utilizzare Dagger per automatizzare questo processo e generare lo stesso codice che avresti scritto manualmente.