JPA: Хранение перечислений в базе данных

У Вас невероятно познавательный сайт!:)

Еще бы под EclipseLink бы кто-нибудь адаптировал :-)

спасибо, полезный пост!

если кто-то удалит или изменит значение в enum'е, то как это синхронизируетс с базой?
(честно говоря с явой знаком плохо и статью детально не осилил, но узнать про этот момент очень интересно)

Я наверное не понимаю, но зачем столько кода, что бы хранить в поле БД одну цифру?

проходил случайно мимо, никак не могу не оставить комментарий :)

все последущее, несмотря на категоричность является исключительно личным мнением (хоть и проверенным во многих проектах) не претендующим на истину в последней инстанции

1.) никогда никогда никогда не используйте ordinals в «перeчислениях» в Яве. Это очень опасно, так как значения (literals) часто меняются. Если где-то используется порядковое значение как ключ, то это очень плохой знак, можно даже сказать, плохой дизайн системы. Гораздо лучше использовать в перичислениях собственные идентификаторы, основанные на предметной области, хотя бы строковые. Пример:

public enum CustomerStatusType implements MyEnum {
ACTIVE("ACT", "Active"),
DELETED("DEL", "Deleted"),
SUSPENDED("SUS", "Suspended");

private String id;
private String description;

private CustomerStatusType(String id, String description) {
this.id = id;
this.description = description;
}

@Override public String getId() {return this.id;}
@Override public String getDescription() {return this.description;}
public static CustomerStatusType getInstanceById(String id) {...}
}

Если этот энум расширить, к примеру добавить до ACTIVE статус CREATED(«CRT», «Created»), то порядковое значение «старых» элементов изменится, но не их идентификаторы. При использовании порядкового значения (ordinal) как идентификатора, произойдет неименуемый крах. Несомненно лучше использовать getId и getInstanceById.

2) EclipseLink и Hibernate позволяют использовать так называемые CustomMapper (UserType). С их помощью можно добится «прозрачного» писания и считывания идентификаторов в базу. К тому же иногда бывает, что нужно сохранять не одно значение, а список. Желательно этот список сохранять как список идентификаторов в одной строке, а не как foreign keys в n-to-m-relation-таблице.

Короткий пример использования, насчет реализации должен к сожалению отослать к документации Hibernate или EclipseLink, там есть примеры.

@Entity
public class Customer {

@Type(type = "example.EnumerationIdMapper", 
parameters = { @Parameter(name = "classname", value = "example.CustomerStatusType") })
@Column(name = "status", nullable = false)
private CustomerStatusType status;

@Type(type = "example.EnumerationIdListMapper", 
parameters = { @Parameter(name = "classname", value = "example.CustomerStatusType") })
@Column(name = "statuses", nullable = true)
private List<CustomerStatusType> statuses;

}

/**
* пример 
*/
public class EnumerationIdMapper implements UserType, ParameterizedType
...
    protected Class myEnum = null;
    protected Method getInstanceById =null;

    /**
     * @see org.hibernate.usertype.UserType#nullSafeGet(ResultSet, java.lang.String[],
     *      java.lang.Object)
     */
    public Object nullSafeGet(ResultSet resultSet, String[] names, Object owner)
            throws HibernateException, SQLException {
        MyEnum targetObject = null;
        try {
            String id = resultSet.getString(names[0]);
            if (!resultSet.wasNull()) {
                targetObject = (MyEnum) this.getInstanceById.invoke(
                        myEnum, new Object[] { id.trim() });
            }
       catch (Exception e) {
         // do something...
        }
        return targetObject;
    }

    /**
     * @see org.hibernate.usertype.UserType#nullSafeSet(PreparedStatement, java.lang.Object, int)
     */
    public void nullSafeSet(PreparedStatement statement, Object value, int index)
            throws HibernateException, SQLException {
        if (value == null) {
            statement.setNull(index, Types.VARCHAR);
        } else {
            statement.setString(index, ((MyEnum) value).getId());
        }
    }

    /**
     * @see org.hibernate.usertype.ParameterizedType#setParameterValues(java.util.Properties)
     */
    public void setParameterValues(Properties properties) {
        if (properties == null) {
            return;
        }
        String className = properties.getProperty("classname");
        if (className == null || className.length() == 0) {
            return;
        }
        try {
            ClassLoader cl = Thread.currentThread().getContextClassLoader();
            Class<?> clazz = cl.loadClass(className);
            this.myEnum = (Class<T>) clazz.asSubclass(Enum.class);
            this.getInstanceById = myEnum.getMethod("getInstanceById",
                    new Class[] { String.class });
        } catch (ClassNotFoundException cnfe) {
            throw new HibernateException("class not found", cnfe);
        }
    }

...
}

Ну и плюс можно использовать JPQL.:

Query query = em.createQuery("select c from Customer c where c.status:=statusValue");
query.setParameter("statusValue", CustomerStatusType.ACTIVE);

Успехов и приятных экспериментов!

Чего то я не могу понять, почему у меня не происходит инъекция энума в Set

public enum AccountRole {
        // ordinal соответсвенно 10, 20, 30
	ROOT, USERMANAGER, USERVIEWER
}

@Entity
@Table(name = "ACCOUNT_GROUP")
public class AccountGroup {
	
	@Id
	@Column(name = "AG_ID", nullable = false, unique = true)
	private Integer groupId;
	
	@Column(name = "AG_NAME", nullable = false, unique = true, length = 32)
	private String groupName;

	@Enumerated(EnumType.ORDINAL)
	@ElementCollection(targetClass = AccountRole.class) 
	@CollectionTable(name = "GROUP_ROLE", 
		joinColumns = @JoinColumn(name = "AG_ID"))
	@Column(name = "ROLE_ID") 
	private Set<AccountRole> roles = new HashSet<>();

...

}

Создаю группу

		AccountGroup group = new AccountGroup();
		group.setGroupName("ABCDE");
		group.setGroupId(101);
		group.getRoles().add(AccountRole.ROOT);
		group.getRoles().add(AccountRole.USERMANAGER);
		accountGroupRepository.save(group);

В БД сохраняется все как надо… в таблицу GROUP_ROLE падает две строки — [101;10] и [101,20]

При чтении же мне выдается InvocationException и пишет, что не может найти enum c ordinal 10 и 20.

На что можно обратить внимание, подскажите пожалуйста?