[카테고리:] Java

원하는 시간에 원하는 기능을 실행해 주는 스케줄러 기능을 Java에서 실행하기 위해서 가장 많이 사용되는 라이브러리가 Quartz입니다. Quartz는 기능을 안정적으로 실행할 수 있다는 장점과 함께, 특히 실행할 시간을 매우 유연하게 지정할 수 있습니다.

아래의 코드는 매 순간의 시간이 5초일때(5초마다가 아님) 특정한 기능, 즉 Job을 실행해 주는 코드입니다.

package quartz;

import static org.quartz.CronScheduleBuilder.cronSchedule;
import static org.quartz.JobBuilder.newJob;
import static org.quartz.TriggerBuilder.newTrigger;

import org.quartz.JobDetail;
import org.quartz.Scheduler;
import org.quartz.SchedulerFactory;
import org.quartz.Trigger;
import org.quartz.impl.StdSchedulerFactory;

public class MainEntry {
    public static void main(String[] args) {
        SchedulerFactory schedulerFactory = new StdSchedulerFactory();
		
        try {
            Scheduler scheduler = schedulerFactory.getScheduler();
			
            JobDetail job = newJob(TestJob.class)
                .withIdentity("jobName", Scheduler.DEFAULT_GROUP)
                .build();
			
            Trigger trigger = newTrigger()
                .withIdentity("trggerName", Scheduler.DEFAULT_GROUP)
                .withSchedule(cronSchedule("5 * * * * ?"))
                .build();
						
            scheduler.scheduleJob(job, trigger);
            scheduler.start();
        } catch(Exception e) {
            e.printStackTrace();
        }		
    }
}

26번째 코드를 보면 cronSchedule 함수를 통해 Job을 실행할 시간을 정하고 있습니다. 시간을 정하는 방식을 5 * * * * ?인데요. 순서대로 초 분 시 일 월 요일 년도(옵션)입니다. 즉 초를 5로 하고 나머지에 대해서는 * 또는 ?로 지정함으로써 매순간의 시간이 5초일때 Job을 실행하게 됩니다. 그럼, 실행할 Job은 어떻게 지정할까요? 20번 코드의 newJob 함수를 통해 지정하고 있습니다. Job으로 TestJob을 사용하고 있는데.. 이 TestJob의 코드는 아래와 같습니다.

package quartz;

import java.util.Date;
import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;

public class TestJob implements Job {
    @Override
    public void execute(JobExecutionContext arg0) throws JobExecutionException {
        System.out.println("Job Executed [" + new Date(System.currentTimeMillis()) + "]"); 
    }
}

위의 예에서는 간단히 Job이 실행되는 시간과 Job Executed라는 문자열을 표시하는 일만 합니다.

Quartz 라이브러리는 http://www.quartz-scheduler.org/downloads 에서 받을 수 있으며, 다운로드 받은 jar 중 최소한 quartz-{version}.jar와 slf4j-api-{version}.jar를 참조해줘야 합니다.

Java의 HashMap 자료구조는 고유한 값인 Key와 1:1로 연관되는 값(Value)을 하나의 쌍(Pair)로 하여 여러 개의 쌍을 저장하는 자료구조입니다. 흔히 Key 값으로 문자열이나 정수값을 사용하는 것으로도 충분합니다. 그러나 기능에 따라서 개발자가 특별한 Key에 대한 타입을 정의해야할 필요가 있습니다.

만약 개발자가 Key 타입으로 아래와 같은 클래스를 정의했다고 합시다.

public class Identifier {
    private long A;
    private long B;
    private long C;
	
    public Identifier(long A, long B, long C) {
        this.A = A;
        this.B = B;
        this.C = C;
    }
}

그리고 위의 Identifier 클래스를 Key로 하는 HashMap을 사용하는 코드를 아래와 같이 작성했다고 합시다.

HashMap<Identifier, String> map = new HashMap<Identifier, String>();
		
Identifier id1 = new Identifier(1,2,3);
map.put(id1, "White");
		
Identifier id2 = new Identifier(2,1,3);
map.put(id2, "Yellow");
		
Identifier id3 = new Identifier(2,1,3);
map.put(id3, "Red");
		
System.out.println(map.get(id2));

Key로써의 Identifier 클래스의 동일성을 Identifier가 가지는 3개의 필드인 A, B, C의 동일함으로 정의한다고 할때, 두개의 Identifier 객체 o1, o2가 있다고 한다면 o1과 o2가 같을 조건은 o1.A == o2.A && o1.B == o2.B && o1.C == o2.C라고 할 수 있습니다. 이러한 정의대로라면 위의 코드의 결과는 new Identifier(2,1,3)으로 생성된 객체 중 가장 마지막으로 저장된 “Red” 문자열을 출력해야 하는데, “Yellow”를 출력하게 됩니다. 그렇다면 원하는 결과를 얻기 위해서 무엇을 해야 할까요?

HashMap의 Key 타입으로써 기능을 충족하기 위해서는 Object 클래스의 equals와 hashCode 함수를 재정의해야 합니다. 아래가 Identifier 클래스에 이 2개의 함수를 재정의한 전체 코드입니다.

import java.util.Objects;

public class Identifier {
    private long A;
    private long B;
    private long C;
	
    public Identifier(long A, long B, long C) {
        this.A = A;
        this.B = B;
        this.C = C;
    }
	
    @Override
    public boolean equals(Object o) {
        if(this == o) return true;	
        if(o == null || getClass() != o.getClass()) return false;
		
        Identifier other = (Identifier)o;
		
        return other.A == A && other.B == B && other.C == C;
    }
	
    @Override
    public int hashCode() {
        int result = (int)(A ^ (A >>> 32));
        
        result = 31 * result + (int)(B ^ (B >>> 32));
        result = 31 * result + (int)(C ^ (C >>> 32));
		
        return result;
    }
}

위의 equals 함수는 앞서 설명한 동일성에 대한 정의를 코드로 작성한 것입니다. hashCode 함수는 최대한 중복되지 않고 다양한 값을 반환할 수 있어야 함과 동시에 같은 값이라고 한다면 같은 hashCode 값을 반환해야 합니다. 즉, new Identifier(2,1,3)를 2번 호출하여 2개의 객체를 생성했다면 이 2개의 객체에 대한 hashCode 함수의 반환값은 같아야 합니다. 이러한 조건을 최대한 수용할 수 있도록 작성했다고 작성한게 위의 hashCode 함수의 구현입니다만… 이게 애매한지라 hashCode 함수에 대해서만큼은 아래의 코드로 대체할 수 있습니다.

@Override
public int hashCode() {
    return Objects.hash(A, B, C); // import java.util.Objects; 가 필요함
}

이제 실행해 보면, 우리가 원하는 결과를 얻을 수 있습니다. 이상으로 HashMap에 대한 Custom Key 타입을 정의하는 방식에 대한 정리였습니다.

log4j 등과 같은 로그를 위한 좋은 라이브러리가 있으나 Java에서 제공하는 기본 Log 기능에 대해 정리합니다. 먼저 가장 간단한 예는 아래와 같습니다. log에 대한 수준(Level)을 지정해 메세지를 콘솔에 표시하는 경우입니다.

package tst_Log_console;

import java.util.logging.Level;
import java.util.logging.Logger;

public class MainEntry {
    private final static Logger LOG = Logger.getGlobal();
	
    public static void main(String[] args) {
        LOG.setLevel(Level.INFO);
		
        LOG.severe("severe Log");
        LOG.warning("warning Log");
        LOG.info("info Log");
    }
}

Log의 수준은 높은 순서로 SEVERE, WARNING, INFO입니다. 각각이 의미하는 바는 심각함, 경고, 정보입니다. setLevel 함수를 통해 표시할 레벨의 수준을 조정할 수 있습니다. 위 코드에 대한 실행 결과는 다음과 같습니다.

4월 09, 2018 5:58:41 오후 tst_Log_console.MainEntry main
심각: severe Log
4월 09, 2018 5:58:41 오후 tst_Log_console.MainEntry main
경고: warning Log
4월 09, 2018 5:58:41 오후 tst_Log_console.MainEntry main
정보: info Log

위처럼 로그의 내용은 이미 정해져 있는데요. 만약 자신만의 로그 형식을 원한다면 먼저 Formatter 클래스를 상속받아 다음과 같은 클래스를 정의해야 합니다.

package tst_Log_console;

import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.logging.Formatter;
import java.util.logging.Handler;
import java.util.logging.LogRecord;

public class CustomLogFormatter extends Formatter {
    public String getHead(Handler h) {
        return "START LOG\n";
    }
	
    public String format(LogRecord rec) {
        StringBuffer buf = new StringBuffer(1000);

        buf.append(calcDate(rec.getMillis()));
        
        buf.append(" [");
        buf.append(rec.getLevel());
        buf.append("] ");
        
        buf.append("[");
        buf.append(rec.getSourceMethodName());
        buf.append("] ");
        
        buf.append(rec.getMessage());
        buf.append("\n");
        
        return buf.toString();
    }

    public String getTail(Handler h) {
    	return "END LOG\n";
    }
    
    private String calcDate(long millisecs) {
        SimpleDateFormat date_format = new SimpleDateFormat("yyyy-MM-dd HH:mm");
        Date resultdate = new Date(millisecs);
        return date_format.format(resultdate);
    }
}

그리고 이 클래스를 다음의 예처럼 활용할 수 있습니다.

package tst_Log_console;

import java.util.logging.ConsoleHandler;
import java.util.logging.Handler;
import java.util.logging.Level;
import java.util.logging.Logger;

public class MainEntry2 {
    private final static Logger LOG = Logger.getGlobal();
	
    public static void main(String[] args) {
        //=============================================
        // 기본 로그 제거
        //------------
        Logger rootLogger = Logger.getLogger("");
        Handler[] handlers = rootLogger.getHandlers();
        if (handlers[0] instanceof ConsoleHandler) {
            rootLogger.removeHandler(handlers[0]);
        }
        //=============================================
		
        LOG.setLevel(Level.INFO);
		
        Handler handler = new ConsoleHandler();
        CustomLogFormatter formatter = new CustomLogFormatter();
        handler.setFormatter(formatter);
        LOG.addHandler(handler);
		
        LOG.severe("severe Log");
        LOG.warning("warning Log");
        LOG.info("info Log");
    }
}

위의 클래스에서 getHead 함수는 로그 기록을 시작할때 한번만 호출되어 로그로써 표시되는 문자열을 반환합니다. 그리고 format은 개발자가 로그를 표시하기 원할때마다 메세지의 형식을 정의하기 위해 호출되는 함수입니다. 그리고 getTail은 프로그램이 종료될때 호출되는 로그 메세지로 표시할 문자열을 반환합니다. (그러나 현재 시점에서 이 getTail은 로그를 콘솔로 표시할 때 호출되지 않는 문제가 있음) 코드를 좀더 살펴보면, 12-20번 코드는 기본적으로 지정된 로그(콘솔창에 이미 정의된 형식으로 내요을 출력함)를 제거합니다. 그리고 24-27번 코드처럼 앞서 정의한 Formatter에 대한 상속 클래스를 생성해 지정합니다. 실행해 보면 다음과 같습니다.

START LOG
2018-04-09 18:06 [SEVERE] [main] severe Log
2018-04-09 18:06 [WARNING] [main] warning Log
2018-04-09 18:06 [INFO] [main] info Log

위의 경우처럼 로그를 화면이 아닌 파일로 저장하고 싶을 때가 있습니다. 이 경우 아래의 코드와 같이 하면 됩니다.

package tst_Log_console;

import java.io.IOException;
import java.util.logging.ConsoleHandler;
import java.util.logging.FileHandler;
import java.util.logging.Handler;
import java.util.logging.Level;
import java.util.logging.Logger;

public class MainEntry3 {
    private final static Logger LOG = Logger.getGlobal();
	
    public static void main(String[] args) throws SecurityException, IOException {
        //=============================================
        // 기본 로그 제거
        //------------
        Logger rootLogger = Logger.getLogger("");
        Handler[] handlers = rootLogger.getHandlers();
        if (handlers[0] instanceof ConsoleHandler) {
            rootLogger.removeHandler(handlers[0]);
        }
        //=============================================
		
        LOG.setLevel(Level.INFO);
		
        Handler handler = new FileHandler("message.log", true);
        
        CustomLogFormatter formatter = new CustomLogFormatter();
        handler.setFormatter(formatter);
        LOG.addHandler(handler);
		
        LOG.severe("severe Log");
        LOG.warning("warning Log");
        LOG.info("info Log");
    }
}

달라지는 내용은 26번 코드에서 ConsoleHandler 대신 FileHandler로 변경되었다는 것입니다. 이 FileHandler 생성자는 첫번째 인자에 사용할 파일명을, 그리고 두번째 인자에 파일 기록시 APPEND 모드인지의 여부를 지정합니다.