Androidでオブジェクト/XMLマッピング

TwitterクライアントなどXMLやJSONをWeb上から取得してアプリに表示することは少なくない。
しかし、XMLやJSONをパースするような単調な処理は出来るだけ無くしたいので、
Spring AndroidとSimple(xmlシリアルフレームワーク)を使用してXMLデータを取得し、
アプリに表示させてみた。
今回はイベント開催支援ツールのATNDのAPIを使用してAndroid系イベントを取得して
イベントタイトルとイベント日時をアプリにリスト表示してみる。
実際に使用するAPI→http://api.atnd.org/events/?keyword=android&format=xml
サンプルプロジェクトのダウンロードリンクは記事の最後。

まず前エントリーを参考にMavenプロジェクトからAndroidプロジェクトを作成。

pom.xmlを追記

view plainprint?

1. <dependency>  
2.   <groupId>org.simpleframework</groupId>  
3.   <artifactId>simple-xml</artifactId>  
4.   <version>2.6.1</version>  
5.   <exclusions>  
6.     <exclusion>  
7.       <artifactId>stax</artifactId>  
8.       <groupId>stax</groupId>  
9.       </exclusion>  
10.       <exclusion>  
11.         <artifactId>stax-api</artifactId>  
12.         <groupId>stax</groupId>  
13.       </exclusion>  
14.       <exclusion>  
15.         <artifactId>xpp3</artifactId>  
16.         <groupId>xpp3</groupId>  
17.       </exclusion>  
18.   </exclusions>  
19. </dependency>  
20. <dependency>  
21.   <groupId>org.springframework.android</groupId>  
22.   <artifactId>spring-android-rest-template</artifactId>  
23.   <version>1.0.0.M4</version>  
24. </dependency>  
25.   
26. <repositories>  
27.   <repository>  
28.     <id>org.springframework.maven.milestone</id>  
29.     <name>Spring Maven Milestone Repository</name>  
30.     <url>http://maven.springframework.org/milestone</url>  
31.     <snapshots><enabled>false</enabled></snapshots>  
32.   </repository>  
33. </repositories>  

<dependency>
  <groupId>org.simpleframework</groupId>
  <artifactId>simple-xml</artifactId>
  <version>2.6.1</version>
  <exclusions>
    <exclusion>
      <artifactId>stax</artifactId>
      <groupId>stax</groupId>
      </exclusion>
      <exclusion>
        <artifactId>stax-api</artifactId>
        <groupId>stax</groupId>
      </exclusion>
      <exclusion>
        <artifactId>xpp3</artifactId>
        <groupId>xpp3</groupId>
      </exclusion>
  </exclusions>
</dependency>
<dependency>
  <groupId>org.springframework.android</groupId>
  <artifactId>spring-android-rest-template</artifactId>
  <version>1.0.0.M4</version>
</dependency>

<repositories>
  <repository>
    <id>org.springframework.maven.milestone</id>
    <name>Spring Maven Milestone Repository</name>
    <url>http://maven.springframework.org/milestone</url>
    <snapshots><enabled>false</enabled></snapshots>
  </repository>
</repositories>

次にXMLデータをマッピングさせるオブジェクトを作成する。
要素には@Element、属性には@Attributeをつける。
@Element、@Attributeのnameは要素名(属性名)と変数名が同じであれば省略可能。
XMLのすべての要素をオブジェクトにマッピングしない場合は@Rootアノテーションにstrict = false
をつける必要がある。
Event.java

view plainprint?

1. package jp.u1aryz.products.atndsearch;  
2.   
3. import org.simpleframework.xml.Element;  
4. import org.simpleframework.xml.Root;  
5.   
6. @Root(name = "event", strict = false)  
7. public class Event {  
8.   
9.     @Element  
10.     private String title;  
11.   
12.     @Element(name = "started_at")  
13.     private String eventDate;  
14.   
15.     public void setTitle(String title) {  
16.         this.title = title;  
17.     }  
18.   
19.     public String getTitle() {  
20.         return title;  
21.     }  
22.   
23.     public void setEventDate(String eventDate) {  
24.         this.eventDate = eventDate;  
25.     }  
26.   
27.     public String getEventDate() {  
28.         return eventDate;  
29.     }  
30. }  

package jp.u1aryz.products.atndsearch;

import org.simpleframework.xml.Element;
import org.simpleframework.xml.Root;

@Root(name = "event", strict = false)
public class Event {

    @Element
    private String title;

    @Element(name = "started_at")
    private String eventDate;

    public void setTitle(String title) {
        this.title = title;
    }

    public String getTitle() {
        return title;
    }

    public void setEventDate(String eventDate) {
        this.eventDate = eventDate;
    }

    public String getEventDate() {
        return eventDate;
    }
}

リストの場合は@ElementListアノテーションを使う。
EventList.java

view plainprint?

1. package jp.u1aryz.products.atndsearch;  
2.   
3. import java.util.List;  
4.   
5. import org.simpleframework.xml.ElementList;  
6. import org.simpleframework.xml.Root;  
7.   
8. @Root(name = "events", strict = false)  
9. public class EventList {  
10.   
11.     @ElementList  
12.     private List<Event> events;  
13.   
14.     public void setEvents(List<Event> events) {  
15.         this.events = events;  
16.     }  
17.   
18.     public List<Event> getEvents() {  
19.         return events;  
20.     }  
21. }  

package jp.u1aryz.products.atndsearch;

import java.util.List;

import org.simpleframework.xml.ElementList;
import org.simpleframework.xml.Root;

@Root(name = "events", strict = false)
public class EventList {

    @ElementList
    private List<Event> events;

    public void setEvents(List<Event> events) {
        this.events = events;
    }

    public List<Event> getEvents() {
        return events;
    }
}

そしてXMLデータからオブジェクトにマッピングさせる処理を作成する。
HTTP通信は通常、UIスレッドとは別のスレッドで行うため、今回のポイントとなる処理も
doInBackground内に入れる。
GetAndroidEventActivity.java

view plainprint?

1. package jp.u1aryz.products.atndsearch;  
2.   
3. import java.util.ArrayList;  
4. import java.util.List;  
5.   
6. import org.springframework.http.HttpEntity;  
7. import org.springframework.http.HttpHeaders;  
8. import org.springframework.http.HttpMethod;  
9. import org.springframework.http.MediaType;  
10. import org.springframework.http.ResponseEntity;  
11. import org.springframework.web.client.RestTemplate;  
12.   
13. import android.app.ListActivity;  
14. import android.app.ProgressDialog;  
15. import android.os.AsyncTask;  
16. import android.os.Bundle;  
17. import android.util.Log;  
18.   
19. public class GetAndroidEventActivity extends ListActivity {  
20.   
21.     private static String TAG = GetAndroidEventActivity.class.getSimpleName();  
22.     private ProgressDialog progressDialog;  
23.   
24.     @Override  
25.     public void onCreate(Bundle savedInstanceState) {  
26.         super.onCreate(savedInstanceState);  
27.     }  
28.   
29.     @Override  
30.     protected void onStart() {  
31.         super.onStart();  
32.         // ATND APIの呼び出しを非同期で行う  
33.         new GetEventTask().execute();  
34.     }  
35.   
36.     private void refreshEvents(List<Event> events) {  
37.         if (events != null) {  
38.             EventListAdapter adapter = new EventListAdapter(this, events);  
39.             setListAdapter(adapter);  
40.         }  
41.     }  
42.   
43.     public void showProgressDialog() {  
44.         if (progressDialog == null) {  
45.             progressDialog = new ProgressDialog(this);  
46.             progressDialog.setIndeterminate(true);  
47.         }  
48.   
49.         progressDialog.setMessage("Loading. Please wait...");  
50.         progressDialog.show();  
51.     }  
52.   
53.     public void dismissProgressDialog() {  
54.         if (progressDialog != null) {  
55.             progressDialog.dismiss();  
56.         }  
57.     }  
58.   
59.     private class GetEventTask extends AsyncTask<Void, Void, List<Event>> {  
60.   
61.         @Override  
62.         protected void onPreExecute() {  
63.             // プログレスバーを表示  
64.             showProgressDialog();  
65.         }  
66.   
67.         @Override  
68.         protected List<Event> doInBackground(Void... params) {  
69.             try {  
70.                 // Android関連のイベントを検索するURL  
71.                 String url =  
72.                     "http://api.atnd.org/events/?keyword=android&format=xml";  
73.                 // Acceptヘッダに"application/xml"をセット  
74.                 HttpHeaders requestHeaders = new HttpHeaders();  
75.                 List<MediaType> acceptableMediaTypes =  
76.                     new ArrayList<MediaType>();  
77.                 acceptableMediaTypes.add(MediaType.APPLICATION_XML);  
78.                 requestHeaders.setAccept(acceptableMediaTypes);  
79.   
80.                 HttpEntity<?> requestEntity =  
81.                     new HttpEntity<Object>(requestHeaders);  
82.                 RestTemplate restTemplate = new RestTemplate();  
83.   
84.                 // HTTPのGETリクエストを実行(マッピングさせるクラスを指定する)  
85.                 ResponseEntity<EventList> responseEntity =  
86.                     restTemplate.exchange(url,  
87.                                         HttpMethod.GET,  
88.                                         requestEntity,  
89.                                         EventList.class);  
90.   
91.                 // イベントリストを取得  
92.                 EventList eventList = responseEntity.getBody();  
93.   
94.                 return eventList.getEvents();  
95.             } catch (Exception e) {  
96.                 Log.e(TAG, e.getMessage(), e);  
97.             }  
98.   
99.             return null;  
100.         }  
101.   
102.         @Override  
103.         protected void onPostExecute(List<Event> result) {  
104.             // プログレスバーを非表示  
105.             dismissProgressDialog();  
106.   
107.             // 結果を返す  
108.             refreshEvents(result);  
109.         }  
110.     }  
111. }  

package jp.u1aryz.products.atndsearch;

import java.util.ArrayList;
import java.util.List;

import org.springframework.http.HttpEntity;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpMethod;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.web.client.RestTemplate;

import android.app.ListActivity;
import android.app.ProgressDialog;
import android.os.AsyncTask;
import android.os.Bundle;
import android.util.Log;

public class GetAndroidEventActivity extends ListActivity {

    private static String TAG = GetAndroidEventActivity.class.getSimpleName();
    private ProgressDialog progressDialog;

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

    @Override
    protected void onStart() {
        super.onStart();
        // ATND APIの呼び出しを非同期で行う
        new GetEventTask().execute();
    }

    private void refreshEvents(List<Event> events) {
        if (events != null) {
            EventListAdapter adapter = new EventListAdapter(this, events);
            setListAdapter(adapter);
        }
    }

    public void showProgressDialog() {
        if (progressDialog == null) {
            progressDialog = new ProgressDialog(this);
            progressDialog.setIndeterminate(true);
        }

        progressDialog.setMessage("Loading. Please wait...");
        progressDialog.show();
    }

    public void dismissProgressDialog() {
        if (progressDialog != null) {
            progressDialog.dismiss();
        }
    }

    private class GetEventTask extends AsyncTask<Void, Void, List<Event>> {

        @Override
        protected void onPreExecute() {
            // プログレスバーを表示
            showProgressDialog();
        }

        @Override
        protected List<Event> doInBackground(Void... params) {
            try {
                // Android関連のイベントを検索するURL
                String url =
                    "http://api.atnd.org/events/?keyword=android&format=xml";
                // Acceptヘッダに"application/xml"をセット
                HttpHeaders requestHeaders = new HttpHeaders();
                List<MediaType> acceptableMediaTypes =
                    new ArrayList<MediaType>();
                acceptableMediaTypes.add(MediaType.APPLICATION_XML);
                requestHeaders.setAccept(acceptableMediaTypes);

                HttpEntity<?> requestEntity =
                    new HttpEntity<Object>(requestHeaders);
                RestTemplate restTemplate = new RestTemplate();

                // HTTPのGETリクエストを実行(マッピングさせるクラスを指定する)
                ResponseEntity<EventList> responseEntity =
                    restTemplate.exchange(url,
                                        HttpMethod.GET,
                                        requestEntity,
                                        EventList.class);

                // イベントリストを取得
                EventList eventList = responseEntity.getBody();

                return eventList.getEvents();
            } catch (Exception e) {
                Log.e(TAG, e.getMessage(), e);
            }

            return null;
        }

        @Override
        protected void onPostExecute(List<Event> result) {
            // プログレスバーを非表示
            dismissProgressDialog();

            // 結果を返す
            refreshEvents(result);
        }
    }
}

最後にViewに取得したデータをセットするAdapterの作成。
特別な処理はしていないので、通常のAndroidの知識で理解出来ると思う。
EventListAdapter.java

view plainprint?

1. package jp.u1aryz.products.atndsearch;  
2.   
3. import java.util.List;  
4.   
5. import android.content.Context;  
6. import android.view.LayoutInflater;  
7. import android.view.View;  
8. import android.view.ViewGroup;  
9. import android.widget.ArrayAdapter;  
10. import android.widget.TextView;  
11.   
12. public class EventListAdapter extends ArrayAdapter<Event> {  
13.   
14.     private LayoutInflater mInflater;  
15.   
16.     public EventListAdapter(Context context, List<Event> objects) {  
17.         super(context, 0, objects);  
18.         mInflater = LayoutInflater.from(context);  
19.     }  
20.   
21.     @Override  
22.     public View getView(int position, View convertView, ViewGroup parent) {  
23.         ViewHolder holder;  
24.   
25.         if (convertView == null) {  
26.             convertView =  
27.                 mInflater.inflate(android.R.layout.simple_list_item_2, null);  
28.             holder = new ViewHolder();  
29.             holder.title =  
30.                 (TextView) convertView.findViewById(android.R.id.text1);  
31.             holder.eventDate =  
32.                 (TextView) convertView.findViewById(android.R.id.text2);  
33.             convertView.setTag(holder);  
34.         } else {  
35.             holder = (ViewHolder) convertView.getTag();  
36.         }  
37.   
38.         Event event = getItem(position);  
39.         holder.title.setText(event.getTitle());  
40.         holder.eventDate.setText(event.getEventDate());  
41.   
42.         return convertView;  
43.     }  
44.   
45. }  
46. class ViewHolder {  
47.     TextView title;  
48.     TextView eventDate;  
49. }  

package jp.u1aryz.products.atndsearch;

import java.util.List;

import android.content.Context;
import android.view.LayoutInflater;
import android.view.View;
import android.view.ViewGroup;
import android.widget.ArrayAdapter;
import android.widget.TextView;

public class EventListAdapter extends ArrayAdapter<Event> {

    private LayoutInflater mInflater;

    public EventListAdapter(Context context, List<Event> objects) {
        super(context, 0, objects);
        mInflater = LayoutInflater.from(context);
    }

    @Override
    public View getView(int position, View convertView, ViewGroup parent) {
        ViewHolder holder;

        if (convertView == null) {
            convertView =
                mInflater.inflate(android.R.layout.simple_list_item_2, null);
            holder = new ViewHolder();
            holder.title =
                (TextView) convertView.findViewById(android.R.id.text1);
            holder.eventDate =
                (TextView) convertView.findViewById(android.R.id.text2);
            convertView.setTag(holder);
        } else {
            holder = (ViewHolder) convertView.getTag();
        }

        Event event = getItem(position);
        holder.title.setText(event.getTitle());
        holder.eventDate.setText(event.getEventDate());

        return convertView;
    }

}
class ViewHolder {
    TextView title;
    TextView eventDate;
}

<uses-permission android:name="android.permission.INTERNET" />を忘れなければ
下記のようにイベントを取得出来る。
日時のフォーマットが見づらいけど。。。

これで単調なパース処理とおさらば〜
時間があればJSONバージョンもやるかも！？

ダウンロードはこちらから