快捷導(dǎo)航

JPA中@CreatedDate和@LastModifiedDate的使用方式

更新時間：2023年11月22日 10:06:22 作者：Evan Wang

這篇文章主要介紹了JPA中@CreatedDate和@LastModifiedDate的使用方式,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教

一、使用步驟

1.在實(shí)體類上加上注解 @EntityListeners(AuditingEntityListener.class)，在相應(yīng)的字段上添加對應(yīng)的時間注解 @LastModifiedDate 和 @CreatedDate。

注意：日期的類型可以使用Date，也可以使用Long。我一般習(xí)慣用Date。

//@Data lombok注解，替我們生成getter和setter。
@Data
@Entity
@Table(name = "task")
@EntityListeners(AuditingEntityListener.class)
public class Task {
    /**
     * 自增主鍵
     */
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Column(name = "id")
    private Integer id;

    /**
     * 創(chuàng)建時間
     */
    @CreatedDate
    @Column(name = "createTime", columnDefinition = "timestamp not null default current_timestamp")
    private Date createTime;

    /**
     * 更新時間
     */
    @LastModifiedDate
    @Column(name = "updateTime", columnDefinition = "timestamp not null default current_timestamp")
    private Date updateTime;
}

2.在Application啟動類中添加注解 @EnableJpaAuditing。

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

3.除了上面提到的注解外，Spring Data JPA 還提供 @CreatedBy 和 @LastModifiedBy 注解，用于保存和更新當(dāng)前操作用戶的信息(如id、name)。

如果有這方面的需求，可以參考下面的配置實(shí)現(xiàn)，代碼如下：

@Data
@Entity
@EntityListeners(AuditingEntityListener.class)
public class Task {

  	/**
     * 自增主鍵
     */
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Column(name = "id")
    private Integer id;

    /**
     * 創(chuàng)建時間
     */
    @CreatedDate
    @Column(name = "createTime", columnDefinition = "timestamp not null default current_timestamp")
    private Date createTime;

    /**
     * 更新時間
     */
    @LastModifiedDate
    @Column(name = "updateTime", columnDefinition = "timestamp not null default current_timestamp")
    private Date updateTime;
    
     /**
     * 創(chuàng)建人
     */
    @CreatedBy
    @Column(name = "createBy", columnDefinition = "varchar(255) not null")
    private String createBy;

    /**
     * 最后修改人
     */
    @LastModifiedBy
    @Column(name = "lastModifiedBy", columnDefinition = "varchar(255) not null")
    private String lastModifiedBy;
}

二、獲取操作員信息

/**
 * Spring Data JPA通過AuditorAware<T>接口獲取用戶信息,
 * 其中泛型T可以為String保存用戶名，也可以為Long/Integer保存用戶ID。
 * @author EvanWang
 *
 */
@Component
public class AuditorConfig implements AuditorAware<String> {

    /**
     * 返回操作員標(biāo)志信息
     *
     * @return
     */
    @Override
    public Optional<String> getCurrentAuditor() {
        // 這里應(yīng)根據(jù)實(shí)際業(yè)務(wù)情況獲取具體信息
        return Optional.of(userName);
    }
}

三、補(bǔ)充注解

Hibernate 也提供了類似上述時間注解的功能實(shí)現(xiàn)，這種方法只需要一步配置，更改為注解 @UpdateTimestamp 和 @CreationTimestamp

代碼如下：

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

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

    @UpdateTimestamp
    @Column(name = "updateTime", columnDefinition = "timestamp not null default current_timestamp")
    private Date updateTime;

    @CreationTimestamp
    @Column(name = "updateTime", columnDefinition = "timestamp not null default current_timestamp")
    private Date createTime;
}