[Retrofit2] Retrofit2에서 API 호출 시 공통 헤더 값 추가 방법

출처

ChatGPT

---

 

방법

1. Interceptor를 사용하여 공통 해더 추가
2. '@Header' 어노테이션 사용
3. '@Headers' 어노테이션 사용
4. OkHttp3 Authenticator 사용 (토큰 자동 갱신)

 

1. Interceptor를 사용하여 공통 헤더 추가

Interceptor는 모든 네트워크 요청에 공통적인 작업을 수행할 수 있게 해준다. 이를 통해 공통 헤더 값을 쉽게 추가할 수 있다.

Interceptor로 공통 헤더 추가하기

장점

• 코드의 반복을 줄여주고, 모든 요청에 자동으로 헤더를 추가한다.
• 보안 토큰과 같은 공통 정보를 추가하는 데 유용하다.

 

import okhttp3.Interceptor;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import retrofit2.Retrofit;
import retrofit2.converter.gson.GsonConverterFactory;

import java.io.IOException;

public class ApiClient {

    private static final String BASE_URL = "https://api.example.com/";
    private static Retrofit retrofit = null;

    public static Retrofit getClient() {
        if (retrofit == null) {
            // Interceptor 설정
            OkHttpClient client = new OkHttpClient.Builder()
                    .addInterceptor(new Interceptor() {
                        @Override
                        public Response intercept(Chain chain) throws IOException {
                            Request original = chain.request();
                            Request request = original.newBuilder()
                                    .header("Authorization", "Bearer YOUR_TOKEN_HERE")  // 공통 헤더 추가
                                    .header("Content-Type", "application/json")
                                    .method(original.method(), original.body())
                                    .build();
                            return chain.proceed(request);
                        }
                    })
                    .build();

            retrofit = new Retrofit.Builder()
                    .baseUrl(BASE_URL)
                    .client(client)
                    .addConverterFactory(GsonConverterFactory.create())
                    .build();
        }
        return retrofit;
    }
}

 

설명

 

• OkHttpClient: OkHttp 클라이언트에 Interceptor를 추가하여 모든 요청에 공통 헤더를 자동으로 추가한다.
• header(): 요청에 헤더를 추가하는 메서드입니다. 여러 개의 헤더를 추가할 수 있다.
• chain.proceed(request): 요청을 계속 진행한다.

2. '@Header' 어노테이션 사용

'@Header' 어노테이션은 특정 요청에만 헤더를 동적으로 추가할 수 있게 해준다. 이 방법은 매번 다른 헤더 값을 넣고 싶을 때 유용하다.

@Header 어노테이션 사용 예시

장점

• 요청마다 다른 헤더 값을 제공할 수 있다.

import retrofit2.Call;
import retrofit2.http.GET;
import retrofit2.http.Header;
import retrofit2.http.Headers;
import retrofit2.http.Path;

public interface ApiService {

    // 동적으로 Authorization 헤더 추가
    @GET("users/{id}")
    Call<User> getUserById(@Path("id") int userId, @Header("Authorization") String token);

    // 동적으로 Content-Type 헤더 추가
    @GET("users/{id}")
    Call<User> getUserByIdWithContentType(@Path("id") int userId, @Header("Content-Type") String contentType);
}

 

 

설명

• @Header("Authorization"): 메소드의 매개변수로 Authorization 헤더 값을 전달한다.
• @Header("Content-Type"): Content-Type 헤더를 메소드 호출 시에 전달한다.

사용 예시

ApiService apiService = retrofit.create(ApiService.class);

Call<User> call = apiService.getUserById(1, "Bearer YOUR_TOKEN_HERE");
call.enqueue(new Callback<User>() {
    @Override
    public void onResponse(Call<User> call, Response<User> response) {
        if (response.isSuccessful()) {
            User user = response.body();
            // 사용자 정보 처리
        }
    }

    @Override
    public void onFailure(Call<User> call, Throwable t) {
        // 오류 처리
    }
});

 

3. '@Headers' 어노테이션 사용

'@Headers' 어노테이션을 사용하여 특정 API 요청에 대해 정적인 헤더를 추가할 수 있다. 이는 특정 엔드포인트에 대해 항상 일정한 헤더가 필요할 때 유용하다.

@Headers 어노테이션 사용 예시

장점

• 특정 요청에 대해 고정된 헤더 값을 명시할 수 있다.\

public interface ApiService {

    // 고정된 헤더 추가
    @Headers({
        "Authorization: Bearer YOUR_TOKEN_HERE",
        "Content-Type: application/json"
    })
    @GET("users/{id}")
    Call<User> getUserById(@Path("id") int userId);
}

 

설명

• @Headers: 헤더 정보를 고정적으로 추가하여 특정 요청에 사용한다. 이 방법은 매번 같은 헤더를 필요로 하는 경우에 유용하다.

4. OkHttp3 Authenticator 사용 (토큰 자동 갱신)

사용자가 인증이 필요한 API를 호출할 때 토큰을 자동으로 갱신해야 하는 경우, "Authenticator"를 사용할 수 있다. 이를 통해 인증 실패 시 자동으로 새로운 토큰을 발급받고 요청을 재시도할 수 있다.

Authenticator 사용 예시

장점

• 자동으로 토큰을 생신하고, 요청을 재시도할 수 있다.

import okhttp3.Authenticator;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import okhttp3.Route;
import retrofit2.Retrofit;
import retrofit2.converter.gson.GsonConverterFactory;

public class ApiClient {

    private static final String BASE_URL = "https://api.example.com/";
    private static Retrofit retrofit = null;

    public static Retrofit getClient() {
        if (retrofit == null) {
            OkHttpClient client = new OkHttpClient.Builder()
                    .authenticator(new Authenticator() {
                        @Override
                        public Request authenticate(Route route, Response response) {
                            // 새로운 토큰 발급 로직 (예시)
                            String newAccessToken = getNewAccessToken();

                            // 새로운 요청을 기존 요청과 함께 새 토큰으로 생성
                            return response.request().newBuilder()
                                    .header("Authorization", "Bearer " + newAccessToken)
                                    .build();
                        }
                    })
                    .build();

            retrofit = new Retrofit.Builder()
                    .baseUrl(BASE_URL)
                    .client(client)
                    .addConverterFactory(GsonConverterFactory.create())
                    .build();
        }
        return retrofit;
    }

    private static String getNewAccessToken() {
        // 새로운 액세스 토큰 발급 로직 구현
        return "NEW_ACCESS_TOKEN";
    }
}

 

설명

 

• Authenticator: 인증 실패 시 호출되는 인터페이스로, 새로운 인증 정보를 제공하고 요청을 재시도한다.
• authenticate(): 새로운 요청을 구성하여 반환하며, 요청이 자동으로 다시 시도된다.

결론 

Retrofit2에서 공통 헤더 값을 추가하는 방법은 여러 가지가 있으며, 각각의 방법은 특정 상황에 맞게 사용할 수 있다.

 

• Interceptor는 모든 요청에 대해 공통적인 헤더를 추가할 때 가장 간단하고 효율적인 방법이다.
• @Header 어노테이션은 동적으로 헤더를 설정할 때 유용하다.
• @Headers 어노테이션은 고정된 헤더 값을 특정 요청에 추가할 때 사용된다.
• Authenticator는 자동으로 토큰을 갱신하여 인증 요청을 재시도할 때 적합하다.

프로젝트의 요구사항에 맞게 적절한 방법을 선택해 Retrofit2에서 헤더를 효과적으로 관리할 수 있다.