1. 引入loggerg类和logger工厂类
2. 声明logger
3. 记录日志

//1. 引入slf4j接口的Logger和LoggerFactoryimport org.slf4j.Logger;import org.slf4j.LoggerFactory;public class UserService {  //2. 声明一个Logger，这个是static的方式，我比较习惯这么写。  private final static Logger logger = LoggerFactory.getLogger(UserService.class);  public boolean verifyLoginInfo(String userName, String password) {    //3. log it，输出的log信息将会是："Start to verify User [Justfly]    logger.info("Start to verify User [{}]", userName);    return false;  }}

• 静态Logger对象相对来说更符合语义，节省CPU，节省内存，不支持注入
• 对象变量Logger支持注入，对于一个JVM中运行的多个引用了同一个类库的应用程序，可以在不同的应用程序中对同个类的Logger进行不同的配置。比如Tomcat上部署了俩个应用，他们都引用了同一个lib。

• public boolean isTraceEnabled();
• public boolean isDebugEnabled();
• public boolean isInfoEnabled();
• public boolean isWarnEnabled();
• public boolean isErrorEnabled();

if(logger.isDebugEnabled()){   logger.debug("["+resultCount+"]/["+totalCount+"] of users are returned");}

if(logger.isDebugEnabled()){   logger.debug("[{}]/[{}] of users in group are returned", resultCount,totalCount); }

• public void info(String msg);

logger.info("开始初始化配置文件读取模块");

• public void info(String format, Object arg);

logger.info("开始导入配置文件[{}]","/somePath/config.properties");

• public void info(String format, Object arg1, Object arg2);

logger.info("开始从配置文件[{}]中读取配置项[{}]的值","/somePath/config.properties","maxSize");

• public void info(String format, Object... arguments);

logger.info("在配置文件[{}]中读取到配置项[{}]的值为[{}]","/somePath/config.properties","maxSize", 5);

• public void info(String msg, Throwable t);

logger.info("读取配置文件时出现异常",new FileNotFoundException("File not exists"));

 输出

2.2.2 如何Log Exception

2.2.2.1 把Exception作为Log方法的最后一个参数

上面讲的参数化Log方法的中的最后一个参数如果是一个Exception类型的对象的时候，logback将会打印该Exception的StackTrace信息。看下面的这个例子：

logger.info("读取配置文件[{}]时出错。","/somePath/config.properties",new FileNotFoundException("File not exists"));

2.2.2.2 Exception不会替换log信息中的参数

另外需要注意的时，该Exception不会作为参数化内容中的参数进行替换。比如下面的代码：

logger.info("读取配置文件[{}]时出错。异常为[{}]","/somePath/config.properties",new FileNotFoundException("File not exists"));

• 把Exception的toString()方法的返回值作为参数

logger.info("读取参数[{}]的时候出错：[{}], 请检查你的配置文件[{}]","maxSize",new FileNotFoundException("File not exists"),"/somePath/config.properties");

• 影响到程序正常运行、当前请求正常运行的异常情况,例如：
• 打开配置文件失败
• 第三方应用网络连接异常
• SQLException
• 不应该出现的情况，例如：
• 某个Service方法返回的List里面应该有元素的时候缺获得一个空List
• 做字符转换的时候居然报错说没有GBK字符集

• 不应该出现但是不影响程序、当前请求正常运行的异常情况，例如：
• 有容错机制的时候出现的错误情况
• 找不到配置文件，但是系统能自动创建配置文件
• 即将接近临界值的时候，例如：
• 缓存池占用达到警告线

• 系统运行信息
• Service方法的出入口
• 主要逻辑中的分步骤
• 外部接口部分
• 客户端请求参数和返回给客户端的结果
• 调用第三方时的调用参数和调用结果

• 用于记录程序变量，例如：
• 多次迭代中的变量
• 用于替代代码中的注释

logger.debug("开始获取员工[{}] [{}]年基本薪资",employee,year);logger.debug("获取员工[{}] [{}]年的基本薪资为[{}]",employee,year,basicSalary);logger.debug("开始获取员工[{}] [{}]年[{}]月休假情况",employee,year,month);logger.debug("员工[{}][{}]年[{}]月年假/病假/事假为[{}]/[{}]/[{}]",employee,year,month,annualLeaveDays,sickLeaveDays,noPayLeaveDays);logger.debug("开始计算员工[{}][{}]年[{}]月应得薪资",employee,year,month);logger.debug("员工[{}] [{}]年[{}]月应得薪资为[{}]",employee,year,month,actualSalary);

3.1.2.2 Trace

3.2 Log中的要点

3.2.1 Log上下文

3.2.2 考虑Log的读者

3.2.3 Log中的变量用[]与普通文本区分开来

3.2.4 Error或者Warn级别中碰到Exception的情况尽量log 完整的异常信息

3.2.5 对于Exception，要每次都Log StackTrace吗？

在一些Exception处理机制中，我们会每层或者每个Service对应一个RuntimeException类，并把他们抛出去，留给最外层的异常处理层处理。典型代码如下:

try{  }catch(Exception ex){  String errorMessage=String.format("Error while reading information of user [%s]",userName);  logger.error(errorMessage,ex);  throw new UserServiceException(errorMessage,ex);}

• 这个信息很重要，我不确认再往上的异常处理层中是否会正常的把它的StackTrace打印出来。
• 如果这个异常信息在往上传递的过程中被多次包装，到了最外层打印StackTrace的时候最底层的真正有用的出错原因有可能不会被打印出来。
• 如果有人改变了LogbackException打印的配置，使得不能完全打印的时候，这个信息可能就丢了。
• 就算重复了又怎么样？都Error了都Warning了还省那么一点空间吗？