feat: #98 In the VocabularyTopExporter hierarchy, return loggerName a…

…nd use a single LoggerWrapper that will append this loggerName to the logs.
kghackers · Nov 27, 2024 · ed1a241 · ed1a241
1 parent 0c2c981
commit ed1a241
Show file tree

Hide file tree

Showing 22 changed files with 122 additions and 66 deletions.
diff --git a/kgstatsSrv/src/main/java/ru/klavogonki/statistics/export/LoggerWrapper.java b/kgstatsSrv/src/main/java/ru/klavogonki/statistics/export/LoggerWrapper.java
@@ -0,0 +1,41 @@
+package ru.klavogonki.statistics.export;
+
+import lombok.extern.log4j.Log4j2;
+import org.apache.logging.log4j.Logger;
+
+@Log4j2
+public class LoggerWrapper {
+
+    private final Logger internalLogger;
+    private final String loggerPrefix;
+    private final String loggerPrefixFull;
+
+    public LoggerWrapper(Logger internalLogger, String loggerPrefix) {
+        this.internalLogger = internalLogger;
+        this.loggerPrefix = loggerPrefix;
+        this.loggerPrefixFull = String.format("[%s]: ", loggerPrefix);
+
+        logger.info("LoggerWrapper initialized for loggerPrefix = \"{}\".", loggerPrefix);
+    }
+
+    private String formatMessage(String message) { // appends prefix
+        // todo: maybe String.format will work for message as well, but let's not risk
+        return loggerPrefixFull + message;
+    }
+
+    public void debug(String message, Object p0) {
+        internalLogger.debug(formatMessage(message), p0);
+    }
+
+    public void debug(String message, Object p0, Object p1) {
+        internalLogger.debug(formatMessage(message), p0, p1);
+    }
+
+    public void warn(String message, Object p0) {
+        internalLogger.warn(formatMessage(message), p0);
+    }
+
+    public void warn(String message, Object p0, Object p1) {
+        internalLogger.warn(formatMessage(message), p0, p1);
+    }
+}
diff --git a/...tsSrv/src/main/java/ru/klavogonki/statistics/export/vocabulary/VocabularyTopExporter.java b/...tsSrv/src/main/java/ru/klavogonki/statistics/export/vocabulary/VocabularyTopExporter.java
@@ -1,24 +1,24 @@
 package ru.klavogonki.statistics.export.vocabulary;
 
 import org.apache.commons.lang3.StringUtils;
-import org.apache.logging.log4j.Logger;
 import org.mapstruct.factory.Mappers;
+import ru.klavogonki.statistics.dto.PlayerVocabularyDto;
+import ru.klavogonki.statistics.entity.PlayerVocabularyStatsEntity;
 import ru.klavogonki.statistics.excel.ExcelExporter;
 import ru.klavogonki.statistics.excel.VocabularyTopByBestSpeedExcelTemplate;
 import ru.klavogonki.statistics.excel.VocabularyTopByHaulExcelTemplate;
 import ru.klavogonki.statistics.excel.VocabularyTopByRacesCountExcelTemplate;
 import ru.klavogonki.statistics.export.DataExporter;
 import ru.klavogonki.statistics.export.ExportContext;
 import ru.klavogonki.statistics.export.ExporterUtils;
+import ru.klavogonki.statistics.export.LoggerWrapper;
 import ru.klavogonki.statistics.freemarker.PageUrls;
 import ru.klavogonki.statistics.freemarker.VocabularyTopByHaulLoginToPageTemplate;
 import ru.klavogonki.statistics.freemarker.VocabularyTopByHaulTemplate;
 import ru.klavogonki.statistics.freemarker.VocabularyTopByRacesCountLoginToPageTemplate;
 import ru.klavogonki.statistics.freemarker.VocabularyTopByRacesCountTemplate;
 import ru.klavogonki.statistics.freemarker.VocabularyTopBySpeedLoginToPageTemplate;
 import ru.klavogonki.statistics.freemarker.VocabularyTopBySpeedTemplate;
-import ru.klavogonki.statistics.dto.PlayerVocabularyDto;
-import ru.klavogonki.statistics.entity.PlayerVocabularyStatsEntity;
 import ru.klavogonki.statistics.mapper.PlayerVocabularyDtoMapper;
 import ru.klavogonki.statistics.util.JacksonUtils;
 
@@ -37,7 +37,8 @@ public interface VocabularyTopExporter extends DataExporter {
 
     int minRacesCount();
 
-    Logger logger();
+    String loggerName();
+    LoggerWrapper logger();
 
     default int pageSize() {
         return 100;

diff --git a/.../ru/klavogonki/statistics/export/vocabulary/non_standard/DigitsOneHundredTopExporter.java b/.../ru/klavogonki/statistics/export/vocabulary/non_standard/DigitsOneHundredTopExporter.java
@@ -1,7 +1,6 @@
 package ru.klavogonki.statistics.export.vocabulary.non_standard;
 
 import lombok.extern.log4j.Log4j2;
-import org.apache.logging.log4j.Logger;
 import org.springframework.context.annotation.Profile;
 import org.springframework.stereotype.Component;
 import ru.klavogonki.common.NonStandardDictionary;
@@ -24,7 +23,7 @@ public int minRacesCount() {
     }
 
     @Override
-    public Logger logger() {
-        return logger;
+    public String loggerName() {
+        return this.getClass().getSimpleName();
     }
 }
diff --git a/.../klavogonki/statistics/export/vocabulary/non_standard/FrequencyVocabularyTopExporter.java b/.../klavogonki/statistics/export/vocabulary/non_standard/FrequencyVocabularyTopExporter.java
@@ -1,7 +1,6 @@
 package ru.klavogonki.statistics.export.vocabulary.non_standard;
 
 import lombok.extern.log4j.Log4j2;
-import org.apache.logging.log4j.Logger;
 import org.springframework.context.annotation.Profile;
 import org.springframework.stereotype.Component;
 import ru.klavogonki.common.NonStandardDictionary;
@@ -24,8 +23,8 @@ public int minRacesCount() {
     }
 
     @Override
-    public Logger logger() {
-        return logger;
+    public String loggerName() {
+        return this.getClass().getSimpleName();
     }
 
     @Override

diff --git a/...java/ru/klavogonki/statistics/export/vocabulary/non_standard/MiniMarathonTopExporter.java b/...java/ru/klavogonki/statistics/export/vocabulary/non_standard/MiniMarathonTopExporter.java
@@ -1,7 +1,6 @@
 package ru.klavogonki.statistics.export.vocabulary.non_standard;
 
 import lombok.extern.log4j.Log4j2;
-import org.apache.logging.log4j.Logger;
 import org.springframework.context.annotation.Profile;
 import org.springframework.stereotype.Component;
 import ru.klavogonki.common.NonStandardDictionary;
@@ -24,8 +23,8 @@ public int minRacesCount() {
     }
 
     @Override
-    public Logger logger() {
-        return logger;
+    public String loggerName() {
+        return this.getClass().getSimpleName();
     }
 
     @Override

diff --git a/...a/ru/klavogonki/statistics/export/vocabulary/non_standard/NormalInEnglishTopExporter.java b/...a/ru/klavogonki/statistics/export/vocabulary/non_standard/NormalInEnglishTopExporter.java
@@ -1,7 +1,6 @@
 package ru.klavogonki.statistics.export.vocabulary.non_standard;
 
 import lombok.extern.log4j.Log4j2;
-import org.apache.logging.log4j.Logger;
 import org.springframework.context.annotation.Profile;
 import org.springframework.stereotype.Component;
 import ru.klavogonki.common.NonStandardDictionary;
@@ -24,8 +23,8 @@ public int minRacesCount() {
     }
 
     @Override
-    public Logger logger() {
-        return logger;
+    public String loggerName() {
+        return this.getClass().getSimpleName();
     }
 
     @Override

diff --git a/...ru/klavogonki/statistics/export/vocabulary/non_standard/OneHundredRussianTopExporter.java b/...ru/klavogonki/statistics/export/vocabulary/non_standard/OneHundredRussianTopExporter.java
@@ -1,7 +1,6 @@
 package ru.klavogonki.statistics.export.vocabulary.non_standard;
 
 import lombok.extern.log4j.Log4j2;
-import org.apache.logging.log4j.Logger;
 import org.springframework.context.annotation.Profile;
 import org.springframework.stereotype.Component;
 import ru.klavogonki.common.NonStandardDictionary;
@@ -24,7 +23,7 @@ public int minRacesCount() {
     }
 
     @Override
-    public Logger logger() {
-        return logger;
+    public String loggerName() {
+        return this.getClass().getSimpleName();
     }
 }
diff --git a/.../java/ru/klavogonki/statistics/export/vocabulary/non_standard/PinkiesPlusTopExporter.java b/.../java/ru/klavogonki/statistics/export/vocabulary/non_standard/PinkiesPlusTopExporter.java
@@ -1,7 +1,6 @@
 package ru.klavogonki.statistics.export.vocabulary.non_standard;
 
 import lombok.extern.log4j.Log4j2;
-import org.apache.logging.log4j.Logger;
 import org.springframework.context.annotation.Profile;
 import org.springframework.stereotype.Component;
 import ru.klavogonki.common.NonStandardDictionary;
@@ -24,7 +23,7 @@ public int minRacesCount() {
     }
 
     @Override
-    public Logger logger() {
-        return logger;
+    public String loggerName() {
+        return this.getClass().getSimpleName();
     }
 }
diff --git a/.../java/ru/klavogonki/statistics/export/vocabulary/non_standard/RingFingersTopExporter.java b/.../java/ru/klavogonki/statistics/export/vocabulary/non_standard/RingFingersTopExporter.java
@@ -1,7 +1,6 @@
 package ru.klavogonki.statistics.export.vocabulary.non_standard;
 
 import lombok.extern.log4j.Log4j2;
-import org.apache.logging.log4j.Logger;
 import org.springframework.context.annotation.Profile;
 import org.springframework.stereotype.Component;
 import ru.klavogonki.common.NonStandardDictionary;
@@ -24,7 +23,7 @@ public int minRacesCount() {
     }
 
     @Override
-    public Logger logger() {
-        return logger;
+    public String loggerName() {
+        return this.getClass().getSimpleName();
     }
 }
diff --git a/...n/java/ru/klavogonki/statistics/export/vocabulary/non_standard/ShortTextsTopExporter.java b/...n/java/ru/klavogonki/statistics/export/vocabulary/non_standard/ShortTextsTopExporter.java
@@ -1,7 +1,6 @@
 package ru.klavogonki.statistics.export.vocabulary.non_standard;
 
 import lombok.extern.log4j.Log4j2;
-import org.apache.logging.log4j.Logger;
 import org.springframework.context.annotation.Profile;
 import org.springframework.stereotype.Component;
 import ru.klavogonki.common.NonStandardDictionary;
@@ -24,8 +23,8 @@ public int minRacesCount() {
     }
 
     @Override
-    public Logger logger() {
-        return logger;
+    public String loggerName() {
+        return this.getClass().getSimpleName();
     }
 
     @Override

diff --git a/...klavogonki/statistics/export/vocabulary/non_standard/TrainingIndexFingersTopExporter.java b/...klavogonki/statistics/export/vocabulary/non_standard/TrainingIndexFingersTopExporter.java
@@ -1,7 +1,6 @@
 package ru.klavogonki.statistics.export.vocabulary.non_standard;
 
 import lombok.extern.log4j.Log4j2;
-import org.apache.logging.log4j.Logger;
 import org.springframework.context.annotation.Profile;
 import org.springframework.stereotype.Component;
 import ru.klavogonki.common.NonStandardDictionary;
@@ -24,8 +23,8 @@ public int minRacesCount() {
     }
 
     @Override
-    public Logger logger() {
-        return logger;
+    public String loggerName() {
+        return this.getClass().getSimpleName();
     }
 
     @Override

diff --git a/...rv/src/main/java/ru/klavogonki/statistics/export/vocabulary/standard/AbraTopExporter.java b/...rv/src/main/java/ru/klavogonki/statistics/export/vocabulary/standard/AbraTopExporter.java
@@ -1,7 +1,6 @@
 package ru.klavogonki.statistics.export.vocabulary.standard;
 
 import lombok.extern.log4j.Log4j2;
-import org.apache.logging.log4j.Logger;
 import org.springframework.context.annotation.Profile;
 import org.springframework.stereotype.Component;
 import ru.klavogonki.common.StandardDictionary;
@@ -23,7 +22,7 @@ public int minRacesCount() {
     }
 
     @Override
-    public Logger logger() {
-        return logger;
+    public String loggerName() {
+        return this.getClass().getSimpleName();
     }
 }
diff --git a/...v/src/main/java/ru/klavogonki/statistics/export/vocabulary/standard/CharsTopExporter.java b/...v/src/main/java/ru/klavogonki/statistics/export/vocabulary/standard/CharsTopExporter.java
@@ -1,7 +1,6 @@
 package ru.klavogonki.statistics.export.vocabulary.standard;
 
 import lombok.extern.log4j.Log4j2;
-import org.apache.logging.log4j.Logger;
 import org.springframework.context.annotation.Profile;
 import org.springframework.stereotype.Component;
 import ru.klavogonki.common.StandardDictionary;
@@ -23,7 +22,7 @@ public int minRacesCount() {
     }
 
     @Override
-    public Logger logger() {
-        return logger;
+    public String loggerName() {
+        return this.getClass().getSimpleName();
     }
 }
diff --git a/.../src/main/java/ru/klavogonki/statistics/export/vocabulary/standard/DigitsTopExporter.java b/.../src/main/java/ru/klavogonki/statistics/export/vocabulary/standard/DigitsTopExporter.java
@@ -1,7 +1,6 @@
 package ru.klavogonki.statistics.export.vocabulary.standard;
 
 import lombok.extern.log4j.Log4j2;
-import org.apache.logging.log4j.Logger;
 import org.springframework.context.annotation.Profile;
 import org.springframework.stereotype.Component;
 import ru.klavogonki.common.StandardDictionary;
@@ -23,7 +22,7 @@ public int minRacesCount() {
     }
 
     @Override
-    public Logger logger() {
-        return logger;
+    public String loggerName() {
+        return this.getClass().getSimpleName();
     }
 }
diff --git a/...rc/main/java/ru/klavogonki/statistics/export/vocabulary/standard/MarathonTopExporter.java b/...rc/main/java/ru/klavogonki/statistics/export/vocabulary/standard/MarathonTopExporter.java
@@ -1,7 +1,6 @@
 package ru.klavogonki.statistics.export.vocabulary.standard;
 
 import lombok.extern.log4j.Log4j2;
-import org.apache.logging.log4j.Logger;
 import org.springframework.context.annotation.Profile;
 import org.springframework.stereotype.Component;
 import ru.klavogonki.common.StandardDictionary;
@@ -23,7 +22,7 @@ public int minRacesCount() {
     }
 
     @Override
-    public Logger logger() {
-        return logger;
+    public String loggerName() {
+        return this.getClass().getSimpleName();
     }
 }
diff --git a/...src/main/java/ru/klavogonki/statistics/export/vocabulary/standard/NoErrorTopExporter.java b/...src/main/java/ru/klavogonki/statistics/export/vocabulary/standard/NoErrorTopExporter.java
@@ -1,7 +1,6 @@
 package ru.klavogonki.statistics.export.vocabulary.standard;
 
 import lombok.extern.log4j.Log4j2;
-import org.apache.logging.log4j.Logger;
 import org.springframework.context.annotation.Profile;
 import org.springframework.stereotype.Component;
 import ru.klavogonki.common.StandardDictionary;
@@ -23,7 +22,7 @@ public int minRacesCount() {
     }
 
     @Override
-    public Logger logger() {
-        return logger;
+    public String loggerName() {
+        return this.getClass().getSimpleName();
     }
 }
diff --git a/...ki/statistics/export/vocabulary/standard/NonStandardVocabularyTopExporterDefaultImpl.java b/...ki/statistics/export/vocabulary/standard/NonStandardVocabularyTopExporterDefaultImpl.java
@@ -1,10 +1,12 @@
 package ru.klavogonki.statistics.export.vocabulary.standard;
 
+import lombok.extern.log4j.Log4j2;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.annotation.Profile;
 import org.springframework.stereotype.Component;
 import ru.klavogonki.statistics.entity.PlayerEntity;
 import ru.klavogonki.statistics.entity.PlayerVocabularyStatsEntity;
+import ru.klavogonki.statistics.export.LoggerWrapper;
 import ru.klavogonki.statistics.export.vocabulary.non_standard.NonStandardVocabularyTopExporter;
 import ru.klavogonki.statistics.repository.PlayerVocabularyStatsRepository;
 import ru.klavogonki.statistics.springboot.Profiles;
@@ -14,11 +16,27 @@
 // todo: same implementation as StandardVocabularyTopExporterDefaultImpl
 @Component
 @Profile(Profiles.DATABASE)
+@Log4j2
 public abstract class NonStandardVocabularyTopExporterDefaultImpl implements NonStandardVocabularyTopExporter {
 
+    private LoggerWrapper loggerWrapper;
+
     @Autowired
     protected PlayerVocabularyStatsRepository repository;
 
+    @Override
+    public LoggerWrapper logger() {
+        return getLoggerWrapper();
+    }
+
+    private LoggerWrapper getLoggerWrapper() {
+        if (loggerWrapper == null) {
+            loggerWrapper = new LoggerWrapper(logger, loggerName());
+        }
+
+        return loggerWrapper;
+    }
+
     @Override
     public List<PlayerVocabularyStatsEntity> getPlayersByBestSpeed() {
         List<PlayerVocabularyStatsEntity> players = repository.findByVocabularyCodeEqualsAndRacesCountGreaterThanEqualAndPlayerBlockedEqualsOrderByBestSpeedDesc(vocabularyCode(), minRacesCount(), PlayerEntity.NOT_BLOCKED);

diff --git a/.../src/main/java/ru/klavogonki/statistics/export/vocabulary/standard/NormalTopExporter.java b/.../src/main/java/ru/klavogonki/statistics/export/vocabulary/standard/NormalTopExporter.java
@@ -1,7 +1,6 @@
 package ru.klavogonki.statistics.export.vocabulary.standard;
 
 import lombok.extern.log4j.Log4j2;
-import org.apache.logging.log4j.Logger;
 import org.springframework.context.annotation.Profile;
 import org.springframework.stereotype.Component;
 import ru.klavogonki.common.StandardDictionary;
@@ -23,7 +22,7 @@ public int minRacesCount() {
     }
 
     @Override
-    public Logger logger() {
-        return logger;
+    public String loggerName() {
+        return this.getClass().getSimpleName();
     }
 }