[Android/Java] 공공 데이터 포털 OpenAPI XML 파싱하기(DOM4J)

2023. 8. 9. 14:52

공공 데이터 포털에서 제공하는 서비스는 오래되면 오래 될수록 JSON을 지원하지 않는 경우가 많은데 내가 사용하려는 API 역시 XML밖에 지원하지 않았다. 나는 통신에 Retrofit 라이브러리를 사용했기에 XML 관련 컨버터를 찾아본 결과 SimpleXml과 TikXml 두 가지가 있었다. SimpleXML은 예전에도 사용해봤었기에 익숙했지만 Deprecated된 상태였고 TikXml은 현 시점에서 관련 라이브러리가 다운로드되질 않아 사용할 수 없었다. 그래서 결국 Scalar 컨버터를 통해 원시 데이터를 받고 직접 XML을 파싱하기로 했다.

먼저 응답 메시지 구조를 보면 위와 같다. Response 내에 Header와 Body가 존재하며 header에는 결과 코드와 결과 메시지가, body에는 요청한 데이터를 담고 있다. 나는 이 중에서 헤더와 종목 코드(jmcd), 종목 이름(jmfldnm)만을 사용할 것이기에 예제에서는 body에서 두 개의 데이터만 추출할 것이다.

이 예제는 Retrofit의 기본 조작까지는 다루지 않기 때문에 기본적인 지식은 가지고 보는 것을 추천한다.

DOM4J 구현

build.gradle

dependencies {
    ..
    implementation 'io.reactivex.rxjava3:rxandroid:3.0.0'
    implementation 'io.reactivex.rxjava3:rxjava:3.0.7'

    implementation 'com.squareup.retrofit2:retrofit:2.9.0'
    implementation 'com.squareup.retrofit2:converter-scalars:2.5.0'
    implementation 'com.squareup.retrofit2:adapter-rxjava3:2.9.0'
    
    implementation 'dom4j:dom4j:1.6.1'
}

1, 2 : 비동기 처리를 위해 RxJava 관련 의존성을 추가한다.
3 : 통신 라이브러리 Retrofit 의존성을 추가한다.
4 : XML을 원시 데이터로 받을 수 있도록 Scalar 컨버터를 추가한다. converter-scalars는 응답을 문자열로 받을 수 있도록 해준다.
5 : Retrofit 통신 결과를 RxJava로 핸들링해주기 위해 관련 의존성을 추가한다.
6 : XML 파싱을 위한 DOM4J 의존성을 추가한다.

코드가 간결해지는 것을 선호하기도 하고 이제는 RxJava에 더 익숙해져서 RxJava를 사용하지만 RxJava를 잘 모른다면 Call으로 결과를 핸들링해도 상관없다.

AndroidManifest.xml

<uses-permission android:name="android.permission.INTERNET" />

<application
    ..
    android:usesCleartextTraffic="true">

매니페스트 파일에서 인터넷 권한과 HTTP 통신을 허용해준다. 공공 데이터 포털의 API는 HTTPS가 아닌 HTTP를 사용한다.

MyClient.java

public class MyClient {
    private static Retrofit retrofit;
    public static final String BASE_URL = "http://testapi.q-net.or.kr/api/service/rest/
InquiryListNationalQualifcationSVC";
    public static final String SERVICE_KEY = "";

    public static Retrofit getRetrofit() {
        if(retrofit == null) {
            retrofit = new Retrofit.Builder()
                    .baseUrl(BASE_URL)
                    .client(new OkHttpClient.Builder().build())
                    .addConverterFactory(ScalarsConverterFactory.create()) 
                    .addCallAdapterFactory(RxJava3CallAdapterFactory.create())
                    .build();
        }

        return retrofit;
    }
}

API 상세 페이지에서 제공하는 서비스 URL과 개인으로 발급받은 서비스 키를 변수에 초기화한다. 코드는 최소한으로 구성하였으니 Scalar 컨버터 추가, RxJava Adapter를 추가하는 부분만 눈여겨 보면 된다.

MyAPI.java

public interface MyAPI {
    @GET("/getList")
    Observable<String> getList(@Query("serviceKey") String serviceKey);
}

API 인터페이스를 작성한다. RxJava를 사용하기에 리턴 타입이 Call이 아닌 Observerble인 것을 볼 수 있다. 호출하려는 API의 URI와 파라미터를 작성한다.

Item.java

public class Item {
    private String jmCode;
    private String jmName;

    public Item(String jmCode, String jmName) {
        this.jmCode = jmCode;
        this.jmName = jmName;
    }

    public String getJmCode() {
        return jmCode;
    }

    public String getJmName() {
        return jmName;
    }
}

데이터 클래스를 작성한다. 자동으로 파싱될 때와 달리 클래스, 멤버 변수, 메서드 레벨에 어노테이션을 사용하지 않아도 된다. 또한 API에서 사용하는 태그 이름을 맞출 필요도 없다. 종목 코드를 기존 "jmcd"에서 "jmCode"로, 종목 이름을 "jmfldnm"에서 "jmName"으로 좀 더 직관적으로 변경해주었다.

필요에 따라 생성자를 작성하고 getter를 작성해준다.

XmlParser.java

public class XmlParser {
    private String resultCode;
    protected Element itemsElement;

    private final String SUCCESSFUL_CODE = "00";
    private final String TAG = "TAG_XmlParser";

    protected XmlParser(String xml) {
        parseXml(xml);
    }

    private void parseXml(String xml){
        if(xml == null || xml.equals(""))
            return;
            
        try {
            Document document = DocumentHelper.parseText(xml);
            Element responseElement = document.getRootElement(); // header, body
            Element headerElement = responseElement.element("header"); // code, msg
            Element bodyElement = responseElement.element("body"); // items
            resultCode = headerElement.element("resultCode").getText();
            itemsElement = bodyElement.element("items");
        } catch(Exception e) {
            e.printStackTrace();
        }
    }

    public boolean isSuccessful() {
        if(resultCode.equals(SUCCESSFUL_CODE))
            return true;
        return false;
    }
    
    public String getResultCode() {
        return resultCode;
    }
}

내 경우 프로젝트에 사용하기로 한 API들이 모두 같은 단체에서 제공되고 있었기에 모두 같은 구조를 띄고 있었다. 루트 태그인 <response> 하위에 <header>와 <body>가, header 하위에는 결과 코드와 결과 메시지를, body 하위에는 실제 요청한 데이터를 가진 <items>가 존재한다. 이 클래스에서는 실제 데이터가 들어 있는 items를 제외한 태그들을 파싱하고 items는 이 클래스를 상속받는 클래스들이 처리하도록 하여 중복 코드를 줄일 것이다. 이렇게 하면 이 클래스를 상속받는 하위 클래스들은 item 태그를 파싱하는 코드만 구현하면 된다.

클래스 구조를 살펴보면 이 클래스가 객체로 초기화될 때 생성자 파라미터로 String 형태의 XML, 즉 원시 데이터를 받고 parseXml 메서드를 호출하여 계층별로 데이터를 파싱하는 것을 볼 수 있다. 먼저 response의 header와 body를 분리한 뒤 헤더에서는 성공 여부를 판단할 결과 코드를 파싱하고 body는 API마다 가진 데이터가 다르기 때문에 여기서는 파싱하지 않고 멤버 변수에 초기화해둔다. 상속받는 자식 클래스에서 사용할 수 있도록 접근 제한자를 protected로 지정한다.

isSuccessful 메서드는 응답 메시지에 담겨 있던 결과 코드를 토대로 호출 성공 여부를 확인하는 일을 한다. 멤버 변수로 성공 코드 "00"을 미리 작성해두었는데 파싱한 결과 코드와 이 값을 비교하여 성공 여부를 판단할 것이다. 내가 사용하는 API들은 모두 성공 코드로 "00"를 사용했지만 다른 API는 성공 코드가 다를 수 있으니 제공하는 API 문서를 확인하는 것이 좋다.

요청이 실패할 가능성도 있기에 resultCode에 대한 getter를 작성하여 isSuccessful이 false를 반환했을 때 resultCode를 확인할 수 있도록 했다.

ItemXmlParser.java

public class ItemXmlParser extends XmlParser {
    private final String TAG = "TAG_ItemXmlParser";

    public ItemXmlParser(String xml) {
        super(xml);
    }

    public List<Item> getItemList() {
        if(itemsElement == null || itemsElement.getText().equals(""))
            return null;
            
        List<Element> elementList = itemsElement.elements();
        List<Item> itemList = new ArrayList<>(elementList.size());

        for(Element e : elementList)
            itemList.add(new Item(
                    e.element("jmcd").getText(),
                    e.element("jmfldnm").getText()));

        return itemList;
    }
}

위에서 만든 XmlParser를 상속받는 클래스다. 이 클래스는 객체화되는 시점에서 <items>를 제외한 모든 태그의 파싱이 끝난 상태이므로 items 태그를 파싱하는 메서드 getItemList만 작성한다. <items> 하위 태그(item)를 순회하며 데이터를 추출하고 리스트를 반환한다.

MainActivity.java

public class MainActivity extends AppCompatActivity {
    private final String TAG = "TAG_MainActivity";

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        MyAPI myAPI = MyClient.getRetrofit().create(MyAPI.class);
        Disposable disposable = myAPI.getJmList(MyClient.SERVICE_KEY)
                .observeOn(AndroidSchedulers.mainThread())
                .subscribeOn(Schedulers.io())
                .subscribe(xml -> {
                    ItemXmlParser xmlParser = new ItemXmlParser(xml);

                    if(xmlParser.isSuccessful()) {
                        List<Item> list = xmlParser.getItemList();
                    } else {
                        // API 호출 실패
                    }
                }, t -> {
                    Log.e(TAG, "통신 실패(" + t.getMessage() + ")");
                    t.printStackTrace();
                });
    }
}

사용은 매우 간단하다. ItemXmlParser 클래스를 생성하면서 원시 데이터인 API 요청 결과를 생성자에 넘겨주고 getItemList를 호출하여 데이터를 확인한다.

'안드로이드 > API' 카테고리의 다른 글

[Android/Java] 공공 데이터 포털 OpenAPI 에러(Expected BEGIN_OBJECT but was STRING at line 1 column 1 path) (0)	2023.08.16

오래된 연습장