@XmlRegistry - wie funktioniert das?

Ich habe einige Beispiele von JAXB2 @XmlRegistry über das internet aber keine gute in-depth tutorials, die Diskussion über das Konzept der Verwendung von @XmlRegistry mit @XmlElementDecl, Frage mich, ob es sich um ein Konzept, dass sich nicht viel erforscht im Allgemeinen.

Anyways, hier ist meine Frage, zuerst einige Beispiel-Klassen, die ich benutze, um unmarshall ein xml mit Hilfe von JAXB:

Main-Klasse, die ich bin versucht zu unmarshal mit JAXB - Employee.java

package com.test.jaxb;

import java.util.List;

import javax.xml.bind.JAXBElement;
import javax.xml.bind.annotation.XmlElementDecl;
import javax.xml.bind.annotation.XmlRegistry;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.namespace.QName;

import com.test.jaxb.dto.Address;

@XmlRootElement
public class Employee {
    private int id;
    private String name;
    private String email;

    private List<Address> addresses;

    public int getId() {
        return id;
    }
    public void setId(int id) {
        this.id = id;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public String getEmail() {
        return email;
    }
    public void setEmail(String email) {
        this.email = email;
    }

    public List<Address> getAddresses() {
        return addresses;
    }
    public void setAddresses(List<Address> addresses) {
        this.addresses = addresses;
    }

    @SuppressWarnings("unused")
    @XmlRegistry
    public static class XMLObjectFactory {
        @XmlElementDecl(scope = Employee.class, name= "id")
        JAXBElement<String> createEmployeeId(String value) {
            return new JAXBElement<String>(new QName("id"), String.class, "100");
        }
        @XmlElementDecl(scope = Employee.class, name= "name")
        JAXBElement<String> createName(String value) {
            return new JAXBElement<String>(new QName("name"), String.class, "Fake Name");
        }
        @XmlElementDecl(scope = Employee.class, name= "email")
        JAXBElement<String> createEmail(String value) {
            return new JAXBElement<String>(new QName("email"), String.class, value);
        }

        @XmlElementDecl(scope = Employee.class, name= "addresses")
        JAXBElement<List> createAddresses(List value) {
            return new JAXBElement<List>(new QName("addresses"), List.class, value);
        }
    }
}

Die Kind-Klasse - Address.java

package com.test.jaxb.dto;

import javax.xml.bind.JAXBElement;
import javax.xml.bind.annotation.XmlElementDecl;
import javax.xml.bind.annotation.XmlRegistry;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.namespace.QName;

import com.test.jaxb.Employee;

@XmlRootElement
public class Address {
    private String addressLine1;
    private String addressLine2;
    private String addressLine3;
    public String getAddressLine1() {
        return addressLine1;
    }
    public void setAddressLine1(String addressLine1) {
        this.addressLine1 = addressLine1;
    }
    public String getAddressLine2() {
        return addressLine2;
    }
    public void setAddressLine2(String addressLine2) {
        this.addressLine2 = addressLine2;
    }
    public String getAddressLine3() {
        return addressLine3;
    }
    public void setAddressLine3(String addressLine3) {
        this.addressLine3 = addressLine3;
    }

    @SuppressWarnings("unused")
    @XmlRegistry
    private static class XMLObjectFactory {
        @XmlElementDecl(scope = Employee.class, name= "addressLine1")
        JAXBElement<String> createAddressLine1(String value) {
            return new JAXBElement<String>(new QName("addressLine1"), String.class, value);
        }
        @XmlElementDecl(scope = Employee.class, name= "addressLine2")
        JAXBElement<String> createAddressLine2(String value) {
            return new JAXBElement<String>(new QName("addressLine2"), String.class, value);
        }
        @XmlElementDecl(scope = Employee.class, name= "addressLine3")
        JAXBElement<String> createAddressLine3(String value) {
            return new JAXBElement<String>(new QName("addressLine3"), String.class, value);
        }
    }
}

Den xml-unmarshallt - employee.xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<employee>
    <id>1</id>
    <name>Vaishali</name>
    <email>[email protected]</email>
    <addresses>
        <address>
            <addressLine1>300</addressLine1>
            <addressLine2>Mumbai</addressLine2>
            <addressLine3>India</addressLine3>
        </address>
        <address>
            <addressLine1>301</addressLine1>
            <addressLine2>Pune</addressLine2>
            <addressLine3>India</addressLine3>
        </address>
    </addresses>
</employee>

Unmarshalling-Code :

package com.test.jaxb;

import java.io.FileReader;

import javax.xml.bind.JAXBContext;
import javax.xml.bind.Unmarshaller;


public class ObjectFactoryTest {
    public static void main(String[] args) throws Exception {
        FileReader reader = new FileReader("resources/employee.xml");
        JAXBContext context = JAXBContext.newInstance(Employee.class);
        Unmarshaller unmarshaller = context.createUnmarshaller();
        Object obj = unmarshaller.unmarshal(reader);
        System.out.println(obj);
    }
}

Wenn ich unmarshal der Mitarbeiter unter Verwendung der obigen xml-code, die Adresse der Liste nicht aufgefüllt. Die daraus resultierende Mitarbeiter-Objekt hat nur eine leere Liste von Adressen. Gibt es etwas falsch mit meinen Zuordnungen?

Finden Sie heraus, was Los ist und sehen, ob die Mitarbeiter-Objekte sind tatsächlich erstellt wird, mithilfe der Objekt-Factory (mit der @XMLRegistry annotation), änderte ich den Wert der id und name in der Fabrik-Methoden, aber das hatte keine Auswirkungen auf die Ausgabe, die mir sagt, JAXB ist nicht wirklich mit der ObjectFactory, warum?

Werde ich aboout diese alle falsch? Jede Hilfe würde geschätzt werden.

InformationsquelleAutor gresdiplitude | 2012-06-18

@XmlRegistry - wie funktioniert das?

@XmlRegistry wird verwendet, um eine Klasse, die @XmlElementDecl Anmerkungen. Ihre JAXB Implementierung dieser Klasse, die Sie benötigen, um sicherzustellen, dass es ist aufgenommen in der Liste der Klassen, die Sie zum bootstrap der JAXBContext. Es ist nicht genug für Sie zu sein, eine statische innere Klasse eines domain-model-Klassen:

JAXBContext context = JAXBContext.newInstance(Employee.class, Employee.XMLObjectFactory.class);

@XmlElementDecl - wie funktioniert das?

Wenn der Wert des Feldes/Eigenschaft wird ein JAXBElement dann müssen Sie nutzen @XmlElementDecl. Ein JAXBElement erfasst Informationen, die hilfreich sein können:

Element name, das ist notwendig, wenn Sie die Zuordnung zu einer Wahl, die Struktur, in denen mehrere Elemente des gleichen Typs. Wenn der name des Elements entspricht nicht einem eindeutigen Typ, dann würden Sie nicht in der Lage sein, um round-trip-Dokument.
JAXBElement können verwendet werden zum repräsentieren ein element mit xsi:nil="true".

XmlObjectFactory

@XmlElementDecl können Sie auch einen Bereich angeben. Ich habe modifiziert das Modell von dir post ein bisschen. Ich habe eingeführt eine XmlObjectFactory Klasse, die zwei @XmlElementDecl. Beide geben Sie einen Namen address. Ich nutzte die scope Eigenschaft so ein, dass für die Eigenschaften innerhalb der Employee Klasse der @XmlElementDecl entsprechend der Address Klasse mit verwendet werden.

package forum11078850;

import javax.xml.bind.JAXBElement;
import javax.xml.bind.annotation.XmlElementDecl;
import javax.xml.bind.annotation.XmlRegistry;
import javax.xml.namespace.QName;

@XmlRegistry
public class XmlObjectFactory {

    @XmlElementDecl(scope = Employee.class, name = "address")
    JAXBElement<Address> createAddress(Address value) {
        return new JAXBElement<Address>(new QName("address"), Address.class, value);
    }

    @XmlElementDecl(name = "address")
    JAXBElement<String> createStringAddress(String value) {
        return new JAXBElement<String>(new QName("address"), String.class, value);
    }

}

Mitarbeiter

Den @XmlElementRef Anmerkung wird die Ursache der Wert der Eigenschaft abgeglichen werden, die auf seinem root-element name. Mögliche übereinstimmungen werden Klassen zugeordnet, die mit @XmlRootElement oder @XmlElementDecl.

package forum11078850;

import java.util.List;

import javax.xml.bind.JAXBElement;
import javax.xml.bind.annotation.*;

@XmlRootElement
@XmlType(propOrder = { "id", "name", "email", "addresses" })
public class Employee {
    private int id;
    private String name;
    private String email;

    private List<JAXBElement<Address>> addresses;

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

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

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }

    @XmlElementWrapper
     @XmlElementRef(name="address")
    public List<JAXBElement<Address>> getAddresses() {
        return addresses;
    }

    public void setAddresses(List<JAXBElement<Address>> addresses) {
        this.addresses = addresses;
    }

}

ObjectFactoryTest

package forum11078850;

import java.io.FileReader;
import javax.xml.bind.*;

public class ObjectFactoryTest {
    public static void main(String[] args) throws Exception {
        FileReader reader = new FileReader("src/forum11078850/input.xml");
        JAXBContext context = JAXBContext.newInstance(Employee.class, XmlObjectFactory.class);
        Unmarshaller unmarshaller = context.createUnmarshaller();
        Object obj = unmarshaller.unmarshal(reader);

        Marshaller marshaller = context.createMarshaller();
        marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
        marshaller.marshal(obj, System.out);
    }
}

Den Address Klasse und input.xml aus meiner ursprünglichen Antwort kann verwendet werden, um dieses Beispiel auszuführen.

URSPRÜNGLICHE ANTWORT

Ich bin mir nicht sicher, wie Sie Sie verwenden möchten @XmlRegistry, also konzentriere ich mich auf den folgenden Teil Ihres Beitrags:

Wenn ich unmarshal der Mitarbeiter unter Verwendung der obigen xml-code, die Adresse der Liste
nicht besiedelt. Die daraus resultierende Mitarbeiter-Objekt hat nur eine leere
Liste von Adressen. Gibt es etwas falsch mit meinen Zuordnungen?

Ihre Liste der Address Objekte verpackt in einem Gruppierungselement (addresses), so müssen Sie die @XmlElementWrapper Anmerkung zum anzeigen dieser use-case. Unten ist ein komplettes Beispiel:

Mitarbeiter

package forum11078850;

import java.util.List;
import javax.xml.bind.annotation.*;

@XmlRootElement
@XmlType(propOrder = { "id", "name", "email", "addresses" })
public class Employee {
    private int id;
    private String name;
    private String email;

    private List<Address> addresses;

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

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

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }

    @XmlElementWrapper
    @XmlElement(name = "address")
    public List<Address> getAddresses() {
        return addresses;
    }

    public void setAddresses(List<Address> addresses) {
        this.addresses = addresses;
    }

}

Adresse

package forum11078850;

public class Address {
    private String addressLine1;
    private String addressLine2;
    private String addressLine3;

    public String getAddressLine1() {
        return addressLine1;
    }

    public void setAddressLine1(String addressLine1) {
        this.addressLine1 = addressLine1;
    }

    public String getAddressLine2() {
        return addressLine2;
    }

    public void setAddressLine2(String addressLine2) {
        this.addressLine2 = addressLine2;
    }

    public String getAddressLine3() {
        return addressLine3;
    }

    public void setAddressLine3(String addressLine3) {
        this.addressLine3 = addressLine3;
    }

}

ObjectFactoryTest

package forum11078850;

import java.io.FileReader;
import javax.xml.bind.*;

public class ObjectFactoryTest {
    public static void main(String[] args) throws Exception {
        FileReader reader = new FileReader("src/forum11078850/input.xml");
        JAXBContext context = JAXBContext.newInstance(Employee.class);
        Unmarshaller unmarshaller = context.createUnmarshaller();
        Object obj = unmarshaller.unmarshal(reader);

        Marshaller marshaller = context.createMarshaller();
        marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
        marshaller.marshal(obj, System.out);
    }
}

Eingang.xml - /Ausgabe

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<employee>
    <id>1</id>
    <name>Vaishali</name>
    <email>[email protected]</email>
    <addresses>
        <address>
            <addressLine1>300</addressLine1>
            <addressLine2>Mumbai</addressLine2>
            <addressLine3>India</addressLine3>
        </address>
        <address>
            <addressLine1>301</addressLine1>
            <addressLine2>Pune</addressLine2>
            <addressLine3>India</addressLine3>
        </address>
    </addresses>
</employee>

Ich habe mehrere Beispiele von '@XmlRegistry' verwendet die gleiche Weise war es, als ich es mit, schauen Sie [hier] (codezealot.org/archives/5). Ich verstehe, dass ich verwenden können '@XmlElementWrapper', dies zu tun. Meine Frage war, mehr über das Verständnis dessen, was '@XmlRegistry' ist und was ich machen kann. AFAIK sollte ich in der Lage zu verwenden, die objectfactory (kommentiert mit "@XmlRegistry') zu unmarshal xml und konvertieren Sie es in ein Objekt. Wenn nicht, für was wird es verwendet? Muss ich mich registrieren, es somehwhere für die es verwendet werden (wie zeige ich in meinem Beispiel, mein Objekt-Fabrik ist nie wirklich verwendet JAXB)?
Mein Verständnis mag völlig fehlerhaft hier, aber ich dachte, es muss eine Möglichkeit der Anwendung etwas ähnliches wie '@XmlElementWrapper' der '@XmlRegistry', als eine Alternative Art der unmarshalling von XML. Keine Punkte für das erraten, ich bin Total verwirrt, wie @XmlRegistry funktioniert!!!
Ich aktualisiert meine Antwort um ein Beispiel für die Nutzung @XmlRegistry und @XmlElementDecl
+1 für die Erklärung der Konzepte, dein blog hat es in der Vergangenheit gegeben, mir Antworten auf viele meiner jaxb Probleme, jedoch habe ich keine tutorials zu diesem Thema, vielleicht könnten Sie tun, auf Sie. Müssen versuchen, diese heraus, bevor ich die Antwort akzeptieren.
Ich bin froh zu hören, Sie gefunden zu haben mein blog nützlich. Ich werde diesen post in einem Artikel als gut. Ich möchte sicherstellen, dass Sie bekommen die Antwort, die du suchst, lass mich nicht aus der Verantwortung, wenn die Dinge nicht noch klar :).
funktioniert! Ihre Antwort erklärt, wie und Wann @XmlRegistry gut, vielen Dank!

InformationsquelleAutor bdoughan

-1

Haben Sie, um eine Liste Objekt-Adresse. In diesem Objekt, haben Sie das Objekt hinzufügen, die die Daten enthält, wie addressline1. addressline2 und so weiter.
```
 i.e.
 List addrObjList = new List();
 addrObjList.add(object); //Bind an object containing data and add one by one 
```
- Zwei Dinge, das sollte nicht erforderlich sein, da die Adresse-Klasse selbst ist annotiert mit @XmlRootElement und hat eine Objekt-Fabrik seines eigenen, JAXB sollte in der Lage sein, das zu tun, automatisch... und zwei - wie ich bereits in meiner Frage JAXB nicht zu sein scheinen mit der Objekt-Factory an alle änderungen, die ich machen, um factory-Methoden haben keine Wirkung.
InformationsquelleAutor Alpesh Prajapati

Schreibe einen Kommentar

Du musst angemeldet sein, um einen Kommentar abzugeben.