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，換個視角總有好處。