minor optimizations to logging and comments in event handlers

gavinking · gavinking · commit 4e9d3a8eccaf · 2025-07-13T23:58:01.000+02:00
diff --git a/hibernate-core/src/main/java/org/hibernate/event/internal/AbstractFlushingEventListener.java b/hibernate-core/src/main/java/org/hibernate/event/internal/AbstractFlushingEventListener.java
@@ -121,13 +121,13 @@ protected void logFlushResults(FlushEvent event) {
 	}
 
 	/**
-	 * process cascade save/update at the start of a flush to discover
+	 * Process cascade save/update at the start of a flush to discover
 	 * any newly referenced entity that must be passed to saveOrUpdate(),
 	 * and also apply orphan delete
 	 */
 	private void prepareEntityFlushes(EventSource session, PersistenceContext persistenceContext)
 			throws HibernateException {
-		LOG.debug( "Processing flush-time cascades" );
+		LOG.trace( "Processing flush-time cascades" );
 		final PersistContext context = PersistContext.create();
 		// safe from concurrent modification because of how concurrentEntries() is implemented on IdentityMap
 		for ( var me : persistenceContext.reentrantSafeEntityEntries() ) {
diff --git a/hibernate-core/src/main/java/org/hibernate/event/internal/AbstractSaveEventListener.java b/hibernate-core/src/main/java/org/hibernate/event/internal/AbstractSaveEventListener.java
@@ -43,7 +43,9 @@
 import static org.hibernate.pretty.MessageHelper.infoString;
 
 /**
- * A convenience base class for listeners responding to save events.
+ * A convenience base class for listeners responding to persist or merge events.
+ * <p>
+ * This class contains common functionality for persisting new transient instances.
  *
  * @author Steve Ebersole.
  */
@@ -58,13 +60,13 @@ public void injectCallbackRegistry(CallbackRegistry callbackRegistry) {
 	}
 
 	/**
-	 * Prepares the save call using the given requested id.
+	 * Prepares the persist call using the given requested id.
 	 *
-	 * @param entity The entity to be saved.
-	 * @param requestedId The id to which to associate the entity.
-	 * @param entityName The name of the entity being saved.
-	 * @param context Generally cascade-specific information.
-	 * @param source The session which is the source of this save event.
+	 * @param entity The entity to be persisted
+	 * @param requestedId The id with which to associate the entity
+	 * @param entityName The name of the entity being persisted
+	 * @param context Generally cascade-specific information
+	 * @param source The session which is the source of this event
 	 *
 	 * @return The id used to save the entity.
 	 */
@@ -79,18 +81,18 @@ protected Object saveWithRequestedId(
 	}
 
 	/**
-	 * Prepares the save call using a newly generated id.
+	 * Prepares the persist call using a newly generated id.
 	 *
-	 * @param entity The entity to be saved
-	 * @param entityName The entity-name for the entity to be saved
-	 * @param context Generally cascade-specific information.
-	 * @param source The session which is the source of this save event.
+	 * @param entity The entity to be persisted
+	 * @param entityName The entity-name for the entity to be persisted
+	 * @param context Generally cascade-specific information
+	 * @param source The session which is the source of this persist event
 	 * @param requiresImmediateIdAccess does the event context require
 	 * access to the identifier immediately after execution of this method
 	 * (if not, post-insert style id generators may be postponed if we are
 	 * outside a transaction).
 	 *
-	 * @return The id used to save the entity; may be null depending on the
+	 * @return The id used to persist the entity; may be null depending on the
 	 *         type of id generator used and the requiresImmediateIdAccess value
 	 */
 	protected Object saveWithGeneratedId(
@@ -140,10 +142,10 @@ else if ( generatedBeforeExecution ) {
 	 * Generate an id before execution of the insert statements,
 	 * using the given {@link BeforeExecutionGenerator}.
 	 *
-	 * @param entity The entity instance to be saved
-	 * @param source The session which is the source of this save event.
-	 * @param generator The entity's generator
-	 * @param persister The entity's persister instance.
+	 * @param entity The entity instance to be persisted
+	 * @param source The session which is the source of this persist event
+	 * @param generator The generator for the entity id
+	 * @param persister The persister for the entity
 	 *
 	 * @return The generated id
 	 */
@@ -158,7 +160,7 @@ private static Object generateId(
 			throw new IdentifierGenerationException( "Null id generated for entity '" + persister.getEntityName() + "'" );
 		}
 		else {
-			if  ( LOG.isDebugEnabled() ) {
+			if ( LOG.isTraceEnabled() ) {
 				// TODO: define toString()s for generators
 				LOG.tracef(
 						"Generated identifier [%s] using generator '%s'",
@@ -171,18 +173,18 @@ private static Object generateId(
 	}
 
 	/**
-	 * Prepares the save call by checking the session caches for a pre-existing
+	 * Prepares the persist call by checking the session caches for a pre-existing
 	 * entity and performing any lifecycle callbacks.
 	 *
-	 * @param entity The entity to be saved.
-	 * @param id The id by which to save the entity.
-	 * @param persister The entity's persister instance.
+	 * @param entity The entity to be persisted
+	 * @param id The id by which to persist the entity
+	 * @param persister The entity's persister instance
 	 * @param useIdentityColumn Is an identity column being used?
-	 * @param context Generally cascade-specific information.
-	 * @param source The session from which the event originated.
+	 * @param context Generally cascade-specific information
+	 * @param source The session from which the event originated
 	 * @param delayIdentityInserts Should the identity insert be delayed?
 	 *
-	 * @return The id used to save the entity; may be null depending on the
+	 * @return The id used to persist the entity; may be null depending on the
 	 *         type of id generator used and on delayIdentityInserts
 	 */
 	protected Object performSave(
@@ -211,7 +213,7 @@ protected Object performSave(
 		}
 
 		if ( LOG.isTraceEnabled() ) {
-			LOG.trace( "Saving " + infoString( persister, id, source.getFactory() ) );
+			LOG.trace( "Persisting " + infoString( persister, id, source.getFactory() ) );
 		}
 
 		final EntityKey key = useIdentityColumn ? null : entityKey( id, persister, source );
@@ -237,18 +239,18 @@ else if ( persistenceContext.containsDeletedUnloadedEntityKey( key ) ) {
 	}
 
 	/**
-	 * Performs all the actual work needed to save an entity (well to get the save moved to
-	 * the execution queue).
+	 * Performs all the actual work needed to persist an entity
+	 * (well to get the persist action moved to the execution queue).
 	 *
-	 * @param entity The entity to be saved
+	 * @param entity The entity to be persisted
 	 * @param key The id to be used for saving the entity (or null, in the case of identity columns)
-	 * @param persister The entity's persister instance.
+	 * @param persister The persister for the entity
 	 * @param useIdentityColumn Should an identity column be used for id generation?
-	 * @param context Generally cascade-specific information.
-	 * @param source The session which is the source of the current event.
+	 * @param context Generally cascade-specific information
+	 * @param source The session which is the source of the current event
 	 * @param delayIdentityInserts Should the identity insert be delayed?
 	 *
-	 * @return The id used to save the entity; may be null depending on the
+	 * @return The id used to persist the entity; may be null depending on the
 	 *         type of id generator used and the requiresImmediateIdAccess value
 	 */
 	protected Object performSaveOrReplicate(
@@ -394,10 +396,10 @@ protected Map<Object,Object> getMergeMap(C anything) {
 	}
 
 	/**
-	 * After the save, will the version number be incremented
+	 * After the persist, will the version number be incremented
 	 * if the instance is modified?
 	 *
-	 * @return True if the version will be incremented on an entity change after save;
+	 * @return True if the version will be incremented on an entity change after persist;
 	 *         false otherwise.
 	 */
 	protected boolean isVersionIncrementDisabled() {
@@ -451,11 +453,11 @@ protected boolean substituteValuesIfNecessary(
 	}
 
 	/**
-	 * Handles the calls needed to perform pre-save cascades for the given entity.
+	 * Handles the calls needed to perform pre-persist cascades for the given entity.
 	 *
-	 * @param source The session from which the save event originated.
-	 * @param persister The entity's persister instance.
-	 * @param entity The entity to be saved.
+	 * @param source The session from which the persist event originated
+	 * @param persister The persister for the entity
+	 * @param entity The entity to be persisted
 	 * @param context Generally cascade-specific data
 	 */
 	protected void cascadeBeforeSave(
@@ -482,11 +484,11 @@ protected void cascadeBeforeSave(
 	}
 
 	/**
-	 * Handles calls needed to perform post-save cascades.
+	 * Handles calls needed to perform post-persist cascades.
 	 *
-	 * @param source The session from which the event originated.
-	 * @param persister The entity's persister instance.
-	 * @param entity The entity being saved.
+	 * @param source The session from which the event originated
+	 * @param persister The persister for the entity
+	 * @param entity The entity being persisted
 	 * @param context Generally cascade-specific data
 	 */
 	protected void cascadeAfterSave(
diff --git a/hibernate-core/src/main/java/org/hibernate/event/internal/DefaultMergeEventListener.java b/hibernate-core/src/main/java/org/hibernate/event/internal/DefaultMergeEventListener.java
@@ -121,7 +121,7 @@ else if ( isPersistentAttributeInterceptable( original ) ) {
 				final PersistentAttributeInterceptor interceptor =
 						asPersistentAttributeInterceptable( original ).$$_hibernate_getInterceptor();
 				if ( interceptor instanceof EnhancementAsProxyLazinessInterceptor proxyInterceptor ) {
-					LOG.trace( "Ignoring uninitialized enhanced-proxy" );
+					LOG.trace( "Ignoring uninitialized enhanced proxy" );
 					event.setResult( source.byId( proxyInterceptor.getEntityName() )
 							.getReference( proxyInterceptor.getIdentifier() ) );
 				}
@@ -314,7 +314,7 @@ protected void entityIsTransient(MergeEvent event, Object id, MergeContext copyC
 		// copy created before we actually copy
 		super.cascadeAfterSave( session, persister, entity, copyCache );
 
-		// this is the second pass through on a merge op, so here we limit the
+		// this is the second pass of a merge operation, so here we limit the
 		// replacement to association types (value types were already replaced
 		// during the first pass)
 //		final Object[] newSourceValues = persister.getValues( entity );
diff --git a/hibernate-core/src/main/java/org/hibernate/event/internal/DefaultPersistEventListener.java b/hibernate-core/src/main/java/org/hibernate/event/internal/DefaultPersistEventListener.java
@@ -19,15 +19,15 @@
 import org.hibernate.internal.CoreMessageLogger;
 import org.hibernate.jpa.event.spi.CallbackRegistryConsumer;
 import org.hibernate.persister.entity.EntityPersister;
-import org.hibernate.pretty.MessageHelper;
 import org.hibernate.proxy.HibernateProxy;
 import org.hibernate.proxy.LazyInitializer;
 
 import static org.hibernate.event.internal.EntityState.getEntityState;
+import static org.hibernate.pretty.MessageHelper.infoString;
 
 /**
- * Defines the default create event listener used by hibernate for creating
- * transient entities in response to generated create events.
+ * Defines the default event listener used by Hibernate for persisting
+ * transient entities in response to generated persist events.
  *
  * @author Gavin King
  */
@@ -53,9 +53,9 @@ public void onPersist(PersistEvent event) throws HibernateException {
 	}
 
 	/**
-	 * Handle the given create event.
+	 * Handle the given persist event.
 	 *
-	 * @param event The create event to be handled.
+	 * @param event The persist event to be handled
 	 *
 	 */
 	@Override
@@ -83,7 +83,7 @@ private void persist(PersistEvent event, PersistContext createCache, Object enti
 		final String entityName = entityName( event, entity, entityEntry );
 		switch ( getEntityState( entity, entityName, entityEntry, source, true ) ) {
 			case DETACHED:
-				throw new PersistentObjectException( "detached entity passed to persist: "
+				throw new PersistentObjectException( "Detached entity passed to persist: "
 						+ EventUtil.getLoggableName( event.getEntityName(), entity) );
 			case PERSISTENT:
 				entityIsPersistent( event, createCache );
@@ -99,7 +99,7 @@ private void persist(PersistEvent event, PersistContext createCache, Object enti
 				break;
 			default:
 				throw new ObjectDeletedException(
-						"deleted entity passed to persist",
+						"Deleted entity passed to persist",
 						null,
 						EventUtil.getLoggableName( event.getEntityName(), entity )
 				);
@@ -135,13 +135,13 @@ private void justCascade(PersistContext createCache, EventSource source, Object
 	}
 
 	/**
-	 * Handle the given create event.
+	 * Handle the given persist event.
 	 *
-	 * @param event The save event to be handled.
-	 * @param createCache The copy cache of entity instance to merge/copy instance.
+	 * @param event The persist event to be handled
+	 * @param createCache The copy cache of entity instance to merge/copy instance
 	 */
 	protected void entityIsTransient(PersistEvent event, PersistContext createCache) {
-		LOG.trace( "Saving transient instance" );
+		LOG.trace( "Persisting transient instance" );
 		final EventSource source = event.getSession();
 		final Object entity = source.getPersistenceContextInternal().unproxy( event.getObject() );
 		if ( createCache.add( entity ) ) {
@@ -154,10 +154,8 @@ private void entityIsDeleted(PersistEvent event, PersistContext createCache) {
 		final Object entity = source.getPersistenceContextInternal().unproxy( event.getObject() );
 		final EntityPersister persister = source.getEntityPersister( event.getEntityName(), entity );
 		if ( LOG.isTraceEnabled() ) {
-			LOG.tracef(
-				"un-scheduling entity deletion [%s]",
-				MessageHelper.infoString( persister, persister.getIdentifier( entity, source ), event.getFactory() )
-			);
+			final Object id = persister.getIdentifier( entity, source );
+			LOG.trace( "Unscheduling entity deletion: " + infoString( persister, id, source.getFactory() ) );
 		}
 		if ( createCache.add( entity ) ) {
 			justCascade( createCache, source, entity, persister );
diff --git a/hibernate-core/src/main/java/org/hibernate/event/internal/DefaultReplicateEventListener.java b/hibernate-core/src/main/java/org/hibernate/event/internal/DefaultReplicateEventListener.java
@@ -97,7 +97,7 @@ private void doReplicate(ReplicateEvent event, EventSource source, Object entity
 				performReplication( entity, id, realOldVersion, persister, replicationMode, source );
 			}
 			else if ( LOG.isTraceEnabled() ) {
-				// do nothing (don't even re-associate object!)
+				// do nothing (don't even reassociate entity!)
 				LOG.trace( "No need to replicate" );
 			}
 
diff --git a/hibernate-core/src/main/java/org/hibernate/event/internal/EntityCopyAllowedLoggedObserver.java b/hibernate-core/src/main/java/org/hibernate/event/internal/EntityCopyAllowedLoggedObserver.java
@@ -15,7 +15,8 @@
 import org.hibernate.internal.CoreLogging;
 import org.hibernate.internal.CoreMessageLogger;
 import org.hibernate.internal.util.collections.IdentitySet;
-import org.hibernate.pretty.MessageHelper;
+
+import static org.hibernate.pretty.MessageHelper.infoString;
 
 /**
  * An {@link EntityCopyObserver} implementation that allows multiple representations of
@@ -53,15 +54,10 @@ public void entityCopyDetected(
 			Object mergeEntity2,
 			EventSource session) {
 		final String entityName = session.getEntityName( managedEntity );
-		LOG.trace(
-				String.format(
-						"More than one representation of the same persistent entity being merged for: %s",
-						MessageHelper.infoString(
-								entityName,
-								session.getIdentifier( managedEntity )
-						)
-				)
-		);
+		if ( LOG.isTraceEnabled() ) {
+			LOG.trace( "More than one representation of the same persistent entity being merged for: "
+						+ infoString( entityName, session.getIdentifier( managedEntity ) ) );
+		}
 		Set<Object> detachedEntitiesForManaged = null;
 		if ( managedToMergeEntitiesXref == null ) {
 			// This is the first time multiple representations have been found;
@@ -125,7 +121,7 @@ public void topLevelMergeComplete(EventSource session) {
 			}
 		}
 		else {
-			LOG.debug( "No entity copies merged." );
+			LOG.debug( "No entity copies merged" );
 		}
 
 		if ( managedToMergeEntitiesXref != null ) {
@@ -135,12 +131,8 @@ public void topLevelMergeComplete(EventSource session) {
 				final StringBuilder sb = new StringBuilder( "Details: merged ")
 						.append( mergeEntities.size() )
 						.append( " representations of the same entity " )
-						.append(
-								MessageHelper.infoString(
-										session.getEntityName( managedEntity ),
-										session.getIdentifier( managedEntity )
-								)
-						)
+						.append( infoString( session.getEntityName( managedEntity ),
+										session.getIdentifier( managedEntity ) ) )
 						.append( " being merged: " );
 				boolean first = true;
 				for ( Object mergeEntity : mergeEntities ) {
diff --git a/hibernate-core/src/main/java/org/hibernate/event/internal/EvictVisitor.java b/hibernate-core/src/main/java/org/hibernate/event/internal/EvictVisitor.java
@@ -72,11 +72,8 @@ private void evictCollection(PersistentCollection<?> collection) {
 		final CollectionPersister persister = ce.getLoadedPersister();
 		final Object loadedKey = ce.getLoadedKey();
 
-		if ( LOG.isDebugEnabled() ) {
-			LOG.debugf(
-					"Evicting collection: %s",
-					collectionInfoString( persister, collection, loadedKey, session )
-			);
+		if ( LOG.isTraceEnabled() ) {
+			LOG.trace( "Evicting collection: " + collectionInfoString( persister, collection, loadedKey, session ) );
 		}
 
 		if ( persister != null ) {

Original file line number	Diff line number	Diff line change
`@@ -97,7 +97,7 @@ private void doReplicate(ReplicateEvent event, EventSource source, Object entity`
`97`	`97`	`performReplication( entity, id, realOldVersion, persister, replicationMode, source );`
`98`	`98`	`}`
`99`	`99`	`else if ( LOG.isTraceEnabled() ) {`
`100`		`- // do nothing (don't even re-associate object!)`
	`100`	`+ // do nothing (don't even reassociate entity!)`
`101`	`101`	`LOG.trace( "No need to replicate" );`
`102`	`102`	`}`
`103`	`103`