JAVA-18116 Review log statements for projects - Week 7 - 2023 (#13583)

jsgrah-spring · jsgmiles · web-flow · commit 23c1abe3f27e · 2023-04-10T14:35:40.000+03:00
JAVA-18116 Review log statements for projects - Week 7 - 2023 (#13583)
---------

Co-authored-by: jogra &lt;joseph.sterling.grah@miles.no&gt;
diff --git a/core-java-modules/core-java-concurrency-advanced/src/main/java/com/baeldung/concurrent/countdownlatch/Worker.java b/core-java-modules/core-java-concurrency-advanced/src/main/java/com/baeldung/concurrent/countdownlatch/Worker.java
@@ -1,9 +1,14 @@
 package com.baeldung.concurrent.countdownlatch;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 import java.util.List;
 import java.util.concurrent.CountDownLatch;
 
 public class Worker implements Runnable {
+
+    private static Logger log = LoggerFactory.getLogger(Worker.class);
     private final List<String> outputScraper;
     private final CountDownLatch countDownLatch;
 
@@ -15,7 +20,7 @@ public class Worker implements Runnable {
     @Override
     public void run() {
         // Do some work
-        System.out.println("Doing some logic");
+        log.debug("Doing some logic");
         outputScraper.add("Counted down");
         countDownLatch.countDown();
     }
diff --git a/core-java-modules/core-java-concurrency-advanced/src/main/java/com/baeldung/concurrent/phaser/LongRunningAction.java b/core-java-modules/core-java-concurrency-advanced/src/main/java/com/baeldung/concurrent/phaser/LongRunningAction.java
@@ -1,8 +1,13 @@
 package com.baeldung.concurrent.phaser;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 import java.util.concurrent.Phaser;
 
 class LongRunningAction implements Runnable {
+
+    private static Logger log = LoggerFactory.getLogger(LongRunningAction.class);
     private String threadName;
     private Phaser ph;
 
@@ -14,18 +19,18 @@ class LongRunningAction implements Runnable {
 
     @Override
     public void run() {
-        System.out.println("This is phase " + ph.getPhase());
-        System.out.println("Thread " + threadName + " before long running action");
+        log.info("This is phase {}", ph.getPhase());
+        log.info("Thread {} before long running action", threadName);
         
         try {
             Thread.sleep(2000);
         } catch (InterruptedException e) {
             e.printStackTrace();
         }
-        
-        System.out.println("Thread " + threadName + " action completed and waiting for others");
+
+        log.debug("Thread {} action completed and waiting for others", threadName);
         ph.arriveAndAwaitAdvance();
-        System.out.println("Thread " + threadName + " proceeding in phase " + ph.getPhase());
+        log.debug("Thread {} proceeding in phase {}", threadName, ph.getPhase());
         
         ph.arriveAndDeregister();
     }
diff --git a/core-java-modules/core-java-concurrency-advanced/src/test/java/com/baeldung/concurrent/phaser/PhaserUnitTest.java b/core-java-modules/core-java-concurrency-advanced/src/test/java/com/baeldung/concurrent/phaser/PhaserUnitTest.java
@@ -4,6 +4,9 @@
 import org.junit.Test;
 import org.junit.runners.MethodSorters;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Executors;
 import java.util.concurrent.Phaser;
@@ -13,6 +16,8 @@
 @FixMethodOrder(MethodSorters.NAME_ASCENDING)
 public class PhaserUnitTest {
 
+    private static Logger log = LoggerFactory.getLogger(PhaserUnitTest.class);
+
     @Test
     public void givenPhaser_whenCoordinateWorksBetweenThreads_thenShouldCoordinateBetweenMultiplePhases() {
         //given
@@ -26,19 +31,19 @@ public void givenPhaser_whenCoordinateWorksBetweenThreads_thenShouldCoordinateBe
         executorService.submit(new LongRunningAction("thread-3", ph));
 
         //then
-        System.out.println("Thread " + Thread.currentThread().getName() + " waiting for others");
+        log.debug("Thread {} waiting for others", Thread.currentThread().getName());
         ph.arriveAndAwaitAdvance();
-        System.out.println("Thread " + Thread.currentThread().getName() + " proceeding in phase " + ph.getPhase());
+        log.debug("Thread {} proceeding in phase {}", Thread.currentThread().getName(), ph.getPhase());
         
         assertEquals(1, ph.getPhase());
 
         //and
         executorService.submit(new LongRunningAction("thread-4", ph));
         executorService.submit(new LongRunningAction("thread-5", ph));
-        
-        System.out.println("Thread " + Thread.currentThread().getName() + " waiting for others");
+
+        log.debug("Thread {} waiting for others", Thread.currentThread().getName());
         ph.arriveAndAwaitAdvance();
-        System.out.println("Thread " + Thread.currentThread().getName() + " proceeding in phase " + ph.getPhase());
+        log.debug("Thread {} proceeding in phase {}", Thread.currentThread().getName(), ph.getPhase());
         
         assertEquals(2, ph.getPhase());
 
diff --git a/core-java-modules/core-java-concurrency-advanced/src/test/resources/logback-test.xml b/core-java-modules/core-java-concurrency-advanced/src/test/resources/logback-test.xml
@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<configuration>
+    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
+        <encoder>
+            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n
+            </pattern>
+        </encoder>
+    </appender>
+
+    <logger name="org.springframework" level="WARN" />
+    <logger name="org.springframework.transaction" level="WARN" />
+
+    <!-- in order to debug some marshalling issues, this needs to be TRACE -->
+    <logger name="org.springframework.web.servlet.mvc" level="WARN" />
+
+    <root level="INFO">
+        <appender-ref ref="STDOUT" />
+    </root>
+</configuration>
diff --git a/libraries-apache-commons-io/pom.xml b/libraries-apache-commons-io/pom.xml
@@ -23,6 +23,11 @@
             <artifactId>commons-io</artifactId>
             <version>${commons-io.version}</version>
         </dependency>
+        <dependency>
+            <groupId>org.projectlombok</groupId>
+            <artifactId>lombok</artifactId>
+            <version>${lombok.version}</version>
+        </dependency>
     </dependencies>
 
     <properties>
diff --git a/libraries-apache-commons-io/src/test/java/com/baeldung/commons/io/CommonsIOUnitTest.java b/libraries-apache-commons-io/src/test/java/com/baeldung/commons/io/CommonsIOUnitTest.java
@@ -22,6 +22,9 @@
 import java.io.IOException;
 import java.nio.charset.Charset;
 
+import lombok.extern.slf4j.Slf4j;
+
+@Slf4j
 public class CommonsIOUnitTest {
 
     @Test
@@ -47,9 +50,9 @@ public void whenUsingFileNameUtils_thenshowdifferentFileOperations() throws IOEx
         String extension = FilenameUtils.getExtension(path);
         String baseName = FilenameUtils.getBaseName(path);
 
-        System.out.println("full path" + fullPath);
-        System.out.println("Extension" + extension);
-        System.out.println("Base name" + baseName);
+        log.debug("full path: " + fullPath);
+        log.debug("Extension: " + extension);
+        log.debug("Base name: " + baseName);
     }
 
     @Test
diff --git a/libraries-apache-commons-io/src/test/resources/logback-test.xml b/libraries-apache-commons-io/src/test/resources/logback-test.xml
@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<configuration>
+    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
+        <encoder>
+            <pattern>%d{yyyy-MM-dd HH:mm:ss} | %-5p | [%thread] %logger{5}:%L - %msg%n</pattern>
+        </encoder>
+    </appender>
+
+    <root level="INFO">
+        <appender-ref ref="STDOUT" />
+    </root>
+</configuration>
diff --git a/patterns-modules/design-patterns-behavioral/src/main/java/com/baeldung/templatemethod/model/HighEndComputerBuilder.java b/patterns-modules/design-patterns-behavioral/src/main/java/com/baeldung/templatemethod/model/HighEndComputerBuilder.java
@@ -1,5 +1,8 @@
 package com.baeldung.templatemethod.model;
 
+import lombok.extern.slf4j.Slf4j;
+
+@Slf4j
 public class HighEndComputerBuilder extends ComputerBuilder {
 
     @Override
@@ -11,7 +14,7 @@ public void addMotherboard() {
     public void setupMotherboard() {
         motherboardSetupStatus.add("Screwing the high-end motherboard to the case.");
         motherboardSetupStatus.add("Pluging in the power supply connectors.");
-        motherboardSetupStatus.forEach(step -> System.out.println(step));
+        motherboardSetupStatus.forEach(step -> log.debug(step));
     }
     
     @Override
diff --git a/patterns-modules/design-patterns-behavioral/src/main/java/com/baeldung/templatemethod/model/StandardComputerBuilder.java b/patterns-modules/design-patterns-behavioral/src/main/java/com/baeldung/templatemethod/model/StandardComputerBuilder.java
@@ -1,5 +1,8 @@
 package com.baeldung.templatemethod.model;
- 
+
+import lombok.extern.slf4j.Slf4j;
+
+@Slf4j
 public class StandardComputerBuilder extends ComputerBuilder {
 
     @Override
@@ -11,7 +14,7 @@ public void addMotherboard() {
     public void setupMotherboard() {
         motherboardSetupStatus.add("Screwing the standard motherboard to the case.");
         motherboardSetupStatus.add("Pluging in the power supply connectors.");
-        motherboardSetupStatus.forEach(step -> System.out.println(step));
+        motherboardSetupStatus.forEach(step -> log.debug(step));
     }
     
     @Override
diff --git a/patterns-modules/design-patterns-behavioral/src/test/resources/logback-test.xml b/patterns-modules/design-patterns-behavioral/src/test/resources/logback-test.xml
@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<configuration>
+    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
+        <encoder>
+            <pattern>%d{yyyy-MM-dd HH:mm:ss} | %-5p | [%thread] %logger{5}:%L - %msg%n</pattern>
+        </encoder>
+    </appender>
+
+    <root level="INFO">
+        <appender-ref ref="STDOUT" />
+    </root>
+</configuration>
diff --git a/spring-drools/src/main/java/com/baeldung/spring/drools/service/TaxiFareCalculatorService.java b/spring-drools/src/main/java/com/baeldung/spring/drools/service/TaxiFareCalculatorService.java
@@ -2,6 +2,8 @@
 
 import org.kie.api.runtime.KieContainer;
 import org.kie.api.runtime.KieSession;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Service;
 
@@ -11,6 +13,8 @@
 @Service
 public class TaxiFareCalculatorService {
 
+    private static final Logger LOGGER = LoggerFactory.getLogger(TaxiFareCalculatorService.class);
+
     @Autowired
     private KieContainer kContainer;
 
@@ -20,7 +24,7 @@ public Long calculateFare(TaxiRide taxiRide, Fare rideFare) {
         kieSession.insert(taxiRide);
         kieSession.fireAllRules();
         kieSession.dispose();
-        System.out.println("!! RIDE FARE !! " + rideFare.getTotalFare());
+        LOGGER.debug("!! RIDE FARE !! " + rideFare.getTotalFare());
         return rideFare.getTotalFare();
     }
 }
diff --git a/vertx-modules/vertx-and-rxjava/src/test/java/com/baeldung/weather/VertxWithRxJavaIntegrationTest.java b/vertx-modules/vertx-and-rxjava/src/test/java/com/baeldung/weather/VertxWithRxJavaIntegrationTest.java
@@ -45,18 +45,18 @@ public void shouldDisplayLightLenghts() throws InterruptedException {
         // read the file that contains one city name per line
         fileSystem
           .rxReadFile("cities.txt").toFlowable()
-            .doOnNext(buffer -> log.info("File buffer ---\n{}\n---", buffer))
+            .doOnNext(buffer -> log.debug("File buffer ---\n{}\n---", buffer))
           .flatMap(buffer -> Flowable.fromArray(buffer.toString().split("\\r?\\n")))
-            .doOnNext(city -> log.info("City from file: '{}'", city))
+            .doOnNext(city -> log.debug("City from file: '{}'", city))
           .filter(city -> !city.startsWith("#"))
-            .doOnNext(city -> log.info("City that survived filtering: '{}'", city))
+            .doOnNext(city -> log.debug("City that survived filtering: '{}'", city))
           .flatMap(city -> searchByCityName(httpClient, city))
           .flatMap(HttpClientResponse::toFlowable)
-            .doOnNext(buffer -> log.info("JSON of city detail: '{}'", buffer))
+            .doOnNext(buffer -> log.debug("JSON of city detail: '{}'", buffer))
           .map(extractingWoeid())
           .flatMap(cityId -> getDataByPlaceId(httpClient, cityId))
           .flatMap(toBufferFlowable())
-            .doOnNext(buffer -> log.info("JSON of place detail: '{}'", buffer))
+            .doOnNext(buffer -> log.debug("JSON of place detail: '{}'", buffer))
           .map(Buffer::toJsonObject)
           .map(toCityAndDayLength())
           .subscribe(System.out::println, Throwable::printStackTrace);
