[java] Vaadin과 RESTful API 통신하기

29 Nov 2023

java

Vaadin은 Java로 작성된 오픈 소스 웹 애플리케이션 프레임워크로, 서버 측에서 사용자 인터페이스를 생성하는 데 사용됩니다. RESTful API는 웹 서비스 간 통신에 사용되는 아키텍처 형식입니다. 이번 포스팅에서는 Vaadin을 사용하여 RESTful API와 통신하는 방법을 알아보겠습니다.

1. RESTful API 클라이언트 라이브러리 추가

Vaadin으로 RESTful API를 통신하기 위해서는 클라이언트 라이브러리를 추가해야 합니다. 대표적인 RESTful API 클라이언트 라이브러리로는 HttpClient와 RestTemplate이 있습니다. 이 중 예제로 HttpClient를 사용하도록 하겠습니다. 아래의 의존성을 pom.xml 파일에 추가합니다.

<dependencies>
    <dependency>
        <groupId>org.apache.httpcomponents</groupId>
        <artifactId>httpclient</artifactId>
        <version>4.5.12</version>
    </dependency>
</dependencies>

2. RESTful API와 통신하는 메서드 구현

Vaadin에서 RESTful API와 통신하기 위해서는 적절한 메서드를 구현해야 합니다. 예를 들어, GET 요청을 보내고 JSON 형식의 응답을 처리하는 메서드는 다음과 같이 작성할 수 있습니다.

import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class RestApiClient {
    
    private static final String API_URL = "https://api.example.com/data";
    
    public String getData() throws Exception {
        // HttpClient 인스턴스 생성
        HttpClient httpClient = HttpClients.createDefault();
        
        // GET 요청 생성
        HttpGet getRequest = new HttpGet(API_URL);
        
        // GET 요청 실행
        HttpResponse response = httpClient.execute(getRequest);
        
        // 응답 파싱
        HttpEntity entity = response.getEntity();
        String responseString = EntityUtils.toString(entity, "UTF-8");
        
        // 응답 반환
        return responseString;
    }
}

위의 예제 코드에서는 Apache HttpClient를 사용하여 GET 요청을 보내고 응답을 받아옵니다. 받아온 응답은 문자열로 반환합니다.

3. Vaadin에서 RESTful API 통신하기

Vaadin에서 위에서 작성한 RESTful API 클라이언트 클래스를 사용하여 API와 통신할 수 있습니다. 예를 들어, 버튼을 클릭하면 API에서 받아온 데이터를 화면에 표시하는 기능을 구현하고 싶다면 다음과 같이 할 수 있습니다.

import com.vaadin.flow.component.button.Button;
import com.vaadin.flow.component.notification.Notification;
import com.vaadin.flow.component.orderedlayout.VerticalLayout;
import com.vaadin.flow.router.Route;

@Route("")
public class MainView extends VerticalLayout {
    
    private RestApiClient restApiClient;
    
    public MainView() {
        restApiClient = new RestApiClient();
        
        Button getDataButton = new Button("Get Data");
        getDataButton.addClickListener(event -> {
            try {
                String data = restApiClient.getData();
                Notification.show("Received data: " + data);
            } catch (Exception e) {
                Notification.show("Error while getting data.");
            }
        });
        
        add(getDataButton);
    }
}

위의 예제 코드에서는 Vaadin의 Button 컴포넌트를 생성하고, 클릭 이벤트 발생 시 RESTful API에서 데이터를 받아와서 Vaadin의 Notification 컴포넌트를 사용하여 데이터를 화면에 표시합니다.

4. 결론

Vaadin을 사용하여 RESTful API와 통신하는 방법에 대해 알아보았습니다. 이를 통해 Vaadin 애플리케이션에서 외부 리소스를 사용하여 데이터를 가져올 수 있습니다. RESTful API 클라이언트 라이브러리를 사용하면 효율적이고 편리하게 API와 통신할 수 있습니다.