Решение ошибки JAXB: два свойства с одинаковыми именами

Быстрый ответ

Работая с JAXB, может случиться, что в классе окажутся два поля с одним и тем же именем. Чтобы обойти эту проблему, воспользуйтесь аннотацией @XmlTransient для метода, где возник конфликт. Это действует так, что JAXB игнорирует данный метод, и проблема будто испаряется. Код с использованием @XmlTransient выглядит вот так:

import javax.xml.bind.annotation.XmlTransient;

public class YourClass {
    
    @XmlTransient 
    public String getConflictingProperty() {
        return this.property;
    }
    
    public void setConflictingProperty(String prop) {
        this.property = prop;
    }
}

Применяя такой подход, мы делаем метод getConflictingProperty «невидимым» для JAXB, но он все еще остается в коде.

Понимание и использование аннотаций JAXB

Ключевые аннотации JAXB, решающие конфликт имен

Аннотация @XmlAccessorType и элемент @XmlRootElement помогут избежать конфликта имен между полями класса. Они указывают JAXB использовать доступ к полям класса для сериализации и десериализации данных, помогая избежать дублирования свойств. Вот как это работает:

import javax.xml.bind.annotation.*;

@XmlRootElement
@XmlAccessorType(XmlAccessType.FIELD)
public class YourClass {
    // все поля класса станут доступны для JAXB
}

Если параметр изменить на XmlAccessType.PROPERTY, JAXB начнет использовать методы доступа (геттеры/сеттеры) для сериализации, что может вызвать конфликт при несовпадении названий.

Подробнее об этом расскажет наш спикер на видео

Сопоставление XML с Java

Чтобы сопоставить XML-элементы и поля Java, важно сохранить соответствие имен. Если имеются расхождения, можно использовать аннотации @XmlElement или @XmlAttribute для установления правильной связи. Пример:

public class YourClass {
    @XmlElement(name = "xmlElementName")
    private String javaFieldName;
}

Где расставлять аннотации JAXB

С помощью правильного расположения аннотаций на полях класса, вы упрощаете их «понимание» JAXB. Аннотации на методах доступа (геттеры/сеттеры) не должны противоречить аннотациям на полях, если явно не указано иное.

JAXB: версии и обнуленные поля

Если ваши поля обнуляются без всякой на то причины, возможно, дело в версии реализации JAXB. Проверьте и при необходимости обновите ваш jaxb-impl.

Визуализация

Представьте себе конфликт свойств в JAXB, как попытку использовать два разных ключа для открытия одного и того же замка на сундуке с сокровищами:

Сундук с сокровищами: это хранилище ваших данных.
Замок: элемент, к которому привязаны свойства JAXB.
Ключ 1: свойство из поля класса.
Ключ 2: свойство из геттера.

Конфликт происходит, когда оба ключа одновременно пытаются войти в замок:

🔑🔒🔑 = JAXB не может выбрать, какой ключ применить.

Решение простое – определите один из ключей как "Не использовать":

@XmlTransient // помечаем поле
private String propertyName;

Теперь JAXB все понятно:

🔑❌🔒✅ = "Используй ключ от геттера!"

Успешное сопоставление:

🏴‍☠️🔓 = XML данные быстро и без проблем превращаются в Java объект.

Советы и хитрости: эффективное использование JAXB

Создание собственного контекста JAXB

Если вам кажется, что стандартный контекст JAXB ограничивает вас, создайте собственный, используя JAXBContextFactory. Это даст вам более глубокий контроль над настройками и поведением:

JAXBContext context = JAXBContext.newInstance("com.example", ClassLoader.getSystemClassLoader());

Определение типа доступа

JAXB оперирует строго либо с полями, либо со свойствами. Нельзя смешивать оба подхода. Если вы используете @XmlAccessorType, примите одно решение и следуйте ему: либо аннотируйте все поля, либо все методы доступа (геттеры).

Дополнительные маппинги с MOXy

Для выполнения более сложных отображений используйте EclipseLink MOXy с дополнительными аннотациями, такими как @XmlPath и @XmlInverseReference, которые отсутствуют в стандартном JAXB:

import org.eclipse.persistence.oxm.annotations.XmlPath;

public class YourClass {
    @XmlPath("nested/element/text()")
    private String valueFromNestedElement;
}

Полезные материалы

1. Jakarta XML Binding™ | projects.eclipse.org — все о JAXB.
2. javax.xml.bind.annotation (Спецификации API Java(TM) EE 7) — подробная документация по аннотациям JAXB.
3. JAXB (с Java 11) – Учебник — основы работы с JAXB в простой и доступной форме.
4. Привязка Java XML и JSON — блог Блейза Доуэна, создателя EclipseLink MOXy и JSON-B.
5. EclipseLink/FAQ/MOXy/JAXB – Eclipsepedia — все, что вам нужно знать о работе с MOXy.