Android上定义一个懒人专用的log

最新推荐文章于 2022-01-06 17:45:37 发布

谷粒先生

最新推荐文章于 2022-01-06 17:45:37 发布

阅读量719

点赞数

分类专栏： android 文章标签： log 日志

本文链接：https://blog.csdn.net/OnionOmelette/article/details/53038878

版权

android 专栏收录该内容

26 篇文章 0 订阅

订阅专栏

在Android上打印log时,我习惯已类名为tag,这样在每一个类都得定义一个tag变量,然后又填入第一个参数,后来觉得很麻烦,在网上找到了一篇有用的博客,这个log类通过获取调用所在的类名为tag进行打印,这样就省了每次填第一个参数的烦恼了,方便了许多.原出处不知道在哪里,这个我是转载过来稍微修改的,下面贴上我修改过的源码.修改AppConfig.DEBUG_MODEL的值就可以控制打印或者不打印了.



import java.io.BufferedWriter;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStreamWriter;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Formatter;
import java.util.Locale;



import android.os.Environment;
import android.text.TextUtils;

/**
 * Log工具，类似android.util.Log。 tag自动产生，格式:
 * customTagPrefix:className.methodName(Line:lineNumber),
 * customTagPrefix为空时只输出：className.methodName(Line:lineNumber)。
 * http://blog.csdn.net/finddreams
 * 复制的博客地址:http://blog.csdn.net/iplayvs2008/article/details/40422999
 * 我调用另一个类转换了,所以此类的类名可以为Log
 */
public class LogLazy {

	public static String customTagPrefix = "junjing"; // 自定义Tag的前缀，可以是作者名
	private static final boolean isSaveLog = false; // 是否把保存日志到SD卡中
	public static final String ROOT = Environment.getExternalStorageDirectory().getPath() + "/finddreams/"; // SD卡中的根目录
	private static final String PATH_LOG_INFO = ROOT + "info/";

	private LogLazy() {
	}

	// 容许打印日志的类型，默认是true，设置为false则不打印
	public static boolean allowD = true;
	public static boolean allowE = true;
	public static boolean allowI = true;
	public static boolean allowV = true;
	public static boolean allowW = true;
	public static boolean allowWtf = true;
	public static final boolean DEBUG = AppConfig.DEBUG_MODEL;

	private static String generateTag(StackTraceElement caller) {
		String tag = "%s.%s(Line:%d)"; // 占位符
		String callerClazzName = caller.getClassName(); // 获取到类名
		callerClazzName = callerClazzName.substring(callerClazzName.lastIndexOf(".") + 1);
		callerClazzName = callerClazzName.substring(callerClazzName.lastIndexOf(".") + 1);// 我的修改,获取倒数第二个类名,原因是我用另一个log输出的.
		tag = String.format(tag, callerClazzName, caller.getMethodName(), caller.getLineNumber()); // 替换
		tag = TextUtils.isEmpty(customTagPrefix) ? tag : customTagPrefix + ":" + tag;
		return tag;
	}

	/**
	 * 自定义的logger
	 */
	public static CustomLogger customLogger;

	public interface CustomLogger {
		void d(String tag, String content);

		void d(String tag, String content, Throwable tr);

		void e(String tag, String content);

		void e(String tag, String content, Throwable tr);

		void i(String tag, String content);

		void i(String tag, String content, Throwable tr);

		void v(String tag, String content);

		void v(String tag, String content, Throwable tr);

		void w(String tag, String content);

		void w(String tag, String content, Throwable tr);

		void w(String tag, Throwable tr);

		void wtf(String tag, String content);

		void wtf(String tag, String content, Throwable tr);

		void wtf(String tag, Throwable tr);
	}

	public static void d(String content) {
		if (!DEBUG)
			return;
		if (!allowD)
			return;
		StackTraceElement caller = getCallerStackTraceElement();
		String tag = generateTag(caller);

		if (customLogger != null) {
			customLogger.d(tag, content);
		} else {
			MyLog.d(tag, content);
		}
	}

	public static void d(String content, Throwable tr) {
		if (!DEBUG)
			return;
		if (!allowD)
			return;
		StackTraceElement caller = getCallerStackTraceElement();
		String tag = generateTag(caller);

		if (customLogger != null) {
			customLogger.d(tag, content, tr);
		} else {
			MyLog.d(tag, content, tr);
		}
	}

	public static void e(String content) {
		if (!DEBUG)
			return;
		if (!allowE)
			return;
		StackTraceElement caller = getCallerStackTraceElement();
		String tag = generateTag(caller);

		if (customLogger != null) {
			customLogger.e(tag, content);
		} else {
			MyLog.e(tag, content);
		}
		if (isSaveLog) {
			point(PATH_LOG_INFO, tag, content);
		}
	}

	public static void e(String content, Throwable tr) {
		if (!DEBUG)
			return;
		if (!allowE)
			return;
		StackTraceElement caller = getCallerStackTraceElement();
		String tag = generateTag(caller);

		if (customLogger != null) {
			customLogger.e(tag, content, tr);
		} else {
			MyLog.e(tag, content, tr);
		}
		if (isSaveLog) {
			point(PATH_LOG_INFO, tag, tr.getMessage());
		}
	}

	public static void i(String content) {
		if (!DEBUG)
			return;
		if (!allowI)
			return;
		StackTraceElement caller = getCallerStackTraceElement();
		String tag = generateTag(caller);

		if (customLogger != null) {
			customLogger.i(tag, content);
		} else {
			MyLog.i(tag, content);
		}

	}

	public static void i(String content, Throwable tr) {
		if (!DEBUG)
			return;
		if (!allowI)
			return;
		StackTraceElement caller = getCallerStackTraceElement();
		String tag = generateTag(caller);

		if (customLogger != null) {
			customLogger.i(tag, content, tr);
		} else {
			MyLog.i(tag, content, tr);
		}

	}

	public static void v(String content) {
		if (!DEBUG)
			return;
		if (!allowV)
			return;
		StackTraceElement caller = getCallerStackTraceElement();
		String tag = generateTag(caller);

		if (customLogger != null) {
			customLogger.v(tag, content);
		} else {
			MyLog.v(tag, content);
		}
	}

	public static void v(String content, Throwable tr) {
		if (!DEBUG)
			return;
		if (!allowV)
			return;
		StackTraceElement caller = getCallerStackTraceElement();
		String tag = generateTag(caller);

		if (customLogger != null) {
			customLogger.v(tag, content, tr);
		} else {
			MyLog.v(tag, content, tr);
		}
	}

	public static void w(String content) {
		if (!DEBUG)
			return;
		if (!allowW)
			return;
		StackTraceElement caller = getCallerStackTraceElement();
		String tag = generateTag(caller);

		if (customLogger != null) {
			customLogger.w(tag, content);
		} else {
			MyLog.w(tag, content);
		}
	}

	public static void w(String content, Throwable tr) {
		if (!DEBUG)
			return;
		if (!allowW)
			return;
		StackTraceElement caller = getCallerStackTraceElement();
		String tag = generateTag(caller);

		if (customLogger != null) {
			customLogger.w(tag, content, tr);
		} else {
			MyLog.w(tag, content, tr);
		}
	}

	public static void w(Throwable tr) {
		if (!DEBUG)
			return;
		if (!allowW)
			return;
		StackTraceElement caller = getCallerStackTraceElement();
		String tag = generateTag(caller);

		if (customLogger != null) {
			customLogger.w(tag, tr);
		} else {
			MyLog.w(tag, tr);
		}
	}

	public static void wtf(String content) {
		if (!DEBUG)
			return;
		if (!allowWtf)
			return;
		StackTraceElement caller = getCallerStackTraceElement();
		String tag = generateTag(caller);

		if (customLogger != null) {
			customLogger.wtf(tag, content);
		} else {
			MyLog.wtf(tag, content);
		}
	}

	public static void wtf(String content, Throwable tr) {
		if (!DEBUG)
			return;
		if (!allowWtf)
			return;
		StackTraceElement caller = getCallerStackTraceElement();
		String tag = generateTag(caller);

		if (customLogger != null) {
			customLogger.wtf(tag, content, tr);
		} else {
			MyLog.wtf(tag, content, tr);
		}
	}

	public static void wtf(Throwable tr) {
		if (!DEBUG)
			return;
		if (!allowWtf)
			return;
		StackTraceElement caller = getCallerStackTraceElement();
		String tag = generateTag(caller);

		if (customLogger != null) {
			customLogger.wtf(tag, tr);
		} else {
			MyLog.wtf(tag, tr);
		}
	}

	private static StackTraceElement getCallerStackTraceElement() {
		return Thread.currentThread().getStackTrace()[4];
	}

	public static void point(String path, String tag, String msg) {
		if (isSDAva()) {
			Date date = new Date();
			SimpleDateFormat dateFormat = new SimpleDateFormat("", Locale.SIMPLIFIED_CHINESE);
			dateFormat.applyPattern("yyyy");
			path = path + dateFormat.format(date) + "/";
			dateFormat.applyPattern("MM");
			path += dateFormat.format(date) + "/";
			dateFormat.applyPattern("dd");
			path += dateFormat.format(date) + ".log";
			dateFormat.applyPattern("[yyyy-MM-dd HH:mm:ss]");
			String time = dateFormat.format(date);
			File file = new File(path);
			if (!file.exists())
				createDipPath(path);
			BufferedWriter out = null;
			try {
				out = new BufferedWriter(new OutputStreamWriter(new FileOutputStream(file, true)));
				out.write(time + " " + tag + " " + msg + "\r\n");
			} catch (Exception e) {
				e.printStackTrace();
			} finally {
				try {
					if (out != null) {
						out.close();
					}
				} catch (IOException e) {
					e.printStackTrace();
				}
			}
		}
	}

	/**
	 * 根据文件路径 递归创建文件
	 * 
	 * @param file
	 */
	public static void createDipPath(String file) {
		String parentFile = file.substring(0, file.lastIndexOf("/"));
		File file1 = new File(file);
		File parent = new File(parentFile);
		if (!file1.exists()) {
			parent.mkdirs();
			try {
				file1.createNewFile();
			} catch (IOException e) {
				e.printStackTrace();
			}
		}
	}

	/**
	 * A little trick to reuse a formatter in the same thread
	 */
	private static class ReusableFormatter {

		private Formatter formatter;
		private StringBuilder builder;

		public ReusableFormatter() {
			builder = new StringBuilder();
			formatter = new Formatter(builder);
		}

		public String format(String msg, Object... args) {
			formatter.format(msg, args);
			String s = builder.toString();
			builder.setLength(0);
			return s;
		}
	}

	private static final ThreadLocal<ReusableFormatter> thread_local_formatter = new ThreadLocal<ReusableFormatter>() {
		protected ReusableFormatter initialValue() {
			return new ReusableFormatter();
		}
	};

	public static String format(String msg, Object... args) {
		ReusableFormatter formatter = thread_local_formatter.get();
		return formatter.format(msg, args);
	}

	public static boolean isSDAva() {
		if (Environment.getExternalStorageState().equals(Environment.MEDIA_MOUNTED)
				|| Environment.getExternalStorageDirectory().exists()) {
			return true;
		} else {
			return false;
		}
	}

}