Merge pull request #113 from ebean-orm/feature/system-logger

Replace slf4j-api with java platform logger (System.Logger)

Author: rbygrave

ebean-migration/pom.xml

@@ -22,12 +22,10 @@
   </properties>
 
   <dependencies>
-
     <dependency>
-      <groupId>org.slf4j</groupId>
-      <artifactId>slf4j-api</artifactId>
-      <version>1.7.36</version>
-      <scope>provided</scope>
+      <groupId>io.avaje</groupId>
+      <artifactId>avaje-applog</artifactId>
+      <version>1.0</version>
     </dependency>
 
     <dependency>
@@ -58,6 +56,13 @@
 
     <!-- test dependencies -->
 
+    <dependency>
+      <groupId>io.avaje</groupId>
+      <artifactId>avaje-slf4j-jpl</artifactId>
+      <version>1.1</version>
+      <scope>test</scope>
+    </dependency>
+
     <dependency>
       <groupId>com.h2database</groupId>
       <artifactId>h2</artifactId>
@@ -82,7 +87,7 @@
     <dependency>
       <groupId>org.postgresql</groupId>
       <artifactId>postgresql</artifactId>
-      <version>42.3.3</version>
+      <version>42.4.2</version>
       <scope>test</scope>
     </dependency>
 
@@ -103,7 +108,7 @@
     <dependency>
       <groupId>org.mariadb.jdbc</groupId>
       <artifactId>mariadb-java-client</artifactId>
-      <version>2.6.0</version>
+      <version>3.0.6</version>
       <scope>test</scope>
     </dependency>
 

ebean-migration/src/main/java/io/ebean/migration/DbNameUtil.java

@@ -8,6 +8,8 @@
 import java.sql.ResultSet;
 import java.sql.SQLException;
 
+import static java.lang.System.Logger.Level.WARNING;
+
 /**
  * Derive well known database platform names from JDBC MetaData.
  */
@@ -64,7 +66,7 @@ private static String readPostgres(Connection connection) {
         }
       }
     } catch (SQLException e) {
-      MigrationRunner.log.warn("Error running detection query on Postgres", e);
+      MigrationRunner.log.log(WARNING, "Error running detection query on Postgres", e);
     }
     return POSTGRES;
   }

ebean-migration/src/main/java/io/ebean/migration/MigrationRunner.java

@@ -1,25 +1,22 @@
 package io.ebean.migration;
 
-import io.ebean.migration.runner.LocalMigrationResource;
-import io.ebean.migration.runner.LocalMigrationResources;
-import io.ebean.migration.runner.MigrationPlatform;
-import io.ebean.migration.runner.MigrationSchema;
-import io.ebean.migration.runner.MigrationTable;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
+import io.avaje.applog.AppLog;
+import io.ebean.migration.runner.*;
 
 import javax.annotation.Nonnull;
 import javax.sql.DataSource;
 import java.sql.Connection;
 import java.sql.SQLException;
 import java.util.List;
 
+import static java.lang.System.Logger.Level.*;
+
 /**
  * Runs the DB migration typically on application start.
  */
 public class MigrationRunner {
 
-  static final Logger log = LoggerFactory.getLogger("io.ebean.migration");
+  static final System.Logger log = AppLog.getLogger("io.ebean.migration");
 
   protected final MigrationConfig migrationConfig;
 
@@ -81,7 +78,7 @@ private Connection getConnection(DataSource dataSource) {
       if (username == null) {
         return dataSource.getConnection();
       }
-      log.debug("using db user [{}] to run migrations ...", username);
+      log.log(DEBUG, "using db user [{0}] to run migrations ...", username);
       return dataSource.getConnection(username, migrationConfig.getDbPassword());
     } catch (SQLException e) {
       String msgSuffix = (username == null) ? "" : " using user [" + username + "]";
@@ -96,7 +93,7 @@ protected void run(Connection connection, boolean checkStateMode) {
     try {
       LocalMigrationResources resources = new LocalMigrationResources(migrationConfig);
       if (!resources.readResources() && !resources.readInitResources()) {
-        log.debug("no migrations to check");
+        log.log(DEBUG, "no migrations to check");
         return;
       }
 
@@ -137,12 +134,12 @@ private void runMigrations(LocalMigrationResources resources, MigrationTable tab
       LocalMigrationResource initVersion = getInitVersion();
       if (initVersion != null) {
         // run using a dbinit script
-        log.info("dbinit migration version:{}  local migrations:{}  checkState:{}", initVersion, localVersions.size(), checkStateMode);
+        log.log(INFO, "dbinit migration version:{0}  local migrations:{1}  checkState:{2}", initVersion, localVersions.size(), checkStateMode);
         checkMigrations = table.runInit(initVersion, localVersions);
         return;
       }
     }
-    log.info("Local migrations:{}  existing migrations:{}  checkState:{}", localVersions.size(), table.size(), checkStateMode);
+    log.log(INFO, "Local migrations:{0}  existing migrations:{1}  checkState:{2}", localVersions.size(), table.size(), checkStateMode);
     checkMigrations = table.runAll(localVersions);
   }
 
@@ -183,7 +180,7 @@ private void close(Connection connection) {
         connection.close();
       }
     } catch (SQLException e) {
-      log.warn("Error closing connection", e);
+      log.log(WARNING, "Error closing connection", e);
     }
   }
 
@@ -196,7 +193,7 @@ private void rollback(Connection connection) {
         connection.rollback();
       }
     } catch (SQLException e) {
-      log.warn("Error on connection rollback", e);
+      log.log(WARNING, "Error on connection rollback", e);
     }
   }
 }

ebean-migration/src/main/java/io/ebean/migration/MigrationVersion.java

@@ -2,6 +2,8 @@
 
 import java.util.Arrays;
 
+import static java.lang.System.Logger.Level.*;
+
 /**
  * The version of a migration used so that migrations are processed in order.
  */
@@ -216,8 +218,8 @@ public static MigrationVersion parse(String raw) {
         delimiterPos++;
       } catch (NumberFormatException e) {
         // stop parsing
-        MigrationRunner.log.warn("The migrationscript '{}' contains non numeric version part. "
-          + "This may lead to misordered version scripts. NumberFormatException {}", raw, e.getMessage());
+        MigrationRunner.log.log(WARNING, "The migrationscript '{0}' contains non numeric version part. "
+          + "This may lead to misordered version scripts. NumberFormatException {1}", raw, e.getMessage());
         break;
       }
     }

ebean-migration/src/main/java/io/ebean/migration/runner/IOUtils.java

@@ -4,22 +4,24 @@
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.OutputStream;
-import java.io.UnsupportedEncodingException;
 import java.net.URL;
 import java.net.URLConnection;
+import java.nio.charset.StandardCharsets;
 
 /**
  * Utilities for IO.
  */
-class IOUtils {
+final class IOUtils {
 
   /**
    * Reads the entire contents of the specified URL and return them as UTF-8 string.
    */
   static String readUtf8(URL url) throws IOException {
     URLConnection urlConnection = url.openConnection();
     urlConnection.setUseCaches(false);
-    return readUtf8(urlConnection.getInputStream());
+    try (InputStream is = urlConnection.getInputStream()) {
+      return readUtf8(is);
+    }
   }
 
   /**
@@ -42,11 +44,7 @@ private static byte[] read(InputStream in) throws IOException {
    * Returns the UTF-8 string corresponding to the specified bytes.
    */
   private static String bytesToUtf8(byte[] data) {
-    try {
-      return new String(data, "UTF-8");
-    } catch (UnsupportedEncodingException e) {
-      throw new IllegalStateException("Support for UTF-8 is mandated by the Java spec", e);
-    }
+    return new String(data, StandardCharsets.UTF_8);
   }
 
   /**
@@ -57,8 +55,8 @@ private static String bytesToUtf8(byte[] data) {
   private static void pump(InputStream in, OutputStream out) throws IOException {
     if (in == null) throw new IOException("Input stream is null");
     if (out == null) throw new IOException("Output stream is null");
-    try {
-      try {
+    try (out) {
+      try (in) {
         byte[] buffer = new byte[4096];
         for (; ; ) {
           int bytes = in.read(buffer);
@@ -67,11 +65,7 @@ private static void pump(InputStream in, OutputStream out) throws IOException {
           }
           out.write(buffer, 0, bytes);
         }
-      } finally {
-        in.close();
       }
-    } finally {
-      out.close();
     }
   }
 }

ebean-migration/src/main/java/io/ebean/migration/runner/LocalMigrationResources.java

@@ -5,21 +5,21 @@
 import io.ebean.migration.JdbcMigration;
 import io.ebean.migration.MigrationConfig;
 import io.ebean.migration.MigrationVersion;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 
 import javax.annotation.Nonnull;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
 import java.util.function.Predicate;
 
+import static java.lang.System.Logger.Level.DEBUG;
+
 /**
  * Loads the DB migration resources and sorts them into execution order.
  */
 public class LocalMigrationResources {
 
-  private static final Logger log = LoggerFactory.getLogger("io.ebean.migration");
+  private static final System.Logger log = MigrationSchema.log;
 
   private final List<LocalMigrationResource> versions = new ArrayList<>();
   private final MigrationConfig migrationConfig;
@@ -73,7 +73,7 @@ private boolean loadedFrom(String path, String platform) {
     if (versions.isEmpty()) {
       return false;
     }
-    log.debug("platform migrations for {}", platform);
+    log.log(DEBUG, "platform migrations for {0}", platform);
     if (searchForJdbcMigrations) {
       addResources(scanForJdbcOnly(path));
     }
@@ -97,7 +97,7 @@ private List<Resource> scanForBoth(String path) {
 
   private void addResources(List<Resource> resourceList) {
     if (!resourceList.isEmpty()) {
-      log.debug("resources: {}", resourceList);
+      log.log(DEBUG, "resources: {0}", resourceList);
     }
     for (Resource resource : resourceList) {
       String filename = resource.name();

ebean-migration/src/main/java/io/ebean/migration/runner/MigrationPlatform.java

@@ -1,9 +1,6 @@
 package io.ebean.migration.runner;
 
-
 import io.ebean.ddlrunner.DdlDetect;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 
 import javax.annotation.Nonnull;
 import java.sql.Connection;
@@ -13,12 +10,14 @@
 import java.util.ArrayList;
 import java.util.List;
 
+import static java.lang.System.Logger.Level.*;
+
 /**
  * Handle database platform specific locking on db migration table.
  */
 public class MigrationPlatform {
 
-  private static final Logger log = LoggerFactory.getLogger("io.ebean.DDL");
+  private static final System.Logger log = MigrationTable.log;
 
   private static final String BASE_SELECT_ID = "select id from ";
   private static final String BASE_SELECT_ALL = "select id, mtype, mstatus, mversion, mcomment, mchecksum, run_on, run_by, run_time from ";
@@ -56,9 +55,9 @@ void lockMigrationTable(String sqlTable, Connection connection) throws SQLExcept
   private static void backoff(int attempt) {
     try {
       if (attempt % 100 == 0) {
-        log.warn("In backoff loop attempting to obtain lock on DBMigration table ...");
+        log.log(WARNING, "In backoff loop attempting to obtain lock on DBMigration table ...");
       } else {
-        log.trace("in backoff loop obtaining lock...");
+        log.log(TRACE, "in backoff loop obtaining lock...");
       }
       Thread.sleep(100);
     } catch (InterruptedException e) {
@@ -122,7 +121,7 @@ void lockMigrationTable(String sqlTable, Connection connection) throws SQLExcept
       while (!obtainLogicalLock(sqlTable, connection)) {
         backoff(++attempts);
       }
-      log.trace("obtained logical lock");
+      log.log(TRACE, "obtained logical lock");
     }
 
     @Override
@@ -150,9 +149,9 @@ private void releaseLogicalLock(String sqlTable, Connection connection) throws S
       String sql = "update " + sqlTable + " set mcomment='<init>' where id=0";
       try (PreparedStatement query = connection.prepareStatement(sql)) {
         if (query.executeUpdate() != 1) {
-          log.error("Failed to release logical lock. Please review why [" + sql + "] didn't update the row?");
+          log.log(ERROR, "Failed to release logical lock. Please review why [" + sql + "] didn't update the row?");
         } else {
-          log.trace("released logical lock");
+          log.log(TRACE, "released logical lock");
         }
       }
     }

ebean-migration/src/main/java/io/ebean/migration/runner/MigrationSchema.java

@@ -1,20 +1,21 @@
 package io.ebean.migration.runner;
 
+import io.avaje.applog.AppLog;
 import io.ebean.migration.MigrationConfig;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 
 import java.sql.Connection;
 import java.sql.ResultSet;
 import java.sql.SQLException;
 import java.sql.Statement;
 
+import static java.lang.System.Logger.Level.INFO;
+
 /**
  * Create Schema if needed and set current Schema in Migration
  */
-public class MigrationSchema {
+public final class MigrationSchema {
 
-  private static final Logger log = LoggerFactory.getLogger("io.ebean.migration");
+  static final System.Logger log = AppLog.getLogger("io.ebean.migration");
 
   private final Connection connection;
   private final String dbSchema;
@@ -40,7 +41,7 @@ private String trim(String dbSchema) {
    */
   public void createAndSetIfNeeded() throws SQLException {
     if (dbSchema != null) {
-      log.info("Migration Schema: {}", dbSchema);
+      log.log(INFO, "Migration Schema: {0}", dbSchema);
       if (createSchemaIfNotExists) {
         createSchemaIfNeeded();
       }
@@ -52,7 +53,7 @@ public void createAndSetIfNeeded() throws SQLException {
 
   private void createSchemaIfNeeded() throws SQLException {
     if (!schemaExists()) {
-      log.info("Creating Schema: {}", dbSchema);
+      log.log(INFO, "Creating Schema: {0}", dbSchema);
       try (Statement query = connection.createStatement()) {
         query.executeUpdate("CREATE SCHEMA " + dbSchema);
       }
@@ -72,7 +73,7 @@ private boolean schemaExists() throws SQLException {
   }
 
   private void setSchema() throws SQLException {
-    log.info("Setting Schema: {}", dbSchema);
+    log.log(INFO, "Setting Schema: {0}", dbSchema);
     connection.setSchema(dbSchema);
   }