more typesafe logging in ConnectionInfoLogger

gavinking · gavinking · commit a9d7ab5c1dde · 2025-09-16T00:05:34.000+02:00
diff --git a/hibernate-core/src/main/java/org/hibernate/engine/jdbc/connections/internal/DataSourceConnectionProvider.java b/hibernate-core/src/main/java/org/hibernate/engine/jdbc/connections/internal/DataSourceConnectionProvider.java
@@ -17,7 +17,6 @@
 import org.hibernate.engine.jdbc.connections.spi.DatabaseConnectionInfo;
 import org.hibernate.engine.jdbc.env.spi.ExtractedDatabaseMetaData;
 import org.hibernate.engine.jndi.spi.JndiService;
-import org.hibernate.internal.log.ConnectionInfoLogger;
 import org.hibernate.service.UnknownUnwrapTypeException;
 import org.hibernate.service.spi.Configurable;
 import org.hibernate.service.spi.InjectService;
diff --git a/hibernate-core/src/main/java/org/hibernate/engine/jdbc/connections/internal/DriverManagerConnectionProvider.java b/hibernate-core/src/main/java/org/hibernate/engine/jdbc/connections/internal/DriverManagerConnectionProvider.java
@@ -26,7 +26,6 @@
 import org.hibernate.service.spi.ServiceRegistryAwareService;
 import org.hibernate.service.spi.ServiceRegistryImplementor;
 import org.hibernate.service.spi.Stoppable;
-import org.hibernate.internal.log.ConnectionInfoLogger;
 
 import static org.hibernate.cfg.JdbcSettings.AUTOCOMMIT;
 import static org.hibernate.cfg.JdbcSettings.DRIVER;
@@ -220,7 +219,7 @@ else if ( connectionCreatorFactory != null ) {
 
 	private static Driver loadDriverIfPossible(String driverClassName, ServiceRegistry serviceRegistry) {
 		if ( driverClassName == null ) {
-			CONNECTION_INFO_LOGGER.debug( "No driver class specified" );
+			CONNECTION_INFO_LOGGER.noDriverClassSpecified();
 			return null;
 		}
 		else if ( serviceRegistry != null ) {
@@ -247,7 +246,7 @@ else if ( serviceRegistry != null ) {
 	private static ConnectionCreatorFactory loadConnectionCreatorFactory(
 			String connectionCreatorFactoryClassName, ServiceRegistry serviceRegistry) {
 		if ( connectionCreatorFactoryClassName == null ) {
-			CONNECTION_INFO_LOGGER.debug( "No connection creator factory class specified" );
+			CONNECTION_INFO_LOGGER.noConnectionCreatorFactoryClassSpecified();
 			return null;
 		}
 		else if ( serviceRegistry != null ) {
@@ -340,7 +339,7 @@ protected int getOpenConnections() {
 	protected void validateConnectionsReturned() {
 		final int allocationCount = getOpenConnections();
 		if ( allocationCount != 0 ) {
-			CONNECTION_INFO_LOGGER.error( "Connection leak detected: there are " + allocationCount + " unclosed connections");
+			CONNECTION_INFO_LOGGER.connectionLeakDetected( allocationCount );
 		}
 	}
 
diff --git a/hibernate-core/src/main/java/org/hibernate/engine/jdbc/connections/internal/PoolState.java b/hibernate-core/src/main/java/org/hibernate/engine/jdbc/connections/internal/PoolState.java
@@ -4,7 +4,6 @@
  */
 package org.hibernate.engine.jdbc.connections.internal;
 
-import org.hibernate.internal.log.ConnectionInfoLogger;
 
 import java.sql.Connection;
 import java.sql.SQLException;
diff --git a/hibernate-core/src/main/java/org/hibernate/engine/jdbc/connections/internal/PooledConnections.java b/hibernate-core/src/main/java/org/hibernate/engine/jdbc/connections/internal/PooledConnections.java
@@ -5,7 +5,6 @@
 package org.hibernate.engine.jdbc.connections.internal;
 
 import org.hibernate.HibernateException;
-import org.hibernate.internal.log.ConnectionInfoLogger;
 
 import java.sql.Connection;
 import java.sql.SQLException;
@@ -32,7 +31,7 @@ class PooledConnections {
 
 	private PooledConnections(
 			Builder builder) {
-		CONNECTION_INFO_LOGGER.debugf( "Initializing Connection pool with %s Connections", builder.initialSize );
+		CONNECTION_INFO_LOGGER.initializingConnectionPool( builder.initialSize );
 		connectionCreator = builder.connectionCreator;
 		connectionValidator = builder.connectionValidator == null
 				? ConnectionValidator.ALWAYS_VALID
@@ -49,18 +48,18 @@ void validate() {
 		if ( !primed && size >= minSize ) {
 			// IMPL NOTE: the purpose of primed is to allow the pool to lazily reach its
 			// defined min-size.
-			CONNECTION_INFO_LOGGER.debug( "Connection pool now considered primed; min-size will be maintained" );
+			CONNECTION_INFO_LOGGER.connectionPoolPrimed();
 			primed = true;
 		}
 
 		if ( size < minSize && primed ) {
 			int numberToBeAdded = minSize - size;
-			CONNECTION_INFO_LOGGER.debugf( "Adding %s Connections to the pool", numberToBeAdded );
+			CONNECTION_INFO_LOGGER.addingConnectionsToPool( numberToBeAdded );
 			addConnections( numberToBeAdded );
 		}
 		else if ( size > maxSize ) {
 			int numberToBeRemoved = size - maxSize;
-			CONNECTION_INFO_LOGGER.debugf( "Removing %s Connections from the pool", numberToBeRemoved );
+			CONNECTION_INFO_LOGGER.removingConnectionsFromPool( numberToBeRemoved );
 			removeConnections( numberToBeRemoved );
 		}
 	}
@@ -85,7 +84,7 @@ private Connection releaseConnection(Connection conn) {
 			t = ex;
 		}
 		closeConnection( conn, t );
-		CONNECTION_INFO_LOGGER.debug( "Connection release failed. Closing pooled connection", t );
+		CONNECTION_INFO_LOGGER.connectionReleaseFailedClosingPooledConnection( t );
 		return null;
 	}
 
@@ -121,7 +120,7 @@ protected Connection prepareConnection(Connection conn) {
 			t = ex;
 		}
 		closeConnection( conn, t );
-		CONNECTION_INFO_LOGGER.debug( "Connection preparation failed. Closing pooled connection", t );
+		CONNECTION_INFO_LOGGER.connectionPreparationFailedClosingPooledConnection( t );
 		return null;
 	}
 
@@ -137,7 +136,7 @@ protected void closeConnection(Connection conn, Throwable t) {
 		}
 		finally {
 			if ( !allConnections.remove( conn ) ) {
-				CONNECTION_INFO_LOGGER.debug( "Connection remove failed." );
+				CONNECTION_INFO_LOGGER.connectionRemoveFailed();
 			}
 		}
 	}
diff --git a/hibernate-core/src/main/java/org/hibernate/engine/jdbc/env/internal/JdbcEnvironmentInitiator.java b/hibernate-core/src/main/java/org/hibernate/engine/jdbc/env/internal/JdbcEnvironmentInitiator.java
@@ -31,7 +31,6 @@
 import org.hibernate.engine.jdbc.spi.SqlExceptionHelper;
 import org.hibernate.event.monitor.internal.EmptyEventMonitor;
 import org.hibernate.event.monitor.spi.EventMonitor;
-import org.hibernate.internal.log.ConnectionInfoLogger;
 import org.hibernate.jdbc.AbstractReturningWork;
 import org.hibernate.jpa.internal.MutableJpaComplianceImpl;
 import org.hibernate.jpa.spi.JpaCompliance;
diff --git a/hibernate-core/src/main/java/org/hibernate/internal/log/ConnectionInfoLogger.java b/hibernate-core/src/main/java/org/hibernate/internal/log/ConnectionInfoLogger.java
@@ -20,6 +20,7 @@
 import static org.jboss.logging.Logger.Level.DEBUG;
 import static org.jboss.logging.Logger.Level.INFO;
 import static org.jboss.logging.Logger.Level.WARN;
+import static org.jboss.logging.Logger.Level.ERROR;
 
 /**
  * @author Steve Ebersole
@@ -79,7 +80,47 @@ public interface ConnectionInfoLogger extends BasicLogger {
 	@Message(value = "Configuring connection pool [%s]", id = 10001012)
 	void configureConnectionPool(String type);
 
-	@LogMessage(level = INFO)
+@LogMessage(level = INFO)
 	@Message(value = "Ignoring setting '%s' for connection provider [%s]", id = 10001013)
 	void ignoredSetting(String setting, Class<?> provider);
+
+	@LogMessage(level = DEBUG)
+	@Message(value = "Initializing connection pool with %s connections", id = 10001014)
+	void initializingConnectionPool(int size);
+
+	@LogMessage(level = DEBUG)
+	@Message(value = "Connection pool now considered primed; min-size will be maintained", id = 10001015)
+	void connectionPoolPrimed();
+
+	@LogMessage(level = DEBUG)
+	@Message(value = "Adding %s connections to the pool", id = 10001016)
+	void addingConnectionsToPool(int numberToBeAdded);
+
+	@LogMessage(level = DEBUG)
+	@Message(value = "Removing %s connections from the pool", id = 10001017)
+	void removingConnectionsFromPool(int numberToBeRemoved);
+
+	@LogMessage(level = DEBUG)
+	@Message(value = "Connection release failed, closing pooled connection", id = 10001018)
+	void connectionReleaseFailedClosingPooledConnection(@Cause Throwable t);
+
+	@LogMessage(level = DEBUG)
+	@Message(value = "Connection preparation failed, closing pooled connection", id = 10001019)
+	void connectionPreparationFailedClosingPooledConnection(@Cause Throwable t);
+
+	@LogMessage(level = DEBUG)
+	@Message(value = "Connection remove failed", id = 10001020)
+	void connectionRemoveFailed();
+
+	@LogMessage(level = DEBUG)
+	@Message(value = "No driver class specified", id = 10001021)
+	void noDriverClassSpecified();
+
+	@LogMessage(level = DEBUG)
+	@Message(value = "No connection creator factory class specified", id = 10001022)
+	void noConnectionCreatorFactoryClassSpecified();
+
+	@LogMessage(level = ERROR)
+	@Message(value = "Connection leak detected: there are %s unclosed connections", id = 10001023)
+	void connectionLeakDetected(int allocationCount);
 }

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,6 @@`
`5`	`5`	`package org.hibernate.engine.jdbc.connections.internal;`
`6`	`6`
`7`	`7`	`import org.hibernate.HibernateException;`
`8`		`-import org.hibernate.internal.log.ConnectionInfoLogger;`
`9`	`8`
`10`	`9`	`import java.sql.Connection;`
`11`	`10`	`import java.sql.SQLException;`
`@@ -32,7 +31,7 @@ class PooledConnections {`
`32`	`31`
`33`	`32`	`private PooledConnections(`
`34`	`33`	`Builder builder) {`
`35`		`- CONNECTION_INFO_LOGGER.debugf( "Initializing Connection pool with %s Connections", builder.initialSize );`
	`34`	`+ CONNECTION_INFO_LOGGER.initializingConnectionPool( builder.initialSize );`
`36`	`35`	`connectionCreator = builder.connectionCreator;`
`37`	`36`	`connectionValidator = builder.connectionValidator == null`
`38`	`37`	`? ConnectionValidator.ALWAYS_VALID`
`@@ -49,18 +48,18 @@ void validate() {`
`49`	`48`	`if ( !primed && size >= minSize ) {`
`50`	`49`	`// IMPL NOTE: the purpose of primed is to allow the pool to lazily reach its`
`51`	`50`	`// defined min-size.`
`52`		`- CONNECTION_INFO_LOGGER.debug( "Connection pool now considered primed; min-size will be maintained" );`
	`51`	`+ CONNECTION_INFO_LOGGER.connectionPoolPrimed();`
`53`	`52`	`primed = true;`
`54`	`53`	`}`
`55`	`54`
`56`	`55`	`if ( size < minSize && primed ) {`
`57`	`56`	`int numberToBeAdded = minSize - size;`
`58`		`- CONNECTION_INFO_LOGGER.debugf( "Adding %s Connections to the pool", numberToBeAdded );`
	`57`	`+ CONNECTION_INFO_LOGGER.addingConnectionsToPool( numberToBeAdded );`
`59`	`58`	`addConnections( numberToBeAdded );`
`60`	`59`	`}`
`61`	`60`	`else if ( size > maxSize ) {`
`62`	`61`	`int numberToBeRemoved = size - maxSize;`
`63`		`- CONNECTION_INFO_LOGGER.debugf( "Removing %s Connections from the pool", numberToBeRemoved );`
	`62`	`+ CONNECTION_INFO_LOGGER.removingConnectionsFromPool( numberToBeRemoved );`
`64`	`63`	`removeConnections( numberToBeRemoved );`
`65`	`64`	`}`
`66`	`65`	`}`
`@@ -85,7 +84,7 @@ private Connection releaseConnection(Connection conn) {`
`85`	`84`	`t = ex;`
`86`	`85`	`}`
`87`	`86`	`closeConnection( conn, t );`
`88`		`- CONNECTION_INFO_LOGGER.debug( "Connection release failed. Closing pooled connection", t );`
	`87`	`+ CONNECTION_INFO_LOGGER.connectionReleaseFailedClosingPooledConnection( t );`
`89`	`88`	`return null;`
`90`	`89`	`}`
`91`	`90`
`@@ -121,7 +120,7 @@ protected Connection prepareConnection(Connection conn) {`
`121`	`120`	`t = ex;`
`122`	`121`	`}`
`123`	`122`	`closeConnection( conn, t );`
`124`		`- CONNECTION_INFO_LOGGER.debug( "Connection preparation failed. Closing pooled connection", t );`
	`123`	`+ CONNECTION_INFO_LOGGER.connectionPreparationFailedClosingPooledConnection( t );`
`125`	`124`	`return null;`
`126`	`125`	`}`
`127`	`126`
`@@ -137,7 +136,7 @@ protected void closeConnection(Connection conn, Throwable t) {`
`137`	`136`	`}`
`138`	`137`	`finally {`
`139`	`138`	`if ( !allConnections.remove( conn ) ) {`
`140`		`- CONNECTION_INFO_LOGGER.debug( "Connection remove failed." );`
	`139`	`+ CONNECTION_INFO_LOGGER.connectionRemoveFailed();`
`141`	`140`	`}`
`142`	`141`	`}`
`143`	`142`	`}`