如何在 JPA 和 Hibernate 中使用 Java 8 LocalDateTime

Question

我有以下 class 描述片段：

... 
@Column(name = "invalidate_token_date")
@Temporal(TemporalType.TIMESTAMP)
private LocalDateTime invalidateTokenDate;
....

此代码不适用于 Hibernate 4，因为 @Temporal 不支持 LocalDateTime.

我从 Joda-Time 看到关于如何使用 LocalDateTime 的建议，但我使用 Java 8.

Answer 1

由于 Hibernate 4 不支持它，您需要实现一个用户类型，如 this 示例所示。

import org.hibernate.HibernateException;
import org.hibernate.engine.spi.SessionImplementor;
import org.hibernate.type.StandardBasicTypes;
import org.hibernate.usertype.EnhancedUserType;

import java.io.Serializable;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Types;
import java.time.Instant;
import java.time.LocalDateTime;
import java.time.ZoneId;
import java.util.Date;

public class LocalDateTimeUserType implements EnhancedUserType, Serializable {

    private static final int[] SQL_TYPES = new int[]{Types.TIMESTAMP};

    @Override
    public int[] sqlTypes() {
        return SQL_TYPES;
    }

    @Override
    public Class returnedClass() {
        return LocalDateTime.class;
    }

    @Override
    public boolean equals(Object x, Object y) throws HibernateException {
        if (x == y) {
            return true;
        }
        if (x == null || y == null) {
            return false;
        }
        LocalDateTime dtx = (LocalDateTime) x;
        LocalDateTime dty = (LocalDateTime) y;
        return dtx.equals(dty);
    }

    @Override
    public int hashCode(Object object) throws HibernateException {
        return object.hashCode();
    }


    @Override
    public Object nullSafeGet(ResultSet resultSet, String[] names, SessionImplementor session, Object owner)
            throws HibernateException, SQLException {
        Object timestamp = StandardBasicTypes.TIMESTAMP.nullSafeGet(resultSet, names, session, owner);
        if (timestamp == null) {
            return null;
        }
        Date ts = (Date) timestamp;
        Instant instant = Instant.ofEpochMilli(ts.getTime());
        return LocalDateTime.ofInstant(instant, ZoneId.systemDefault());
    }

    @Override
    public void nullSafeSet(PreparedStatement preparedStatement, Object value, int index, SessionImplementor session)
            throws HibernateException, SQLException {
        if (value == null) {
            StandardBasicTypes.TIMESTAMP.nullSafeSet(preparedStatement, null, index, session);
        } else {
            LocalDateTime ldt = ((LocalDateTime) value);
            Instant instant = ldt.atZone(ZoneId.systemDefault()).toInstant();
            Date timestamp = Date.from(instant);
            StandardBasicTypes.TIMESTAMP.nullSafeSet(preparedStatement, timestamp, index, session);
        }
    }

    @Override
    public Object deepCopy(Object value) throws HibernateException {
        return value;
    }

    @Override
    public boolean isMutable() {
        return false;
    }

    @Override
    public Serializable disassemble(Object value) throws HibernateException {
        return (Serializable) value;
    }

    @Override
    public Object assemble(Serializable cached, Object value) throws HibernateException {
        return cached;
    }

    @Override
    public Object replace(Object original, Object target, Object owner) throws HibernateException {
        return original;
    }

    @Override
    public String objectToSQLString(Object object) {
        throw new UnsupportedOperationException();
    }

    @Override
    public String toXMLString(Object object) {
        return object.toString();
    }

    @Override
    public Object fromXMLString(String string) {
        return LocalDateTime.parse(string);
    }

}

然后可以在带有@Type 注释的映射中使用新的用户类型。例如

@Type(type="com.hibernate.samples.type.LocalDateTimeUserType")
@Column(name = "invalidate_token_date")
private LocalDateTime invalidateTokenDate;

@Type 注解需要实现 userType 接口的 class 的完整路径；这是用于生成映射列的目标类型的工厂。

Here's 如何在 JPA2.1 中做同样的事情

Answer 2

如果能用JavaEE 7，还有更优雅的solution：

>> 实现这个：

@Converter(autoApply = true)
public class LocalDateTimeConverter implements AttributeConverter<LocalDateTime, Date> {

    @Override
    public Date convertToDatabaseColumn(LocalDateTime date) {
        if (date == null){
            return null;
        }
        return date.toDate();
    }

    @Override
    public LocalDateTime convertToEntityAttribute(Date value) {
        if (value == null) {
            return null;
        }
        return LocalDateTime.fromDateFields(value);
    }
}

>> 像这样使用：

... 
@Column(name = "invalidate_token_date")
private LocalDateTime invalidateTokenDate;
....

值 (autoApply = true) 表示 @Converter 自动用于 JPA 实体中每个 LocalDateTime 属性的转换。

顺便说一句，AttributeConverter 也非常适合映射枚举。

Answer 3

我创建了一个简单的插件来允许我们使用 java.time.* 类。这时候最常用的类就实现了。看这里：https://github.com/garcia-jj/jpa-javatime.

如果您使用 Maven，这是工件配置：

<dependency>
    <groupId>br.com.otavio</groupId>
    <artifactId>jpa-javatime</artifactId>
    <version>0.2</version>
</dependency>

项目页面有更多使用方法的信息。

谢谢。

Answer 4

对于任何 Hibernate 5.x 用户，

<dependency>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-java8</artifactId>
    <version>5.0.0.Final</version>
</dependency>

您无需执行任何其他操作。只需添加依赖项，Java 8 种时间类型应该像任何其他基本类型一样工作，不需要注释。

private LocalDateTime invalidateTokenDate;

注意：这不会保存到 timestamp 类型。使用 MySQL 进行测试，它保存为 datetime 类型。

Answer 5

从 2.2 版本开始，JPA 提供了对映射 Java 8 Date/Time API 的支持，例如 LocalDateTime、LocalTime、LocalDateTimeTime、 OffsetDateTime 或 OffsetTime.

此外，即使使用 JPA 2.1，Hibernate 5.2 默认也支持所有 Java 8 Date/Time API。

在 Hibernate 5.1 和 5.0 中，您必须添加 hibernate-java8 Maven 依赖项。

那么，假设我们有以下实体：

@Entity(name = "UserAccount")
@Table(name = "user_account")
public class UserAccount {

    @Id
    private Long id;

    @Column(name = "first_name", length = 50)
    private String firstName;

    @Column(name = "last_name", length = 50)
    private String lastName;

    @Column(name = "subscribed_on")
    private LocalDateTime subscribedOn;

    //Getters and setters omitted for brevity
}

请注意 subscribedOn 属性是一个 LocalDateTime Java 对象。

坚持UserAccount时：

UserAccount user = new UserAccount()
    .setId(1L)
    .setFirstName("Vlad")
    .setLastName("Mihalcea")
    .setSubscribedOn(
        LocalDateTime.of(
            2020, 5, 1,
            12, 30, 0
        )
    );

entityManager.persist(user);

Hibernate 生成正确的 SQL INSERT 语句：

INSERT INTO user_account (
    first_name, 
    last_name, 
    subscribed_on, 
    id
) 
VALUES (
    'Vlad', 
    'Mihalcea', 
    '2020-05-01 12:30:00.0', 
    1
)

在获取 UserAccount 实体时，我们可以看到 LocalDateTime 已从数据库中正确获取：

UserAccount userAccount = entityManager.find(
    UserAccount.class, 1L
);

assertEquals(
    LocalDateTime.of(
        2020, 5, 1,
        12, 30, 0
    ),
    userAccount.getSubscribedOn()
);

如何在 JPA 和 Hibernate 中使用 Java 8 LocalDateTime

How to use the Java 8 LocalDateTime with JPA and Hibernate

hibernate

jpa

date

java-8

localdatetime