minor cleanups to SessionFactory logging

Author: gavinking

hibernate-core/src/main/java/org/hibernate/internal/CoreMessageLogger.java

@@ -9,6 +9,7 @@
 import java.io.IOException;
 import java.sql.SQLException;
 import java.sql.SQLWarning;
+import java.util.Map;
 import java.util.Properties;
 import java.util.ServiceConfigurationError;
 import java.util.Set;
@@ -73,8 +74,20 @@ public interface CoreMessageLogger extends BasicLogger {
 	void callingJoinTransactionOnNonJtaEntityManager();
 
 	@LogMessage(level = DEBUG)
-	@Message(value = "Closing", id = 31)
-	void closing();
+	@Message(value = "Instantiating factory with settings: %s", id = 30)
+	void instantiatingFactory(Map<String, Object> settings);
+
+	@LogMessage(level = DEBUG)
+	@Message(value = "Closing factory", id = 31)
+	void closingFactory();
+
+	@LogMessage(level = DEBUG)
+	@Message(value = "Serializing factory: %s", id = 32)
+	void serializingFactory(String uuid);
+
+	@LogMessage(level = DEBUG)
+	@Message(value = "Deserialized factory: %s", id = 33)
+	void deserializedFactory(String uuid);
 
 	@LogMessage(level = WARN)
 	@Message(value = "Composite-id class does not override equals(): %s", id = 38)

hibernate-core/src/main/java/org/hibernate/internal/SessionFactoryImpl.java

@@ -182,12 +182,10 @@ public class SessionFactoryImpl implements SessionFactoryImplementor, BindingCon
 	private final transient Map<String,Object> settings;
 
 	private final transient SessionFactoryServiceRegistry serviceRegistry;
-	private final transient EventEngine eventEngine;//Needs to be closed!
+	private final transient EventEngine eventEngine;
 	private final transient JdbcServices jdbcServices;
 	private final transient SqlStringGenerationContext sqlStringGenerationContext;
 
-	// todo : org.hibernate.jpa.boot.spi.PersistenceUnitDescriptor too?
-
 	private final transient RuntimeMetamodelsImplementor runtimeMetamodels;
 	private final PersistenceUnitUtil jpaPersistenceUnitUtil;
 	private final transient CacheImplementor cacheAccess;
@@ -245,7 +243,7 @@ public SessionFactoryImpl(
 		settings = getSettings( options, serviceRegistry );
 		maskOutSensitiveInformation( settings );
 		deprecationCheck( settings );
-		LOG.debugf( "Instantiating SessionFactory with settings: %s", settings );
+		LOG.instantiatingFactory( settings );
 
 		sqlStringGenerationContext = createSqlStringGenerationContext( bootMetamodel, options, jdbcServices );
 
@@ -258,7 +256,6 @@ public SessionFactoryImpl(
 		}
 
 		filters = new HashMap<>( bootMetamodel.getFilterDefinitions() );
-		LOG.debugf( "Session factory constructed with filter configurations : %s", filters );
 
 		final FilterDefinition tenantFilter = filters.get( TenantIdBinder.FILTER_NAME );
 		if ( tenantFilter == null ) {
@@ -359,12 +356,12 @@ public SessionFactoryImpl(
 				close();
 			}
 			catch (Exception closeException) {
-				LOG.debug( "Eating error closing the SessionFactory after a failed attempt to start it" );
+				LOG.trace( "Eating error closing factory after failed instantiation" );
 			}
 			throw e;
 		}
 
-		LOG.debug( "Instantiated SessionFactory" );
+		LOG.debug( "Instantiated factory" );
 	}
 
 	private EventMonitor loadEventMonitor() {
@@ -770,7 +767,7 @@ public Interceptor getInterceptor() {
 	@Override
 	public Reference getReference() {
 		// from javax.naming.Referenceable
-		LOG.debug( "Returning a Reference to the SessionFactory" );
+		LOG.debug( "Returning a Reference to the factory" );
 		return new Reference(
 				SessionFactoryImpl.class.getName(),
 				new StringRefAddr( "uuid", getUuid() ),
@@ -809,7 +806,7 @@ public void close() throws HibernateException {
 		}
 
 		try {
-			LOG.closing();
+			LOG.closingFactory();
 			observer.sessionFactoryClosing( this );
 
 		// NOTE : the null checks below handle cases where close is called from
@@ -1543,11 +1540,9 @@ public JavaType<Object> getTenantIdentifierJavaType() {
 	 */
 	@Serial
 	private void writeObject(ObjectOutputStream out) throws IOException {
-		if ( LOG.isDebugEnabled() ) {
-			LOG.debugf( "Serializing: %s", getUuid() );
-		}
+		LOG.serializingFactory( getUuid() );
 		out.defaultWriteObject();
-		LOG.trace( "Serialized" );
+		LOG.trace( "Serialized factory" );
 	}
 
 	/**
@@ -1560,11 +1555,9 @@ private void writeObject(ObjectOutputStream out) throws IOException {
 	 */
 	@Serial
 	private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException {
-		LOG.trace( "Deserializing" );
+		LOG.trace( "Deserializing factory" );
 		in.defaultReadObject();
-		if ( LOG.isDebugEnabled() ) {
-			LOG.debugf( "Deserialized: %s", getUuid() );
-		}
+		LOG.deserializedFactory( getUuid() );
 	}
 
 	/**
@@ -1580,15 +1573,15 @@ private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundE
 	 */
 	@Serial
 	private Object readResolve() throws InvalidObjectException {
-		LOG.trace( "Resolving serialized SessionFactory" );
+		LOG.trace( "Resolving serialized factory" );
 		return locateSessionFactoryOnDeserialization( getUuid(), name );
 	}
 
 	private static SessionFactory locateSessionFactoryOnDeserialization(String uuid, String name)
 			throws InvalidObjectException{
 		final SessionFactory uuidResult = SessionFactoryRegistry.INSTANCE.getSessionFactory( uuid );
 		if ( uuidResult != null ) {
-			LOG.debugf( "Resolved SessionFactory by UUID [%s]", uuid );
+			LOG.debug( "Resolved factory by UUID: " + uuid );
 			return uuidResult;
 		}
 
@@ -1597,12 +1590,12 @@ private static SessionFactory locateSessionFactoryOnDeserialization(String uuid,
 		if ( name != null ) {
 			final SessionFactory namedResult = SessionFactoryRegistry.INSTANCE.getNamedSessionFactory( name );
 			if ( namedResult != null ) {
-				LOG.debugf( "Resolved SessionFactory by name [%s]", name );
+				LOG.debug( "Resolved factory by name: " + name );
 				return namedResult;
 			}
 		}
 
-		throw new InvalidObjectException( "Could not find a SessionFactory [uuid=" + uuid + ",name=" + name + "]" );
+		throw new InvalidObjectException( "No SessionFactory with uuid [" + uuid + "] and name [" + name + "]" );
 	}
 
 	/**
@@ -1627,7 +1620,7 @@ void serialize(ObjectOutputStream oos) throws IOException {
 	 * @throws IOException indicates problems reading back serial data stream
 	 */
 	static SessionFactoryImpl deserialize(ObjectInputStream ois) throws IOException {
-		LOG.trace( "Deserializing SessionFactory from Session" );
+		LOG.trace( "Resolving factory from deserialized session" );
 		final String uuid = ois.readUTF();
 		boolean isNamed = ois.readBoolean();
 		final String name = isNamed ? ois.readUTF() : null;