[Spring] @Async를 활용한 비동기 메서드 만들기

https://spring.io/guides/gs/async-method/

Creating Asynchronous Methods

Spring에서 가이드를 제공해준 것을 기반으로 @Async를 어떻게 사용하는지에 대해서 학습했다.

가이드에서는 GitHub 사용자 정보를 쿼리하고 GitHub의 API를 통해 데이터를 검색하는 조회 서비스를 빌드한다. 

 

CompletableFuture는 여러 비동기 작업을 파이프라인으로 쉽게 연결하고 단일 비동기 계산으로 병합할 수 있다. 

 

 

1️⃣ 프로젝트 생성하기 

https://start.spring.io/

여기서 애플리케이션에 필요한 종속성을 가져오고 대부분의 설정을 자동으로 수행해준다. 

Gradle 을 선택해주고, java는 버전에 맞게 선택해준 다음, 

종속성을 클릭하고 Spring web을 선택하면 된다!

(가이드에서는 Spring web만 추가했지만 @Slf4j 어노테이션을 사용하기 위해서 lombok도 종속성 추가해줬다)

그리고 생성 클릭해주면 압축 파일이 생기고 그 압축 파일 풀어서 프로젝트 열면 된다. 

 

 

2️⃣ User class 생성하기 

❗ @JsonIgnore, @JsonIgnoreProperties, @JsonIgnoreType 차이점 

우선 이런 어노테이션은 Json 직렬화, 역직렬화에서 속성을 무시하는데 사용한다. 

(직렬화 : 객체의 직렬화는 객체의 내용을 바이트 단위로 변환하여 파일 또는 네트워크를 통해서 스트림이 가능하도록 하는 것을 의미한다.) 

 

@JsonIgnore : 클래스의 속성(필드, 멤버변수) 수준에서 사용 

@JsonIgnoreProperties : 클래스 수준에서 사용 

@JsonIgnoreType : 클래스 수준에서 사용하고, 전체 클래스 무시 (클래스 자체를 json 데이터 맵핑에서 사용 불가) 

 

@JsonIgnoreProperties(ignoreUnknown = true)

: 역직렬화, json 데이터가 가진 프로퍼티 중에 자바 class의 vo 프로퍼티에 값이 없는 경우에 에러를 던지지 않고 무시한다. 

 

 

2️⃣ GitHub 조회 서비스 

GitHub를 쿼리하여 사용자 정보를 찾는 서비스이다. 

서비스 클래스에서 findUser()는 RestTemplate를 사용하여 api를 호출한 다음 응답을  User객체로 수신받는다. 

@Async 어노테이션이 붙은 메서드는 별도의 스레드가 생성되어 실행된다. 

그리고 반환 타입은 CompletableFuture<> 인데, 이는 Async메서드에서 반환할 때 사용해야 하는 타입이다. 

 

 

3️⃣ main 함수 작성 

@EnableAsync 

: 비동기 함수를 실행할 수 있도록 해준다. 

이 어노테이션은 스프링이 뒤에서 설명할 @Async 어노테이션이 정의된 메서를 스프링이 백그라운드 스레드 풀을 사용하여 실행할 수 있도록 한다. 

 

그리고 Executor를 반환하는 taskExecutor()를 정의하여 스레드 풀에 대해 설정해주었다. 

이를 정의하지 않으면 SimpleAsyncTaskExecutor를 생성하고 사용한다. 

 

 

4️⃣ AppRunner.class

CommandLineRunner 

: 스프링 부트 애플리케이션 구동 시점에 특정 코드 실행시키기 위해서 사용한다. 

이를 구현한 클래스에서 @Component 어노테이션을 선언해두면 컴포넌트 스캔이 되고, 구동 시점에 run 메서드의 코드가 실행된다. 

 

github api 를 요청하는 코드를 CommandLineRunner를 상속받아 run 메서드에 구현하였다. 

api 요청 전 시간을 측정하고 3개의 요청이 완료된 후에 응답을 3개의 응답을 받는데까지 걸리는 시간을 측정해준다. 

(join() :응답을 기다리는 역할)

 

❗

get() : get() 메서드를 통해 결과를 확인할 수 있는데, get을 하게 되면 작업이 끝날때까지 잠시 기다렸다가 결과값을 반환하게 된다. 

-> 이건 내가 실수 했던 것으로 get() 메서드로 결과를 확인할 수 있다는 것만 생각하고 이렇게 꺼내왔는데 이러면 작업을 끝날때까지 기다렸다가 결과값을 반환하기 때문에 굳이 비동기 메서드를 사용했으면서 동기처리를 하게 된다 ㅋㅋㅋㅋㅋ

이런 바보같은 짓을 하고서 다른 프로젝트에서 이를 적용하려는데 동작은 하는거 같은데 뭔가 찝찝하네~ 이러고만 있었다..ㅎ 

 

allOf() : 병렬 실행해서 결과를 조합할 때 사용한다. 

 

 

5️⃣ 결과

findUser()는 @Async 어노테이션을 사용하여 비동기식으로 처리를 지정하였고, PivotalSoftware, CloudFoundry, Spring-Projects 유저 정보 조회 api는 응답이 오지 않더라도 먼저 요청이 이루어진다. 

만약 동기식이라면 PivotalSoftware에 대한 유저 정보를 요청하고 응답을 받은 뒤, 다음 코드가 진행된다. 

이러한 결과를 통해 비동기 처리는 웹 서버로 요청을 먼저 전송한 이후, 응답 결과를 수신하기 전에 다른 로직을 실행할수 있으므로 작업의 효율을 높일 수 있다.