>  기사  >  Java  >  Log4j의 Java 코드 예는 정기적으로 로그를 인쇄하고 모듈 이름 구성을 추가합니다.

Log4j의 Java 코드 예는 정기적으로 로그를 인쇄하고 모듈 이름 구성을 추가합니다.

高洛峰
高洛峰원래의
2017-01-18 12:54:211283검색

간격 구성 및 정기적으로 로그 인쇄
log4j를 통해 로그를 정기적으로 인쇄해 달라는 요청을 받았습니다. 요청은 다음과 같습니다. 로그는 정기적으로 인쇄되어야 하며 시간 간격은 구성 가능합니다. 타이밍에 대해 말하면 가장 먼저 떠오르는 것은 DailyRollingFileAppender 클래스입니다. datePattern에 따르면 이는 SimpleDateFormat 클래스를 참조할 수 있습니다.

'.'yyyy- MM: 월별

'.'yyyy-ww: 매주

'.'yyyy-MM-dd: 매일

'.'yyyy-MM-dd-a: 하루에 두번

'.'yyyy-MM-dd-HH : 매시간

'.'yyyy-MM-dd-HH-mm : 매분

까지 관찰 결과 유사한 n분 날짜 형식이 없는 것으로 확인되었으므로 DailyRollingFileAppender 클래스를 기반으로 사용자 정의 클래스를 작성하십시오. 프로세스는 다음과 같습니다.

1) DailyRollingFileAppender 클래스 소스 코드를 복사하고 MinuteRollingAppender로 이름을 변경합니다. log4j.xml에서 구성 항목을 추가하고 set 및 get 메소드를 추가합니다.

private int intervalTime = 10;

2) DailyRollingFileAppender 클래스는 RollingCalendar 클래스를 사용하여 다음 간격 시간을 계산하고, 매개변수인 IntervalTime을 전달해야 하므로 RollingCalendar 클래스는 메서드가 다음과 같으므로 내부 클래스로 수정됩니다. datePattern을 기준으로 다음 롤오버 작업의 시간을 계산할 필요가 없습니다. 다른 시간 모드가 필요한 경우 수정 방법은 다음과 같습니다.

public Date getNextCheckDate(Date now)
{
 this.setTime(now);
 this.set(Calendar.SECOND, 0);
 this.set(Calendar.MILLISECOND, 0);
 this.add(Calendar.MINUTE, intervalTime);
 return getTime();
}

3) 시간이 분 단위로 구성할 수 있으므로 시간 모드를 비활성화하고 이를 정적 최종으로 변경한 다음 그에 따라 get을 제거해야 합니다. , set 메서드의 datePattern 매개 변수 및 MinuteRollingAppender 생성자

private static String DATEPATTERN = "'.'yyyy-MM-dd-HH-mm'.log'";

마찬가지로 여러 datePattern을 제공하는 ComputeCheckPeriod() 메서드도 삭제할 수 있습니다. 이 시점에서 변환이 완료되고 완성된 클래스는 다음과 같습니다.

package net.csdn.blog;
  
import java.io.File;
import java.io.IOException;
import java.io.InterruptedIOException;
import java.text.SimpleDateFormat;
import java.util.Calendar;
import java.util.Date;
import java.util.GregorianCalendar;
  
import org.apache.log4j.FileAppender;
import org.apache.log4j.Layout;
import org.apache.log4j.helpers.LogLog;
import org.apache.log4j.spi.LoggingEvent;
  
/**
 * 按分钟可配置定时appender
 *
 * @author coder_xia
 *
 */
public class MinuteRollingAppender extends FileAppender
{
 /**
  * The date pattern. By default, the pattern is set to "'.'yyyy-MM-dd"
  * meaning daily rollover.
  */
 private static String DATEPATTERN = "'.'yyyy-MM-dd-HH-mm'.log'";
 /**
  * 间隔时间,单位:分钟
  */
 private int intervalTime = 10;
  
 /**
  * The log file will be renamed to the value of the scheduledFilename
  * variable when the next interval is entered. For example, if the rollover
  * period is one hour, the log file will be renamed to the value of
  * "scheduledFilename" at the beginning of the next hour.
  *
  * The precise time when a rollover occurs depends on logging activity.
  */
 private String scheduledFilename;
  
 /**
  * The next time we estimate a rollover should occur.
  */
 private long nextCheck = System.currentTimeMillis() - 1;
  
 Date now = new Date();
  
 SimpleDateFormat sdf;
  
 RollingCalendar rc = new RollingCalendar();
  
 /**
  * The default constructor does nothing.
  */
 public MinuteRollingAppender()
 {
 }
  
 /**
  * Instantiate a MinuteRollingAppender and open the file
  * designated by filename. The opened filename will become the
  * ouput destination for this appender.
  */
 public MinuteRollingAppender(Layout layout, String filename)
   throws IOException
 {
  super(layout, filename, true);
  activateOptions();
 }
  
 /**
  * @return the intervalTime
  */
 public int getIntervalTime()
 {
  return intervalTime;
 }
  
 /**
  * @param intervalTime
  *   the intervalTime to set
  */
 public void setIntervalTime(int intervalTime)
 {
  this.intervalTime = intervalTime;
 }
  
 @Override
 public void activateOptions()
 {
  super.activateOptions();
  if (fileName != null)
  {
   now.setTime(System.currentTimeMillis());
   sdf = new SimpleDateFormat(DATEPATTERN);
   File file = new File(fileName);
   scheduledFilename = fileName
     + sdf.format(new Date(file.lastModified()));
  
  }
  else
  {
   LogLog
     .error("Either File or DatePattern options are not set for appender ["
       + name + "].");
  }
 }
  
 /**
  * Rollover the current file to a new file.
  */
 void rollOver() throws IOException
 {
  String datedFilename = fileName + sdf.format(now);
  // It is too early to roll over because we are still within the
  // bounds of the current interval. Rollover will occur once the
  // next interval is reached.
  if (scheduledFilename.equals(datedFilename))
  {
   return;
  }
  
  // close current file, and rename it to datedFilename
  this.closeFile();
  
  File target = new File(scheduledFilename);
  if (target.exists())
  {
   target.delete();
  }
  
  File file = new File(fileName);
  boolean result = file.renameTo(target);
  if (result)
  {
   LogLog.debug(fileName + " -> " + scheduledFilename);
  }
  else
  {
   LogLog.error("Failed to rename [" + fileName + "] to ["
     + scheduledFilename + "].");
  }
  
  try
  {
   // This will also close the file. This is OK since multiple
   // close operations are safe.
   this.setFile(fileName, true, this.bufferedIO, this.bufferSize);
  }
  catch (IOException e)
  {
   errorHandler.error("setFile(" + fileName + ", true) call failed.");
  }
  scheduledFilename = datedFilename;
 }
  
 /**
  * This method differentiates MinuteRollingAppender from its super class.
  *
  * 

* Before actually logging, this method will check whether it is time to do * a rollover. If it is, it will schedule the next rollover time and then * rollover. * */ @Override protected void subAppend(LoggingEvent event) { long n = System.currentTimeMillis(); if (n >= nextCheck) { now.setTime(n); nextCheck = rc.getNextCheckMillis(now); try { rollOver(); } catch (IOException ioe) { if (ioe instanceof InterruptedIOException) { Thread.currentThread().interrupt(); } LogLog.error("rollOver() failed.", ioe); } } super.subAppend(event); } /** * RollingCalendar is a helper class to MinuteRollingAppender. Given a * periodicity type and the current time, it computes the start of the next * interval. * */ class RollingCalendar extends GregorianCalendar { private static final long serialVersionUID = -3560331770601814177L; RollingCalendar() { super(); } public long getNextCheckMillis(Date now) { return getNextCheckDate(now).getTime(); } public Date getNextCheckDate(Date now) { this.setTime(now); this.set(Calendar.SECOND, 0); this.set(Calendar.MILLISECOND, 0); this.add(Calendar.MINUTE, intervalTime); return getTime(); } } }

테스트 구성 파일은 다음과 같습니다.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
  
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
  
 <appender name="myFile" class="net.csdn.blog.MinuteRollingAppender"> 
  <param name="File" value="log4jTest.log" />
  <param name="Append" value="true" />
  <param name="intervalTime" value="2"/>
  <layout class="org.apache.log4j.PatternLayout">
   <param name="ConversionPattern" value="%p %d (%c:%L)- %m%n" />
  </layout>
 </appender>
  
 <root>
  <priority value="debug"/>
  <appender-ref ref="myFile"/> 
 </root>
  
</log4j:configuration>

타이밍 구현과 관련하여 Java에서 제공하는 Timer 구현을 사용할 수도 있습니다. 이렇게 하면 매번 시간을 계산하고 비교할 필요가 없습니다. 차이점은 실제로 스레드를 직접 시작하고 RollOver 메서드를 호출하는 것입니다.

package net.csdn.blog;
  
import java.io.File;
import java.io.IOException;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Timer;
import java.util.TimerTask;
  
import org.apache.log4j.FileAppender;
import org.apache.log4j.Layout;
import org.apache.log4j.helpers.LogLog;
  
public class TimerTaskRollingAppender extends FileAppender
{
 /**
  * The date pattern. By default, the pattern is set to "&#39;.&#39;yyyy-MM-dd"
  * meaning daily rollover.
  */
 private static final String DATEPATTERN = "&#39;.&#39;yyyy-MM-dd-HH-mm&#39;.log&#39;";
  
 /**
  * 间隔时间,单位:分钟
  */
 private int intervalTime = 10;
  
 SimpleDateFormat sdf = new SimpleDateFormat(DATEPATTERN);
  
 /**
  * The default constructor does nothing.
  */
 public TimerTaskRollingAppender()
 {
 }
  
 /**
  * Instantiate a <code>TimerTaskRollingAppender</code> and open the file
  * designated by <code>filename</code>. The opened filename will become the
  * ouput destination for this appender.
  */
 public TimerTaskRollingAppender(Layout layout, String filename)
   throws IOException
 {
  super(layout, filename, true);
  activateOptions();
 }
  
 /**
  * @return the intervalTime
  */
 public int getIntervalTime()
 {
  return intervalTime;
 }
  
 /**
  * @param intervalTime
  *   the intervalTime to set
  */
 public void setIntervalTime(int intervalTime)
 {
  this.intervalTime = intervalTime;
 }
  
 @Override
 public void activateOptions()
 {
  super.activateOptions();
  Timer timer = new Timer();
  timer.schedule(new LogTimerTask(), 1000, intervalTime * 60000);
 }
  
 class LogTimerTask extends TimerTask
 {
  @Override
  public void run()
  {
   String datedFilename = fileName + sdf.format(new Date());
   closeFile();
   File target = new File(datedFilename);
   if (target.exists())
    target.delete();
   File file = new File(fileName);
   boolean result = file.renameTo(target);
   if (result)
    LogLog.debug(fileName + " -> " + datedFilename);
   else
    LogLog.error("Failed to rename [" + fileName + "] to ["
      + datedFilename + "].");
   try
   {
    setFile(fileName, true, bufferedIO, bufferSize);
   }
   catch (IOException e)
   {
    errorHandler.error("setFile(" + fileName
      + ", true) call failed.");
   }
  }
 }
}

그러나 위의 구현에는 두 가지 문제가 있습니다. :

1) 동시성

동시성 문제가 발생할 수 있는 곳 중 하나는 run()에서 closeFile()을 호출한 후, subAppend() 메소드가 로그를 작성하는 경우입니다. 이 순간 다음 오류가 보고됩니다.

java.io.IOException: Stream closed
 at sun.nio.cs.StreamEncoder.ensureOpen(Unknown Source)
 at sun.nio.cs.StreamEncoder.write(Unknown Source)
 at sun.nio.cs.StreamEncoder.write(Unknown Source)
 at java.io.OutputStreamWriter.write(Unknown Source)
 at java.io.Writer.write(Unknown Source)
..............................

해결 방법은 비교적 간단합니다. 전체 run() 메서드를 동기식으로 만들고 동기화된 키워드를 추가하면 됩니다. 현재로서는 쓰기 속도가 충분히 빠르면 로그가 손실될 수 있습니다.

2) 성능

Timer를 사용하는 것은 비교적 간단하지만 실행하는 경우 Timer의 작업 시간이 너무 길면 Timer 개체가 독점되어 후속 작업을 실행할 수 없게 됩니다. 해결 방법은 비교적 간단합니다. 다음과 같이 구현되는 타이머 클래스 ScheduledExecutorService를 사용하세요.

/**
 *
 */
package net.csdn.blog;
  
import java.io.File;
import java.io.IOException;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.concurrent.Executors;
import java.util.concurrent.TimeUnit;
  
import org.apache.log4j.FileAppender;
import org.apache.log4j.Layout;
import org.apache.log4j.helpers.LogLog;
  
/**
 * @author coder_xia
 *   <p>
 *   采用ScheduledExecutorService实现定时配置打印日志
 *   <p>
 *
 */
public class ScheduledExecutorServiceAppender extends FileAppender
{
 /**
  * The date pattern. By default, the pattern is set to "&#39;.&#39;yyyy-MM-dd"
  * meaning daily rollover.
  */
 private static final String DATEPATTERN = "&#39;.&#39;yyyy-MM-dd-HH-mm&#39;.log&#39;";
  
 /**
  * 间隔时间,单位:分钟
  */
 private int intervalTime = 10;
  
 SimpleDateFormat sdf = new SimpleDateFormat(DATEPATTERN);
  
 /**
  * The default constructor does nothing.
  */
 public ScheduledExecutorServiceAppender()
 {
 }
  
 /**
  * Instantiate a <code>ScheduledExecutorServiceAppender</code> and open the
  * file designated by <code>filename</code>. The opened filename will become
  * the ouput destination for this appender.
  */
 public ScheduledExecutorServiceAppender(Layout layout, String filename)
   throws IOException
 {
  super(layout, filename, true);
  activateOptions();
 }
  
 /**
  * @return the intervalTime
  */
 public int getIntervalTime()
 {
  return intervalTime;
 }
  
 /**
  * @param intervalTime
  *   the intervalTime to set
  */
 public void setIntervalTime(int intervalTime)
 {
  this.intervalTime = intervalTime;
 }
  
 @Override
 public void activateOptions()
 {
  super.activateOptions();
  Executors.newSingleThreadScheduledExecutor().scheduleAtFixedRate(
    new LogTimerTask(), 1, intervalTime * 60000,
    TimeUnit.MILLISECONDS);
 }
  
 class LogTimerTask implements Runnable
 {
  @Override
  public void run()
  {
   String datedFilename = fileName + sdf.format(new Date());
   closeFile();
   File target = new File(datedFilename);
   if (target.exists())
    target.delete();
   File file = new File(fileName);
   boolean result = file.renameTo(target);
   if (result)
    LogLog.debug(fileName + " -> " + datedFilename);
   else
    LogLog.error("Failed to rename [" + fileName + "] to ["
      + datedFilename + "].");
   try
   {
    setFile(fileName, true, bufferedIO, bufferSize);
   }
   catch (IOException e)
   {
    errorHandler.error("setFile(" + fileName
      + ", true) call failed.");
   }
  }
 }
}


타이밍 구현에 대해서는 거의 완료되었습니다. 기본값은 10분마다 새 로그 파일을 생성하는 것입니다. 구성 중에 직접 설정할 수 있습니다. 그러나 구성하는 사람이 시간 간격이 분이라는 것을 모르는 경우에는 숨겨진 위험이 있습니다. 초라고 생각하면 600을 할당하고 디버그를 켜고 GB의 로그 파일을 생성합니다. 아래 수정 사항은 RollingFileAppender의 최대 크기와 구성 가능한 최대 백업 파일 개수를 합쳐서 다시 개선한 내용입니다. 변환 과정에 대한 설명은 다음번에 계속하겠습니다.

모듈 이름 구성 추가

앞서 log4j 예약 인쇄의 사용자 정의 클래스 구현에 대해 이야기했습니다. 우리는 RollingFileAppender 클래스에서 코드를 복사합니다. 해결해야 할 유일한 것은 동시성 문제, 즉 파일이 닫히고 이름 변경 파일이 닫히고 로그 이벤트가 발생하면 출력 스트림이 닫히는 것입니다. 오류가 보고됩니다.

첫 번째 경우 log4j73d3276cca4423eeeaf44766d19395f2를 구성한 후 Logger 생성 시 다음과 유사한 방법을 사용할 수 있습니다.

Logger logger=Logger.getLogger("Test");

두 번째 경우 두 경우 모두 동일한 로그 파일에 서로 다른 모듈을 인쇄할 수 있기를 바라지만, 문제가 있을 때 문제를 찾을 수 있도록 로그에 모듈 이름을 인쇄할 수 있기를 바랍니다. 따라서 이 기사에서는 필요에 따라 Appender 클래스에 구성 ModuleName을 추가해야 합니다. 예약된 인쇄와 달리 RollingFileAppender 클래스를 변환의 기본 클래스로 사용합니다.

먼저 구성 항목 moduleName을 추가하고 get 및 set 메소드를 추가합니다.

RollingFileAppender에서 상속되므로 subAppend()에서 LoggingEvent의 데이터 형식을 지정하고 formatInfo 메소드 형식 코드는 생략됩니다.

최종 제품 카테고리는 다음과 같습니다.

package net.csdn.blog;
  
import org.apache.log4j.Category;
import org.apache.log4j.RollingFileAppender;
import org.apache.log4j.spi.LoggingEvent;
  
/**
 * @author coder_xia
 *
 */
public class ModuleAppender extends RollingFileAppender
{
 private String moduleName;
  
 /**
  * @return the moduleName
  */
 public String getModuleName()
 {
  return moduleName;
 }
  
 /**
  * @param moduleName
  *   the moduleName to set
  */
 public void setModuleName(String moduleName)
 {
  this.moduleName = moduleName;
 }
  
 /**
  * 格式化打印内容
  *
  * @param event
  *   event
  * @return msg
  */
 private String formatInfo(LoggingEvent event)
 {
  StringBuilder sb = new StringBuilder();
  if (moduleName != null)
  {
   sb.append(moduleName).append("|");
   sb.append(event.getMessage());
  }
  return sb.toString();
 }
  
 @Override
 public void subAppend(LoggingEvent event)
 {
  String msg = formatInfo(event);
  super.subAppend(new LoggingEvent(Category.class.getName(), event
    .getLogger(), event.getLevel(), msg, null));
 }
}

Log4j 예약 로그 인쇄 및 모듈 이름 구성 추가에 대한 더 많은 Java 코드 예제를 보려면 PHP 중국어 웹사이트에 주목하세요!

성명:
본 글의 내용은 네티즌들의 자발적인 기여로 작성되었으며, 저작권은 원저작자에게 있습니다. 본 사이트는 이에 상응하는 법적 책임을 지지 않습니다. 표절이나 침해가 의심되는 콘텐츠를 발견한 경우 admin@php.cn으로 문의하세요.