Android開発 JSONをVolleyで取得して、お天気アプリを作る

JSONデータを返すAPIを叩いて、ビューに表示するだけの簡単なAndroidサンプルアプリです。
APIを叩くときには、Androidの非同期HTTP通信ライブラリである”Volley”を使います。
今回のアプリは、この、Volleyのトレーニング目的で作ってみました。
APIは、livedoor 天気情報のAPIを利用します。（http://weather.livedoor.com/weather_hacks/webservice）

さて、このVolleyとはいったい何でしょうか？
こちらの記事が参考になります。

ネットワーク通信用ライブラリVolleyを使いこなす | Tech Booster
http://techbooster.org/android/hacks/16474/

Android SDKでは非同期処理(またはマルチスレッド化)のための機構が用意されています。AsyncTaskやService、それらを拡張したAsyncTaskLoader、IntentServiceが代表的です。さらに汎用的に使えるHandler、ApacheのHttpClient、JavaのExecutorService、Threadなど非同期処理のための仕組みが豊富に存在していますが非同期でのキャンセル処理や取得済みデータのキャッシュ方法など周辺技術と組み合わせて設計しないといけません。
Android SDKの標準APIは応用力が高いのですが、習得するまでの難しさ、エラー処理、各バージョンごとの実装差異が存在しています。これらの課題を解消するためにVolleyライブラリが作られました。

以前、Apache HTTP Client（DefaultHttpClient）を使ったサンプルアプリを作ったことがあるのですが、どうやら、最近のAndroidでは、メインスレッドからネットワーク処理を行うことを許していないそうで。別スレッドを立ち上げてHTTPの処理を実行したり、さらに、これが別スレッドであるがためにViewに情報を渡そうとすると、ハンドラを生成したりと案外面倒だった記憶があります。Volleyは、この複雑だった処理を簡潔に書けるようにします。
Volleyは、ネットワークリクエストとキャッシュをスレッドプールを使って、それぞれの通信処理をリクエストという単位でキューイングして処理を捌きます。そして、コールバックで処理結果がUIスレッドに渡されます。
ネットワーク経由で取得した情報をビューへ渡すための処理をVolleyに任せる感じです。

Android StudioのプロジェクトにVolleyを導入

app/build.gradleファイルを編集、compile行を追記。

dependencies {
    ...
    compile 'com.android.volley:volley:1.0.0'
}

この状態で、Android StudioのメニューからBuild -> Make Projectしてみてください。エラーが出なかったらVolleyライブラリ導入成功です。

Volleyを使ったサンプルコード

以下、サンプルコードです。

	<RelativeLayout 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:paddingLeft="@dimen/activity_horizontal_margin"
	android:paddingRight="@dimen/activity_horizontal_margin"
	android:paddingTop="@dimen/activity_vertical_margin"
	android:paddingBottom="@dimen/activity_vertical_margin" tools:context=".MainActivity">

	<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
	android:layout_width="match_parent"
	android:layout_height="match_parent"
	android:orientation="vertical">

	<TextView
	android:id="@+id/textview_title"
	android:layout_width="wrap_content"
	android:layout_height="wrap_content"
	android:textSize="@dimen/abc_text_size_large_material"
	android:textColor="@android:color/black"
	android:background="#ffb8db83" />

	<ListView
	android:id="@+id/listview_forecasts"
	android:layout_width="fill_parent"
	android:layout_height="wrap_content"
	android:background="#ffbff8ec" />

	<ScrollView
	android:layout_width="match_parent"
	android:layout_height="match_parent">

	<TextView
	android:id="@+id/textview_description"
	android:layout_width="wrap_content"
	android:layout_height="wrap_content"
	android:background="#ffffffff"
	android:textColor="@android:color/black" />

	</ScrollView>

	</LinearLayout>

	</RelativeLayout>

view raw activity_main.xml hosted with ❤ by GitHub

	<?xml version="1.0" encoding="utf-8"?>
	<manifest xmlns:android="http://schemas.android.com/apk/res/android"
	package="com.example.yako.volleyinstalltest" >

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

	<application
	android:name="AppController"
	android:allowBackup="true"
	android:icon="@mipmap/ic_launcher"
	android:label="@string/app_name"
	android:theme="@style/AppTheme" >
	<activity
	android:name=".MainActivity"
	android:label="@string/app_name" >
	<intent-filter>
	<action android:name="android.intent.action.MAIN" />

	<category android:name="android.intent.category.LAUNCHER" />
	</intent-filter>
	</activity>
	</application>

	</manifest>

view raw AndroidManifest.xml hosted with ❤ by GitHub

	package com.example.yako.volleyinstalltest;

	import android.app.Application;
	import android.text.TextUtils;

	import com.android.volley.Request;
	import com.android.volley.RequestQueue;
	import com.android.volley.toolbox.JsonObjectRequest;
	import com.android.volley.toolbox.Volley;

	/**
	* AppController
	*/
	public class AppController extends Application {

	public static final String TAG = AppController.class
	.getSimpleName();

	private RequestQueue mRequestQueue;

	private static AppController mInstance;

	@Override
	public void onCreate() {
	super.onCreate();
	mInstance = this;
	}

	public static synchronized AppController getInstance() {
	return mInstance;
	}

	public RequestQueue getRequestQueue() {
	if (mRequestQueue == null) {
	mRequestQueue = Volley.newRequestQueue(getApplicationContext());
	}

	return mRequestQueue;
	}


	public <T> void addToRequestQueue(JsonObjectRequest req, String tag) {
	// set the default tag if tag is empty
	req.setTag(TextUtils.isEmpty(tag) ? TAG : tag);
	getRequestQueue().add(req);
	}

	public <T> void addToRequestQueue(Request<T> req) {
	req.setTag(TAG);
	getRequestQueue().add(req);
	}

	public void cancelPendingRequests(Object tag) {
	if (mRequestQueue != null) {
	mRequestQueue.cancelAll(tag);
	}
	}
	}

view raw AppController.java hosted with ❤ by GitHub

	apply plugin: 'com.android.application'

	android {
	compileSdkVersion 22
	buildToolsVersion "22.0.1"

	defaultConfig {
	applicationId "com.example.yako.volleyinstalltest"
	minSdkVersion 15
	targetSdkVersion 22
	versionCode 1
	versionName "1.0"
	}
	buildTypes {
	release {
	minifyEnabled false
	proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
	}
	}
	}

	dependencies {
	compile fileTree(dir: 'libs', include: ['*.jar'])
	compile 'com.android.support:appcompat-v7:22.2.0'
	compile 'com.android.volley:volley:1.0.0'
	}

view raw build.gradle hosted with ❤ by GitHub

	package com.example.yako.volleyinstalltest;

	import android.support.v7.app.ActionBarActivity;
	import android.os.Bundle;
	import android.view.Menu;
	import android.view.MenuItem;
	import android.app.Activity;
	import android.app.ProgressDialog;
	import android.os.Bundle;
	import android.util.Log;
	import android.widget.ArrayAdapter;
	import android.widget.ListView;
	import android.widget.TextView;
	import com.android.volley.AuthFailureError;
	import com.android.volley.NetworkError;
	import com.android.volley.NoConnectionError;
	import com.android.volley.ParseError;
	import com.android.volley.Request;
	import com.android.volley.Response;
	import com.android.volley.ServerError;
	import com.android.volley.TimeoutError;
	import com.android.volley.VolleyError;
	import com.android.volley.VolleyLog;
	import com.android.volley.toolbox.JsonObjectRequest;
	import org.json.JSONArray;
	import org.json.JSONException;
	import org.json.JSONObject;

	public class MainActivity extends ActionBarActivity {

	// JSONデータ取得URL
	private final String URL_API = "http://weather.livedoor.com/forecast/webservice/json/v1?city=130010";

	// Volleyでリクエスト時に設定するタグ名、キャンセル時に利用クラス名をタグ指定
	private static final Object TAG_REQUEST_QUEUE = MainActivity.class.getName();

	// 地区名用テキストビュー
	TextView textview_title;

	// 地区名用テキストビュー
	TextView textview_description;

	// 予報表示用リストビューのアダプター
	ArrayAdapter<String> adapter;

	// ログ出力用のタグ
	private static final String TAG = MainActivity.class.getSimpleName();

	// Volleyへ渡すタグ
	String tag_json_obj = "json_obj_req";

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

	Log.e(TAG, "onCreate");

	// ビューを設定
	// 地区名
	textview_title = (TextView) findViewById(R.id.textview_title);
	// 予報
	ListView listview_forecasts = (ListView) findViewById(R.id.listview_forecasts);
	adapter = new ArrayAdapter<String>(this, android.R.layout.simple_list_item_1);
	listview_forecasts.setAdapter(adapter);
	// 天気概況
	textview_description = (TextView) findViewById(R.id.textview_description);

	// リクエスト処理
	request();
	}

	// リクエスト処理
	private void request() {
	// ロードダイアログ表示
	final ProgressDialog pDialog = new ProgressDialog(this);
	pDialog.setMessage("Loading...");
	pDialog.show();

	JsonObjectRequest jsonObjReq = new JsonObjectRequest(Request.Method.GET, URL_API, null,
	new Response.Listener<JSONObject>() {
	// レスポンス受信のリスナー
	@Override
	public void onResponse(JSONObject response) {
	// ログ出力
	Log.d(TAG, "onResponse: " + response.toString());

	// ロードダイアログ終了
	pDialog.hide();

	try {
	// 地区名を取得、テキストビューに登録
	String title = response.getString("title");
	textview_title.setText(title);

	// 天気概況文を取得、テキストビューに登録
	JSONObject description = response.getJSONObject("description");
	String description_text = description.getString("text");
	textview_description.setText(description_text);

	// 天気予報の予報日毎の配列を取得
	JSONArray forecasts = response.getJSONArray("forecasts");
	for (int i = 0; i < forecasts.length(); i++) {
	JSONObject forecast = forecasts.getJSONObject(i);
	// 日付を取得
	String date = forecast.getString("date");
	// 予報を取得
	String telop = forecast.getString("telop");
	// リストビューに登録
	adapter.add(date + ":" + telop);
	}
	} catch (JSONException e) {
	Log.e(TAG, e.getMessage());
	}
	}
	},
	new Response.ErrorListener() {
	// リクエストエラーのリスナー
	@Override
	public void onErrorResponse(VolleyError error) {
	// ロードダイアログ終了
	pDialog.hide();

	// エラー処理
	Log.d(TAG, "Error: " + error.getMessage());

	if( error instanceof NetworkError) {
	} else if( error instanceof ServerError) {
	} else if( error instanceof AuthFailureError) {
	} else if( error instanceof ParseError) {
	} else if( error instanceof NoConnectionError) {
	} else if( error instanceof TimeoutError) {
	}
	}

	}
	);

	// シングルトンクラスで実行
	AppController.getInstance().addToRequestQueue(jsonObjReq, tag_json_obj);
	}

	@Override
	public boolean onCreateOptionsMenu(Menu menu) {
	// Inflate the menu; this adds items to the action bar if it is present.
	getMenuInflater().inflate(R.menu.menu_main, menu);
	return true;
	}

	@Override
	public boolean onOptionsItemSelected(MenuItem item) {
	// Handle action bar item clicks here. The action bar will
	// automatically handle clicks on the Home/Up button, so long
	// as you specify a parent activity in AndroidManifest.xml.
	int id = item.getItemId();

	//noinspection SimplifiableIfStatement
	if (id == R.id.action_settings) {
	return true;
	}

	return super.onOptionsItemSelected(item);
	}
	}

view raw MainActivity.java hosted with ❤ by GitHub

include ':app'

view raw settings.gradle hosted with ❤ by GitHub

以下の資料を参考にしました。

Transmitting Network Data Using Volley | Android Developers
https://developer.android.com/training/volley/index.html
Android working with Volley Library
http://www.androidhive.info/2014/05/android-working-with-volley-library-1/
Volleyについて調べる(1) - 未処分利益
http://www.vagrantup.jp/entry/2013/12/07/164310
Volley 基礎 (Android アプリ用ネットワークライブラリ) - ひだまりソケットは壊れない
http://vividcode.hatenablog.com/entry/android-app/volley-basis
Android - Volleyの起動・停止・キャンセル - Qiita
http://qiita.com/ueno-yuhei/items/d81dc638951ce3f6988a
ケーワン・エンタープライズのエンジニアメモ(｀･ω･´)ゞﾋﾞｼｯ!!: Volleyを使ってみる（JsonArrayRequest、JsonObjectRequest編）
http://k-1-ne-jp.blogspot.jp/2013/09/volleyjsonrequestjsonarrayrequestjsonob.html
【Android】Volleyを使ってネットワーク通信その２実装編【ライブラリ】 | 手巻き式IT
http://temakishiki.com/?p=141

2015年7月18日土曜日

Android開発 JSONをVolleyで取得して、お天気アプリを作る

Author

Search

Archive