Android, dependency, Informacion, injection, roboguice

Android >> Inyección de dependencias usando RoboGuice

roboguice-blog

En este tutorial vamos a ver como utilizar el framework de inyección de dependencias RoboGuice que nos ayuda a simplificar alguna de las tareas que debemos realizar siempre que creamos una aplicación Android. Entre estas tareas se encuentran las llamadas al método findViewById() o la carga recursos (strings, drawable, etc) con el método getResources(). Usando RoboGuice, en vez de usar estas funciones usaremos anotaciones. Si has usado JUnit, el framework Spring en Java o Symfony2 en PHP estarás relacionado con el uso de anotaciones, si no es así, decir que una anotación es una forma de añadir metadatos a la aplicación en tiempo de ejecución.

Entre las aplicaciones que hacen uso de RoboGuice se encuentran Facebook Messenger, Pulse, Groupon o SwiftKey

Instalación

Vamos a usar la versión 2.0 de RoboGuice en este tutorial. Como casi todas las librerías Java podremos instalarla a través de Maven o descargar el fichero .jar.

Instalación para proyectos Maven

Debemos añadir la siguiente dependencia en la lista de nuestro fichero pom.xml: 

<dependency>
  <groupId>org.roboguice</groupId>
  <artifactId>roboguice</artifactId>
  <version>2.0</version>
</dependency>

Adicionálmente se puede añadir la siguiente dependecia para marcar alguna inyección como @Nullable, es decir, que el valor que se va a inyectar pueda ser nulo. 

 <!-- For the optional Nullable annotation -->
<dependency>
  <groupId>com.google.code.findbugs</groupId>
  <artifactId>jsr305</artifactId>
  <version>1.3.9</version>
</dependency>

Instalación para restos de proyectos

Deberemos de descargarnos los siguientes ficheros .jar y añadirlos al directorio libs de nuestra aplicación:

A continuación añadimos estos ficheros .jar a nuestra aplicación. Si estamos usando Eclipse hacemos lo siguiente:

  1. Clic derecho sobre nuestra aplicación Build Path → Configure Build Path…
  2. Clic en Java Build Path y seleccionamos la pestaña Libraries. A continuación clic en el botón Add External JARs… y añadimos todos los .jar.

Usando RoboGuice

Vamos a crear una aplicación llamada FormRoboGuice. Nuestro layout será el siguiente:

res / layout / activity_main.xml

<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:orientation="vertical"
    android:paddingBottom="@dimen/activity_vertical_margin"
    android:paddingLeft="@dimen/activity_horizontal_margin"
    android:paddingRight="@dimen/activity_horizontal_margin"
    android:paddingTop="@dimen/activity_vertical_margin"
    tools:context=".MainActivity" >

    <EditText
        android:id="@+id/et_name"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:hint="Write your name" />

    <Button
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:onClick="sayHello"
        android:text="Say Hello" />

    <LinearLayout
        android:layout_width="match_parent"
        android:layout_height="wrap_content" >

        <ImageView
            android:id="@+id/img_user"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:contentDescription="@string/app_name" />

        <TextView
            android:id="@+id/text_name"
            android:layout_width="match_parent"
            android:layout_height="match_parent" />
    </LinearLayout>

</LinearLayout>

Además debemos añadir el siguiente permiso en el fichero AndroidManifest.xml para permitir que nuestra aplicación pueda usar la vibración del dispositivo: 

<uses-permission android:name="android.permission.VIBRATE" />

El código de nuestra aplicación sin usar RoboGuice sería el siguiente:

MainActivity.java

package com.amatellanes.android;

import android.app.Activity;
import android.content.Context;
import android.graphics.drawable.Drawable;
import android.os.Bundle;
import android.os.Vibrator;
import android.view.View;
import android.widget.EditText;
import android.widget.ImageView;
import android.widget.TextView;

public class MainActivity extends Activity {

    private EditText etName;
    private ImageView imgUser;
    private TextView textName;

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

        etName = (EditText) findViewById(R.id.et_name);
        imgUser = (ImageView) findViewById(R.id.img_user);
        textName = (TextView) findViewById(R.id.text_name);
    }

    public void sayHello(View view) {

        Vibrator mVibrator = (Vibrator) getSystemService(Context.VIBRATOR_SERVICE);
        mVibrator.vibrate(500);// Vibrate for 500 milliseconds

        String name = etName.getText().toString();
        textName.setText(getString(R.string.hello, name));

        Drawable image = getResources().getDrawable(R.drawable.ic_user);
        imgUser.setImageDrawable(image);
    }
}

Si usamos RoboGuice lo primero es especificar que nuestra actividad extiende de la clase RoboActivity: 

public class MainActivity extends RoboActivity {
    ...
}

Dentro de nuestra actividad vamos a usar las siguientes anotaciones:

  • @ContentView: Permite especificar el layout de nuestra actividad. Podremos ahorrarnos tener que usar el método setContentView() en el método onCreate() de nuestra actividad: 
    @ContentView(R.layout.activity_main)
public class MainActivity extends RoboActivity {
    ...
}
  • @InjectView: Permite inyectar una vista en nuestra actividad:

    @InjectView(R.id.et_name) private EditText etName;
  • @InjectResource: Permite inyectar un recurso (string, drawable, integer, etc) en nuestra actividad:

    @InjectResource(R.drawable.ic_user) private Drawable image;
  • @Inject: Permite inyectar un servicio del sistema (system service) en nuestra actividad, por ejemplo el servicio Vibrator o NotificationManager :

    @Inject private Vibrator vibrator;

Nuestra actividad usando RoboGuice quedaría así:

MainActivity.java

package com.amatellanes.android;

import roboguice.activity.RoboActivity;
import roboguice.inject.ContentView;
import roboguice.inject.InjectResource;
import roboguice.inject.InjectView;
import android.graphics.drawable.Drawable;
import android.os.Bundle;
import android.os.Vibrator;
import android.view.View;
import android.widget.EditText;
import android.widget.ImageView;
import android.widget.TextView;

import com.google.inject.Inject;

@ContentView(R.layout.activity_main)
public class MainActivity extends RoboActivity {

    @InjectView(R.id.et_name) private EditText etName;
    @InjectView(R.id.img_user) private ImageView imgUser;
    @InjectView(R.id.text_name) private TextView textName;

    @InjectResource(R.string.hello) private String hello;
    @InjectResource(R.drawable.ic_user) private Drawable image;

    @Inject private Vibrator vibrator;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
    }

    public void sayHello(View view) {

        vibrator.vibrate(500);// Vibrate for 500 milliseconds

        String name = etName.getText().toString();
        textName.setText(String.format(hello, name));

        imgUser.setImageDrawable(image);
    }
}

Descargar código | Github

Más Información | Roboguice on GitHub & RoboGuice on Google Code (Deprecated)