Java util Logger的使用步骤

Java util Logger是java原生的日志生成工具,不需要另外引用类库,使用方便,学习简单,能够在小型应用中灵活使用。下面从实际应用角度,对Logger的使用步骤作出总结,以实现快速掌握。

Logger的使用一般包括以下几个步骤:

一、 定义全局的Logger,在不同的类中共用

关键语句

 Logger myLogger = Logger.getLogger("com.mycompany.myapp");

方法参数是Logger的名称,当名称相同时候,同一个名称的Logger只创建一个,实现各个类中共享。

二、 设定输出媒介控制器(Handler)

共有四步:

  1. 一般日志输出包括调试时输出到控制台,以及程序运行时输出到文件,因此Handler包括了控制台ConsoleHandler以及文件FileHandler
  2. Handler输出的日志格式为默认格式,系统提供的格式包括SimpleFormatterXMLFormatter等,输出的内容一般比较冗余,不满足使用,最好使用自定义内容输出格式,可使用派生自Formatter类的自定义子类。
  3. 设定Handler的输出等级,默认是info级。
  4. Handler加入到Logger中。

关键语句

  //创建consoleHandler 自定义类实例,用于在控制台发送日志
  ConsoleHandler consoleHandler = new ConsoleHandler();
  //设置consoleHandler实例输出格式
  consoleHandler.setFormatter(new ConsoleLogFormatter());
  //加入到Logger中
  myLogger.addHandler(consoleHandler);
  //不显示系统自带的consoleHandler,否则控制台将发出两条同样的日志
  myLogger.setUseParentHandlers(false);
    
  //在工程目录下创建log文件夹
  File dir = new File("log");
  if(!dir.exists() || !dir.isDirectory())
  dir.mkdir();

  //创建fileHandler 自定义类实例,用于在文件保存日志  
  FileHandler fileHandler = new         
  FileHandler("log\\myapp.%u.%g.txt",1000,2,true);
  fileHandler.setFormatter(new FileLogFormatter());
  fileHandler.setLevel(Level.INFO);
  myLogger.addHandler(fileHandler);

说明 :

  • 创建日志文件前,若没有文件夹,log将会报错,因此在写入日志文件前,检查文件夹是否存在,不存在则创建文件夹。
  • FileHandler fileHandler = new FileHandler("log\myapp.%u.%g.txt",1000,2,true);
    语句意义为:新建FileHandler,地址为工程文件路径下;log\myapp.%u.%g.txt,循环文件编号为%u.%g,文件最大1000字节,2个文件循环,是否追加文件为“是”,否则总为新建文件。
  • myLogger.setUseParentHandlers(false);
    语句意义为:系统自带的consoleHandler设置为不生效,仅生效增加的自定义consoleHandler,否则控制台将发出两条同样的日志。

三、 Logger设置输出等级,并输出日志

关键语句

    myLogger.setLevel(Level.INFO);
    myLogger.info("一般信息1 ");
    myLogger.info("一般信息2 ");

完整的程序代码为:

public class LogProduce {

    public static void main(String[] args) throws IOException {

        Logger myLogger = Logger.getLogger("com.mycompany.myapp");

        ConsoleHandler consoleHandler = new ConsoleHandler();
        consoleHandler.setFormatter(new ConsoleLogFormatter());
        myLogger.addHandler(consoleHandler);
        myLogger.setUseParentHandlers(false);

        File dir = new File("log");
        if(!dir.exists() || !dir.isDirectory())
            dir.mkdir();

        FileHandler fileHandler = new FileHandler("log\\myapp.%u.%g.txt",1000,2,true);
        fileHandler.setFormatter(new FileLogFormatter());
        fileHandler.setLevel(Level.INFO);
        myLogger.addHandler(fileHandler);

        myLogger.setLevel(Level.INFO);
        myLogger.info("一般信息1 ");
        myLogger.info("一般信息2 ");

        LogUser logUser1 = new LogUser();
        logUser1.produceLog();
    }
}

实际输出为;
Console输出:


未命名图片.jpg

文件输出:


image.png

四、补充说明

  1. ConsoleLogFormatterFileLogFormatter 两个派生的 Formatter 子类
public class FileLogFormatter extends Formatter {

    public FileLogFormatter(){
        super();
    }

    @Override
    public String format(LogRecord r) {
        Date date = new Date();
        String sDate = date.toString();
        String lineSperator = System.getProperty("line.separator");

        StringBuilder sb = new StringBuilder();
        sb.append("[" + sDate + "]" + "[" + r.getLevel() +"]");
        sb.append(r.getMessage());
        //在一条日志结束后采用常量方式的系统换行符,因为 “\n” 形式可能不识别 
        sb.append(lineSperator);

        return sb.toString();
    }
}

该子类重写了format方法,用于用户自定义输出,使用StringBuilder类拼装。
关键语句

String lineSperator = System.getProperty("line.separator");

若直接在格式字符串中插入传统换行符“\n",在输出文件中可能不能识别,因此采用系统定义的换行符 line.separator
类似的,ConsoleLogFormatter代码为:

public class ConsoleLogFormatter extends Formatter {

    public ConsoleLogFormatter(){
        super();
    }

    @Override
    public String format(LogRecord r) {

        String lineSperator = System.getProperty("line.separator");

        StringBuilder sb = new StringBuilder();
        sb.append(r.getMessage());
        sb.append(lineSperator);

        return sb.toString();

    }
}
  1. 子类中调用Logger
    在子类中调用getLogger即可。
public class LogUser {

    Logger myLogger = Logger.getLogger("com.mycompany.myapp");

    public void produceLog(){

        myLogger.info("LogUser.produceLog");
    }
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,539评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,594评论 3 396
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 165,871评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,963评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,984评论 6 393
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,763评论 1 307
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,468评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,357评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,850评论 1 317
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,002评论 3 338
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,144评论 1 351
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,823评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,483评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,026评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,150评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,415评论 3 373
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,092评论 2 355