Java Architecture for XML Binding

JAXB осигурява бърз и удобен начин за обвързване на XML схеми и Java представителства, като улеснява разработчиците на Java да включват XML данни и функции за обработка в Java приложения. Като част от този процес, JAXB предоставя методи за демаркиране (четене) на документи от XML екземпляри в дървета със съдържание на Java и след това преобразуване (писане) на дървета със съдържание на Java обратно в документи на XML инстанции. JAXB предоставя също начин за генериране на XML схема от Java обекти.

Анотация	Описание
@XmlRootElement(namespace = “namespace”)	Дефинира коренния елемент за XML дърво
@XmlType(propOrder = { “field2”, “field1”,.. })	Позволява да се определи редът, в който полетата се записват във XML файла
@XmlElement(name = “newName”)	Определя XML елемента, който ще бъде използван. Използва се когато XML името е различно от Java полетo
@XmlAccessorType(XmlAccessType.TYPE)	Определя по какъв начин JAXB достъпва данните в класа — дали чрез полета, getter/setter методи, публични членове или само изрично анотирани елементи
@XmlElementWrapper(name = “wrapperName”)	Създава обвиващ родителски XML елемент около списък от елементи
@XmlTransient	Изключва поле или метод от XML сериализацията

Стойност na AccessType	Описание
FIELD	JAXB използва директно всички полета на класа
PROPERTY	JAXB използва getter/setter методите
PUBLIC_MEMBER	JAXB използва публични полета и публични getter/setter методи
NONE	Само елементи с изрично зададени JAXB анотации се обработват

###

JAXB библиотека

https://mvnrepository.com/artifact/org.glassfish.jaxb/jaxb-runtime

Дефиниране на клас, моделиращ данните в XML файла

@XmlRootElement(name = "student")
@XmlAccessorType(XmlAccessType.FIELD)
// Не е задължително но ако искате, можете да определите реда, в който да се запишат полетата
@XmlType(propOrder = {"fakNum", "name", "specialty"})
public class Student {

    private String name;
    //Ако името на променливата не е подходящо за записване в XML файл, можете лесно да се промените
    @XmlElement(name = "fakNum")
    private String number;
    private String specialty;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getNumber() {
        return number;
    }

    public void setNumber(String number) {
        this.number = number;
    }

    public String getSpecialty() {
        return specialty;
    }

    public void setSpecialty(String specialty) {
        this.specialty = specialty;
    }
}

Създаване на клас за съдържанието на XML файла

//Тази анотация означава, че клас "Group.java" е основният елемент на файла
@XmlRootElement(name = "group")
@XmlAccessorType(XmlAccessType.FIELD)
public class Group {

    // XmLElementWrapper генерира обвиващ елемент около XML елементите, родителския елемент
    @XmlElementWrapper(name = "studentList")
    // XmlElement задава името на вътрешните елементи
    @XmlElement(name = "student")
    private ArrayList<Student> students;
    private int number;
    private String department;

    public void setStudents(ArrayList<Student> students) {
        this.students = students;
    }

    public ArrayList<Student> getStudents() {
        return students;
    }

    public int getNumber() {
        return number;
    }

    public void setNumber(int number) {
        this.number = number;
    }

    public String getDepartment() {
        return department;
    }

    public void setDepartment(String department) {
        this.department = department;
    }
}

Трансформиране в XML

Преобразуването на Java обект към XML се извършва чрез Marshaller. Този процес се нарича marshalling и позволява съдържанието на Java обект да бъде записано като XML структура.

При servlet приложения най-често се използва Writer, защото резултатът трябва да се изпрати директно към HTTP отговора чрез:

response.getWriter()

По този начин XML съдържанието се генерира директно в изходния поток без необходимост от междинен файл.

Реализация:

public void writeToXML(Writer writer, Group group) {

    // Създаване на JAXB контекст за класа Group
    JAXBContext context = JAXBContext.newInstance(Group.class);

    // Създаване на marshaller инстанция
    Marshaller m = context.createMarshaller();

    // Форматиране на XML резултата за по-добра четимост
    m.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE);

    // Записване на Java обекта в изходния поток
    m.marshal(group, writer);
}

Обяснение:

• JAXBContext определя кой клас ще бъде преобразуван
• Marshaller извършва самото преобразуване
• JAXB_FORMATTED_OUTPUT форматира XML с отстъпи
• writer задава къде ще бъде записан резултатът

Работа с файлове:

Същият метод може да работи и с файлове чрез FileWriter:

FileWriter writer = new FileWriter("group.xml");
writeToXML(writer, group);
writer.close();

Това позволява XML съдържанието да бъде записано във файл вместо в HTTP отговор.

Трансформиране от XML

Преобразуването на XML към Java обект се извършва чрез Unmarshaller. Този процес се нарича unmarshalling и позволява XML данните да бъдат прочетени и превърнати в Java обект.

При servlet приложения входящите данни обикновено се четат чрез:

request.getReader()

Затова е по-удобно методът да работи с Reader.

Реализация:

public Group readerFromXML(Reader reader) {

    // Създаване на JAXB контекст
    JAXBContext context = JAXBContext.newInstance(Group.class);

    // Създаване на unmarshaller инстанция
    Unmarshaller um = context.createUnmarshaller();

    // Прочитане на XML и създаване на Java обект
    Group group = (Group) um.unmarshal(reader);

    return group;
}

Добавяне на XSD схема за валидация:

String xsdFile = this.getClass()
        .getClassLoader()
        .getResource("xml/student.xsd")
        .getPath();

XSD файлът съдържа правилата за XML структурата и може да бъде използван при валидиране.

Реализация със схема за валидиране:

public Group readerFromXML(Reader reader) {

    // Създаване на JAXB контекст
    JAXBContext context = JAXBContext.newInstance(Group.class);

    // Създаване на unmarshaller инстанция
    Unmarshaller um = context.createUnmarshaller();

    // Валидиране с XSD схема
    SchemaFactory sf = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI);
    Schema schema = sf.newSchema(new File(xsdFile));
    um.setSchema(schema);

    // Прочитане на XML и създаване на Java обект
    Group group = (Group) um.unmarshal(reader);

    return group;
}

Обяснение:

• Unmarshaller преобразува XML към Java обект
• SchemaFactory зарежда XSD схемата
• setSchema() активира XML валидацията
• reader подава входния XML поток

Работа с файлове:

Методът може да работи и с файл чрез FileReader:

FileReader reader = new FileReader("group.xml");
Group group = readerFromXML(reader);
reader.close();

Така XML може да бъде зареден от външен файл.