Hibernate：有了 save，为什么还需要 persist？

背景

万物皆自然，每个 API 的设计，无论是否正确，都有其意图。因此，在学习某些框架的时候，我们需要经常思考：这个 API 的设计意图是啥？

本文来探讨一下 Session 中 persist 的设计意图。

官方注释

save

     /**
      * Persist the given transient instance, first assigning a generated identifier. (Or
      * using the current value of the identifier property if the <tt>assigned</tt>
      * generator is used.) This operation cascades to associated instances if the
      * association is mapped with {@code cascade="save-update"}
      *
      * @param object a transient instance of a persistent class
      *
      * @return the generated identifier
      */
     public Serializable save(Object object);

persist

     /**
      * Make a transient instance persistent. This operation cascades to associated
      * instances if the association is mapped with {@code cascade="persist"}
      * <p/>
      * The semantics of this method are defined by JSR-220.
      *
      * @param object a transient instance to be made persistent
      */
     public void persist(Object object);

解释

save 因为需要返回一个主键值，因此会立即执行 insert 语句，而 persist 在事务外部调用时则不会立即执行 insert 语句，在事务内调用还是会立即执行 insert 语句的。

看 persist 的注释会觉得其不会立即执行 insert 语句，为何 在事务内调用会立即执行 insert 语句，后面再分析。

测试

SessionHelper

 package demo;

 import org.hibernate.*;
 import org.hibernate.cfg.*;

 public final class SessionHelper {
     private static SessionFactory factory;

     public static void execute(SessionAction action) {
         execute(action, false);
     }

     public static void execute(SessionAction action, boolean beforeTransaction) {
         Session session = openSession();
         try {
             if (beforeTransaction) {
                 System.out.println("action");
                 action.action(session);
             }

             System.out.println("begin transaction");
             session.beginTransaction();
             if (!beforeTransaction) {
                 System.out.println("action");
                 action.action(session);
             }

             System.out.println("flush and commit");
             session.flush();
             session.getTransaction().commit();
         } catch (Exception ex) {
             session.getTransaction().rollback();
         } finally {
             session.close();
         }
     }

     @SuppressWarnings("deprecation")
     public static Session openSession() {
         if (factory == null) {
             factory = new Configuration().configure().buildSessionFactory();
         }

         return factory.openSession();
     }
 }

save

 package demo;

 import model.*;

 import org.hibernate.*;
 /*
  * save 会导致 insert 语句的立即执行。
  */
 public class SaveDemo implements Demo {

     @Override
     public void run() {
         SessionHelper.execute(new SessionAction() {

             @Override
             public void action(Session session) {
                 User user = new User();
                 user.setUsername("woshishui");
                 user.setPassword("123456");

                 session.save(user);
             }

         });
     }

 }

输出结果

 begin transaction
 action
 Hibernate:
     /* insert model.User
         */ insert
         into
             USERS
             (USERNAME, PASSWORD)
         values
             (?, ?)
 flush and commit

persis in transactiont

 package demo;

 import model.*;

 import org.hibernate.*;

 /*
  * persist 在事务中执行，会导致 insert 语句的立即执行。
  */
 public class PersisInTransactiontDemo implements Demo {

     @Override
     public void run() {
         SessionHelper.execute(new SessionAction() {

             @Override
             public void action(Session session) {
                 User user = new User();
                 user.setUsername("woshishui");
                 user.setPassword("123456");

                 session.persist(user);
             }

         });
     }

 }

输出结果

 begin transaction
 action
 Hibernate:
     /* insert model.User
         */ insert
         into
             USERS
             (USERNAME, PASSWORD)
         values
             (?, ?)
 flush and commit

persis before transactiont

 package demo;

 import model.*;

 import org.hibernate.*;

 /*
  * persist 不在事务中执行，不会导致 insert 语句的立即执行，而是在 flush 时执行 insert 语句。
  */
 public class PersisBeforeTransactiontDemo implements Demo {

     @Override
     public void run() {
         SessionHelper.execute(new SessionAction() {

             @Override
             public void action(Session session) {
                 User user = new User();
                 user.setUsername("woshishui");
                 user.setPassword("123456");

                 session.persist(user);
             }

         }, true);
     }

 }

输出结果

 action
 begin transaction
 flush and commit
 Hibernate:
     /* insert model.User
         */ insert
         into
             USERS
             (USERNAME, PASSWORD)
         values
             (?, ?)

分析

为何 persist 在事务内和事务外表现的行为不同呢？为何这样设计？目前还没有查到官方的第一手资料（刚学习 Java 和 Hibernate），我的猜测是：事务外的 persist 是为了应对长事务，事务内的 persist 是为了和 save 保持一个语义。

备注

学习 Hibernate 的过程也相当于从新学习了一遍 EntityFramework，换个视角总有好处。