使用Hibernate JPA的自定义布尔用户类型

ANSI SQL 1999标准引入了BOOLEAN数据类型（尽管遗憾的是仅作为可选功能）。但是到目前为止，大多数主要的数据库系统仍未实现它。结果，布尔列以各种方式实现。例如，包含“ Y”或“ N”的CHAR列，或使用BIT列。随后，JPA无法提供将实体的布尔字段映射到数据库列的标准化方法。

Hibernate为使用包含“ Y”或“ N”字符的CHAR（1）列的布尔实现提供了一个自定义YesNoType。但是对于其他实践，您基本上必须提供自己的解决方案。幸运的是，Hibernate提供了创建自己的自定义UserType的可能性。在此博客条目中，我将提供一个这样的自定义布尔UserType的示例。

最近，我遇到了一个荷兰传统数据库架构，其中“ Y”（表示“是”）和“ N”（表示“否”）分别由“ J”（“ ja”）和“ N”（“ nee”）表示，分别。排除使用Hibernate的YesNoType。更复杂的是，其中一些列使用CHAR（1），另一些使用带有填充空间的CHAR（2）–不要问为什么！

因此，我最终编写了一个自定义UserType，使我基本上可以转换以下内容…

起点

@Entity
@Table(name = "FOO_BAR")
public class FooBar implements Serializable {@Column(name = "FOO_ INDICATOR")private String fooIndicator;@Column(name = "BAR_ INDICATOR", length = 2)private String barIndicator;// …
}

进入...

理想情况

@Entity
@Table(name = "FOO_BAR")
@TypeDefs({@TypeDef(name = JaNeeType.NAME, typeClass = JaNeeType.class)
})
public class FooBar implements Serializable {@Column(name = "FOO_INDICATOR)@Type(type = JaNeeType.NAME)private Boolean fooIndicator;@Column(name = "BAR_INDICATOR", length = 2)@Type(type = JaNeeType.NAME, parameters = { @Parameter(name = "length", value = "2") })@Type(type = JaNeeType.NAME)private Boolean barIndicator;// …
}

编码自定义类型被证明是相当简单的。我只需要实现org.hibernate.usertype.UserType接口。要处理变化的列长度，需要添加“ length”参数，这需要实现第二个接口org.hibernate.usertype.ParameterizedType。

下面给出的是我所做的最终结果。

JaNeeType

package it.jdev.examples.persistence.hibernate;import java.io.Serializable;
import java.lang.invoke.MethodHandles;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Types;
import java.util.Properties;import org.apache.commons.lang3.StringUtils;
import org.hibernate.HibernateException;
import org.hibernate.engine.spi.SessionImplementor;
import org.hibernate.usertype.ParameterizedType;
import org.hibernate.usertype.UserType;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;/*** A type that maps between {@link java.sql.Types#VARCHAR CHAR(1) or CHAR(2)} and {@link Boolean} (using "J " and "N ").* <p>* Optionally, a parameter "length" can be set that will result in right-padding with spaces up to the* specified length.*/
public class JaNeeType implements UserType, ParameterizedType {public static final String NAME = "ja_nee";private static final Logger LOGGER = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());private int length = 1;@Overridepublic int[] sqlTypes() {return new int[] { Types.VARCHAR };}@SuppressWarnings("rawtypes")@Overridepublic Class returnedClass() {return Boolean.class;}@Overridepublic boolean equals(final Object x, final Object y) throws HibernateException {if (x == null || y == null) {return false;} else {return x.equals(y);}}@Overridepublic int hashCode(final Object x) throws HibernateException {assert (x != null);return x.hashCode();}@Overridepublic Object nullSafeGet(final ResultSet rs, final String[] names, final SessionImplementor session, final Object owner) throws HibernateException, SQLException {final String s = rs.getString(names[0]);if (StringUtils.isBlank(s)) {return false;}if ("J".equalsIgnoreCase(s.trim())) {return Boolean.TRUE;}return Boolean.FALSE;}@Overridepublic void nullSafeSet(final PreparedStatement st, final Object value, final int index, final SessionImplementor session) throws HibernateException, SQLException {String s = Boolean.TRUE.equals(value) ? "J" : "N";if (this.length > 1) {s = StringUtils.rightPad(s, this.length);}st.setString(index, s);}@Overridepublic Object deepCopy(final Object value) throws HibernateException {return value;}@Overridepublic boolean isMutable() {return true;}@Overridepublic Serializable disassemble(final Object value) throws HibernateException {return (Serializable) value;}@Overridepublic Object assemble(final Serializable cached, final Object owner) throws HibernateException {return cached;}@Overridepublic Object replace(final Object original, final Object target, final Object owner) throws HibernateException {return original;}@Overridepublic void setParameterValues(final Properties parameters) {if (parameters != null && !parameters.isEmpty()) {final String lengthString = parameters.getProperty("length");try {if (StringUtils.isNotBlank(lengthString)) {this.length = Integer.parseInt(lengthString);}} catch (final NumberFormatException e) {LOGGER.error("Error parsing int " + lengthString, e);}}}}