mercredi 20 octobre 2010

Android JAX-RS Client : partie cliente avec Gson

Dans un post précédent, nous avons vu comment il était possible d'exposer des services JAX-RS JSON grâce au Google appEngine et aux API Java Jersey et Jackson. Nous allons cette fois-ci aborder la partie cliente de ces services sous Android dont voici une capture d'écran :

Téléchargement et installation des outils

Pour reproduire ce tutorial, vous aurez besoin des outils et API suivants :
  • Eclipse : le célèbre IDE
  • SDK Android : pour développer des applications Android avec Eclipse
  • Gson : API de sérialisation / désérialisation made in Google
Une fois téléchargés et installés, créez un nouvel Android Project dans votre workspace Eclipse :


Ajoutez un répertoire /lib à la racine du projet et importez-y la librairie gson.jar. Ajoutez également la dépendance au classpath du projet Eclipse.


Afin d'autoriser notre application à effectuer des appels réseaux via Internet, il faut ajouter au fichier AndroidManifest.xml la permission android.permission.INTERNET :
<?xml version="1.0" encoding="utf-8"?>
<manifest 
    xmlns:android="http://schemas.android.com/apk/res/android"
    package="net.androgames.blog.sample.rest.client"
    android:versionCode="1"
    android:versionName="1.0">
      
    <application 
        android:icon="@drawable/icon" 
        android:label="@string/app_name">
    
        <activity 
            android:name=".UserConsumer"
            android:label="@string/app_name"
            android:screenOrientation="portrait">
                  
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />
                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
            
        </activity>

    </application>
    
    <uses-sdk android:minSdkVersion="4" />
    
    <uses-permission android:name="android.permission.INTERNET" />

</manifest>

Mise en place de l'interface utilisateur

Notre application sera décomposée en deux parties. L'une permettra la création, la mise à jour et la suppression d'utilisateurs tandis que l'autre affichera la liste de tous les utilisateurs avec leur prénom, nom et id :


Le layout utilisé pour le rendu d'un utilisateur de la liste est définit par le fichier user.xml du répertoire res/layout :
<?xml version="1.0" encoding="UTF-8"?>
<LinearLayout 
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="fill_parent"
    android:layout_height="?android:attr/listPreferredItemHeight"
    android:padding="6dip">
    
    <ImageView
        android:src="@drawable/user"
        android:layout_width="48dip"
        android:layout_height="48dip"
        android:layout_marginRight="6dip" />

    <LinearLayout
        android:orientation="vertical"
        android:layout_width="0dip"
        android:layout_weight="1"
        android:layout_height="fill_parent">

        <TextView
            android:id="@+id/name"
            android:textAppearance="?android:textAppearanceMedium"
            android:layout_width="fill_parent"
            android:layout_height="0dip"
            android:layout_weight="1"
            android:ellipsize="marquee"
            android:gravity="center_vertical" />

        <LinearLayout
            android:orientation="horizontal"
            android:layout_width="fill_parent"
            android:layout_height="0dip"
            android:layout_weight="1" >

            <TextView
                android:textAppearance="?android:textAppearanceSmall"
                android:textColor="#FFCC3333"
                android:textStyle="bold"
                android:layout_marginRight="6dip"
                android:layout_width="wrap_content"
                android:layout_height="wrap_content"
                android:text="ID :"
                android:ellipsize="marquee" />
            
            <TextView
                android:id="@+id/id"
                android:textAppearance="?android:textAppearanceSmall"
                android:layout_width="wrap_content"
                android:layout_height="wrap_content"
                android:layout_marginRight="6dip"
                android:singleLine="true"
                android:ellipsize="marquee" />
            
        </LinearLayout>
            
    </LinearLayout>

</LinearLayout>
Le formulaire permettant la mise à jour ou la suppression d'un utilisateur existant, ainsi que la création de nouveaux utilisateurs se présentera sous les formes suivantes :



Les actions réalisables sont au nombre de 5 :
  1. Créer un nouvel utilisateur
  2. Enregistrer les modifications apportées au nom ou au prénom d'un utilisateur
  3. Supprimer un utilisateur
  4. Annuler l'édition en cours d'un utilisateur, le formulaire est alors remis à zéro
  5. En cliquant sur un utilisateur de la la liste, le formulaire se met à jour avec les informations de l'utilisateur sélectionné.
<?xml version="1.0" encoding="utf-8"?>
<LinearLayout 
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:orientation="vertical"
    android:layout_width="fill_parent"
    android:layout_height="fill_parent">
    
    <LinearLayout
        android:orientation="vertical"
        android:paddingLeft="6dip"
        android:paddingRight="6dip"
        android:layout_width="fill_parent"
        android:layout_height="wrap_content">
        
        <TextView
            android:text="@string/forName"
            android:textAppearance="?android:textAppearanceLarge"
            android:layout_width="fill_parent"
            android:layout_height="wrap_content"/>
    
        <EditText 
            android:id="@+id/forName"
            android:layout_width="fill_parent"
            android:layout_height="wrap_content"/>
        
        <TextView
            android:text="@string/name"
            android:textAppearance="?android:textAppearanceLarge"
            android:layout_width="fill_parent"
            android:layout_height="wrap_content"/>
    
        <EditText 
            android:id="@+id/name"
            android:layout_width="fill_parent"
            android:layout_height="wrap_content"/>
    
        <LinearLayout
            android:orientation="horizontal"
            android:layout_gravity="right"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content">
            
            <Button 
                android:id="@+id/insertOrUpdate"
                android:onClick="insertOrUpdate"
                android:layout_width="wrap_content"
                android:layout_height="wrap_content"/>
            
            <Button 
                android:id="@+id/delete"
                android:text="@string/delete"
                android:onClick="delete"
                android:visibility="gone"
                android:layout_width="wrap_content"
                android:layout_height="wrap_content"/>
            
            <Button 
                android:id="@+id/initialize"
                android:text="@string/initialize"
                android:onClick="initialize"
                android:visibility="gone"
                android:layout_width="wrap_content"
                android:layout_height="wrap_content"/>
                
        </LinearLayout>
    
    </LinearLayout>
        
    <ListView 
        android:id="@+id/users"
        android:layout_height="0dip"
        android:layout_weight="1"
        android:layout_width="fill_parent" />
        
</LinearLayout>
Dans le Layout ci dessus, on remarquera en particulier que les boutons ne sont pas tous présents par défaut. Les boutons "Enregistrer", "Supprimer" et "Annuler" ne sont proposés que si un utilisateur de la liste à été sélectionné. L'attribut android:onClick des balises Button permet de spécifier le nom de la méthode appelée lorsque lorsque le bouton est pressé. Ces méthodes doivent être déclarées dans la ou les Activity qui utilisent le Layout comme content view. Elle doivent être publiques et prendre un unique paramètre de type View.

Pour le rendu de la liste des utilisateurs, nous utilisons un ListAdapter afin de faire le pont entre la ListView (couche de présentation) et notre liste d'utilisateurs (modèle de données).
package net.androgames.blog.sample.rest.client;

import java.util.List;

import android.content.Context;
import android.database.DataSetObserver;
import android.view.LayoutInflater;
import android.view.View;
import android.view.ViewGroup;
import android.widget.BaseAdapter;
import android.widget.ListView;
import android.widget.TextView;

public class UserAdapter extends BaseAdapter {

    private List<User> users;
    private LayoutInflater inflater;

    public UserAdapter(final ListView list, Context context) {
        this.inflater = LayoutInflater.from(context);
        // on attache l'adapter à la ListView
        list.setAdapter(this);
        // raffraichissement de la liste lorsque
        // une donnée est modifiée
        registerDataSetObserver(new DataSetObserver() {
            public void onChanged() {
                list.invalidateViews();
            }
        });
    }

    public int getCount() {
        if (users == null) {
            return 0;
        } else {
            return users.size();
        }
    }

    public Object getItem(int position) {
        return users.get(position);
    }

    public long getItemId(int position) {
        return position;
    }

    public View getView(int position, View convertView, ViewGroup parent) {
        
        TaskHolder holder;
        
        // récupération du holder
        if (convertView == null) {
            convertView = inflater.inflate(R.layout.user, null);
            holder = new TaskHolder();
            holder.name = (TextView) convertView.findViewById(R.id.name);
            holder.id = (TextView) convertView.findViewById(R.id.id);
            convertView.setTag(holder);
        } else {
            holder = (TaskHolder) convertView.getTag();
        }
        
        // affichage de l'utilisateur d'index demande
        // via l'utilisation du holder
        if (position < getCount()) {
            User user = (User) getItem(position);
            holder.name.setText(user.getPrenom() + " " +user.getNom());
            holder.id.setText(user.getId());
        }
        
        return convertView;
    }
    
    public void setUsers(List<User> users) {
        this.users = users;
        // mise à jour de la liste
        notifyDataSetChanged();
    }
    
    public void addUser(User user) {
        if (!users.contains(user)) {
            users.add(user);
            // mise à jour de la liste
            notifyDataSetChanged();
        }
    }

    public void removeUser(User user) {
        users.remove(user);
        // mise à jour de la liste
        notifyDataSetChanged();
    }
    
    /**
     * Holder class :
     * Permet de ne pas multiplier le nombre
     * d'instance de View utilisées pour
     * l'affichae des utilisateurs dans la
     * ListView
     */
    static class TaskHolder {
        TextView name;
        TextView id;
    }

}
La méthode getView de l'Adapter permet de retourner une instance du LinearLayout utilisé pour le rendu d'un utilisateur (/res/layout/user.xml) et dans lequel les vues sont remplies avec les données de l'utilisateur en position demandée.

Appels aux services REST

L'interface utilisateur maintenant en place, nous allons nous pencher sur les appels aux services REST. Afin de ne pas tomber dans les fameuses erreurs ANR (Application Not Responding), les appels aux services s'exécuteront dans un Thread différent de celui utilisé pour les interactions avec l'utilisateur (rendu graphique, capture des événements, ...). Pour cela, nous utiliserons des AsyncTask afin que l'envoi de la requête au serveur, l'attente de la réponse et la récupération de la réponse s'exécute en parallèle du Thread principal. La méthode est similaire à l'utilisation du de la classe SwingWorker de Java 6.
/**
 * Classe abstraite pour l'envoi de requètes asynchrones au serveur.
 */
public abstract class AbstractTask 
        extends AsyncTask<HttpRequestBase, Void, HttpResponse> {
    
    /**
     * Appelée avant le lancement du traitement en arrière plan.
     * Cette méthode est exécutée dans le Thread appelant.
     */
    protected void onPreExecute() {}
    
    /**
     * Traitement en arrière plan.
     * Cette méthode est exécuté dans un Thread différent
     * du Thread appelant.
     */
    protected HttpResponse doInBackground(final HttpRequestBase...requests) {}

    /**
     * Appelée après la fin du traitement en arrière plan.
     */
    protected void onPostExecute(final HttpResponse response) {}
    
    /**
     * Traitement spécifique du JSON
     * @param in Le contenu de la réponse HTTP OK
     */
    protected abstract void handleJson(final InputStream in);

};
Cette classe nous permet de définir un comportement générique pour chacun des appels aux services REST ainsi qu'un comportement spécifique à implémenter :
onPreExecute
Cette méthode est appelée dans le Thread principal avant que le traitement en tâche de fond ne soit lancé. Dans notre cas, nous l'utiliserons pour afficher une fenêtre popup d'attente.
doInBackground
Cette méthode appelée dans un Thread annexe permet de lancer un traitement en tâche de fond. Nous l'utiliserons pour effectuer les requêtes HTTP à destination du serveur et attendre la réponse de ce dernier. Cette méthode retourne un objet dans le type correspond à celui de la méthode ci dessous.
onPostExecute
Cette méthode est appelée dans le Thread principal une fois que le traitement en tâche de fond a terminé.Elle prend en paramètre le résultat du traitement effectué en tache de fond. Dans notre cas, cette méthode sera utilisée pour analyser la réponse du serveur et traiter le contenu de celle-ci.
handleJson
Cette méthode abstraite doit être surchargée pour traiter de manière spécifique le contenu de la réponse du serveur au format JSON.
Nous utiliserons 4 implémentations différentes de cette classe abstraite, chacune ayant pour but le traitement d'un type particulier de réponse du serveur :
/**
 * Récupération de la liste des User
 */
private class ListUsersTask extends AbstractTask {

    protected void handleJson(final InputStream in) {
        final Type collectionType = new TypeToken<List<User>>(){}.getType();
        List<User> users = null;
        synchronized (lock) {
            users = gson.fromJson(new InputStreamReader(in), collectionType);
        }
        // La liste récupérée initialement est la référence
        // des User pour l'application Android
        adapter.setUsers(users);
    }

};
/**
 * Recuperation d'un utilisateur
 * déjà référencé localement
 */
private class GetUserTask extends AbstractTask {

    protected void handleJson(final InputStream in) {
        synchronized (lock) {
            updateCurrentUser(gson.fromJson(new InputStreamReader(in), User.class));
        }
    }

};
/**
 * Récupération d'un nouvel utilisateur
 * non encore référencé localement
 */
private class AddUserTask extends AbstractTask {

    protected void handleJson(final InputStream in) {
        synchronized (lock) {
            updateCurrentUser(gson.fromJson(new InputStreamReader(in), User.class));
        }
        adapter.addUser(currentUser);
    }

};
/**
 * Suppression d'un utilisateur
 * référencé localement
 */
private class DeleteUserTask extends AbstractTask {

    protected void handleJson(final InputStream in) {
        User fakeUser = new User();
        try {
            fakeUser.setId(new BufferedReader(
                    new InputStreamReader(in, ENCODING_UTF_8)).readLine());
        } catch (Exception e) {}
        adapter.removeUser(fakeUser);
        updateCurrentUser(null);
    }

};
Dans le cas de la suppression d'un utilisateur, le serveur nous renvoie un objet de type String sans délimiteur d'objet JSON : '{' ou '['. Nous traitons donc le contenu directement comme une chaine de caractères au moyen d'un BufferedReader.

Pour lancer ces traitements asynchrones d'envoi des requêtes au serveur, nous devons au préalable construire la HttpRequestBase que nous allons passer en paramètre à l'une de nos AbstractTask. Le code ci-dessous nous permet de mettre à jour l'utilisateur en cours d'édition en quelques étapes :
  1. Création d'un bean User avec les informations modifiées du formulaire
  2. Création d'une instance de la classe HttpPost pointant sur /user/{user.getId()}
  3. Le Content-Type du Header de la requête précise que le contenu est de type application/json
  4. Le bean User est sérialisé en JSON via la librairie Gson
  5. La représentation JSON est encodée en UTF-8 et positionnée dans la requête HTTP
  6. La requête est envoyé via une GetUserTask afin de récupérer le bean User retourné par le serveur
// mise a jour du currentUser
User updatedUser = new User();
updatedUser.setNom(name.getEditableText().toString());
updatedUser.setPrenom(forName.getEditableText().toString());
// création d'une requête de type POST
// l'URL contient l'ID du User à mettre à jour
HttpPost request = new HttpPost(
        getString(R.string.user_endpoint) + "/" + currentUser.getId());
// précision du Content-Type
request.setHeader("Content-Type", JSON_CONTENT_TYPE);
synchronized (lock) {
    try {
        // l'objet de type User sérialisé est envoyé dans le corps
        // de la requête HTTP et encodé en UTF-8 (cf. Jackson)
        request.setEntity(new StringEntity(gson.toJson(updatedUser), ENCODING_UTF_8));
    } catch (UnsupportedEncodingException e) {}
}
(new GetUserTask()).execute(request);
L'emploi de l'encodage UTF-8 est imposé par la librairie Jackson utilisé par Jersey côté serveur pour la sérialisation / désérialisation du JSON. En espérant un support de l'encodage ISO-8859-1 dans une prochaine release...

Pour l'appel aux autres méthodes du serveur vous pouvez regarder le code complet de l'Activity donné ci-dessous :
package net.androgames.blog.sample.rest.client;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.UnsupportedEncodingException;
import java.lang.reflect.Type;
import java.util.List;

import org.apache.http.HttpResponse;
import org.apache.http.HttpStatus;
import org.apache.http.client.methods.HttpDelete;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.client.methods.HttpPut;
import org.apache.http.client.methods.HttpRequestBase;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.params.BasicHttpParams;
import org.apache.http.params.HttpParams;
import org.apache.http.params.HttpProtocolParams;

import android.app.Activity;
import android.app.AlertDialog;
import android.app.Dialog;
import android.app.ProgressDialog;
import android.content.DialogInterface;
import android.content.DialogInterface.OnClickListener;
import android.os.AsyncTask;
import android.os.Bundle;
import android.util.Log;
import android.view.View;
import android.widget.AdapterView;
import android.widget.Button;
import android.widget.EditText;
import android.widget.ListView;
import android.widget.AdapterView.OnItemClickListener;

import com.google.gson.Gson;
import com.google.gson.reflect.TypeToken;

public class UserConsumer extends Activity implements OnItemClickListener {
    
    private static final DefaultHttpClient httpClient = new DefaultHttpClient();
    static {
        HttpParams params = new BasicHttpParams();
        HttpProtocolParams.setContentCharset(params, "UTF-8");
        httpClient.setParams(params); 
    }
    
    private static final Gson gson = new Gson();

    private static final String JSON_CONTENT_TYPE = "application/json; charset=UTF-8";
    private static final String ENCODING_UTF_8 = "UTF-8";

    private static final int DIALOG_ERROR = 0;
    private static final int DIALOG_LOADING = 1;
    
    private EditText name, forName;
    private Button insertOrUpdate, initialize, delete;
    
    private User currentUser; // utilisateur courant
    private UserAdapter adapter; // utilisé comme référentiel local
    
    private Object lock = new Object();
    
    /**
     * Classe abstraite pour l'envoi de requêtes asynchrones au serveur.
     */
    private abstract class AbstractTask 
            extends AsyncTask<HttpRequestBase, Void, HttpResponse> {
        
        /**
         * Appelée avant le lancement du traitement en arrière plan.
         * Cette méthode est exécutée dans le Thread appelant.
         */
        protected void onPreExecute() {
            showDialog(DIALOG_LOADING);
        }
        
        /**
         * Traitement en arrière plan.
         * Cette méthode est exécutée dans un Thread différent
         * du Thread appelant.
         */
        protected HttpResponse doInBackground(final HttpRequestBase...requests) {
            HttpResponse response = null;
            synchronized (lock) {
                try {
                    response = httpClient.execute(requests[0]);
                } catch (Exception e) {
                    Log.e(UserConsumer.class.getSimpleName(), 
                            "Erreur d'appel au serveur", e);
                }
            }
            return response;
        }

        /**
         * Appelé après la fin du traitement en arrière plan.
         */
        protected void onPostExecute(final HttpResponse response) {
            dismissDialog(DIALOG_LOADING);
            if (response == null 
                    || !(response.getStatusLine()
                            .getStatusCode() == HttpStatus.SC_OK)) {
                showDialog(DIALOG_ERROR);
            } else {
                try {
                    handleJson(response.getEntity().getContent());
                } catch (IOException e) {
                    Log.e(UserConsumer.class.getSimpleName(), 
                            "Erreur de flux", e);
                }
            }
        }
        
        /**
         * Traitement spécifique du JSON
         * @param in Le contenu de la réponse HTTP OK
         */
        protected abstract void handleJson(final InputStream in);

    };
    
    /**
     * Récupération de la liste des User
     */
    private class ListUsersTask extends AbstractTask {

        protected void handleJson(final InputStream in) {
            final Type collectionType = new TypeToken<List<User>>(){}.getType();
            List<User> users = null;
            synchronized (lock) {
                users = gson.fromJson(new InputStreamReader(in), collectionType);
            }
            // La liste récupérée initialement est la référence
            // des User pour l'application Android
            adapter.setUsers(users);
        }

    };
    
    /**
     * Recuperation d'un utilisateur
     * déjà référencé localement
     */
    private class GetUserTask extends AbstractTask {

        protected void handleJson(final InputStream in) {
            synchronized (lock) {
                updateCurrentUser(gson.fromJson(new InputStreamReader(in), User.class));
            }
        }

    };
    
    /**
     * Récupération d'un nouvel utilisateur
     * non encore référencé localement
     */
    private class AddUserTask extends AbstractTask {

        protected void handleJson(final InputStream in) {
            synchronized (lock) {
                updateCurrentUser(gson.fromJson(new InputStreamReader(in), User.class));
            }
            adapter.addUser(currentUser);
        }

    };
    
    /**
     * Suppression d'un utilisateur
     * référencé localement
     */
    private class DeleteUserTask extends AbstractTask {

        protected void handleJson(final InputStream in) {
            User fakeUser = new User();
            try {
                fakeUser.setId(new BufferedReader(
                        new InputStreamReader(in, ENCODING_UTF_8)).readLine());
            } catch (Exception e) {}
            adapter.removeUser(fakeUser);
            updateCurrentUser(null);
        }

    };
    
    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.main);
        adapter = new UserAdapter((ListView) findViewById(R.id.users), this);
        insertOrUpdate = (Button) findViewById(R.id.insertOrUpdate);
        initialize = (Button) findViewById(R.id.initialize);
        delete = (Button) findViewById(R.id.delete);
        name = (EditText) findViewById(R.id.name);
        forName = (EditText) findViewById(R.id.forName);
    }
    
    @Override
    public void onResume() {
        super.onResume();
        // recuperation de tous les utilisateurs
        (new ListUsersTask()).execute(new HttpGet(getString(R.string.user_endpoint)));
        // initialisation des actions
        ((ListView) findViewById(R.id.users)).setOnItemClickListener(this);
        // initialisation de l'IHM
        // currentUser peut ne pas être null
        // si l'activité a été résumée
        updateCurrentUser(currentUser);
    }
    
    /**
     * Clique sur le bouton Créer ou Enregistrer
     * @param v
     */
    public void insertOrUpdate(View v) {
        if (currentUser == null) {
            // nouvel utilisateur
            User user = new User();
            user.setNom(name.getEditableText().toString());
            user.setPrenom(forName.getEditableText().toString());
            // création d'une requête de type POST
            // l'URL contient l'ID du User Ã  mettre Ã  jour
            HttpPut request = new HttpPut(getString(R.string.user_endpoint));
            // précision du Content-Type
            request.setHeader("Content-Type", JSON_CONTENT_TYPE);
            synchronized (lock) {
                try {
                    // l'objet de type User sérialisé est envoyé dans le corps
                    // de la requête HTTP et encodé en UTF-8 (cf. Jackson)
                    request.setEntity(new StringEntity(
                            gson.toJson(user), ENCODING_UTF_8));
                } catch (UnsupportedEncodingException e) {}
            }
            (new AddUserTask()).execute(request);
        } else {
            // mise a jour du currentUser
            User updatedUser = new User();
            updatedUser.setNom(name.getEditableText().toString());
            updatedUser.setPrenom(forName.getEditableText().toString());
            // création d'une requête de type POST
            // l'URL contient l'ID du User Ã  mettre Ã  jour
            HttpPost request = new HttpPost(
                    getString(R.string.user_endpoint) + "/" + currentUser.getId());
            // précision du Content-Type
            request.setHeader("Content-Type", JSON_CONTENT_TYPE);
            synchronized (lock) {
                try {
                    // l'objet de type User sérialisé est envoyé dans le corps
                    // de la requête HTTP et encodé en UTF-8 (cf. Jackson)
                    request.setEntity(new StringEntity(
                            gson.toJson(updatedUser), ENCODING_UTF_8));
                } catch (UnsupportedEncodingException e) {}
            }
            (new GetUserTask()).execute(request);
        }
    }
    
    /**
     * Clique sur le bouton Supprimer
     * @param v
     */
    public void delete(View v) {
        // envoi d'une requête DELETE au serveur
        // sur l'URL correspondant au User Ã  supprimer
        (new DeleteUserTask()).execute(new HttpDelete(
                getString(R.string.user_endpoint) + "/" + currentUser.getId()));
    }
    
    /**
     * Clique sur le bouton Annuler
     * @param v
     */
    public void initialize(View v) {
        // raz du formulaire
        updateCurrentUser(null);
    }

    // Met a jour le formulaire avec les
    // informations de l'utilisateur passé
    // en paramètre. Si le formulaire est 
    // positionné sur les données d'un utilisateur
    // de même id, le référentiel local est mis à jour
    private void updateCurrentUser(User user) {
        if (user == null) {
            currentUser = null;
            name.setText("");
            forName.setText("");
            delete.setVisibility(View.GONE);
            initialize.setVisibility(View.GONE);
            insertOrUpdate.setText(R.string.create);
        } else {
            if (!user.equals(currentUser)) {
                // changement de User
                currentUser = user;
            } else {
                // mise a jour des informations du User
                // dans le référentiel local
                currentUser.setNom(user.getNom());
                currentUser.setPrenom(user.getPrenom());
                adapter.notifyDataSetChanged();
            }
            // mise à jour du formulaire
            name.setText(currentUser.getNom());
            forName.setText(currentUser.getPrenom());
            delete.setVisibility(View.VISIBLE);
            initialize.setVisibility(View.VISIBLE);
            insertOrUpdate.setText(R.string.update);
        }
    }
    
    @Override
    public Dialog onCreateDialog(int dialogId) {
        Dialog dialog = null;
        AlertDialog.Builder builder = null;
        switch (dialogId) {
        
            case DIALOG_LOADING : // recuperation en cours...
                dialog = new ProgressDialog(this);
                ((ProgressDialog) dialog).setIndeterminate(true);
                ((ProgressDialog) dialog).setMessage(getString(R.string.loading));
                break;
                
            case DIALOG_ERROR : // message d'erreur
                builder = new AlertDialog.Builder(this);
                builder.setTitle(R.string.error)
                       .setMessage(R.string.error_message)
                       .setNegativeButton(R.string.close, new OnClickListener() {
                            public void onClick(DialogInterface dialog, int which) {
                                dialog.dismiss();
                            }
                        });
                dialog = builder.create();
                break;
        }
        return dialog;
    }
    
    /**
     * L'utilisateur à cliqué sur un User de la liste,
     * le formulaire est mis à jour avec les informations
     * du User récupérés depuis le serveur
     */

    public void onItemClick(AdapterView<?> parent, View view, int position, long id) {
        // mise a jour du formulaire avec les informations
        // du User sélectionné par l'utilisateur
        updateCurrentUser((User) adapter.getItem(position));
        
        // on aurait également pu demander l'utilisateur 
        // au serveur à chaque fois, mais on considere
        // que la liste initialement chargée est notre
        // référence afin de garder un jeu de donnée cohérent
        
        // (new GetUserTask()).execute(new HttpGet(
        //        getString(R.string.user_endpoint) + 
        //        "/" + ((User) adapter.getItem(position)).getId()));
    }
    
}
Vous pouvez récupérer l'exemple complet sur Google Code : SampleAndroidRestClient.

mardi 12 octobre 2010

Android JAX-RS Client : partie serveur avec Jersey et App Engine

En 2008, Google a ouvert son offre de cloud computing au monde Java. Depuis, le Google appEngine permet à n'importe quelle personne de déployer une application web Java scalable et à haute disponibilité ! Dans ce tutorial, nous allons voir comment exposer un service REST en JSON dans le cloud au moyen de l'appEngine et de l'api Jersey JAX-RS. Le webservice exposé consistera en un simple CRUD d'objets de type User.

Téléchargement et installation des outils

Pour suivre ce tutorial, vous aurez besoin des outils et api suivantes :
Une fois téléchargées et installée, créez un nouveau Web Application Project :


Ajoutez les librairies Jersey suivante dans le répertoire war/WEB-INF :
  • asm.jar
  • commons-validator.jar
  • jackson-core-asl.jar
  • jackson-jaxrs.jar
  • jackson-mapper-asl.jar
  • jackson-xc.jar
  • jersey-client.jar
  • jersey-core.jar
  • jersey-json.jar
  • jettison.jar
  • jsr311-api.jar


Mise en place du modèle de données

Dans le répertoire src/META-INF du projet, nous allons remplacer le fichier de configuration JDO créé par défaut par un fichier de configuration JPA persistence.xml :

<?xml version="1.0" encoding="UTF-8" ?>
<persistence version="1.0"
    xmlns="http://java.sun.com/xml/ns/persistence"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://java.sun.com/xml/ns/persistence
                        http://java.sun.com/xml/ns/persistence/persistence_1_0.xsd">

    <persistence-unit name="transactions-optional">
        <provider>
                org.datanucleus.store.appengine.jpa.DatastorePersistenceProvider
        </provider>
        <properties>
            <property name="datanucleus.NontransactionalRead" value="true"/>
            <property name="datanucleus.NontransactionalWrite" value="true"/>
            <property name="datanucleus.ConnectionURL" value="appengine"/>
        </properties>
    </persistence-unit>

</persistence>

Nous nous contenterons de la configuration JPA minimale.
Notre entité persisté sera une classe User :

package net.androgames.blog.sample.rest.server;

import java.io.Serializable;

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;

import org.datanucleus.jpa.annotations.Extension;


@Entity
public class User implements Serializable {

    /**
     * 1 : Version initiale
     */
    private static final long serialVersionUID = 1L;

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Extension(vendorName="datanucleus", key="gae.encoded-pk", value="true")
    private String id;
    
    private String nom;
    private String prenom;
    
    public String getId() {
        return id;
    }
    public void setId(String id) {
        this.id = id;
    }
    public String getNom() {
        return nom;
    }
    public void setNom(String nom) {
        this.nom = nom;
    }
    public String getPrenom() {
        return prenom;
    }
    public void setPrenom(String prenom) {
        this.prenom = prenom;
    }
    
}

Mise en place de Jersey et CRUD simple

Pour exposer les fonctionnalités de création, suppression, modification et récupération en REST, nous allons utiliser l'api Jersey. Comme la plupart des framework utilisés dans une application web, sa configuration s'effectue en déclarant une Servlet spécifique dans le fichier web.xml :

<?xml version="1.0" encoding="utf-8"?>
<web-app 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="http://java.sun.com/xml/ns/javaee"
    xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
                        http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" 
    version="2.5">

    <servlet>
        <servlet-name>Jersey</servlet-name>
        <servlet-class>
            com.sun.jersey.spi.container.servlet.ServletContainer
        </servlet-class>
        <!-- Packages a analyser -->
        <init-param>
            <param-name>com.sun.jersey.config.property.packages</param-name>
            <param-value>net.androgames.blog.sample.rest.server</param-value>
        </init-param>
        <!-- Mapping JSON POJO -->
        <init-param>
            <param-name>com.sun.jersey.api.json.POJOMappingFeature</param-name>
            <param-value>true</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>
    
    <servlet-mapping>
        <servlet-name>Jersey</servlet-name>
        <url-pattern>/*</url-pattern>
    </servlet-mapping>
    
    <session-config>
        <session-timeout>30</session-timeout>
    </session-config>
    
</web-app>

La sérialisation / désérialisation des POJO par Jersey sera effectuée par la classe com.sun.jersey.api.json.POJOMappingFeature. Jersey va ainsi supporter la sérialisation / désérialisation au format JSON. L'implémentation de notre CRUD est la suivante :

package net.androgames.blog.sample.rest.server;

import java.util.List;
import java.util.logging.Logger;

import javax.persistence.EntityManager;
import javax.persistence.EntityManagerFactory;
import javax.persistence.Persistence;
import javax.ws.rs.Consumes;
import javax.ws.rs.DELETE;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.PUT;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;

import com.sun.jersey.api.NotFoundException;

@Path("/user")
@Produces("application/json")
@Consumes("application/json")
public class UserService {
    
    private static final Logger log = Logger.getLogger(UserService.class.getName());
    
    private static final EntityManagerFactory ENTITY_MANAGER = 
        Persistence.createEntityManagerFactory("transactions-optional");
    
    public static EntityManager getEntityManager() {
        return ENTITY_MANAGER.createEntityManager();
    }

    /**
     * Mise a jour d'un utilisateur par son id
     * @param id
     * @param user
     * @return
     */
    @POST
    @Path("{id}")
    public User update(
            @PathParam("id") String id, 
            User user) {
        log.info("Mise a jour du user d'id : " + id);
        
        if (user == null) {
            throw new IllegalArgumentException();
        }
        
        EntityManager em = getEntityManager();
        User persistedUser = em.getReference(User.class, id);
        
        if (persistedUser == null) {
            throw new NotFoundException();
        }
        
        persistedUser.setNom(user.getNom());
        persistedUser.setPrenom(user.getPrenom());

        em.getTransaction().begin();
        em.merge(persistedUser);
        em.getTransaction().commit();
        
        return persistedUser;
    }

    /**
     * Recupere un utilisateur par son id
     * @param deviceId
     * @return
     */
    @GET
    @Path("{id}")
    public User get(@PathParam("id") String id) {
        log.info("Recuperation du user d'id : " + id);
        
        EntityManager em = getEntityManager();
        User persistedUser = em.getReference(User.class, id);
        
        if (persistedUser == null) {
            throw new NotFoundException();
        }
        
        return persistedUser;
    }

    /**
     * Recuperation de la liste des utilisateurs
     * @param deviceId
     * @return
     */
    @GET
    @SuppressWarnings("unchecked")
    public List<User> list() {
        log.info("Recuperation des utilisateurs");
        
        EntityManager em = getEntityManager();
        List<User> users = em.createQuery("SELECT u FROM User u").getResultList();
        
        return users;
    }

    /**
     * Supprime un utilisateur par son id
     * @param deviceId
     * @return
     */
    @DELETE
    @Path("{id}")
    public String delete(@PathParam("id") String id) {
        log.info("Suppression du user d'id : " + id);
        
        EntityManager em = getEntityManager();
        User persistedUser = em.getReference(User.class, id);
        
        if (persistedUser == null) {
            throw new NotFoundException();
        }

        em.getTransaction().begin();
        em.remove(persistedUser);
        em.getTransaction().commit();
        
        return id;
    }

    /**
     * Ajoute un utilisateur
     * @param deviceId
     * @return
     */
    @PUT
    public User add(User user) {
        log.info("Ajout d'un utilisateur");
        
        EntityManager em = getEntityManager();
        em.getTransaction().begin();
        em.persist(user);
        em.getTransaction().commit();
        
        return user;
    }
    
}

Jersey se configure au moyen d'annotations :
@Path
Cette annotation permet de spécifier le chemin d'accès à la ressource relativement au chemin paramétré dans le fichier web.xml pour la Servlet Jersey. Utilisée sur la déclaration d'une classe, elle s'applique à toutes ses méthodes. Utilisée sur une méthode, elle s'applique relativement au Path définit pour la classe.
@PathParam
Elle permet de récupérer une partie du Path en paramètre d'une méthode. Dans notre exemple, nous déclarons le Path "/user/{id}" pour la méthode get. Ainsi définit, notre Path nous permet de récupérer la partie mappée par "{id}" grâce à l'annotation PathParam.
@PUT, @POST, @GET, @DELETE
Ces annotations permettent de spécifier la méthode HTTP à mapper sur une méthode de la classe UserService. Seules les requêtes du type spécifié seront transmises à la méthode. Cela permet d'utiliser le même chemin "/user" pour la création d'un utilisateur (PUT), la récupération de tous les utilisateurs (GET) et la suppression d'un utilisateur (DELETE). La récupération d'un utilisateur (GET) et la imse à jour d'un utilisateur (POST) partagent le chemin "/user/{id}".
@Produce
Cette annotation permet de préciser le (ou les) type MIME que Jersey peut utiliser pour sérialiser les retours des méthodes annotées PUT, GET, POST, DELETE, ... Dans notre exemple, nous avons spécifier une sérialisation en JSON pour l'ensemble des méthodes de la classe. Il est également possible de spécifier le type MIME par version, ou d'en spécifier plusieurs séparés par des virgules. Dans ce cas, le type MIME utilisé pour la sérialisation correspond au premier type MIME rencontré dans le header HTTP Accept.
@Consume
Tout comme l'annotation Produce, cette annotation permet de définir un type MIME et, plus précisément, le type MIME qui sera utiliser par Jersey pour désérialiser les valeurs à passer en paramètre aux méthodes exposées. Dans notre exemple, nous attendons donc pour les méthodes add et update une requête HTTP nous envoyant un bean User sérialisé en JSON. Il est également possible de spécifier le type MIME par méthode ou d'en préciser plus d'un.

Test des services avec l'API de test Jersey


Jersey offre la possibilité de recetter rapidement un webservice REST en utilisant la classe Client de son API. L'exemple ci dessous montre comment tester rapidement l'ajout, la mise à jour, la récupération et la suppression d'un utilisateur.

package net.androgames.blog.sample.rest.server;

import javax.ws.rs.core.MediaType;

import com.sun.jersey.api.client.Client;
import com.sun.jersey.api.client.WebResource;

public class TestUserService {

    private static final String URL = "http://localhost:8888/user";
    
    /**
     * 
     * @param args
     */
    public static void main(String[] args) {
        
        // creation d'un client Jersey
        Client c = Client.create();
        WebResource r;
        User user;
        
        // test d'insertion d'un utilisateur
        r = c.resource(URL);
        user = new User();
        user.setNom("Vianey");
        user.setPrenom("");
        user = r.type(MediaType.APPLICATION_JSON_TYPE)
                .accept(MediaType.APPLICATION_JSON_TYPE)
                .put(User.class, user);
        
        System.out.println("User enregistré avec l'id : " + user.getId());
        
        // test de mise a jour de l'utilisateur
        r = c.resource(URL + "/" + user.getId());
        user = new User();
        user.setNom("Vianey");
        user.setPrenom("Antoine");
        user = r.type(MediaType.APPLICATION_JSON_TYPE)
                .accept(MediaType.APPLICATION_JSON_TYPE)
                .post(User.class, user);
        
        System.out.println("User mise a jour : " + user.getPrenom() + " " + user.getNom());
        
        // test de recuperation de l'utilisateur
        r = c.resource(URL + "/" + user.getId());
        user = r.type(MediaType.APPLICATION_JSON_TYPE)
                .accept(MediaType.APPLICATION_JSON_TYPE)
                .get(User.class);
        
        System.out.println("User récupéré : " + user.getPrenom() + " " + user.getNom());
        
        // test de suppression des utilisateurs
        r = c.resource(URL + "/" + user.getId());
        r.type(MediaType.APPLICATION_JSON_TYPE)
                .accept(MediaType.APPLICATION_JSON_TYPE)
                .delete();
        
    }

}

Pour le test de récupération de la liste des utilisateurs, je n'ai malheureusement pas trouver de méthode élégante pour désérialiser directement le type List en JAX-RS comme cela est fait avec le type User... Une solution répandue consiste à retourner un wrapper encapsulant la liste des utilisateurs. Dans le prochain tutorial, nous aborderons nous verrons comment coder un client Android pour ces webservices avec l'utilisation d'une librairie nous permettant de désérialiser de manière élégante notre liste d'utilisateur. A la prochaine !

dimanche 3 octobre 2010

Prendre une photo avec l'API Camera Android

Dans ce tutorial, nous allons voir comment utiliser l'API Android pour prendre des photos avec le téléphone. Pour que cela soit possible, il faut déclarer dans le manifest de l'application la permission suivante :
<uses-permission android:name="android.permission.CAMERA" />
Afin de s'assurer que l'application soit utilisable uniquement par les téléphones disposant d'un appareil photo numérique (APN), il suffit d'ajouter la ligne suivante dans le manifest :
<uses-feature android:name="android.hardware.camera" />
<uses-feature android:name="android.hardware.camera.autofocus" />
La seconde permet de s'assurer que l'appareil photo dispose d'un auto focus.

Pour utiliser la camera Android, il faut une SurfaceView afin d'afficher en temps réel la preview de la camera et un bouton, pour indiquer à quel moment la photo doit être prise. L'API permet de récupérer différentes données :
Vous trouverez ci-dessous le code d'une SurfaceView permettant la prise de photo au moyen de l'API Camera Android :
import java.io.IOException;
import java.util.List;

import android.content.Context;
import android.hardware.Camera;
import android.hardware.Camera.Size;
import android.util.AttributeSet;
import android.view.SurfaceHolder;
import android.view.SurfaceView;

/**
 * 
 * Android Camera API archetype
 * 
 * Under GPL v3 : http://www.gnu.org/licenses/gpl-3.0.html
 * 
 * @author antoine vianey
 *
 */
public final class CameraLivePreview extends SurfaceView 
        implements SurfaceHolder.Callback {
    
    private SurfaceHolder holder;
    private Camera camera;

    /**
     * Retrieve raw picture data after shooting
     */
    private Camera.PictureCallback rawCallback = 
            new Camera.PictureCallback() {
        public void onPictureTaken(byte[] data, Camera c) {
            // work with raw data
            // ...
        }
    };
    
    /**
     * Retrieve jpeg compress data after shooting
     */
    private Camera.PictureCallback jpegCallback = 
            new Camera.PictureCallback() {
        public void onPictureTaken(byte[] data, Camera c) {
            // start the camera preview
            camera.startPreview();
            // work with the jpeg data
            // ...
        }
    };
    
    /**
     * Retrieve frame data for each frame
     */
    private Camera.PreviewCallback frameCallback = 
            new Camera.PreviewCallback() {
        public void onPreviewFrame(byte[] data, Camera camera) {
            // work with the frame data
            // ...
        }
    };
    
    /**
     * Retrieve information about shutter
     */
    private Camera.ShutterCallback shutterCallback = 
            new Camera.ShutterCallback() {
        public void onShutter() {
            // handle shutter done
            // ...
        }
    };
    
    /**
     * Ensure it is supported by adding 
     * android.hardware.camera.autofocus feature
     * to the application manifest
     */
    private Camera.AutoFocusCallback autoFocusCallback = 
            new Camera.AutoFocusCallback() {
        public void onAutoFocus(boolean success, Camera camera) {
            // handle focus done
            // you can choose to take a picture
            // after auto focus is completed
            camera.takePicture(shutterCallback, rawCallback, jpegCallback);
        }
    };

    public CameraLivePreview(Context context) {
        super(context);
        init();
    }

    public CameraLivePreview(Context context, AttributeSet attrs) {
        super(context, attrs);
        init();
    }

    public CameraLivePreview(Context context, AttributeSet attrs, 
            int defStyle) {
        super(context, attrs, defStyle);
        init();
    }
    
    private void init() {
        holder = getHolder();
        holder.addCallback(this);
        holder.setType(SurfaceHolder.SURFACE_TYPE_PUSH_BUFFERS);
    }
    
    public void surfaceCreated(SurfaceHolder holder) {
        // surface created
        // we can tell the camera to render
        // into the surface
        // but it's not ready to preview yet
        camera = Camera.open();
        try {
            camera.setPreviewDisplay(holder);
        } catch (IOException exception) {
            camera.release();
            camera = null;
        }
    }

    public void surfaceDestroyed(SurfaceHolder holder) {
        // surface destroyed
        // we must tell the camera to stop it preview
        camera.stopPreview();
        camera.release();
        camera = null;
    }

    public void surfaceChanged(SurfaceHolder holder, 
            int format, int w, int h) {
        // we get the surface dimensions
        // we can configure the preview
        Camera.Parameters parameters = camera.getParameters();

        List<Size> sizes = parameters.getSupportedPreviewSizes();
        Size optimalSize = getOptimalPreviewSize(sizes, w, h);
        parameters.setPreviewSize(optimalSize.width, optimalSize.height);

        camera.setParameters(parameters);
        
        // let render
        camera.startPreview();
        camera.setPreviewCallback(frameCallback);
    }

    private Size getOptimalPreviewSize(List<Size> sizes, int w, int h) {
        
        // requirement
        final double ASPECT_TOLERANCE = 0.05;
        
        double targetRatio = (double) w / h;
        if (sizes == null) {
            return null;
        }

        Size optimalSize = null;
        double minDiff = Double.MAX_VALUE;

        int targetHeight = h;

        // find a size that match aspect ratio and size
        for (Size size : sizes) {
            double ratio = (double) size.width / size.height;
            if (Math.abs(ratio - targetRatio) > ASPECT_TOLERANCE)
                continue;
            if (Math.abs(size.height - targetHeight) < minDiff) {
                optimalSize = size;
                minDiff = Math.abs(size.height - targetHeight);
            }
        }

        // it's not possible
        // ignore the requirement
        if (optimalSize == null) {
            minDiff = Double.MAX_VALUE;
            for (Size size : sizes) {
                if (Math.abs(size.height - targetHeight) < minDiff) {
                    optimalSize = size;
                    minDiff = Math.abs(size.height - targetHeight);
                }
            }
        }
        
        return optimalSize;
    }

    public void takePhoto() {
        // take a photo :
        // 1 - auto focus
        // 2 - take the picture in the auto focus callback
        camera.autoFocus(autoFocusCallback);
    }

}
N'hésitez pas à partager vos création utilisant l'API Camera.
Fork me on GitHub