[TECH] Retrofit2 Multipart사용하기

[티끌] 티끌 Retrofit2 Multipart를 사용해 서버와 이미지 데이터 주고 받기
 
안녕하세요 돌아온 티플의 안드로이드 개발자 김유정입니다 :D

 

티끌의 3차 업데이트에는 새로운 기능이 포함되어 있는데요.
오늘은새로운 기능 구현을 위해 사용했던 Retrofit2의 Multipart에 대해 소개하도록 하겠습니다.

---

👩‍💻Retrofit2란?

Retrofit은 안드로이드와 서버간의 REST API 통신을 도와주는 OkHTTP 기반 라이브러리로 티끌 역시 안드로이드와 서버 통신에 Retrofit을 사용하고 있습니다. Retrofit의 특징은 아래와 같습니다.

• 기존 라이브러리(Volley, AsyncTack)에 비해 높은 성능
• Annotaion으로 HTTP 메소드를 정의하여 가독성이 높음
• JSON, XML을 자동으로 파싱해주는 Converter 연동을 지원하므로 유지보수가 쉬움

 

 

---

👩‍💻Multipart란?

Retrofit을 사용해 Multipart 데이터를 보내기로 했으니 Multipart에 대해 알아봐야겠죠?

Multipart란 클라이언트가 요청을 보낼 때 HTTP 요청을 바디의 여러 부분으로 나누어 보내는 방식을 말합니다.

파일 전송 시에 주로 사용되는 방법으로 클라이언트는 서버에 파일을 업로드할 때 HTTP 바디 부분에 파일 데이터를 담아 전송하게 되는데, Multipart 형식으로 전송할 시 한 번에 여러개의 파일 또는 데이터를 전송할 수 있게 되는 것이죠!

 

---

👩‍💻Retrofit2 Multipart 실습

 

본격적으로 Retrofit2 Multipart 사용 과정을 설명해볼텐데요,

아래의 과정은 Retrofit2에 대한 사용 세팅이 마친 상태에서 이루어졌다는 것을 염두해주세요 :)

 

1. 서버 요청 확인

개발 전 먼저 백엔드 개발자가 정리해둔 API 명세서를 확인합니다.

id와 Content는 각각 int와 String형으로 memoDto에 담기고, json type으로 지정되어있습니다.

image는 Mulipartfile 형식으로 지정되어 있는 것을 확인할 수 있습니다.

 

2. API Interface 설정

명세에 맞추어 API 인터페이스를 구현해줍니다.

• @Multipart 어노테이션 : Multipart 요청을 사용할 것임을 정의
• @POST 어노테이션 : POST HTTP 요청을 "/memo" 엔드포인트에 보낼 것임을 정의
• fun memo : memo 메서드는 서버로 데이터를 전송하고 받아오는 역할을 수행
• @Part("memoDto") : 멀티파트 부분 중 하나로, memoDto라는 이름으로 텍스트 데이터를 전송
• @Part image : MultipartBody.Part 형태로 이미지를 전송, 이때 ?는 이미지가 null 값일 수 있음을 의미
• memo 메서드는 통신의 결과로 ResponseChallengeJoin 형태의 응답을 반환

 

더불어 memoDto는 아래와 같은 data class로 정의해두었습니다.

 

3. API 사용

Interface가 정의되었다면 실제 API가 사용될 페이지에서 API를 사용할 수 있습니다.

본 API를 호출하기 위해 postMemo 메서드를 정의했고 크게 API 사용을 위한 전처리 부분과, 실제 API 사용부로 나눌 수 있습니다.

 

먼저 전처리 부분입니다.

• memoDto에 각각 string과 int형의 데이터를 담아주어야하므로 형변환 후 JSON 형식의 memoDto를 생성
• Gson 라이브러리를 사용해 memoDto 객체를 JSON 형식으로 변환하고, memoDtoRequestBody 변수에 저장
• uri 변수에 이미지 uri가 담겨 있다면 해당 uri에서 이미지 파일을 가져오고 MultipartBody.Part 형태로 변환
• 이때 uri 변수가 null값일 경우 null 값을 유지

 

사전에 정의한 API 인터페이스를 사용하는 부분입니다.

• memo 메서드를 사용해 실제 데이터를 서버에 전송
• 이때, input은 액세스 토큰, JSON 형식의 memoDto, MultipartBody.Part  형식의 이미지 데이터
• 서버의 응답을 비동기적으로 처리하기 위해 enqueue 메서드를 사용해 콜백 등록
• onFailure를 사용해 오류 처리

 

 

---

👩‍💻 마치며

String이나 Int형을 주로 주고받는 일반적인 Retrofit의 사용과 달리 Multipart는 서버의 요청에 따라 형 변환을 거쳐야해 까다롭고, 생소하게 느껴지기도 합니다. 하지만 항상 백엔드 개발자의 명세서를 꼼꼼히 확인하고 API를 사용하면 요청에 성공하는 짜릿함을 느낄 수 있답니다 :D !

 

⬇️ 지금 구글 플레이 스토어에서 티끌 다운 받기
https://play.google.com/store/apps/details?id=com.team7.tikkle&hl=ko-KR

📩 Contact : yuu-jeong@naver.com
📲 SNS : https://instagram.com/yu.eek