[SWIFT] XML Parser 사용하기!

Do Gyung Kim (Bryan)·2023년 11월 16일
iOSproject
0

XML 파일 처리하기

셔틀 버스 앱을 개발하다가 공공데이터 OpenAPI를 사용하려고 하는데 XML로 통신이 이루어 졌다.
JSON처리는 JSONDecoder를 사용해서 비교적 쉽게 처리 할 수 있었는데 XML이 잘 사용되지 않은 방식이라 그런지 정보가 많이 없어서 차근 차근 해보도록 하자.

준비

<response>
	<comMsgHeader/>
	<msgHeader>
		<queryTime>2023-07-02 20:09:20.659</queryTime>
		<resultCode>0</resultCode>
		<resultMessage>정상적으로 처리되었습니다.</resultMessage>
	</msgHeader>
	<msgBody>
		<busArrivalItem>
		<flag>PASS</flag>
		<locationNo1>2</locationNo1>
		<locationNo2>7</locationNo2>
		<lowPlate1>0</lowPlate1>
		<lowPlate2>0</lowPlate2>
		<plateNo1>경기78아1212</plateNo1>
		<plateNo2>경기78아1237</plateNo2>
		<predictTime1>2</predictTime1>
		<predictTime2>13</predictTime2>
		<remainSeatCnt1>39</remainSeatCnt1>
		<remainSeatCnt2>41</remainSeatCnt2>
		<routeId>228000177</routeId>
		<staOrder>74</staOrder>
		<stationId>228002023</stationId>
		</busArrivalItem>
	</msgBody>
</response>

위와 같은 형식의 데이터를 처리하고 싶었다.
우선 처리를 위해 해당 데이터를 담을 구조체를 만들어 줬다.

Struct → BusTime

https://jsonformatter.org/xml-to-swift 해당 사이트를 이용해서 쉽게 만들 수 있다.


import Foundation

// MARK: - BusTime
struct BusTime {
    let response: Response
}

// MARK: - Response
struct Response {
    let comMsgHeader: String
    let msgHeader: MsgHeader
    let msgBody: MsgBody
}

// MARK: - MsgBody
struct MsgBody {
    let busArrivalItem: BusArrivalItem
}

// MARK: - BusArrivalItem
struct BusArrivalItem {
    let flag, locationNo1, locationNo2, lowPlate1: String
    let lowPlate2, plateNo1, plateNo2, predictTime1: String
    let predictTime2, remainSeatCnt1, remainSeatCnt2, routeID: String
    let staOrder, stationID: String
}

// MARK: - MsgHeader
struct MsgHeader {
    let queryTime, resultCode, resultMessage: String
}

Custom Parser

  • XML 처리는 XMLParser를 사용한다.
  • XMLParser는 url 통해 통신이 가능하다.
  • 통신을 통해 받는 데이터를 맞게 처리를 해줘야한다.
  • XMLParserDelegate 프로토콜을 사용하여 delegate 클래스를 만들어 준다.
class MyXMLParser: NSObject, XMLParserDelegate {
    private var currentElement: String?
    private var busTime: BusTime?
    
    // XMLParserDelegate 메서드 중 시작 태그를 만났을 때 호출되는 메서드
    func parser(_ parser: XMLParser, didStartElement elementName: String, namespaceURI: String?, qualifiedName qName: String?, attributes attributeDict: [String : String] = [:]) {
        currentElement = elementName
        if elementName == "response" {
            busTime = BusTime(response: Response(comMsgHeader: "", msgHeader: MsgHeader(queryTime: "", resultCode: "", resultMessage: ""), msgBody: MsgBody(busArrivalItem: BusArrivalItem(flag: "", locationNo1: "", locationNo2: "", lowPlate1: "", lowPlate2: "", plateNo1: "", plateNo2: "", predictTime1: "", predictTime2: "", remainSeatCnt1: "", remainSeatCnt2: "", routeID: "", staOrder: "", stationID: ""))))
        }
    }
    
    // XMLParserDelegate 메서드 중 태그의 텍스트를 만났을 때 호출되는 메서드
    func parser(_ parser: XMLParser, foundCharacters string: String) {
        print("Parser text parser")
        if let element = currentElement {
            if element == "comMsgHeader" {
                busTime?.response.comMsgHeader = string
            } else if element == "queryTime" {
                busTime?.response.msgHeader.queryTime = string
            } else if element == "resultCode" {
                busTime?.response.msgHeader.resultCode = string
            } else if element == "resultMessage" {
                busTime?.response.msgHeader.resultMessage = string
            } else if element == "flag" {
                busTime?.response.msgBody.busArrivalItem.flag = string
            } else if element == "locationNo1" {
                busTime?.response.msgBody.busArrivalItem.locationNo1 = string
            } else if element == "locationNo2" {
                busTime?.response.msgBody.busArrivalItem.locationNo2 = string
            } else if element == "lowPlate1" {
                busTime?.response.msgBody.busArrivalItem.lowPlate1 = string
            } else if element == "lowPlate2" {
                busTime?.response.msgBody.busArrivalItem.lowPlate2 = string
            } else if element == "plateNo1" {
                busTime?.response.msgBody.busArrivalItem.plateNo1 = string
            } else if element == "plateNo2" {
                busTime?.response.msgBody.busArrivalItem.plateNo2 = string
            } else if element == "predictTime1" {
                busTime?.response.msgBody.busArrivalItem.predictTime1 = string
            } else if element == "predictTime2" {
                busTime?.response.msgBody.busArrivalItem.predictTime2 = string
            } else if element == "remainSeatCnt1" {
                busTime?.response.msgBody.busArrivalItem.remainSeatCnt1 = string
            } else if element == "remainSeatCnt2" {
                busTime?.response.msgBody.busArrivalItem.remainSeatCnt2 = string
            } else if element == "routeId" {
                busTime?.response.msgBody.busArrivalItem.routeID = string
            } else if element == "staOrder" {
                busTime?.response.msgBody.busArrivalItem.staOrder = string
            } else if element == "stationId" {
                busTime?.response.msgBody.busArrivalItem.stationID = string
            }
        }
    }
    
    // XMLParserDelegate 메서드 중 종료 태그를 만났을 때 호출되는 메서드
    func parser(_ parser: XMLParser, didEndElement elementName: String, namespaceURI: String?, qualifiedName qName: String?) {
        currentElement = nil
    }
    
    // 파싱이 완료되었을 때 호출되는 메서드 (테스트용)
    func parserDidEndDocument(_ parser: XMLParser) {
        // 파싱 결과 출력
        if let busTime = busTime {
            print("comMsgHeader: \\(busTime.response.comMsgHeader)")
            print("queryTime: \\(busTime.response.msgHeader.queryTime)")
            print("resultCode: \\(busTime.response.msgHeader.resultCode)")
            print("resultMessage: \\(busTime.response.msgHeader.resultMessage)")
            print("flag: \\(busTime.response.msgBody.busArrivalItem.flag)")
            print("locationNo1: \\(busTime.response.msgBody.busArrivalItem.locationNo1)")
            print("locationNo2: \\(busTime.response.msgBody.busArrivalItem.locationNo2)")
            print("lowPlate1: \\(busTime.response.msgBody.busArrivalItem.lowPlate1)")
            print("lowPlate2: \\(busTime.response.msgBody.busArrivalItem.lowPlate2)")
            print("plateNo1: \\(busTime.response.msgBody.busArrivalItem.plateNo1)")
            print("plateNo2: \\(busTime.response.msgBody.busArrivalItem.plateNo2)")
            print("predictTime1: \\(busTime.response.msgBody.busArrivalItem.predictTime1)")
            print("predictTime2: \\(busTime.response.msgBody.busArrivalItem.predictTime2)")
            print("remainSeatCnt1: \\(busTime.response.msgBody.busArrivalItem.remainSeatCnt1)")
            print("remainSeatCnt2: \\(busTime.response.msgBody.busArrivalItem.remainSeatCnt2)")
            print("routeID: \\(busTime.response.msgBody.busArrivalItem.routeID)")
            print("staOrder: \\(busTime.response.msgBody.busArrivalItem.staOrder)")
            print("stationID: \\(busTime.response.msgBody.busArrivalItem.stationID)")
        }
    }
}

여기까지만 봐도 JSON 보다 귀찮은 작업인 걸 확인 할 수 있다.
XML은 태그별로 Parsing을 직접 처리하게 코드를 짜야한다 ㅠ

처리하기

  1. Url 설정
    API 호출에 사용할 URL 주소를 URL 타입으로 만들어 준다.
guard let url = URL(string: self.url) else { return }
  1. XMLParser 인스턴스 만들기
    위에서 만든 url를 사용해 XMLParser 생성
    myXMLParser도 만들어 줌
guard let xmlParser = XMLParser(contentsOf: url) else { return }
let myParser = MyXMLParser()
  1. myXMLParser delegate 하기 및 parse 작업
xmlParser.delegate = myParser
xmlParser.parse()
  1. 함수로 만들어 실행
func load(){
    guard let url = URL(string: url) else { return }
    guard let xmlParser = XMLParser(contentsOf: url) else { return }
    let myParser = MyXMLParser()
    xmlParser.delegate = myParser
    xmlParser.parse()
}

//결과 
comMsgHeader: 
queryTime: 2023-07-04 20:18:48.041
resultCode: 0
resultMessage: 정상적으로 처리되었습니다.
flag: PASS
locationNo1: 2
locationNo2: 13
lowPlate1: 0
lowPlate2: 0
plateNo1: 경기78아1212
plateNo2: 경기78아1228
predictTime1: 2
predictTime2: 27
remainSeatCnt1: 48
remainSeatCnt2: 4
routeID: 228000177
staOrder: 74
stationID: 228002023

문제!!

  • Playground에서 실행하면 잘 되는데, 프로젝트 파일에서는 출력이 안된다…
  • Singleton으로 실행하기 위해 구조체를 만들어서 View의 onAppear에서 실행하게 했는데, 별다른 에러 없이 진행이 된다
  • print를 해보면 nil 값 리턴
struct BusAPI {
    static let shared = BusAPI()
    
    let key = "asdfwef"
    
    let stationId = "228002023"
    
    let routeId = "228000177"
    
    let url = "<https://apis.data.go.kr/6410000/busarrivalservice/getBusArrivalItem?serviceKey=\(key)&stationId=\(stationId)&routeId=\(routeId)>"

    func load() {
        guard let url = URL(string: self.url) else { return }
        guard let xmlParser = XMLParser(contentsOf: url) else { return }
        let myParser = MyXMLParser()
        xmlParser.delegate = myParser
        xmlParser.parse()
        
        print(myParser.busTime?.response.msgHeader.resultMessage)
    }
}

What I Tried!

  • 아무런 에러는 나지 않지만 xmlParser.parse() 에서 false를 리턴한다.
  • 아무래도 네트워크 통신에러라고 생각이 들어서 세부적인 로그를 보기 위해 preview가 아닌 simulator를 돌려봤다.
  • should not occur on this application's main thread as it may lead to UI unresponsiveness. Please switch to an asynchronous networking API such as URLSession.
  • 네트워크 작업을 메인 쓰레드에서 하지 말라는 에러인거 같다.

IOS 16

  • IOS 16부터 메인 쓰레드에서 비동기 작업을 허락하지 않는 듯 싶다.
  • Alamofire를 통해 비동기 작업을 처리해야할듯.

Alamofire

  • 데이터를 불러오지 못해 Alamofire를 사용해 데이터 통신을 하기로 변경
  • parameter 형식으로 정상적인 데이터 통신이 이루어지지 않음
func load() {
        ///공공데이터 key는 인코딩 되어 있기 때문에 디코딩한다.
        let deocdeKey =  key.removingPercentEncoding ?? ""
        
        ///파라미터로 넘기는 값은 Alamofire가 인코딩한다. 하지만 안됐음 ㅠ
        let parameter: [String : String] = [
            "ServiceKey" : deocdeKey,
            "stationId" : stationId,
            "routeId" : routeId,
            "staOrder" : "0"
        ]
        
        AF.request(self.url, parameters: parameter)
            .responseData { (response) in
                switch response.result {
                case .success(let result):
                    let parser = XMLParser(data: result)
                    parser.delegate = self
                    parser.parse()
                    
                case .failure(let error):
                    print(error.localizedDescription, error)
                }
        }
}

에러를 확인해보니 아래 에러가 떳다.

URLSessionTask failed with error: An SSL error has occurred and a secure connection to the server cannot be made. sessionTaskFailed(error: Error Domain=NSURLErrorDomain Code=-1200

  • 해당 에러는 HTTP 통신 관련 에러였다.

해결방법

자세히까지는 모르지만, 보안을 위해 기본적으로 HTTP 통신이 막혀있는 URL을 사용했을 때 뜨는 것을 보인다

nscurl --ats-diagnostics --verbose <https://apis.data.go.kr/6410000/busarrivalservice/getBusArrivalItem>
  • 터미널에 위 명령어를 사용하면 어떤 TLS 버전의 도메인이 에러가 뜨는지 알 수 있다.
  • 이 중 Result:가 PASS인 ATS를 찾아서 xCode에서 설정 해줘야한다
Configuring PFS exceptions for apis.data.go.kr

---
Disabling Perfect Forward Secrecy
ATS Dictionary:
{
    NSExceptionDomains =     {
        "apis.data.go.kr" =         {
            NSExceptionRequiresForwardSecrecy = false;
        };
    };
}
Result : PASS

Info.plist

  • 설정을 위해서는 Info.plist를 수정해줘야 한다.
  • 해당 부분이 swiftUI에서 사용하는 info.plist이다.

  • App Transport Security Settings
    이 부분에 앞서 터미널에서 Result가 Pass인 부분을 보고 알맞게 넣어주면 된다!

Conclusion

결국 성공 해서 버스 도착 시간을 받아 올 수 있었다.!!

참조

Transport-Security-설정법
https://phillip5094.tistory.com/132

profile
Do Gyung Kim (Bryan)
이전 포스트

xcodeproj & wcworkspace 간단히 쓱~ 훑어보기

다음 포스트

[UIKit] Basics Of UIKit!

0개의 댓글