ユーティリティクラスの設計について

Question

前提・実現したいこと

ログ出力をする共通クラスの設計について悩んでいます。

発生している問題

下記ソースのクラスを作成し、
呼び出し元のクラスでログ出力時に次のメソッドと引数を渡してログ出力することを考えています。

クラス:LogUtil
メソッド：outLog
引数：fileName(ファイル名),　←呼び出し元クラスが変われば変わる
　　　logLevel(出力時のログレベル),　←呼び出し元クラスでDEBUG or INFO or WARN or ERRORを設定
　　　logClass(log4j2.xmlのロガー名), ←呼び出し元クラスでA or Bを設定
　　　msg(出力するメッセージ) ←呼び出し元クラスで出力したいメッセージを設定

今の時点だと呼び出し元で毎度当該クラスをnewしてインスタンスを生成するのは効率的ではないとと考えています。
staticなメソッドにすることで毎度当該クラスをnewしなくてもよくなることが分かったのですが、
outLogメソッドをそのままstaticにしても問題ないか分からなくなってしまいました。

クラスの設計は初めてのためアドバイスなどございましたら、よろしくお願いいたします。

該当のソースコード

package sub;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

public class LogUtil {
	//定数の設定
	static final String LOGCLASS_A = "A";
	static final String LOGCLASS_B = "B";

	static final String LOGGER_A = "Alogger";
	static final String LOGGER_B = "Blogger";

	static final String LOGLEVEL_D = "DEBUG";
	static final String LOGLEVEL_I = "INFO";
	static final String LOGLEVEL_W = "WARN";
	static final String LOGLEVEL_E = "ERROR";

	//コンストラクタ
	public LogUtil() {}

	public int outLog(String fileName, String logLevel, String logClass, String msg) {

		//処理結果
		int rc = 0;

		//ファイル名の設定
		System.setProperty("logFileName",fileName);

		try {
			//loggerの取得
			Logger logger = null;

			switch(logClass) {
			case LOGCLASS_A:
				logger = LogManager.getLogger(LOGGER_A);
				break;
			case LOGCLASS_B:
				logger = LogManager.getLogger(LOGGER_B);
				break;
			}

			//ログ出力
			this.writeLogMsg(logger, logLevel, msg);

			return rc;

		}catch(Throwable T) {
			return rc = 9;
		}
	}

	//ログ書き出し
	private void writeLogMsg(Logger logger, String logLevel, String msg) throws Throwable {
		switch(logLevel) {
		case LOGLEVEL_D:
			logger.debug(msg);
			break;
		case LOGLEVEL_I:
			logger.info(msg);
			break;
		case LOGLEVEL_W:
			logger.warn(msg);
			break;
		case LOGLEVEL_E:
			logger.error(msg);
			break;
		}
	}
}

Answer 1

クラスの設計は初めてのためアドバイスなどございましたら、よろしくお願いいたします。

クラスの定義方法を知るというだけの学習目的なら何も言いませんが、"ログ出力をする共通クラス"は本当に必要でしょうか。必要かどうかは使う側の人のことを考えてみると良いでしょう。

共通クラスを使った場合

public class Program{
    private LogUtil logUtil = new LogUtil();
    public static void main(String[] args){
         logUtil.outLog("hoge.log","INFO","Alogger","mainが呼ばれました");
    }
}

log4jのLoggerをそのまま使った場合

public class Program{
    private Logger logger = LogManager.getLogger("Alogger");
    public static void main(String[] args){
         logger.info("mainが呼ばれました");
    }
}

どちらの方が使いやすいでしょうか？
私はログに残すメッセージだけを渡せば利用できる後者が使いやすいと感じます。
※後者はファイル出力先が引数にはありませんが、どのファイルに出力するかはlog4j.xmlで設定できます。

なので、改めて言いますが「クラスの設計を行う」という意味だと今回のテーマは不適当のように思えます。
私なら今回は共通クラスを作るのはやめて、普通にlog4jのLoggerを利用するという選択肢を取ります。

ユーティリティクラスの設計について

ユーティリティクラスはstaticなメソッドだけ定義してください。
また、関数のように使えれば良い訳ですからインスタンス化の必要もありません。

ユーティリティクラスが何かという話については以前の質問にあるようなので確認されると良いでしょう。

Comments

[g1081828]

ご回答ありがとうございます。
必要可否について勉強になりました。

Answer 2

UtilクラスはクラスっていうよりC++とかでのnamespaceらしいです。

ダメっていうほどでもありませんが、好ましくはないかも?

私なら、コンストラクタで msg 以外の引数を受け取り、outLogメソッドで msg を引き受けて 処理する...かなぁ。

public class LogEx{
   public LogEx( String fileName, String logLevel, String logClass ){
      // ここでフィールドにセットしておく
   }
   public bool outLog( String msg ){
      // ここで フィールドと 引数msg を用いて処理する
   }
   private String filename_;
   private String logLevel_;
   // ... ほかにもフィールドがある
}

としておけば、

log1 オブジェクトは log1.txt を管理、log2オブジェクトは log2.txt を管理...という風に役割分担できる。

そして、ほかのメソッドやクラスなんかでも使いたいなら、その都度newせずに、

1. mainメソッド内で new する
2. mainメソッド内のLogExオブジェクトを引数として渡す
3. (ほかのクラス内で)渡されたLogExオブジェクトを使う

とすればいい。

public class Runner{
   public Runner( LogEx log1 ){ log1_ = log1; }
   public run( void ){
          // ログを残す必要があるなら log1_ を使う。
   }
   private LogEx log1_;
}

という風に、引数で受け取ればnewは一回でいい。