一个日志工具类

最新推荐文章于 2024-08-19 11:28:40 发布
最新推荐文章于 2024-08-19 11:28:40 发布
阅读量3.8k 收藏
点赞数
分类专栏： Android
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/watermusicyes/article/details/50417492
版权

一个日志工具类 L.java

这是一个日志工具类，挺好用的！分享出来，支持一下功能

  1. 输出各种级别的log日志：v、d、i、e

    L.v(“msg”)不带tag的日志输出，并且可以打印出当前所处的文件、方法以及行数；
    L.vt(“tag” , “msg”)自定义tag的日志输出。

  2. 格式化json数据

    L.json(“json_string”)不带tag的json日志输出；
    L.jsonT(“tag” , “json_string”)带tag的json日志输出；

  3. 在Application中配置如下代码，在打包时，自动屏蔽log输出

    if (!BuildConfig.DEBUG) {
        //如果为非debug模式
        L.disableDebug();
}

代码如下所示：


import android.content.Context;
import android.os.Environment;
import android.text.TextUtils;
import android.util.Log;

import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;

import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Locale;


/**
 * 打印log的类, 会调用系统的log, 将调用该log的类名作为tag, 并且自动在log信息中添加方法信息和行信息.<br/>
 * 如果需要使用自定义Tag的Log, 需要调用 {@link #vt(String, String)} |
 * {@link #dt(String, String)} 方法.<br/>
 * <br/>
 * 如果需要打印Log, 只需要调用 {@link #enableDebug()} 方法.(默认为打印Log) <br/>
 * 如果需要关闭打印Log, 只需要调用 {@link #disableDebug()} 方法.(默认为打印Log) <br/>
 * <br/>
 * 如果需要将Log保存到文件中, 只需要调用 {@link #enableFileLog(Context)} 方法.(默认不将Log保存到文件中) <br/>
 * 如果需要取消将Log保存到文件中, 只需要调用 {@link #disableFileLog()} 方法.(默认不将Log保存到文件中) <br/>
 * 
 * <pre>
 *   如果应用程序的Application是继承自 BaseApplication}, 那么久不需要做特殊处理.
 *   否则的话, 推荐使用方式:
 *   在Application的onCreate方法中添加如下函数. 这样在打混淆包的时候, 不需要做额外的处理, 会自动取消打印Log.
 *   if(!BuildConfig.DEBUG){//如果为非debug模式
 *       L.disableDebug();
 *   }
 * 
 * </pre>
 * 
 * @author Kingt
 * 
 */
public class L {
    private static boolean DEBUG = true;
    private static boolean LOG_ON_FILE = false;
    private static String packageName = "";

    private static String sClassName = null;
    private static String sMethodName = null;

    /**
     * 获取系统分隔符
     */
    private static final String LINE_SEPARATOR = System.getProperty("line.separator");
    /**
     * Json缩进
     */
    private static final int JSON_INDENT = 4;

    /**
     * 获取日志信息：当前类名、当前方法名儿
     */
    private static void getTrace() {
        StackTraceElement caller = new Throwable().fillInStackTrace()
                .getStackTrace()[2];

        String className = new StringBuilder().append(caller.getClassName())
                .toString();
        sClassName = className.substring(className.lastIndexOf(".") + 1);
        sMethodName = new StringBuilder().append(
                caller.getMethodName() + "->" + caller.getLineNumber() + ": ")
                .toString();
    }

    /**
     * Verbose 级别的日志输出
     * @param text 要打印的内容
     */
    public static void v(String text) {
        if (!DEBUG)
            return;

        getTrace();

        String message = sClassName + "->" + sMethodName + text;
        Log.v(sClassName, message);
        if (LOG_ON_FILE)
            logOnFile(Log.VERBOSE, sClassName, message);
    }

    public static void v(String text, Object... args) {
        if (!DEBUG)
            return;

        try {
            text = String.format(text, args);
        } catch (RuntimeException e) {

        }

        getTrace();

        String message = sClassName + "->" + sMethodName + text;
        Log.v(sClassName, message);
        if (LOG_ON_FILE)
            logOnFile(Log.VERBOSE, sClassName, message);
    }

    public static void vt(String tag, String text) {
        if (!DEBUG)
            return;

        getTrace();

        String message = sClassName + "->" + sMethodName + text;
        Log.v(tag, message);
        if (LOG_ON_FILE)
            logOnFile(Log.VERBOSE, tag, message);
    }

    /**
     * 调用系统的Log, 将调用该方法的类名作为tag, 并且自动在log信息中添加方法信息和行信息.
     * 
     * @param text
     *            需要打印的Log信息
     */
    public static void d(String text) {
        if (!DEBUG)
            return;

        getTrace();
        String message = sClassName + "->" + sMethodName + text;
        Log.d(sClassName, message);
        if (LOG_ON_FILE)
            logOnFile(Log.DEBUG, sClassName, message);
    }

    /**
     * 
     * 调用系统的Log, 将调用该方法的类名作为tag, 并且自动在log信息中添加方法信息和行信息. 如果格式化出错, 不会抛出异常,
     * 但是只会将text本身打印出来<br/>
     * <br/>
     * 
     * 示例:
     * 
     * <pre>
     * L.d(&quot;我要打印一个字符串:%s 打印一个整数:%d&quot;, &quot;这是一个字符串&quot;, 100);
     * 则在LogCat的输出信息是:"我要打印一个字符串:这是一个字符串 打印一个整数:100"
     * </pre>
     * 
     * @param text
     *            需要打印的Log信息, 可以使用%s %d %f等格式化类型
     * @param args
     *            %s %d %f等的格式化数据
     * @see String#format(String, Object...)
     */
    public static void d(String text, Object... args) {
        if (!DEBUG)
            return;

        try {
            text = String.format(text, args);
        } catch (RuntimeException e) {

        }

        getTrace();

        String message = sClassName + "->" + sMethodName + text;
        Log.d(sClassName, message);
        if (LOG_ON_FILE)
            logOnFile(Log.DEBUG, sClassName, message);
    }

    /**
     * 使用自定义Tag打印Log, 并且但是会自动在输出日志前添加方法信息和行信息.
     * 
     * @param tag
     *            自定义的Tag
     * @param text
     *            要打印的内容
     */
    public static void dt(String tag, String text) {
        if (!DEBUG)
            return;

        getTrace();

        String message = sClassName + "->" + sMethodName + text;
        Log.d(tag, message);
        if (LOG_ON_FILE)
            logOnFile(Log.DEBUG, tag, message);
    }

    public static void i(String text) {
        if (!DEBUG)
            return;

        getTrace();

        String message = sClassName + "->" + sMethodName + text;
        Log.i(sClassName, message);
        if (LOG_ON_FILE)
            logOnFile(Log.INFO, sClassName, message);
    }

    public static void i(String text, Object... args) {
        if (!DEBUG)
            return;

        try {
            text = String.format(text, args);
        } catch (RuntimeException e) {

        }

        getTrace();

        String message = sClassName + "->" + sMethodName + text;
        Log.i(sClassName, message);
        if (LOG_ON_FILE)
            logOnFile(Log.INFO, sClassName, message);
    }

    public static void w(String text) {
        if (!DEBUG)
            return;

        getTrace();

        String message = sClassName + "->" + sMethodName + text;
        Log.w(sClassName, message);
        if (LOG_ON_FILE)
            logOnFile(Log.WARN, sClassName, message);
    }

    public static void w(String text, Object... args) {
        if (!DEBUG)
            return;

        try {
            text = String.format(text, args);
        } catch (RuntimeException e) {

        }

        getTrace();

        String message = sClassName + "->" + sMethodName + text;
        Log.w(sClassName, message);
        if (LOG_ON_FILE)
            logOnFile(Log.WARN, sClassName, message);
    }

    public static void e(String text) {
        if (!DEBUG)
            return;

        getTrace();

        String message = sClassName + "->" + sMethodName + text;
        Log.e(sClassName, message);
        if (LOG_ON_FILE)
            logOnFile(Log.ERROR, sClassName, message);
    }

    /**
     * 使用自定义Tag打印Log, 并且但是会自动在输出日志前添加方法信息和行信息.
     *
     * @param tag
     *            自定义的Tag
     * @param text
     *            要打印的内容
     */
    public static void et(String tag, String text) {
        if (!DEBUG)
            return;

        getTrace();

        String message = sClassName + "->" + sMethodName + text;
        Log.e(tag, message);
        if (LOG_ON_FILE)
            logOnFile(Log.DEBUG, tag, message);
    }

    /**
     * 格式化Json字符串 不打tag的情况下，默认使用当前类名作为Tag
     * @param msg
     */
    public static void json(String msg){

        if (!DEBUG)
            return;

        if (TextUtils.isEmpty(msg)) {
            Log.d(sClassName, "Empty or Null json content");
            return;
        }

        getTrace();

        String message = "";

        try {
            if (msg.startsWith("{")) {
                JSONObject jsonObject = new JSONObject(msg);
                message = jsonObject.toString(JSON_INDENT);
            } else if (msg.startsWith("[")) {
                JSONArray jsonArray = new JSONArray(msg);
                message = jsonArray.toString(JSON_INDENT);
            }
        } catch (JSONException e) {
            d(sClassName, e.getCause().getMessage() + "\n" + msg);
            return;
        }

        printLine(sClassName, true);

        message = sClassName + "->" + sMethodName  + LINE_SEPARATOR + message;
        String[] lines = message.split(LINE_SEPARATOR);
        StringBuilder jsonContent = new StringBuilder();
        for (String line : lines) {
            jsonContent.append("║ ").append(line).append(LINE_SEPARATOR);
        }
        Log.d(sClassName, jsonContent.toString());

        printLine(sClassName, false);

        if (LOG_ON_FILE)
            logOnFile(Log.DEBUG, sClassName, message);

    }

    /**
     * 格式化json 并打自己标签
     * @param tag  tag
     * @param msg  json
     */
    public static void jsonT(String tag , String msg){

        if (!DEBUG)
            return;

        if (TextUtils.isEmpty(msg)) {
            Log.d(sClassName, "Empty or Null json content");
            return;
        }

        getTrace();

        String message = "";

        try {
            if (msg.startsWith("{")) {
                JSONObject jsonObject = new JSONObject(msg);
                message = jsonObject.toString(JSON_INDENT);
            } else if (msg.startsWith("[")) {
                JSONArray jsonArray = new JSONArray(msg);
                message = jsonArray.toString(JSON_INDENT);
            }
        } catch (JSONException e) {
            dt(tag, e.getCause().getMessage() + "\n" + msg);
            return;
        }

        printLine(tag, true);

        message = sClassName + "->" + sMethodName  + LINE_SEPARATOR + message;
        String[] lines = message.split(LINE_SEPARATOR);
        StringBuilder jsonContent = new StringBuilder();
        for (String line : lines) {
            jsonContent.append("║ ").append(line).append(LINE_SEPARATOR);
        }
        Log.d(tag, jsonContent.toString());

        printLine(tag, false);

        if (LOG_ON_FILE)
            logOnFile(Log.DEBUG, tag, message);

    }
    private static void printLine(String tag, boolean isTop) {
        if (isTop) {
            Log.d(tag, "╔═══════════════════════════════════════════════════════════════════════════");
        } else {
            Log.d(tag, "╚═══════════════════════════════════════════════════════════════════════════");
        }
    }



    public static void e(String text, Object... args) {
        if (!DEBUG)
            return;

        try {
            text = String.format(text, args);
        } catch (RuntimeException e) {

        }

        getTrace();

        String message = sClassName + "->" + sMethodName + text;
        Log.e(sClassName, message);
        if (LOG_ON_FILE)
            logOnFile(Log.ERROR, sClassName, message);

    }

    public static void e(Throwable e) {
        if (!DEBUG)
            return;

        if (e == null)
            return;

        getTrace();

        String message = sClassName + "->" + sMethodName + e.toString();
        Log.e(sClassName, message);
        if (LOG_ON_FILE)
            logOnFile(Log.ERROR, sClassName, message);
    }

    public static void e(Throwable e, String text) {
        if (!DEBUG)
            return;

        if (e == null)
            return;

        getTrace();

        String message = sClassName + "->" + sMethodName + text;
        Log.e(sClassName, message);
        if (LOG_ON_FILE)
            logOnFile(Log.ERROR, sClassName, sClassName);
    }

    private static void logOnFile(int level, String tag, String text) {
        SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss",
                Locale.CHINA);
        String time = sdf.format(new Date());
        FileWriter writer = null;
        try {
            File logFile = new File(getCachedFolder() + "log.log");
            if (logFile.exists() && logFile.length() > 100 * 1024) {// 大于100KB
                logFile.renameTo(new File(getCachedFolder() + "log_" + time
                        + ".log"));
            }

            writer = new FileWriter(logFile, true);
            writer.write(time + "/" + level + "/" + tag + "/" + text);
            writer.flush();
        } catch (IOException e) {
            e.printStackTrace();
        } finally {
            try {
                if (writer != null)
                    writer.close();
            } catch (IOException e) {

            }
        }

    }

    /**
     * 获取Log缓存路径
     * 
     * @return Log缓存路径
     */
    private static String getCachedFolder() {
        String path;
        if (Environment.getExternalStorageState().equals(
                Environment.MEDIA_MOUNTED)) {// 有SD卡
            path = Environment.getExternalStorageDirectory().getPath()
                    + "/Android/data/" + packageName + "/log/";
        } else {
            path = Environment.getDataDirectory().getPath() + "/data/"
                    + packageName + "/log/";
        }

        File file = new File(path);
        if (!file.isDirectory()) {
            file.mkdirs();
        }

        return path;
    }

    /**
     * 打开调试模式
     */
    public static void enableDebug() {
        DEBUG = true;
    }

    /**
     * 关闭调试模式
     */
    public static void disableDebug() {
        DEBUG = false;
    }

    /**
     * 允许将Log保存到文件中(默认不保存到文件中)
     */
    public static void enableFileLog(Context context) {
        LOG_ON_FILE = true;

        if (context != null)
            packageName = context.getPackageName();
    }

    /**
     * 取消将Log保存到文件中(默认不保存到文件中)
     */
    public static void disableFileLog() {
        LOG_ON_FILE = false;
    }


}

可以在这里下载该文件：

gits: L.java

张庚
关注
专栏目录
日志工具类-java实现
12-16
开发项目经常需要日志模块打印输出，因此封装一个日志内，供自己平时使用，有些模块重复书写浪费时间，所以直接拉下来能快速一点。
Log工具类
第4个苹果
04-19 373
import android.util.Log;      /**   * Log统一管理类   *    *    *    */   public class L   {          private L()       {           /* cannot be instantiated */           throw new Unsupporte
JAVA-日志工具类
最新发布
caryeko的专栏
08-19 182
规范日志打印，统一日志模板。
统一日志工具类
09-05
封装了Android Log类的功能，便于统一控制日志输出，通过BuildConfig.DEBUG控制日志是否输出，在debug版本自动开启日志，正式版本关闭日志
logback+slf4j打印工具类
12-27
LoggerUtil.getLogger(name).info()；可实现对需要打印的事务每天打印生成一个文件，下载后文件加包名可直接使用，内含jar包
logback日志工具
08-24
压缩包内包括使用logback所需要的jar包和使用文档，文档是自己手写的，有什么不懂的地方可以私信我，哈哈。
超实用的android自定义log日志输出工具类
08-26
今天，我们将要介绍一个超实用的Android自定义日志输出工具类，该工具类可以满足大多数开发者的需求。 日志输出工具类的优点 该工具类具有以下优点： 1. 在LogUtlis方法的第一个参数中填this可以输出当前类的名称...
Android日志工具类
11-12
Android系统内置了`Log`类，但为了更好地管理和组织日志输出，通常会自定义一个日志工具类，如本案例中的`Logger`。这个工具类通常会提供更丰富的功能，比如分类、颜色标记、打印堆栈轨迹等，以提升日志的可读性和...
C# 打印日志工具类
12-05
本文将详细解析标题为“C# 打印日志工具类”的主题，以及如何实现一个可自定义格式、路径和内容的日志工具类。我们将主要关注C#编程语言中的日志管理，尤其是`LogManager.cs`文件中可能包含的代码结构和功能。 首先...
Java 工具类 —— JAVA项目整合Logback
u011909918的博客
01-03 1414
无论什么语言，我们在写Helloworld的时候就已经使用到了日志。 日志，顾名思义，是记录我们代码执行的记录，它的意义在于后续查看我们代码执行的情况和效率，当然对于一个程序员来说，最重要的就是定位问题。同时，优质的日志是可以看出整个程序的思路和逻辑。所以实现业务看不出技术水平，在实现业务的基础上打印优质的日志也是一门学问。。 注意：密码类似的东西千万不要打印........ 一、我有Sys...
Java自定义日志工具类
11-13
Java日志工具类，支持控制台输出日志信息，也支持用文件持久化日志信息。有配置文件log.config可以配置。
自定义日志工具类LoggerInterceptor.java
05-25
自定义日志工具类LoggerInterceptor.java
java工具类,日志处理类
10-07
java通用异常处理类,日志处理类Log,不用重启程序，动态读取配置文件
java日志记录工具类
09-25
调用方法:IndexDataLog.print(入参)，可以设置文件大小，文件写满以后自动创建新的日志文件。一般用来记录用户的搜索词，或操作记录。目前以json格式保存日志，入参稍作修改，可以传入对象,linux和windows都支持。
java日志处理类
11-01
java日志处理类
日志工具类
11-01 312
http://hqlong.com/2009/01/530.html，希望大家提出宝贵意见。 下载 源码 <?php date_default_timezone_set("Asia/ShangHai"); /** * 日志通用类 * * 使用示例： ...
简单的写日志工具类LogUtil
学习，思考，记录
01-08 1577
1、LogUtil.h #ifndef __LOG_UTIL_H_ #define __LOG_UTIL_H_ #include #include #include #include #include #include #include using namespace std; #define PATH_LOG_FILE ".\\LogFile.txt" class
Java常用类-日志
--lky的博客
05-05 810
Java常用类 一个有经验的Java开发人员特征之一就是善于使用已有的轮子来造车，在这篇博客中 我会总结一些在学习和实际开发中用到的一些比较常见的类库和API。 常见的类库-日志 slf4j标准 日志库大概是我们接触到的最多的了，因为每一个项目中都需要他们，打印日志是服务器端应用中最重要的事情，日志也是了解你的程序到底发生了什么的唯一途径，在Java中尽管jdk附带自己的日志库，但是还有很多更好的选择可以使用，如Log4j，SLF4J和LogBack 在java中日志分为两个体系一个日志门面接口和日志框
CommonUtilities日志操作类实现
系统日志操作类是软件开发中用于记录系统运行状态和异常信息的重要工具，通常包含对日志的创建、读取、删除、备份等一系列操作。在这个类中，可以看到以下几个关键知识点： 1. **命名空间引用**：在代码的开头，...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值