Android Retrofit xml

pass·2023년 7월 18일

Android

목록 보기

18/36

🔥 Android Retrofit 을 사용하여 xml 파일 파싱하기

🎈 Android 에서 Retrofit 을 사용하여 api 통신을 할 때, 대표적으로 xml 파일이나 json 파일을 요청하여 받는다. 이 중 xml 파일을 요청하여 받는 과정을 알아보자.

🌈 배경

이번 android 프로젝트에서 일출 일몰 API 를 사용하여 오늘 날짜의 일출 시간과 일몰 시간을 가져오는 과정이 필요하였다.
공공데이터 포털에서 일출, 일몰 시간을 제공해주는 API 를 발견하여 사용하기로 하였다.
공공데이터포털 : https://www.data.go.kr/data/15012688/openapi.do

Retrofit 을 활용하면 대부분 Json 으로 응답이 오기 때문에 GsonConverter 를 사용한다. 하지만 공공데이터나 일부 오래된 데이터는 Xml 결과만을 제공한다.
일출 일몰 API 도 Xml 결과만을 제공하기 때문에 xml Converter 가 필요하였는데, 간편하게 자주 사용되는 SimpleXmlConverter 가 deprecated 되어 Tikxml 라이브러리를 사용하였다.

Tikxml 라이브러리는 어노테이션을 사용하여 xml 을 파싱한다.
Tikxml 로 xml 응답을 파싱하는 과정을 알아보자.

참고 : Tikxml 사용법 공식 문서

https://github.com/Tickaroo/tikxml/blob/master/docs/AnnotatingModelClasses.md

🔥 사용 환경

android
java
retrofit
xml
Xml Converter : tikxml (https://github.com/Tickaroo/tikxml)

✔ xml 구조

<response>
	<header>
		<resultCode>00</resultCode>
		<resultMsg>NORMAL SERVICE.</resultMsg>
	</header>
	<body>
		<items>
			<item>
				<aste>2141 </aste>
				<astm>0334 </astm>
				<civile>2023 </civile>
				<civilm>0453 </civilm>
				<latitude>3734</latitude>
				<latitudeNum>37.5666660</latitudeNum>
				<location>서울</location>
				<locdate>20230717</locdate>
				<longitude>12659</longitude>
				<longitudeNum>126.9833330</longitudeNum>
				<moonrise>0420 </moonrise>
				<moonset>1957 </moonset>
				<moontransit>1211 </moontransit>
				<naute>2100 </naute>
				<nautm>0416 </nautm>
				<sunrise>0524 </sunrise>
				<sunset>1952 </sunset>
				<suntransit>123814</suntransit>
			</item>
		</items>
		<numOfRows>10</numOfRows>
		<pageNo>1</pageNo>
		<totalCount>1</totalCount>
	</body>
</response>

✔ 상수

public static final String API_SUNSET_BASE_URL = "https://apis.data.go.kr/";
public static final String API_SERVICE_KEY = "서비스키";

서비스키는 보이지 않게 따로 관리해주어야 하지만, 이번 예제에서는 넘어가도록 하겠다.

✔ Gradle

implementation 'com.tickaroo.tikxml:annotation:0.8.13'
implementation 'com.tickaroo.tikxml:core:0.8.13'
implementation 'com.tickaroo.tikxml:retrofit-converter:0.8.13'
annotationProcessor 'com.tickaroo.tikxml:processor:0.8.13'

java 이기 때문에 annotationProcessor 를 사용하였고, kotlin일 경우 kapt 를 사용하면 된다.

✔ data

@Xml(name = "response")
public class Sunset {
    @Element(name = "header")
    Header header;
    @Element(name = "body")
    Body body;

    public Header getHeader() {
        return header;
    }

    public Body getBody() {
        return body;
    }
}

@Xml(name = "body")
public class Body {
    @Element(name = "items")
    Items items;

    public Items getItems() {
        return items;
    }
}

@Xml(name = "header")
public class Header {
    @PropertyElement(name = "resultCode")
    String resultCode;
    @PropertyElement(name = "resultMsg")
    String resultMsg;

    public String getResultCode() {
        return resultCode;
    }

    public String getResultMsg() {
        return resultMsg;
    }
}

@Xml(name = "items")
public class Items {
    @Element(name = "item")
    Item item;

    public Item getItem() {
        return item;
    }
}

@Xml(name = "item")
public class Item {
    @PropertyElement(name = "sunrise")
    String sunrise;
    @PropertyElement(name = "sunset")
    String sunset;

    public String getSunrise() {
        return sunrise;
    }

    public String getSunset() {
        return sunset;
    }
}

java 는 public class 를 하나의 java 파일에 담을 수 없어 각각의 파일을 만들어 주었다.
kotlin 의 경우 public 을 지우고, 하나의 java 파일에 넣을 수 있다.
xml 태그에 있는 내용들을 담기 위해 각각의 태그마다 class 를 만들어 주었다.
Item 에서 필요한 내용만 변수로 만들어 주었다.
@PropertyElement : 더 이상 자식 태그가 없는 변수
@Element : 자식 태그가 있는 변수
@xml(name = "태그이름")

✔ API Service Interface

public interface SunsetApi {
    @GET("/B090041/openapi/service/RiseSetInfoService/getAreaRiseSetInfo")
    Call<Sunset> getSunset(
            @Query(value = "serviceKey", encoded = true) String serviceKey,
            @Query("locdate") String locdate,
            @Query("location") String location
    );
}

Get 형식으로 요청
요청 인자로 "serviceKey"와 "locdate", "location" 을 넘겨주어야 하므로 Query에 작성

✔ 사용

TikXml parser = new TikXml.Builder().exceptionOnUnreadXml(false).build();

// Retrofit
Retrofit retrofit = new Retrofit.Builder()
        .baseUrl(API_SUNSET_BASE_URL)
        .addConverterFactory(TikXmlConverterFactory.create(parser))
        .build();

SunsetApi sunsetApi = retrofit.create(SunsetApi.class);

sunsetApi.getSunset(API_SERVICE_KEY, "20230718", "서울")
        .enqueue(new Callback<Sunset>() {
            @Override
            public void onResponse(Call<Sunset> call, Response<Sunset> response) {
                if (response.isSuccessful() && response.body() != null) {
                    String sunrise = response.body().getBody().getItems().getItem().getSunrise();
                    String sunset = response.body().getBody().getItems().getItem().getSunset();
                   
                    // 추가 로직
                    
                } else {
                    Log.d("오류", String.valueOf(response.code()));
                }
            }

            @Override
            public void onFailure(Call<Sunset> call, Throwable t) {
                Log.d("오류", t.getMessage());
            }
        });

pass

안드로이드 개발자 지망생

이전 포스트

Android Glide 이미지가 갱신되지 않는 오류

다음 포스트

Android 현재 위치 가져오기

1개의 댓글

happy

2023년 7월 18일

정말 좋은 정보 감사합니다!

답글 달기