[Android] 안드로이드 - Retrofit2 라이브러리 사용을 위한 설정 방법

Retrofit은 안드로이드 앱에서 네트워크 통신을 간편하게 처리할 수 있도록 도와주는 라이브러리이다. 이 라이브러리는 Square사에서 개발되었으며, 안드로이드 앱에서 RESTful API와의 통신을 효율적으로 관리하고 구현하는 데 사용된다.

 

Retrofit의 주요 기능

• API Interface 정의: Retrofit을 사용하면 REST API와 상호작용하기 위한 인터페이스를 정의할 수 있다. 이 인터페이스에서 API 엔드포인트, HTTP 요청 메소드, 요청 시 필요한 매개변수 등을 명시할 수 있다.
• HTTP 클라이언트 설정: Retrofit은 OkHttp와 함께 사용될 수 있어, HTTP 클라이언트를 생성하고 설정하는 데 도움을 준다. 이를 통해 네트워크 연결 설정, 타임아웃 등을 관리할 수 있다.
• Annotation 기반의 요청 처리: Retrofit은 애노테이션 기반으로 HTTP 요청을 처리합니다. 각 메소드에 @GET, @POST, @PUT, @DELETE 등을 사용하여 요청의 종류와 요청 URL을 명시할 수 있다.
• 객체 직렬화 및 역직렬화: JSON 또는 XML과 같은 데이터 형식을 안드로이드 앱의 자바 객체로 변환하거나 그 반대로 변환하는 과정을 처리할 수 있다. 이는 Gson과 같은 컨버터를 사용하여 처리된다.
• 비동기적 응답 처리: Retrofit은 HTTP 요청을 비동기적으로 처리하여 메인 스레드를 차단하지 않고 백그라운드에서 작업을 수행할 수 있도록 도와준다. 콜백, RxJava 등을 활용하여 응답을 받고 처리할 수 있다.

 

1. api 패키지-NetworkClient.class 생성

라이브러리 사용을 위한 변수를 만들고
getRetrofitClient 함수를 아래와 같이 작성한다.

public class NetworkClient {

    public static Retrofit retrofit; // 라이브러리 사용을 위한 변수 사용

    public static Retrofit getRetrofitClient(Context context){
        if(retrofit == null){
            // 통신 로그 확인할때 필요한 코드
            HttpLoggingInterceptor loggingInterceptor =
                    new HttpLoggingInterceptor();
            loggingInterceptor.setLevel(HttpLoggingInterceptor.Level.BODY); // 이 부분만 변경 ★

            // 네트워크 연결관련 코드
            OkHttpClient httpClient = new OkHttpClient.Builder()
                    .connectTimeout(1, TimeUnit.MINUTES) // 1분동안 작업을 하기 위해 연결 (사진 전송 등)
                    .readTimeout(1, TimeUnit.MINUTES) // 데이터를 가져올 때
                    .writeTimeout(1, TimeUnit.MINUTES) // 보낼 때
                    .addInterceptor(loggingInterceptor)
                    .build();
            // 네트워크로 데이터를 보내고 받는
            // 레트로핏 라이브러리 관련 코드
            retrofit = new Retrofit.Builder()
                    .baseUrl(Config.DOMAIN)
                    .client(httpClient)
                    .addConverterFactory(GsonConverterFactory.create())
                    .build();
        }
        return retrofit;
    }
}

 

2. api 패키지 - UserApi.class 생성

- UserApi.class를 생성한 뒤 Interface로 변경한다.

- register 회원가입 api에서 사용자에게 입력받은 내용을 User user로 받아오고(이 때, User 클래스 생성)
유효성 검사가 끝나면 UserRes로 응답을 전달한다.(이 때, UserRes 클래스 생성) 

import retrofit2.Call;
import retrofit2.http.Body;
import retrofit2.http.POST;

public interface UserApi {
    // 회원가입 Api
    @POST("/user/register")
    Call<UserRes> register(@Body User user); 

}

 

3. model 패키지 - User.class 생성

생성자까지 미리 생성해준다.

public class User {

    public String email;
    public String password;
    public String nickname;

    public User(){

    }

    public User(String email, String password, String nickname) {
        this.email = email;
        this.password = password;
        this.nickname = nickname;
    }
}

 

4. model 패키지 - UserRes.class 생성

응답 받을 변수들을 만들어준다.

public class UserRes {

    // 응답...!
    public String result;
    public String access_token;

}

 

5. 해당 Activity 설정

본인은 회원가입을 위한 Activity를 사용했다.

1. retrofit 사용을 위한 변수를 생성한다.
2. api 패키지에 있는, Interface를 생성한다.
3. 보낼 데이터를 묶음 처리해서 만든다.
4. api 호출한다.
5. 서버로부터 받은 응답을 처리하는 코드를 작성한다.

btnRegister.setOnClickListener(new View.OnClickListener() {
    @Override
    public void onClick(View v) {
        String email = editEmail.getText().toString().trim();
        String password = editPassword.getText().toString().trim();
        String nickname = editNickname.getText().toString().trim();

        // 네트워크 회원가입 API를 호출한다. ★★★★★
        
        // 1. retrofit 변수 생성
        Retrofit retrofit = NetworkClient.getRetrofitClient(RegisterActivity.this);

        // 2. api 패키지에 있는, Interface 생성
        UserApi api = retrofit.create(UserApi.class);

        // 3. 보낼 데이터 만든다. => 묶음 처리 : 클래스의 객체 생성.

        User user = new User(email, password, nickname);

        // 4. api 호출
        Call<UserRes> call = api.register(user);

        // 5. 서버로부터 받은 응답을 처리하는 코드 작성.
        call.enqueue(new Callback<UserRes>() {
            @Override
            public void onResponse(Call<UserRes> call, Response<UserRes> response) {
            
                // 서버에서 보낸 응답이 200 OK일 때 처리하는 코드
                if(response.isSuccessful()){
                    UserRes userRes = response.body();

                    SharedPreferences sp = getSharedPreferences(Config.PREFERENCE_NAME,MODE_PRIVATE);
                    SharedPreferences.Editor editor = sp.edit();
                    editor.putString("token",userRes.access_token);
                    editor.apply();

                    // 이상 없으므로 메인 액티비티를 실행한다.
                    Intent intent = new Intent(RegisterActivity.this,MainActivity.class);
                    startActivity(intent);
                    finish();
                }


            }

            @Override
            public void onFailure(Call<UserRes> call, Throwable t) {

                // 유저한테 네트워크 통신 실패했다고 알려준다.
                Toast.makeText(RegisterActivity.this,"네트워크 통신 실패.",Toast.LENGTH_SHORT).show();

            }
        });


    }
});