Ringster's Techblog

Tech, Mobile, Internet

Archive for 12월 3rd, 2014

Volley를 이용해 Network Data 전송하기 (2) – Request Queue 설정하기

leave a comment »

지난 포스팅(여기)에서 Volley를 이용하여 Network Data 전송을 하기 위해서는
1) RequestQueue 생성, 2) Request Object 생성,  3) 생성한 Object를 RequestQueue로 전달의 3단계가 필요하다고 하였다.
지난 포스팅에서는 RequestQueue를 생성하지 않고, Volley의 편의 메소드를 이용하여 RequestQueue를 생성하였는데,
이번에는 직접 RequestQueue를 생성하여 custom action을 가능하도록 하는 법을 알아보겠다.


1. Network 및 Cache 설정하기

RequestQueue는 작업을 위해 Request를 처리할 network 와 cache가 필요하다. volley는 toolbox에
one-file-per-response cache를 제공하는 DiskBasedCache와 개발자의 선택에 따라 AndroidHttpClient나
HttpURLConnection을 이용하는 BasicNetwork의 기본 구현을 제공한다. BasicNetwork는 HttpClient로
초기화되어야 하는데, 보통 HttpURLConnection이나 AndroidHttpClient가 쓰인다.

HttpURLConnection은 API Level 9 이하에서 안정적이지 않으므로 API Level 9 이하에서는 AndroidHttpClient를
사용하고, 이후에는 HttpURLConnection을 사용하도록 하려면 다음과 같이 기기가 어떤 Android Version에서
구동되는지 확인하는 코드를 이용한다.

HttpStack stack;
...
// If the device is running a version >= Gingerbread...
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.GINGERBREAD) {
    // ...use HttpURLConnection for stack.
} else {
    // ...use AndroidHttpClient for stack.
}
Network network = new BasicNetwork(stack);

 Volley에서는 기본적으로 API Level 9 이하에서는 AndroidHttpClient를 그 이후에는
HttpURLConnection을 이용한다.
그럼 Customized된 Request Queue를 이용해  SimpleRequest 전송 시와 동일한 동작을 하는 코드를 보자

public class MainActivity extends ActionBarActivity {
	private final String url = "http://www.google.com";
	
	@Override
	protected void onCreate(Bundle savedInstanceState) {
		super.onCreate(savedInstanceState);
		setContentView(R.layout.activity_main);
		final TextView mTextView = (TextView) findViewById(R.id.text);
		
		RequestQueue mRequestQueue;

		// Instantiate the cache
		Cache cache = new DiskBasedCache(getCacheDir(), 1024 * 1024); // 1MB cap

		// Set up the network to use HttpURLConnection as the HTTP client.
		Network network = new BasicNetwork(new HurlStack());
		

		// Instantiate the RequestQueue with the cache and network.
		mRequestQueue = new RequestQueue(cache, network);

		// Start the queue
		mRequestQueue.start();

		// Formulate the request and handle the response.
		StringRequest stringRequest = new StringRequest(Request.Method.GET, url,
		        new Response.Listener<String>() {
		    @Override
		    public void onResponse(String response) {
		    	mTextView.setText("Response is: "+ response.substring(0,500));
		    }
		},
		    new Response.ErrorListener() {
		        @Override
		        public void onErrorResponse(VolleyError error) {
		        	mTextView.setText(error.toString());
		    }
		});

		// Add the request to the RequestQueue.
		mRequestQueue.add(stringRequest);
	}
}

1회성 네트워크 작업을 할때는 RequestQueue를 생성한 후 RequestQueue.stop() 을 통해 작업을 종료시킬 수
있지만, 이러한 단순한 작업은 volley.newRequestQueue()를 이용하고 커스톰 RequestQueue는 Singleton으로
생성하여 App의 Lifetime 동안 존재하도록 구현하는 것이 일반적이다.

2. Singleton Pattern 사용하기

Application이 지속적으로 네트워크 작업을 한다면,  App의 Lifetime동안 존재할 RequestQueue 인스턴스가 있는
것이 효과적이다. 이는 여러가지 접근 방법을 통해 구현 가능한데 하나의 Singleton class를 생성하여
RequestQueue 및 사용할 volley function 들을 캡슐화하거나, Application의 Subclass를 생성하여 Application의
onCreate()메소드에서 requestQueue를 설정하면 된다.
두번째 방법보다는 첫번째 방법이  S/W의 모듈화에 좋으므로 첫번째 방법을 사용하기로 하며,
요점은 RequestQueue를 Activity context가 아닌 Application의 context를 통해 초기화하여
계속해서 재생성되지 않도록 하는 것이다.

 RequestQueue와 ImageLoader를 제공하는 Singleton Class를 생성해보자. (ImageLoader는 다음편에 설명)

public class MySingleton {
    private static MySingleton mInstance;
    private RequestQueue mRequestQueue;
    private ImageLoader mImageLoader;
    private static Context mCtx;

    private MySingleton(Context context) {
        mCtx = context;
        mRequestQueue = getRequestQueue();

        mImageLoader = new ImageLoader(mRequestQueue,
                new ImageLoader.ImageCache() {
            private final LruCache<String, Bitmap>
                    cache = new LruCache<String, Bitmap>(20);

            @Override
            public Bitmap getBitmap(String url) {
                return cache.get(url);
            }

            @Override
            public void putBitmap(String url, Bitmap bitmap) {
                cache.put(url, bitmap);
            }
        });
    }

    public static synchronized MySingleton getInstance(Context context) {
        if (mInstance == null) {
            mInstance = new MySingleton(context);
        }
        return mInstance;
    }

    public RequestQueue getRequestQueue() {
        if (mRequestQueue == null) {
            // getApplicationContext() is key, it keeps you from leaking the
            // Activity or BroadcastReceiver if someone passes one in.
            mRequestQueue = Volley.newRequestQueue(mCtx.getApplicationContext());
        }
        return mRequestQueue;
    }

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

    public ImageLoader getImageLoader() {
        return mImageLoader;
    }
}

이제 작성한 Singleton Class를 이용해 위해서 한 작업과 동일한 코드를 작성해보자.

public class MainActivity extends ActionBarActivity {
	private final String url = "http://www.google.com";
	
	@Override
	protected void onCreate(Bundle savedInstanceState) {
		super.onCreate(savedInstanceState);
		setContentView(R.layout.activity_main);
		final TextView mTextView = (TextView) findViewById(R.id.text);
		
		// Get a RequestQueue
		RequestQueue queue = MySingleton.getInstance(this.getApplicationContext()).
		    getRequestQueue();
		
		// Formulate the request and handle the response.
		StringRequest stringRequest = new StringRequest(Request.Method.GET, url,
		        new Response.Listener<String>() {
		    @Override
		    public void onResponse(String response) {
		    	mTextView.setText("Response is: "+ response.substring(0,500));
		    }
		},
		    new Response.ErrorListener() {
		        @Override
		        public void onErrorResponse(VolleyError error) {
		        	mTextView.setText(error.toString());
		    }
		});

		// Add a request (in this example, called stringRequest) to your RequestQueue.
		MySingleton.getInstance(this).addToRequestQueue(stringRequest);	
	}
}

이로서 Singleton pattern을 이용해 위에서 작성한 코드와 동일한 동작을 구현하였다.
다음 포스팅에서는 지금까지 사용해왔던 StringRequest를 비롯하여 ImageRequest, JSONObjectRequest 등
Standard Request를 사용하는 법을 알아보고, Singleton class에 추가한 ImageLoader의 사용법 또한 알아보겠다.

Written by Ringster

2014/12/03 at 11:03 am

Volley를 이용해 Network Data 전송하기 (1) – Simple Request 전송

leave a comment »

안드로이드 App을 제작하다보면 이미지 파일 업로드/다운로드, Json 형식의 응답 주고 받기 등
네트워크를 통한 데이터 전송을 빈번하게 사용한다. 이를 위해 가장 많이 쓰이는 방법은 AsyncTask를 생성하여
DoitBackground 메소드 내에서 네트워크 작업을 처리하는 것인데, 이러한 작업들을 좀더 쉽고 빠르게 하기 위해
Google은 2013년 Google I/O에서 volley라는 Http 라이브러리를 공개했다.

Google Volley에 대한 자세한 설명은 Naver의 정상혁 님이 쓰신 글(여기)이나
Google I/O 발표자료 (110 – Volley- Easy,Fast Networking for Android)를 참조하기로 하고,
Google 개발자 튜토리얼(여기)을 참조하여 Volley를 이용해 네트워크 데이터를 처리하는 방법을 알아보도록 하자.


1. Volley Library Download 받기 및 프로젝트에 추가하여 사용준비 하기

먼저 다음 명령어를 실행하여 git repository에서 volley를 다운로드 받는다.

git clone https://android.googlesource.com/platform/frameworks/volley

다음 명령어를 실행하여 build 환경을 재설정하고,

/Applications/adt-bundle-mac-x86_64-20140321/sdk/tools/android update project -p .

volley를 다운받은 폴더에서 lib파일을 생성한다.

/Applications/apache-ant-1.9.4/bin/ant jar;

그 이후 Project의 libs 폴더 안에 생성된 volley.jar파일을 붙여넣는다. (Eclipse 기준)

마지막으로 AndroidMenifest.xml 파일에 android.permission.INTERNET 퍼미션을 추가한다.

2. newRequestQueue 사용하기

Volley를 사용하는 방법은 크게 3단계로 나뉜다.
1) RequestQueue를 생성한다. 2) Request Object를 생성한다. 3) 생성한 Object를 RequestQueue로 넘긴다.
이번 포스팅에서는 RequestQueue를 생성하는 편의 메소드인 newRequestQueue를 이용하여
간단한 네트워크 데이터 전송을 수행하는 방법을 알아보도록 하자.

final TextView mTextView = (TextView) findViewById(R.id.text);
...

// Instantiate the RequestQueue. 
// 1) 편의 메소드를 이용하여 RequestQueue 생성 및 초기화
RequestQueue queue = Volley.newRequestQueue(this);
String url = "http://www.google.com";

// Request a string response from the provided URL. 
// 2) Request Obejct인 StringRequest 생성
StringRequest stringRequest = new StringRequest(Request.Method.GET, url,
            new Response.Listener<String>() {
    @Override
    public void onResponse(String response) {
        // Display the first 500 characters of the response string.
        mTextView.setText("Response is: "+ response.substring(0,500));
    }
}, new Response.ErrorListener() {
    @Override
    public void onErrorResponse(VolleyError error) {
        mTextView.setText("That didn't work!");
    }
});
// 3) 생성한 StringRequest를 RequestQueue에 추가
queue.add(stringRequest);

Volley를 이용한 네트워크 응답은 언제나 main Thread로 전송되므로
response Handler를 통해 바로 Main UI에 접근할 수 있다.

add() 메소드를 수행하면 volley는 하나의 cache thread와 network dispatch thread pool을 실행시키고,
cache dispatcher를 통해 cache가 이용 가능한 Request는 cache 쓰레드로 보내고, 그렇지 않은 Request는
network thread로 보내 round robin 방식으로 처리한다.
처리된 결과는 쓰레드에 상관없이 모두 main Thread로 보내진다 (구조도 보기)

2. Request 취소하기

Request를 취소하기 위해서는 생성한 Request Object에 대하여 cancel() 메소드를 수행하면 된다.
volley는 cancel() 된 Object의 Response Handler가 수행되지 않음을 보장한다.
이는 Activity의 onStop() 메소드에서 모든 pending Request를 취소할 수 있고 onSaveInstanceState()가
호출되었든지 아니든지 간에 response Handler에서 getActivity()==null 체크나 기타 방어코드를 사용해가며
노력을 낭비할 필요가 없음을 의미한다.

이러한 장점을 얻기위해서는 모든 request를 적절한 시기에 취소하기 위해 추적해야 하는데,
이를 위한 간단한 방법이 있다.

바로 tag를 이용하여 모든 request를 tagging 하고 그 request의 적절한 취소 시기에 requestQueue.cancelAll(this)
메소드를 호출하는 것이다. 예를 들어서 다음과 같이 모든 request에 Tag를 추가하고,

public static final String TAG = "MyTag";
StringRequest stringRequest; // Assume this exists.
RequestQueue mRequestQueue;  // Assume this exists.

// Set the tag on the request.
stringRequest.setTag(TAG);

// Add the request to the RequestQueue.
mRequestQueue.add(stringRequest);

Activity의 onStop 메소드에서 해당 Tag를 이용하여 모든 Request를 취소하는 것이다

@Override
protected void onStop () {
    super.onStop();
    if (mRequestQueue != null) {
        mRequestQueue.cancelAll(TAG);
    }
}

이와 유사하게 ViewPager 는 page가 swipe될때 mRequestQueue.cancelAll(this)를 호출하여
기존 Request들을 취소하고 새로운 Request를 추가할 수 있다.

Written by Ringster

2014/12/03 at 8:51 am

Yurim Jin, Programmer&Designer

Fork my brain because I'm ready to commit

jamesjungkuelee's biotech story

Biotech, entrepreneur, life

Communications as Ikor

기업 위기관리의 모든 것

Charles Pyo Ventures

시도와 실패, 성장의 기록. 2막에서도 계속되는 모험들.

techNeedle 테크니들

글로벌 테크 소식을 인사이트와 함께 전달합니다

Open API, Cloud, DevOps 와 eBook

Open API, eBook, Cloud, DevOps

Economics of almost everything

Tech, Mobile, Internet

cylee

Tech, Mobile, Internet

gorekun.log

고어쿤로그

Google Developers Korea Blog

Tech, Mobile, Internet

Android Developers Blog

Tech, Mobile, Internet

최피디의 앱스 개발기

기술, 앱스, SNS, 창업

D2 Blog

Tech, Mobile, Internet

All of Software

Tech, Mobile, Internet

'Startup's Story Platform’

'Startup's Story Platform’