[Andorid] Volley 사용법

📌 Volley란?

웹 요청과 응답을 단순화하기 위해 만들어진 라이브러리로, 요청(Request) 객체를 만들어 요청 큐(RequestQueue)에 넣어주면 요청 큐가 알아서 웹 서버에 요청하고 응답까지 받아준다. 우리가 지정된 메서드를 만들어두면 응답이 왔을 때 그 메서드가 자동으로 호출된다. Volley 라이브러리의 장점은 스레드를 사용하지 않아도 된다는 점이다.

📌 Volley 라이브러리 추가하기

Volley는 외부 라이브러리이므로 build.gradle 파일에 정보를 추가해야 사용할 수 있다. Gradle Scripts > build.gradle(Module: ~) 에서 dependencies에 다음 코드를 추가한다.

implementation 'com.android.volley:volley:1.2.1'

📌 INTERNET 권한 추가하기

인터넷을 사용하기 때문에 AndroidManifest.xml 파일에 INTERNET 권한을 추가해야한다. 또 application 태그에 useCleartextTraffic속성을 true로 준다.

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

android:usesCleartextTraffic="true"

📌 웹 요청하기

입력상자에 사이트 주소를 입력하고 요청하기 버튼을 누르면 해당 주소로 웹 요청을 하도록 MainActivity.java 파일에 코드를 입력한다. 먼저 OnCreate() 메서드 안에 있는 코드를 보면 화면에 만든 요청하기 버튼(requestBtn)을 누를 시 makeRequest() 메서드가 실행되도록 했다. 그리고 요청 큐는 static 키워드로 클래식 변수를 선언 한 후 할당했다. 요청 큐는 한 번만 만들어 계속 사용할 수 있기 때문이다. 요청 큐는 하나의 액티비티에서만 사용하는 것이 아니라 앱 전체에서 사용하는 것이 일반적이다. 요청 큐를 만들 때는 Volley.newRequestQueue 메서드를 사용한다.

    private ActivityMainBinding binding;
    static RequestQueue requestQueue;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        binding = ActivityMainBinding.inflate(getLayoutInflater());
        setContentView(binding.getRoot());

        binding.requestBtn.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View view) {
                makeRequest(); // 요청하기 버튼을 누르면 makeRequest() 메서드 실행함.
            }
        });

        if(requestQueue == null) {
            requestQueue = Volley.newRequestQueue(getApplicationContext()); // 요청 큐를 만듦.
        }
    }

makeRequest() 메서드에서는 요청을 보내기 위해 StringRequest 클래스로 요청 객체를 만들었다. StringRequest는 문자열을 주고받기 위해 사용하는 요청 객체이고, 이외에도 다양한 요청 객체가 있는데, 일반적으로 StringRequest 객체만으로도 충분하다. 나머지 부분에 대한 설명은 주석에 적어놓았다.

package com.example.samplerequest;


import androidx.appcompat.app.AppCompatActivity;

import android.os.Bundle;
import android.view.View;

import com.android.volley.AuthFailureError;
import com.android.volley.Request;
import com.android.volley.RequestQueue;
import com.android.volley.Response;
import com.android.volley.VolleyError;
import com.android.volley.toolbox.StringRequest;
import com.android.volley.toolbox.Volley;
import com.example.samplerequest.databinding.ActivityMainBinding;

import java.util.HashMap;
import java.util.Map;

public class MainActivity extends AppCompatActivity {
    private ActivityMainBinding binding;
    static RequestQueue requestQueue;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        binding = ActivityMainBinding.inflate(getLayoutInflater());
        setContentView(binding.getRoot());

        binding.requestBtn.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View view) {
                makeRequest(); // 요청하기 버튼을 누르면 makeRequest() 메서드 실행함.
            }
        });

        if(requestQueue == null) {
            requestQueue = Volley.newRequestQueue(getApplicationContext()); // 요청 큐를 만듦.
        }
    }

    public void makeRequest() {
        String url = binding.editText.getText().toString(); // 변수 url에 입력상자에 들어간 주소를 String으로 바꿔 넣음.

        // 요청 객체를 만듦.(StringRequest - 문자열을 주고받기 위해 사용하는 요청객체)
        /* 요청객체를 new 연산자로 만들 때 총 4개의 파라미터 전달
        1. GET or POST 메서드 전달(요청 방식 지정)
        2. url(웹 사이트 주소) 전달
        3. 응답받을 리스너 객체 전달(응답 받으면 onResponse 메서드 자동 호출)
        4. 에러가 발생했을 때 호출될 리스너 객체 전달
         */
        StringRequest request = new StringRequest(Request.Method.GET, url, 
                new Response.Listener<String>() {
                    @Override
                    public void onResponse(String response) {
                        println("응답 -> " + response);
                    }
                },
                new Response.ErrorListener() {
                    @Override
                    public void onErrorResponse(VolleyError error) {
                        println("에러 -> " + error.getMessage());
                    }
                }
                ) {
            @Override
            protected Map<String, String> getParams() throws AuthFailureError {
                Map<String, String> params = new HashMap<String, String>();

                return params;
            }
        };
        request.setShouldCache(false);
        requestQueue.add(request); // 요청 큐의 add 메서드로 요청 객체 넣기
        println("요청 보냄.");
    }

    public void println(String data) {
        binding.requestTv.append(data + "\n");
    }
}

📌 실행 결과

실행 결과는 다음과 같다. 공공데이터포털 오픈 API의 Request URL를 넣고 요청하기 버튼을 눌렀더니 JSON 형태로 된 응답 결과가 텍스트뷰에 출력되었다.