Skip to content

Commit 976e2c1

Browse files
finnetrollekdavisk6
authored andcommitted
OpenFeignGH-985: Correct unexpected behavior when using JavaLogger (OpenFeign#1047)
Fixes OpenFeign#985 * JavaLogger(String name) added. Workaround for JavaLogger() provided * JavaLogger() marked as deprecated. Workaround for JavaLogger() removed * Little fix for note in README * One more little fix for note in README * JavaLogger(Class<?>) constructor added
1 parent 964ae79 commit 976e2c1

3 files changed

Lines changed: 98 additions & 3 deletions

File tree

‎README.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -738,13 +738,16 @@ public class Example {
738738
public static void main(String[] args) {
739739
GitHub github = Feign.builder()
740740
.decoder(new GsonDecoder())
741-
.logger(new Logger.JavaLogger().appendToFile("logs/http.log"))
741+
.logger(new Logger.JavaLogger("GitHub.Logger").appendToFile("logs/http.log"))
742742
.logLevel(Logger.Level.FULL)
743743
.target(GitHub.class, "https://api.github.com");
744744
}
745745
}
746746
```
747747
748+
> **A Note on JavaLogger**:
749+
> Avoid using of default ```JavaLogger()``` constructor - it was marked as deprecated and will be removed soon.
750+
748751
The SLF4JLogger (see above) may also be of interest.
749752
750753

‎core/src/main/java/feign/Logger.java‎

Lines changed: 39 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
import java.io.IOException;
1717
import java.io.PrintWriter;
1818
import java.io.StringWriter;
19+
import java.util.concurrent.atomic.AtomicInteger;
1920
import java.util.logging.FileHandler;
2021
import java.util.logging.LogRecord;
2122
import java.util.logging.SimpleFormatter;
@@ -164,8 +165,44 @@ protected void log(String configKey, String format, Object... args) {
164165
*/
165166
public static class JavaLogger extends Logger {
166167

167-
final java.util.logging.Logger logger =
168-
java.util.logging.Logger.getLogger(Logger.class.getName());
168+
final java.util.logging.Logger logger;
169+
170+
/**
171+
* @deprecated Use {@link #JavaLogger(String)} or {@link #JavaLogger(Class)} instead.
172+
*
173+
* This constructor can be used to create just one logger. Example =
174+
* {@code Logger.JavaLogger().appendToFile("logs/first.log")}
175+
*
176+
* If you create multiple loggers for multiple clients and provide different files
177+
* to write log - you'll have unexpected behavior - all clients will write same log
178+
* to each file.
179+
*
180+
* That's why this constructor will be removed in future.
181+
*/
182+
@Deprecated
183+
public JavaLogger() {
184+
logger = java.util.logging.Logger.getLogger(Logger.class.getName());
185+
}
186+
187+
/**
188+
* Constructor for JavaLogger class
189+
*
190+
* @param loggerName a name for the logger. This should be a dot-separated name and should
191+
* normally be based on the package name or class name of the subsystem, such as java.net
192+
* or javax.swing
193+
*/
194+
public JavaLogger(String loggerName) {
195+
logger = java.util.logging.Logger.getLogger(loggerName);
196+
}
197+
198+
/**
199+
* Constructor for JavaLogger class
200+
*
201+
* @param clazz the returned logger will be named after clazz
202+
*/
203+
public JavaLogger(Class<?> clazz) {
204+
logger = java.util.logging.Logger.getLogger(clazz.getName());
205+
}
169206

170207
@Override
171208
protected void logRequest(String configKey, Level logLevel, Request request) {
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
/**
2+
* Copyright 2012-2019 The Feign Authors
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
5+
* in compliance with the License. You may obtain a copy of the License at
6+
*
7+
* http://www.apache.org/licenses/LICENSE-2.0
8+
*
9+
* Unless required by applicable law or agreed to in writing, software distributed under the License
10+
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
11+
* or implied. See the License for the specific language governing permissions and limitations under
12+
* the License.
13+
*/
14+
package feign;
15+
16+
import org.junit.Test;
17+
import java.lang.reflect.Field;
18+
19+
public class MultipleLoggerTest {
20+
21+
private static java.util.logging.Logger getInnerLogger(Logger.JavaLogger logger)
22+
throws Exception {
23+
Field inner = logger.getClass().getDeclaredField("logger");
24+
inner.setAccessible(true);
25+
return (java.util.logging.Logger) inner.get(logger);
26+
}
27+
28+
@Test
29+
public void testAppendSeveralFilesToOneJavaLogger() throws Exception {
30+
Logger.JavaLogger logger = new Logger.JavaLogger().appendToFile("1.log").appendToFile("2.log");
31+
java.util.logging.Logger inner = getInnerLogger(logger);
32+
assert (inner.getHandlers().length == 2);
33+
}
34+
35+
@Test
36+
public void testJavaLoggerInstantationWithLoggerName() throws Exception {
37+
Logger.JavaLogger l1 = new Logger.JavaLogger("First client").appendToFile("1.log");
38+
Logger.JavaLogger l2 = new Logger.JavaLogger("Second client").appendToFile("2.log");
39+
java.util.logging.Logger logger1 = getInnerLogger(l1);
40+
assert (logger1.getHandlers().length == 1);
41+
java.util.logging.Logger logger2 = getInnerLogger(l2);
42+
assert (logger2.getHandlers().length == 1);
43+
}
44+
45+
@Test
46+
public void testJavaLoggerInstantationWithClazz() throws Exception {
47+
Logger.JavaLogger l1 = new Logger.JavaLogger(String.class).appendToFile("1.log");
48+
Logger.JavaLogger l2 = new Logger.JavaLogger(Integer.class).appendToFile("2.log");
49+
java.util.logging.Logger logger1 = getInnerLogger(l1);
50+
assert (logger1.getHandlers().length == 1);
51+
java.util.logging.Logger logger2 = getInnerLogger(l2);
52+
assert (logger2.getHandlers().length == 1);
53+
}
54+
55+
}

0 commit comments

Comments
 (0)