Eclipse中输出带颜色的log4j日志信息

不念不忘少年蓝@ 2022-06-02 05:43 253阅读 0赞

转自：http://www.javatang.com/archives/2015/03/16/17361179.html

使用Eclipse开发程序的时候，有时候希望将不同级别的日志在控制台显示成不同的颜色，这样查看起来非常的方便。如果希望控制台显示不同的颜色，需要使用[ANSI escape code][]，比如如果将文本内容(text)使用红色输出，使用如下格式：

1.   "\\u001b\[" +     // 前缀
2.   "0" +         // 高亮
3.   ";" +          // 分隔符
4.   "31" +      // 颜色代码（红色）
5.   "m" +          // 后缀
6.   text +      // 文本内容
7.   "\\u001b\[m"     // 结束符

不过需要说明的是，windows自2000之后控制台不支持ANSI escape code，并且默认的Eclipse控制台也不支持，需要先安装一个名为[ANSI Escape in Console][]的插件，可以直接在Eclipse Marketplace中搜索安装，如果因为网络的问题出现错误可以多尝试几遍。安装完成之后会在Console窗口出现一个![ANSIEscapeinConsole-icon][]小图标，用来控制是否启用ANSI escape code模式。  
![ANSI Escape in Console][ANSI Escape in Console 1]

根据上面的规则，可以使用三种方法实现输出带颜色的日志信息：

1. 自定义ConsoleAppender  
Dan Dyer实现了一个[ANSIConsoleAppender][]，代码如下：

1.   import org.apache.log4j.ConsoleAppender;
2.   import org.apache.log4j.Level;
3.   import org.apache.log4j.Priority;
4.   import org.apache.log4j.spi.LoggingEvent;   
5.   
6.   /\*\*
7.    \* Colour-coded console appender for Log4J.
8.    \*/
9.   public class ANSIConsoleAppender extends ConsoleAppender
10.  \{ 
11.      private static final int NORMAL = 0;
12.      private static final int BRIGHT = 1;
13.      private static final int FOREGROUND\_BLACK = 30;
14.      private static final int FOREGROUND\_RED = 31;
15.      private static final int FOREGROUND\_GREEN = 32;
16.      private static final int FOREGROUND\_YELLOW = 33;
17.      private static final int FOREGROUND\_BLUE = 34;
18.      private static final int FOREGROUND\_MAGENTA = 35;
19.      private static final int FOREGROUND\_CYAN = 36;
20.      private static final int FOREGROUND\_WHITE = 37;   
21.  
22.      private static final String PREFIX = "\\u001b\[";
23.      private static final String SUFFIX = "m";
24.      private static final char SEPARATOR = ';';
25.      private static final String END\_COLOUR = PREFIX + SUFFIX;   
26.  
27.      private static final String FATAL\_COLOUR = PREFIX
28.        + BRIGHT + SEPARATOR + FOREGROUND\_RED + SUFFIX;
29.      private static final String ERROR\_COLOUR = PREFIX
30.        + NORMAL + SEPARATOR + FOREGROUND\_RED + SUFFIX;
31.      private static final String WARN\_COLOUR = PREFIX
32.        + NORMAL + SEPARATOR + FOREGROUND\_YELLOW + SUFFIX;
33.      private static final String INFO\_COLOUR = PREFIX
34.        + NORMAL\+ SEPARATOR + FOREGROUND\_GREEN + SUFFIX;
35.      private static final String DEBUG\_COLOUR = PREFIX
36.        + NORMAL + SEPARATOR + FOREGROUND\_CYAN + SUFFIX;
37.      private static final String TRACE\_COLOUR = PREFIX
38.        + NORMAL + SEPARATOR + FOREGROUND\_BLUE + SUFFIX;   
39.  
40.      /\*\*
41.       \* Wraps the ANSI control characters around the
42.       \* output from the super-class Appender.
43.       \*/
44.      protected void subAppend(LoggingEvent event)
45.      \{ 
46.          this.qw.write(getColour(event.getLevel()));
47.          super.subAppend(event);
48.          this.qw.write(END\_COLOUR);   
49.  
50.          if(this.immediateFlush)
51.          \{ 
52.              this.qw.flush();
53.          \}
54.      \}   
55.  
56.      /\*\*
57.       \* Get the appropriate control characters to change
58.       \* the colour for the specified logging level.
59.       \*/
60.      private String getColour(Level level)
61.      \{ 
62.          switch (level.toInt())
63.          \{ 
64.              case Priority.FATAL\_INT: return FATAL\_COLOUR;
65.              case Priority.ERROR\_INT: return ERROR\_COLOUR;
66.              case Priority.WARN\_INT: return WARN\_COLOUR;
67.              case Priority.INFO\_INT: return INFO\_COLOUR;
68.              case Priority.DEBUG\_INT:return DEBUG\_COLOUR;
69.              default: return TRACE\_COLOUR;
70.          \}
71.      \}
72.  \}

可以根据自己的要求调整显示的颜色，这个时候需要在log4j的配置文件将Console设置成上面的ANSIConsoleAppender：  
log4j.rootLogger=INFO, Console  
log4j.appender.Console=ANSIConsoleAppender

2. 自定义PatternLayout  
Ingo Thon实现了一个[ColoredPatternLayout][]（源代码 [ColoredPatternLayout.java][]），内容如下：

1.  /\*
2.   \* Copyright  2002,2004 The Apache Software Foundation
3.   \*
4.   \*  Licensed under the Apache License, Version 2.0 (the "License");
5.   \*  you may not use this file except in compliance with the License.
6.   \*  You may obtain a copy of the License at
7.   \*
8.   \*      http://www.apache.org/licenses/LICENSE-2.0
9.   \*
10.   \*  Unless required by applicable law or agreed to in writing, software
11.   \*  distributed under the License is distributed on an "AS IS" BASIS,
12.   \*  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13.   \*  See the License for the specific language governing permissions and
14.   \*  limitations under the License.
15.   \*
16.   \*/
17.  package util.log4j;
18.  
19.  import org.apache.log4j.PatternLayout;
20.  import org.apache.log4j.spi.LoggingEvent;
21.  import org.apache.log4j.Level;
22.  
23.  import java.util.StringTokenizer;
24.  
25.  /\*\*
26.   \* A layout wich has the same functions as the
27.   \*     Patternlayout.
28.   \* But it also allows to let the output be colored
29.   \* The ColorStrings are formated as follows 
30.   \*     "foreground/background/attribute" where
31.   \*      <ul>
32.   \*        <li> foreground and backround is one of
33.   \*         <ul>
34.   \*          <li>black</li>
35.   \*          <li>red</li>
36.   \*          <li>green</li>
37.   \*          <li>yellow</li>
38.   \*          <li>blue</li>
39.   \*          <li>magenta</li>
40.   \*          <li>cyan</li>
41.   \*          <li>white</li>
42.   \*         </ul>
43.   \*        </li>
44.   \*        <li> attribute is one of
45.   \*         <ul>
46.   \*          <li>normal</li><li>bright</li><li>dim</li>
47.   \*          <li>underline</li><li>blink</li><li>reverse</li>
48.   \*          <li>hidden</li>
49.   \*         </ul>
50.   \*        </li>
51.   \*      </li>
52.   \*     </ul>
53.   \* 
54.   \* 
55.   \*   the following colors could be set
56.   \*   <ul>
57.   \*     <li>FatalErrorColor</li>
58.   \*     <li>ErrorColor</li>
59.   \*     <li>WarnColor</li>
60.   \*     <li>InfoColor</li>
61.   \*     <li>DebugColor</li>
62.   \*   </ul>
63.   \* 
64.   \* 
65.   \* major parts of this class came from the apache ant AnsiColorLogger
66.   \* @author Ingo Thon isthon a-t gmx d0t de
67.   \* @version 0.1 (alpha)
68.   \*/
69.  public class ColoredPatternLayout extends PatternLayout\{ 
70.      private static final String CONFIGURATION\_SEPARATOR="/";
71.  
72.      private static final String PREFIX = "\\u001b\[";
73.      private static final String SUFFIX = "m";
74.      private static final char SEPARATOR = ';';
75.      private static final String END\_COLOR = PREFIX + SUFFIX;
76.  
77.      private static final String ATTR\_NORMAL = "0";
78.      private static final String ATTR\_BRIGHT = "1";
79.      private static final String ATTR\_DIM = "2";
80.      private static final String ATTR\_UNDERLINE = "3";
81.      private static final String ATTR\_BLINK = "5";
82.      private static final String ATTR\_REVERSE = "7";
83.      private static final String ATTR\_HIDDEN = "8";
84.  
85.      private static final String FG\_BLACK = "30";
86.      private static final String FG\_RED = "31";
87.      private static final String FG\_GREEN = "32";
88.      private static final String FG\_YELLOW = "33";
89.      private static final String FG\_BLUE = "34";
90.      private static final String FG\_MAGENTA = "35";
91.      private static final String FG\_CYAN = "36";
92.      private static final String FG\_WHITE = "37";
93.  
94.      private static final String BG\_BLACK = "40";
95.      private static final String BG\_RED = "41";
96.      private static final String BG\_GREEN = "42";
97.      private static final String BG\_YELLOW = "44";
98.      private static final String BG\_BLUE = "44";
99.      private static final String BG\_MAGENTA = "45";
100.      private static final String BG\_CYAN = "46";
101.      private static final String BG\_WHITE = "47";
102.  
103.      private String fatalErrorColor
104.      = PREFIX + ATTR\_DIM + SEPARATOR + FG\_RED + SUFFIX;
105.      private String errorColor
106.      = PREFIX + ATTR\_DIM + SEPARATOR + FG\_RED + SUFFIX;
107.      private String warnColor
108.      = PREFIX + ATTR\_DIM + SEPARATOR + FG\_MAGENTA + SUFFIX;
109.      private String infoColor
110.      = PREFIX + ATTR\_DIM + SEPARATOR + FG\_GREEN + SUFFIX;
111.      private String debugColor
112.      = PREFIX + ATTR\_DIM + SEPARATOR + FG\_WHITE + SUFFIX;
113.     
114.      public ColoredPatternLayout()\{ 
115.      super();
116.      \}
117.      public ColoredPatternLayout(String pattern)\{ 
118.      super(pattern);
119.      \}
120.  
121.      public String format(LoggingEvent event)\{ 
122.      if( event.getLevel() == Level.FATAL)\{ 
123.          return fatalErrorColor\+super.format(event)\+END\_COLOR;
124.      \}else if( event.getLevel() == Level.ERROR)\{ 
125.          return errorColor\+super.format(event)\+END\_COLOR;
126.      \}if( event.getLevel() == Level.WARN)\{ 
127.          return warnColor\+super.format(event)\+END\_COLOR;
128.      \}if( event.getLevel() == Level.INFO)\{ 
129.          return infoColor\+super.format(event)\+END\_COLOR;
130.      \}if( event.getLevel() == Level.DEBUG)\{ 
131.          return debugColor\+super.format(event)\+END\_COLOR;
132.      \}else\{ 
133.          throw new RuntimeException("Unsupported Level "\+event.toString());
134.      \}
135.      \}
136.      private String makeFgString(String fgColorName)\{ 
137.      //System.out.println("fg "+fgColorName);
138.      if(fgColorName.toLowerCase().equals("black"))\{ 
139.          return FG\_BLACK;
140.      \}else if(fgColorName.toLowerCase().equals("red"))\{ 
141.          return FG\_RED;
142.      \}else if(fgColorName.toLowerCase().equals("green"))\{ 
143.          return FG\_GREEN;
144.      \}else if(fgColorName.toLowerCase().equals("yellow"))\{ 
145.          return FG\_YELLOW;
146.      \}else if(fgColorName.toLowerCase().equals("blue"))\{ 
147.          return FG\_BLUE;
148.      \}else if(fgColorName.toLowerCase().equals("magenta"))\{ 
149.          return FG\_MAGENTA;
150.      \}else if(fgColorName.toLowerCase().equals("cyan"))\{ 
151.          return FG\_CYAN;
152.      \}else if(fgColorName.toLowerCase().equals("white"))\{ 
153.          return FG\_WHITE;
154.      \}
155.      System.out.println("log4j: ColoredPatternLayout Unsupported FgColor "\+fgColorName);
156.      return "\-1";
157.      \}
158.      private String makeBgString(String bgColorName)\{ 
159.      //System.out.println("bg "+bgColorName);
160.      if(bgColorName.toLowerCase().equals("black"))\{ 
161.          return BG\_BLACK;
162.      \}else if(bgColorName.toLowerCase().equals("red"))\{ 
163.          return BG\_RED;
164.      \}else if(bgColorName.toLowerCase().equals("green"))\{ 
165.          return BG\_GREEN;
166.      \}else if(bgColorName.toLowerCase().equals("yellow"))\{ 
167.          return BG\_YELLOW;
168.      \}else if(bgColorName.toLowerCase().equals("blue"))\{ 
169.          return BG\_BLUE;
170.      \}else if(bgColorName.toLowerCase().equals("magenta"))\{ 
171.          return BG\_MAGENTA;
172.      \}else if(bgColorName.toLowerCase().equals("cyan"))\{ 
173.          return BG\_CYAN;
174.      \}else if(bgColorName.toLowerCase().equals("white"))\{ 
175.          return BG\_WHITE;
176.      \}
177.      System.out.println("log4j: ColoredPatternLayout Unsupported BgColor "\+bgColorName);
178.      return "\-1";
179.      \}
180.  
181.  
182.      private String makeAttributeString(String attributeName)\{ 
183.      //System.out.println("attribute "+attributeName);
184.      if(attributeName.toLowerCase().equals("normal"))\{ 
185.          return ATTR\_NORMAL;
186.      \}else if(attributeName.toLowerCase().equals("bright"))\{ 
187.          return ATTR\_BRIGHT;
188.      \}else if(attributeName.toLowerCase().equals("dim"))\{ 
189.          return ATTR\_DIM;
190.      \}else if(attributeName.toLowerCase().equals("underline"))\{ 
191.          return ATTR\_UNDERLINE;
192.      \}else if(attributeName.toLowerCase().equals("blink"))\{ 
193.          return ATTR\_BLINK;
194.      \}else if(attributeName.toLowerCase().equals("reverse"))\{ 
195.          return ATTR\_REVERSE;
196.      \}else if(attributeName.toLowerCase().equals("hidden"))\{ 
197.          return ATTR\_HIDDEN;
198.      \}
199.      System.out.println("log4j: ColoredPatternLayout Unsupported Attribute "\+attributeName);
200.  
201.      return "\-1";
202.      \}
203.  
204.      private String makeColorString(String colorName)\{ 
205.      //System.out.println(colorName);
206.      StringTokenizer tokenizer=new StringTokenizer(colorName,
207.                                CONFIGURATION\_SEPARATOR);
208.      String fgColor=FG\_WHITE;
209.      String bgColor=BG\_BLACK;
210.      String attr=ATTR\_NORMAL;
211.      if(!tokenizer.hasMoreTokens())\{ 
212.          return PREFIX + ATTR\_NORMAL + SEPARATOR + FG\_WHITE + SUFFIX;
213.      \}
214.      if(tokenizer.hasMoreTokens())\{ 
215.          fgColor=makeFgString(tokenizer.nextToken());
216.      \}
217.      if(tokenizer.hasMoreTokens())\{ 
218.          bgColor=makeBgString(tokenizer.nextToken());
219.      \}
220.      if(tokenizer.hasMoreTokens())\{ 
221.          attr=makeAttributeString(tokenizer.nextToken());
222.      \}
223.      //return PREFIX + ATTR\_DIM + SEPARATOR + FG\_WHITE + SUFFIX;
224.      return PREFIX + attr
225.          + SEPARATOR + fgColor
226.          + SEPARATOR + bgColor
227.          +SUFFIX;
228.      \}
229.      //\--> from here configuration \{ 
230.      /\*\* returns the configured color for error msgs
231.       \* should normally return only the string for the color
232.       \*/
233.      public String getFatalErrorColor()\{ 
234.      return fatalErrorColor;
235.      \}
236.      public void setFatalErrorColor(String colorName)\{ 
237.      fatalErrorColor=makeColorString(colorName);
238.      \}
239.      /\*\* returns the configured color for error msgs
240.       \* should normally return only the string for the color
241.       \*/
242.      public String getErrorColor()\{ 
243.      return errorColor;
244.      \}
245.      public void setErrorColor(String colorName)\{ 
246.      //System.out.println(colorName);
247.      errorColor=makeColorString(colorName);
248.      \}
249.      /\*\* returns the configured color for error msgs
250.       \* should normally return only the string for the color
251.       \*/
252.      public String getWarnColor()\{ 
253.      return warnColor;
254.      \}
255.      public void setWarnColor(String colorName)\{ 
256.      warnColor=makeColorString(colorName);
257.      \}
258.      /\*\* returns the configured color for error msgs
259.       \* should normally return only the string for the color
260.       \*/
261.      public String getInfoColor()\{ 
262.      return infoColor;
263.      \}
264.      public void setInfoColor(String colorName)\{ 
265.      infoColor=makeColorString(colorName);
266.      \}
267.      /\*\* returns the configured color for error msgs
268.       \* should normally return only the string for the color
269.       \*/
270.      public String getDebugColor()\{ 
271.      return debugColor;
272.      \}
273.      public void setDebugColor(String colorName)\{ 
274.      //System.out.println(makeColorString(colorName));
275.      debugColor=makeColorString(colorName);
276.      \}
277.  
278.      //<-- configuration \}
279.  
280.  
281.  \}

需要在log4j配置文件中设置自定义的layout，并且可以设置各种日志级别的颜色：  
log4j.rootLogger=INFO, Console  
log4j.appender.Console=org.apache.log4j.ConsoleAppender  
log4j.appender.Console.layout=util.log4j.ColoredPatternLayout  
log4j.appender.Console.layout.ErrorColor=red  
log4j.appender.Console.layout.DebugColor=blue/green/bright

3. 使用[jcabi-log][]的MulticolorLayout  
jcabi-log是一个非常不错的日志工具包，基于slf4j，同时也提供了一个用于log4j的layout：[MulticolorLayout][]。首先在maven中引用jcabi-log:

1.  <dependency>
2.    <groupId>com.jcabi</groupId>
3.    <artifactId>jcabi-log</artifactId>
4.    <version>0.16</version>
5.  </dependency>

然后在log4j配置文件中启用MulticolorLayout：  
log4j.rootLogger=INFO, Console  
log4j.appender.Console=org.apache.log4j.ConsoleAppender  
log4j.appender.Console.layout=com.jcabi.log.MulticolorLayout  
log4j.appender.Console.layout.ConversionPattern=\[%color\{%-5p\}\] %c: %m%n

综合来看我觉得方案2最轻量并且可自定义，但如果不是采用log4j的话可以使用jcabi-log包。需要注意的是，如果目标控制器不支持ANSI escape或者生产环境中需要将日志写入到文件中的话不建议使用，否则会增加一些不可识别的字符。

参考资料：  
[Making a log4j console appender use different colors for different threads][]  
[Colored Pattern Layout][ColoredPatternLayout]  
[Colour-coded Console Logging with Log4J][ANSIConsoleAppender]  
[ANSI Escape in Console (eclipse marketplace)][ANSI Escape in Console]  
[ANSI的Escape序列屏幕控制码][ANSI_Escape]

[ANSI escape code]: http://en.wikipedia.org/wiki/ANSI_escape_code
[ANSI Escape in Console]: http://marketplace.eclipse.org/content/ansi-escape-console
[ANSIEscapeinConsole-icon]: /images/20220602/27880faeef734b53961ecc7860b09bc2.png
[ANSI Escape in Console 1]: /images/20220602/730fa7c83d0a4f08bee4274441151b26.png
[ANSIConsoleAppender]: http://blog.uncommons.org/2006/04/09/colour-coded-console-logging-with-log4j/
[ColoredPatternLayout]: http://www.cafebabe.info/log4j/ColoredPatternLayout.html
[ColoredPatternLayout.java]: http://www.cafebabe.info/log4j/ColoredPatternLayout.java
[jcabi-log]: http://log.jcabi.com/
[MulticolorLayout]: http://log.jcabi.com/multicolor.html
[Making a log4j console appender use different colors for different threads]: http://stackoverflow.com/questions/7848325/making-a-log4j-console-appender-use-different-colors-for-different-threads
[ANSI_Escape]: http://blog.chinaunix.net/uid-627277-id-2706168.html