Создание неизменяемых объектов с помощью JAXB

Ответ 1

Вы можете создать прокси для своего beans перед тем, как вернуть его клиенту. Вам понадобится javassist для создания прокси из классов (создание прокси из интерфейсов может быть выполнено с помощью Java SE напрямую).

Затем вы можете вызвать исключение, если вызываются методы, начинающиеся с "set".

Вот многоразовый класс с методом, который может обернуть "любое" POJO:

import java.lang.reflect.Method;

import javassist.util.proxy.MethodFilter;
import javassist.util.proxy.MethodHandler;
import javassist.util.proxy.Proxy;
import javassist.util.proxy.ProxyFactory;

public class Utils {

 public static <C> C createInmutableBean(Class<C> clazz, final C instance)
        throws InstantiationException, IllegalAccessException {
    if (!clazz.isAssignableFrom(instance.getClass())) {
        throw new IllegalArgumentException("given instance of class "
                + instance.getClass() + " is not a subclass of " + clazz);
    }
    ProxyFactory f = new ProxyFactory();
    f.setSuperclass(clazz);
    f.setFilter(new MethodFilter() {
        public boolean isHandled(Method m) {
            // ignore finalize()
            return !m.getName().equals("finalize");
        }
    });
    Class c = f.createClass();
    MethodHandler mi = new MethodHandler() {
        public Object invoke(Object self, Method m, Method proceed,
                Object[] args) throws Throwable {
            if (m.getName().startsWith("set")) {
                throw new RuntimeException("this bean is inmutable!");
            }

            return m.invoke(instance, args); // execute the original method
                                                // over the instance
        }
    };
    C proxy = (C) c.newInstance();

    ((Proxy) proxy).setHandler(mi);
    return (C) proxy;
 }
}

И вот пример кода. Пусть Employee будет вашим bean:

public class Employee{
  private String name="John";
  private String surname="Smith";
  public String getName() {
    return name;
  }
  public void setName(String name) {
    this.name = name;
  }
  public String getSurname() {
    return surname;
  }
  public void setSurname(String surname) {
    this.surname = surname;
  }
};

И вот тестовый пример, показывающий, что вы можете создать прокси для POJO, использовать его получатели, но вы не можете использовать его сеттеры

@Test
public void testProxy() throws InstantiationException, IllegalAccessException{
    Employee aBean = new Employee();

    //I can modify the bean
    aBean.setName("Obi-Wan");
    aBean.setSurname("Kenobi");

    //create the protected java bean with the generic utility
    Employee protectedBean = Utils.createInmutableBean(Employee.class, aBean);

    //I can read
    System.out.println("Name: "+protectedBean.getName());
    System.out.println("Name: "+protectedBean.getSurname());

    //but I can't modify
    try{
        protectedBean.setName("Luke");
        protectedBean.setSurname("Skywalker");
        throw new RuntimeException("The test should not have reached this line!");
    }catch(Exception e){
        //I should be here
        System.out.println("The exception was expected! The bean should not be modified (exception message: "+e.getMessage()+")");
        assertEquals("Obi-Wan", protectedBean.getName());
        assertEquals("Kenobi", protectedBean.getSurname());
    }
}

Ответ 2

по JSR-133 (зависимость от Java 1.5) вы можете использовать отражение для установки неинициализированных конечных переменных. поэтому вы можете инициализировать null в частном конструкторе и использовать JAXB + неизменно чисто без XMLAdapter.

пример из https://test.kuali.org/svn/rice/sandbox/immutable-jaxb/, получил это из комментария к блогу Blaise http://blog.bdoughan.com/2010/12/jaxb-and-immutable-objects.html#comment-form_584069422380571931

package blog.immutable;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;

@XmlRootElement(name="customer")
@XmlAccessorType(XmlAccessType.NONE)
public final class Customer {

    @XmlAttribute
    private final String name;

    @XmlElement
    private final Address address;

    @SuppressWarnings("unused")
    private Customer() {
        this(null, null);
    }

    public Customer(String name, Address address) {
        this.name = name;
        this.address = address;
    }

    public String getName() {
        return name;
    }

    public Address getAddress() {
        return address;
    }

}

Ответ 3

Вы можете использовать эти компиляторы XJC для непосредственного создания неизменяемых классов:

• https://github.com/sabomichal/immutable-xjc
• https://github.com/danielwegener/xjc-immutable-plugin

Ответ 4

JAXB может работать с непубличными конструкторами/методами, поэтому единственным приемлемым подходом было бы защитить конструкторы и сеттеры no-arg, в результате получив "псевдо-неизменяемые" объекты.

Я выбираю этот подход каждый раз, когда вручную записываю JAXB-аннотированные классы, но вы можете проверить, возможно ли это также для сгенерированного кода.

Ответ 5

Основываясь на этом сообщении в блоге http://blog.bdoughan.com/2010/12/jaxb-and-immutable-objects.html от Blaise Doughan (который много знает о JAXB), похоже, что нет встроенной поддержки неизменяемых объектов, поэтому необходимы ваши объекты-обертки.