Spring Data JPA 时间注解：@CreatedDate 和 @LastModifiedDate

happyJared

发布于 2020-02-11 07:48:25

4.5K10

代码可运行

运行总次数：0

代码可运行

选择 Spring Data JPA 框架开发时，常用在实体和字段上的注解有@Entity、@Id、@Column等。在表设计规范中，通常建议保留的有两个字段，一个是更新时间，一个是创建时间。Spring Data JPA 提供了相应的时间注解，只需要两步配置，就可以帮助开发者快速实现这方面的功能。

在实体类上加上注解 @EntityListeners(AuditingEntityListener.class)，在相应的字段上添加对应的时间注解 @LastModifiedDate 和 @CreatedDate

注意：日期类型可以用 Date 也可以是 Long

@Entity
@EntityListeners(AuditingEntityListener.class)
public class User {

     /**
     * 自增主键
     */
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Integer id;

     /**
     * 更新时间
     */
    @LastModifiedDate
    @Column(nullable = false)
    private Long updateTime;

     /**
     * 创建时间
     */
    @CreatedDate
    @Column(updatable = false, nullable = false)
    private Date createTime;

    // 省略getter和setter

在Application启动类中添加注解 @EnableJpaAuditing

@EnableJpaAuditing
@SpringBootApplication
public class TestApplication {

    public static void main(String[] args) {
        SpringApplication.run(TestApplication.class, args);
    }
    
}

此外，Spring Data JPA 还提供 @CreatedBy 和 @LastModifiedBy 注解，用于保存和更新当前操作用户的信息(如id、name)。如果有这方面的需求，可以参考下面的配置实现：

@Entity
@EntityListeners(AuditingEntityListener.class)
public class User {

     /**
     * 自增主键
     */
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Integer id;

     /**
     * 更新时间
     */
    @LastModifiedDate
    @Column(nullable = false)
    private Long updateTime;

     /**
     * 创建时间
     */
    @CreatedDate
    @Column(updatable = false, nullable = false)
    private Date createTime;
    
     /**
     * 创建人
     */
    @CreatedBy
    private Integer createBy;

    /**
     * 最后修改人
     */
    @LastModifiedBy
    private Integer lastModifiedBy;

    // 省略getter和setter

配置实现AuditorAware接口，以获取字段需要插入的信息：

@Configuration
public class AuditorConfig implements AuditorAware<Integer> {

    /**
     * 返回操作员标志信息
     *
     * @return
     */
    @Override
    public Optional<Integer> getCurrentAuditor() {
        // 这里应根据实际业务情况获取具体信息
        return Optional.of(new Random().nextInt(1000));
    }

}

2019.04 补充

Hibernate 也提供了类似上述时间注解的功能实现，这种方法只需要一步配置，更改为注解 @UpdateTimestamp 和 @CreationTimestamp 即可（参考如下）：

@Data
@MappedSuperclass
@NoArgsConstructor
@AllArgsConstructor
public class BaseEntity {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Integer id;

    @UpdateTimestamp
    @Column(nullable = false)
    private Date updateTime;

    @CreationTimestamp
    @Column(nullable = false, updatable = false)
    private Date createTime;

    @NotNull
    private Boolean deleted = false;

}