About JAXB

Java Architecture for XML Binding (JAXB)
번역 : 이원찬

Ed Ort and Bhakti Mehta


이 기사는 다음의 주제들을 다룰것입니다.

- JAXB란 무엇인가?
- 예제1 : XML문서 접근
- 스키마 바인딩
- 다큐먼트 언마샬
- 예제2 : XML문서 생성
- 스키마 바인딩
- 내용트리 작성
- 내용트리 마샬
- 예제3 : XML문서 갱신
- 바인딩 커스터마이징
- 별도의 잇점
- 예제 실행

What's JAXB?

Extensable Markup Language(XML)과 자바기술은 개발자가 인터넷을 통해 데이터와 프로그램의 교환을 돕는 자연스러운 파트너이다. 이것은 XML이 이기종 시스템들과 데이터를 교환하기 위한 표준으로 부상했으며 자바기술은 포터블 어플리케이션 플랫폼을 제공하기 때문이다. 이러한 파트너쉽은 특히 웹서비스에 대해 매우 중요하다. 이것은 사용자와 어플리케이션 개발자의 요구에 따른 프로그램의 기능을 어디서, 어디로든지(from anywhere to anywhere) 웹상에서 제공할 수 있다. XML과 자바기술은 웹서비스와 어플리케이션을 구현하기 위한 이상적인 도구로 인정받고 있다.

그러나 실제 이 둘을 어떨게 조합할 것인가? 더 구체적으로 말하자면 어떻게 자바 프로그램으로 XML문서(이것은 XML태그 데이터를 포함한 파일을 말한다) 에 접근하고 이를 이용할 것인가 하는것이다. 이를 구현하기 위한 가장 보편화된 방법중의 하나는 Simple API for XML(SAX)나 Document Object Model(DOM)과 같은 파서의 도움을 받는것이다. 이 파서들은 Java API for XML Processing(JAXP)에 포함되어 제공된다. 자바 개발자는 어플리케이션에서 JAXP API를 통해 SAX나 DOM을 호출하여 파싱된 데이터(이것은 문서를 스캔하고 논리적으로 여러개의 조각으로 나누는것이다.) 를 얻을 수 있다. 파싱된 데이터는 어플리케이션 이용될 수 있다. SAX의 경우는 파서가 문서의 시작점에서 시작된다. 그리고 문서의 각 부분을 순차적으로 어플리케이션에 전달한다. 메모리에는 아무것도 남기지 않는다. 어플리케이션은 파서로부터 데이터를 받을때에는 어떤 액션을 취할 수 있지만 어떤 데이터도 메모리상에 두고 취급 할 수 없다. 예를들어 이것은 데이터를 메모리상에서 갱신하고 갱신된 데이터를 XML파일로 리턴할 수 없다.

DOM접근법으로, 파서는 객체의 트리를 생성한다. 이 트리는 문서상에 존재하는 컨텐츠와 데이터의 정렬을 그대로 표현한다. 이 경우 트리는 메모리상에 존재한다. 어플리케이션은 트리를 이용해 필요한 데이터에 접근하고 적절한 연산을 수행한다.

지금 개발자들은 XML문서를 더 쉽게 이용한 수 있는 또다른 자바API를 만났다.(Java Architecture for XML Binding(JAXB)). 이 API에 대한 구현은 지금 Java Web Services Developer Pack v.1.1(또는 그 이상 버젼)에서 구할 수 있다.

이제부터 실제 JAXB가 어떻게 행동하는지, SAX와 DBM기반 처리와 비교해 보겠다.

An Example : Accessing an XML Document

당신은 books.xml과 같은 XML문서를 접근하고 출력하는 자바 어플리케이션을 개발할 필요가 있다. 이 문서는 책이름, 저자, 요약설명, ISBN과 같은 책에 관한 데이터를 포함하고 있다. 당신은 SAX 또는 DOM으로 XML문서에 접근하여 데이터를 출력할 수 있다. 예를들어, SAX를 사용한다면 다음과 같은 절차를 따르게된다:

먼저 SAX파서를 생성하는 프로그램을 작성하고 그 파서로 XML문서를 파싱한다. SAX파서는 문서의 처음부터 시작한다. 파서가 XML문서의 시작을 알리는 태그와 같은 특정 신호를 받았을때(SAX용어로, 이벤트라 한다) 호출한 프로그램은 해당 데이터를 이용할 수 있다.

컨텐트 핸들러를 생성하라. 이 핸들러는 이벤트가 발생할때마다 파서에 의해 호출되는 메소드를 정의한다. 이러한 콜백 메소드들은 데이터를 받을때 주로 적절한 액션을 수행한다.

예를들어, 여기 JAXP를 이용하여 XML문서를 파싱하고 생성하는 프로그램이 있다. 프로그램은 MyContentHandler라는 컨텐트핸들러를 이용한다. 이 핸들러는 SAX파서를 이용해 전달받은 데이터를 출력한다.

이제 JAXB를 이용하여 어떻게 books.xml과 같은 XML문서를 처리하고 데이터를 출력하는지 살펴보자. JAXB를 이용하여 당신은 다음과 같은 일을 할 수 있다:

* XML문서를 위한 스키마를 바인딩한다.
* 문서를 언마샬하여 자바 객체로 컨텐츠를 생성한다. 자바객체는 컨텐츠를 표현하고 XML문서형태로 정리된다. 이것은 당신의 프로그램에서 직접 이용할 수 있다.

마샬링이 끝나고 프로그램은 XML문서상에 있는 데이터에 접근하고 출력할 수 있다. 이것은 자바 컨텐츠 객체에 접근하여 손쉽게 출력된다. 여기에는 파서를 생성하고나 이용하지 않는다. 그리고, 컨텐츠 핸들러나 콜백 메소드도 사용되지 않는다. 이것은 개발자가 XML또는 XML처리에 대해 알지 못하여도 XML데이터를 처리할 수 있다는 것을 의미한다.

Bind the Schema

JAXB는 XML문서를 자바형식의 프로그램으로 표현하여 자바 프로그램으로 부터 XML문서에 대한 접근을 손쉽게 한다. 이를 위한 첫번째 단계는 XML문서에 해당하는 스키마를 이와 상응하는 자바클래스들로 바인딩 하는것이다.

Schema: 스키마는 XML스펙이다. 이것은 XML문서에 허용가능한 컴퍼넌트화 컴퍼넌트간의 관계를 관리한다. 예를들어, 스키마는 각 요소(element)들을 구분한다. 그것은 XML문서에 표현된다. 이것이 반드시 어떤 순서로 보여져야 한다거나, 어떤 속성(attribute)을 가질 수 있는지, 어떤 요소가 다른 요소로 확장되는지 구분한다. XML문서는 반드시 XML스키마를 가질 필요는 없다. 스키마가 정확한 XML문서 형태를 갖추었는지 확인 하는 절차가 필요하다. JAXB는 당신이 접근하고자 하는 XML문서는 스키마를 가지고 있다. 이 스키마는 W3C XML Schema Language오 생성되었다.

이 예를 가정해 보자. books.xml문서는 books.xsd라는 W3C XML Schema를 가지고 있다. 이 스키마는 이라는 이름의 컴플렉스타입의 요소를 정의한다. 이것은 이 요소가 자식요소를 가진다는 것을 의미한다. 이 경우 요소이다. 각 요소는 , , 등과 같은 자식요소를 가지고 있다.

바인딩: 스키마를 바인딩한다는 말은 스키마를 표현하는 자바 클래스의 집합을 생성한다는 의미이다. 모든 JAXB구현은 바인딩 컴파일러라 불리는 스키마를 바인딩하기 위한 도구를 제공한다. (바인딩 컴파일러의 사용법은 각기 구현에 따라 다르다) 예를들어, JAXB레퍼런스 구현은 스크립트롤 통해 호출되는 바인딩 컴파일러를 제공한다. 당신이 books.xsd 스키마를 JAXB레퍼런스 구현에서 제공하는 바인딩 컴파일러를 이용하여 바인딩 하기를 원한다고 가정하자. 당신이 솔라리스 운영체제 환경에 있다면 당신은 스키마를 바인딩하기 위해 다음과 같이 스크립트를 이용할 수 있다.

xjc.sh -p test.jaxb books.xsd -d work

-p 옵션은 생성된 클래스를 위한 패키지를 구분하고 -d 옵션은 클래스가 저장될 디렉토리를 구분한다. 이 명령으로 클래스들은 test.jaxb. 라고 work 디렉토리 아래에 패키지된다.

바인딩 컴파일러는 인터페이스 집합과 그 인터페이스를 구현하는 클래스들을 생성할 책임을 가지고 있다. 다음은 books.xsd 스키마를 위해 생성된 인터페이스들이다:

- CollectionType.java 요소의 (unnamed)Complex type을 나타낸다.
- Collection.java 요소를 나타낸다.
- BookType.java BookType Complex type을 나타낸다.
- ObjectFactory.java 인터페이스의 인스턴스를 생성하기위한 메소드들을 가지고있다.

다음의 클래스들은 인터페이스를 구현한다. (이 구현들은 impl서브디렉토리에 생성된다.) 이 클래스들은 구현중심이라는 것을 명심하라. 클래스들은 구현 중심이므로 하나의 JAXB구현에서 바인딩 컴파일러에 의해 생성된 클래스들은 또다른 JAXB구현에 대해서는 재대로 작동하지 않을 것이다. 그러므로, 다른 JAXB를 구현하기 위해서는 스키마를 바인딩 컴파일러와 함께 다시 재바인딩 해주어야 한다.

- impl/CollectionTypeImpl.java CollectionType.java에 기술된 CollectionType인터페이스를 구현한다.
- impl/CollectionImpl.java Collection.java에 기술된 Collection을 구현한다.
- impl/BookTypeImpl.java BookType.java에 기술된 BookType을 구현한다.

This compiles all of the interfaces and classes in the test.jaxb package generated by the binding compiler.

생성된 모든 클래스들은 book.xsd스키마 전체를 나타낸다. 클래스의 get과 set메소드는 스키마에 명시된 요소와 속성의 타입에 따라 데이터를 넣거나 가져오는데 사용된다.

이제 당신은 생성된 인터페이스와 클래스들을 컴파일 할 수 있다. 예를들어 :

javac test/jaxb/*.java test/jaxb/impl/*.java

이 컴파일은 test.jaxb 패키지에 포함된 모든 클래스들과 인터페이스를 컴파일 한다.

Unmarshal the Document

XML문서를 언마샬 하는것은 컨텐츠객체의 트리를 생성하는 것이다. 이것은 문서의 컨텐츠와 구성을 표현한다. 컨텐츠 트리는 DOM기반의 트리가 아니다. 사실, JAXB를 통해 생성된 컨텐츠 트리는 DOM기반 트리에 비해 더 효율적으로 메모리를 사용한다.

컨텐츠 객체는 바인딩 컴파일러에 의해 컴파일된 클래스들의 인스턴스들이다. 바인딩 컴파일러 외에 JAXB구현은 마샬링과 같은 JAXB와 관현된 구현 런타임API를 제공해야만 한다. API들은 바인딩 프레임웍의 부분으로 제공된다. 바인딩 프레임웍은 세개의 패키지로 구성된다. 기본패키지인 javax.xml.bind 는 마샬링, 언마샬링, 확인(validation)과 같은 기능을 수행한다. 두번째로 javax.xml.bind.util 패키지는 많은 유틸리티 클래스들을 포함한다. 세번째로 javax.xml.bind.helper 패키지는 JAXB구현 제공자(priovider)를 위해 설계되었다. (역자주: JAXB implementation provider는 바인딩 컴파일러로 생성된 JAXB implementation을 말한다)

XML문서를 언마샬하기 위해서는:

- JAXBContext 객체를 생성한다. 이 객체는 JAXB API의 엔트리포인트를 제공한다. 객체를 생성할때는 컨텍스트경로를 명시하여야 한다. 이것은 바인딩 컴파일러에 의해 생성된 인터페이스를 포함한 하나 또는 그 이상의 패키지명의 목록이다. 컨텍스트경로에 여러개의 패키지명을 허용함으로써 JAXB는 서로다른 스키마의 XML데이터요소 조합을 언마샬할 수 있도록 지원한다.

예를들어 다음의 코드는 컨텍스트경로가 test.jaxb인 JAXBContext객체를 생성한다. 이 패키지는 books.xsd스키마를 위한 인터페이스를 포함한다.

import javax.xml.bind.JAXBContext;

JAXBContext jc = JAXBContext.newInstance("test.jaxb");

- 언마샬객체는 언마샬링과정을 제어한다. 이것은 실질적인 언마샬명령을 수행사는 메소드를 포함한다. 예를들어, 다음의 코드는 Unmarshaller 객체를 생성한다.

Import javax.xml.bind.Unmarshaller;

Unmarshaller unmarshaller = jc.createUnmarshaller();

- unmarshal 메소드를 호출하면 실질적인 XML문서의 엄마샬링을 한다. 예를들어 다음의 문장은 books.xml파일의 XML데이터를 언마샬한다.

Collection collection = (Collection)unmarshaller.unmarshal(new File(“books.xml”));

(주의) 여기서 Collection은 java.util.Collection이 아니라 test.jaxb.Collection 이다.

- 스키마에서 파생된 클래스의 get메소드의 사용은 XML데이터에 접근할수있게 한다. JAXB컴파일러가 생성한 클래스는 해당 스키마의 각 속성타입 또는 요소의 데이터를 획득하거나 기술할 수 있는 get, set메소드를 포함하고 있다. 예를들어, 다음의 문장은 books와 book요소의 데이터를 가져온다.

CollectionType.BooksType booksType = collection.getBooks();
List bookList = booksType.getBook();

데이터를 획득한 다음에는 프로그램상에서 직접 이것을 출력할 수 있다. 여기 books.xml파일의 데이터를 언마샬 하고 화면에 출력하는 프로그램 예제가 있다. 이 프로그램을 실행하면 다음의 결과를 보게 될 것이다.

Book details
Item id: 999
Book Name: Learning JAXB
Book ISBN: 123445
Book Price: 34 $
Book category: other
Book promotion: 10% on this book if purchased by March 2003
No of Authors 1
Author Name Jane Doe

Book details
Item id: 129
Book Name: Java Webservices today and Beyond
Book ISBN: 522965
Book Price: 29 $
Book category: magazine
Book promotion: Buy one get Learning webservices Part 1 free
No of Authors 2
Author Name John Brown
Author Name Peter T.

원본데이터의 확인 : 프로그램이 다음의 문장을 포함하고 있는지 확인하라.

unmarshaller.setValidating(true);

이 문장은 JAXB의 중요한 기능을 보여준다: 원본데이터의 무결성 검사는 스키마를 이용해 언마샬과정의 일부로 확인될 수 있다. 이경우, JAXB에게 원본데이터의 무결성을 검사할것인지 묻게된다. 만약 데이터에 문제가 발견되면 JAXB구현은 이것을 기록하거나 다른 행동을 취할 수 있다. JAXB는 여기에 매우 많은 유연성을 제공한다. JAXB스펙은 에러가 발생하였을 시 모든 제공자(Provider)가 validation 에러를 남기도록 명시하고 있다. 그러나, 구현(implementation)은 데이터의 처리를 멈추지 않아도 된다. 어떤 제공자는 첫번째 오류가 발생시 실행을 멈출것이고, 어떤 제공자는 매우 많은 에러가 발견되어도 멈추지 않을 것이다. 다시말해, 이것은 JAXB구현이 올바르지않은 XML문서도 성공적으로 언마샬 하고 자바객체트리를 생성할 수 있음을 말한다. 그러나, 결과는 바뀌지 않을 것이다. 모든 JAXB구현에게 핵심적으로 요구되는 기능은 정상적인 문서를 언마샬 할 수 있는것이다.

당신이 이러한 validation작업을 과부하(Overhead)라고 생각한다면 이러한 validating작업을 언제든지 끌수도 있다.

다른 소스의 언마샬링: 앞서본 예제가 파일로 저장된 XML데이터를 어떻게 언마샬하는지 설명하였지만 이것은 파일 뿐만이 아니라 InputStream객체나 URL, DOM노드와 같은 다른 소스도 언마샬할 수 있다. 예를들어, javax.xml.transform.sax.SAXSource객체는 언마샬할 수 있다. SAX이벤트도 언마샬 할 수 있다. 다시말해, 당신은 다큐먼트의 SAX파싱을 하고 이벤트를 JAXB에 전달하여 언마샬을 할 수 있다.

언마샬링을 하지않고 데이터 다루기: JAXB는 언마샬을 하지 않고도 XML데이터를 다룰수 있도록 한다. 스키마로부터 생성된 클래스들중에 ObjectFactory라는 클래스가 있다. 이것은 각 스키마에서 파생된 인터페이스와 클래스의 객체를 생성하는 메소드를 가지고 있다. 예를들어, books.xsd를 위해 생성된 패키지에는 ObjectFactory클래스가 있고 이 클래스는 createCollection이라는 Collection객체를 생성하기 위한 메소드가 있고 createBookType은 BookType객체를 생성한다. 이 메소드들은 어떤 언마샬과정을 거치지 않고 컨텐츠객체의 트리를 생성할 수 있게 한다. 이런 객체를 생성한 뒤에 컨텐츠를 삽입하기 위해서는 각 객체의 set메소드를 이용하면 된다.

또 다른 예제: XML문서 구축

당신은 XML문서데이터를 직접 제어하는것 보다 자바 어플리케이션을 통해 제어하는것을 필요로 할것이다. 여기 JAXB를 이용한 쉬운예가 있다.

XML문서를 생성하기 위해 DOM식의 접근법을 사용하였을 것이다. 이것은 당신이 문서의 내용을 메모리상에서 생성할 필요가 있기 때문이다. 반면에 SAX는 메모리상에서 데이터를 생성하는 작업을 허용하지 않는다. DOM식의 접근법을 이용할때, 프로그램은 문서를 생성하기 위해 DOM객체와 메소드를 생성하고 사용하게 된다. DOM은 데이터를 정렬하여 트리객체처럼 보여주도록 설계되었다. 당신의 프로그램이 Document 객체의 메소드를 사용하면 트리의 노드와 같은 다른 객체를 생성해 낼 수 있다. 각 노드는 XML문서의 내용을 포함하고 있다. 당신은 트리의 정렬순서에 따라 노드를 추가할 수 있다. 다시말해, DOM객체의 메소드는 루트노드를 만들거나 그 루트노드를 Document객체에 추가한다.