Java 백엔드 개발: Retrofit을 사용한 API 호출

Java 백엔드 개발: API 호출에 Retrofit을 사용하세요

인터넷 기술의 급속한 발전으로 API는 애플리케이션과 서비스 간의 통신을 위한 표준 프로토콜이 되었으며 모바일 애플리케이션, 웹 사이트 개발 등 다양한 시나리오에서 널리 사용됩니다. Java 백엔드 개발 분야에서 Retrofit은 현재 API 호출 구현을 위한 매우 인기 있는 프레임워크입니다. 이 기사에서는 Retrofit이 무엇인지, Retrofit을 사용하여 API 호출을 수행하는 방법을 소개합니다.

1. Retrofit이란

Retrofit은 서버 측 API 호출을 구현하기 위한 Java 기반 프레임워크로, 주석을 사용하여 HTTP 요청, 매개변수 및 응답 본문을 설명하므로 Java 인터페이스를 통해 서버 측 API 호출을 구현합니다. OkHttp를 기본 네트워크 요청 라이브러리로 사용하고 동기 및 비동기 네트워크 요청 방법을 지원하며 요청 재시도, 요청 캐싱, 파일 업로드 등과 같은 많은 보조 기능을 제공합니다. Retrofit은 또한 요청 및 응답 본문을 Java 객체로 쉽게 변환할 수 있는 Gson, Jackson, Moshi 등과 같은 다양한 데이터 변환기를 지원합니다.

2. Retrofit을 사용하여 API 호출을 수행하는 방법

1. 종속성 가져오기

Retrofit을 사용하여 API 호출을 수행하려면 먼저 프로젝트에 관련 종속성을 추가해야 합니다. Maven 프로젝트에서는 pom.xml 파일에 다음과 같은 종속성을 추가할 수 있습니다.

<dependency>
  <groupId>com.squareup.retrofit2</groupId>
  <artifactId>retrofit</artifactId>
  <version>2.9.0</version>
</dependency>
<dependency>
  <groupId>com.squareup.retrofit2</groupId>
  <artifactId>converter-gson</artifactId>
  <version>2.9.0</version>
</dependency>

그 중 Retrofit은 Retrofit 프레임워크 자체의 종속성이며, Converter-gson은 Retrofit의 Gson 데이터 변환기의 종속성입니다.

2. API 인터페이스 생성

Retrofit을 사용하여 API 호출을 수행하는 경우 먼저 해당 API 인터페이스를 생성해야 합니다. 인터페이스는 서버 API의 URL, 요청 방법, 요청 매개변수, 반환 데이터 유형 및 기타 정보를 설명합니다. 예를 들어, 다음 코드는 서버에 GET 요청을 보내고 문자열을 반환하기 위한 기본 인터페이스를 정의합니다.

public interface ApiService {
    @GET("/api/hello")
    Call<String> getHello();
}

이 인터페이스에서는 Retrofit에서 제공하는 @GET 주석을 사용하여 HTTP 요청 유형과 URL 주소를 설명합니다. Call를 사용하여 반환된 데이터 유형을 설명합니다. 여기서 T는 문자열, 사용자 정의 개체 등과 같은 Java 유형일 수 있습니다.

3. Retrofit 객체 생성

인터페이스가 정의된 후 Retrofit을 사용하여 해당 서비스 인스턴스를 생성해야 합니다. Retrofit 객체를 생성할 때 요청 URL, 데이터 변환기, 네트워크 요청 라이브러리 및 기타 관련 속성을 지정할 수 있습니다. 예를 들어 다음 코드는 Retrofit 인스턴스를 생성하고 요청 URL, Gson 데이터 변환기 및 OkHttp 네트워크 요청 라이브러리를 지정합니다.

Retrofit retrofit = new Retrofit.Builder()
    .baseUrl("http://localhost:8080")
    .addConverterFactory(GsonConverterFactory.create())
    .client(new OkHttpClient.Builder().build())
    .build();

그 중 baseUrl은 서버의 기본 URL 주소를 지정하고, addConverterFactory는 데이터 변환기를 GsonConverter로 지정합니다. 클라이언트는 기본 네트워크 요청 라이브러리로 OkHttp 사용을 지정합니다. 여기에서는 OkHttpClient의 기본 구성이 사용되지만 연결 시간 초과, 읽기 및 쓰기 시간 초과 등과 같은 관련 매개변수를 직접 구성할 수도 있습니다.

4. API 인스턴스 생성

Retrofit은 동적 프록시를 통해 API 인터페이스의 구현 클래스를 생성하여 API 호출을 매우 간단하게 만듭니다. 예를 들어, 다음 코드는 API 인스턴스를 생성하고 getHello 메서드를 호출합니다.

ApiService apiService = retrofit.create(ApiService.class);
Call<String> call = apiService.getHello();
Response<String> response = call.execute();
System.out.println(response.body());

이 코드에서는 ApiService 구현 클래스가 Retrofit.create 메서드를 통해 동적으로 생성되고, getHello 메서드를 사용하여 Call 개체를 가져옵니다. 마지막으로 호출된 Call의 실행 메소드는 요청을 동기적으로 실행합니다. 실행 메소드는 서버가 반환한 모든 정보를 포함하는 Response 객체를 반환합니다. 여기서 body 속성은 서버가 반환한 데이터입니다.

요청을 비동기적으로 실행하려면 Call의 enqueue 메소드를 사용할 수 있습니다. 예:

ApiService apiService = retrofit.create(ApiService.class);
Call<String> call = apiService.getHello();
call.enqueue(new Callback<String>() {
  @Override
  public void onResponse(Call<String> call, Response<String> response) {
    System.out.println(response.body());
  }
  
  @Override
  public void onFailure(Call<String> call, Throwable t) {
    t.printStackTrace();
  }
});

이 코드에서는 Call의 enqueue 메소드를 사용하여 요청을 비동기적으로 실행하고 콜백 인터페이스를 구현하여 요청 결과를 처리합니다. 요청이 성공하면 onResponse 메소드가 호출되고, 요청이 실패하면 onFailure 메소드가 호출됩니다.

3. 요약

이 글에서는 API 인터페이스 생성, Retrofit 인스턴스 생성, API 인스턴스 생성 및 네트워크 요청 수행 과정을 포함한 Retrofit의 기본 사용법을 소개합니다. Retrofit은 주석을 사용하여 API 호출을 단순화하여 프런트엔드와 백엔드가 데이터와 상호 작용하는 것을 매우 편리하게 만듭니다. Retrofit은 스레드로부터 안전하지 않고 멀티 스레드 환경에서 적절한 동기화가 필요하므로 Retrofit을 사용할 때 스레드 안전 문제에 주의해야 합니다.

위 내용은 Java 백엔드 개발: Retrofit을 사용한 API 호출의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!