实现思路

  1. springboot默认使用slf4j作为日志门面, logback作为其实现

(logback的配置文件加载顺序为logback.xml—->application.properties—->logback-spring.xml, 一般在logback.xml中定义变量, 在logback-spring.xml中实现)

  1. 日志要全局保持统一规范的格式, 以便后续拓展, 比如写入es后供前端展示查阅等
  2. 在service层对mybatisPlus已有的Mapper接口做自定义封装, 添加上日志记录, 这里舍弃了mybatisPlus默认的IService和ServiceImpl, 因为这两者接口都是default, 不便做日志的拓展

配置解析

公共模块core包

base.xml, 基础日志配置

  1. 这里定义了三个appender, 一个控制台输出, 一个文件记录, 一个写入es
  2. 这里使用的滚动策略是SizeAndTimeBasedRollingPolicy, 默认配置为每天生成日志文件, 每个文件最大100M(一天内日志记录大于100M, 则生成多个文件), 保存10个历史记录日志文件, 所有日志文件一起不能超过10G ```java <?xml version=”1.0” encoding=”UTF-8”?>

${log_file:-${log_file_default}} ${log_file_pattern:-${log_file_pattern_default}} ${log_file_max_size:-${log_file_max_size_default}} ${log_file_max_history:-${log_file_max_history_default}} ${log_file_max_total_size:-${log_file_max_total_size_default}} ${log_pattern:-${log_pattern_default}} ${log_pattern:-${log_pattern_default}} 

  1. 这里因为保存位置为src/java/xxx/logger下, 因此注意打包时需要一起打入resources
  2. ```java
  3.  <resources>
  4.             <resource>
  5.                 <directory>src/main/java</directory>
  6.                 <includes>
  7.                     <include>**/*.xml</include>
  8.                 </includes>
  9.             </resource>
  10.         </resources>

AbstractLogger

  1. package top.xinzhang0618.oa.logger;
  3. import org.slf4j.Logger;
  4. import org.slf4j.MDC;
  5. import top.xinzhang0618.oa.Assert;
  6. import top.xinzhang0618.oa.util.StringUtils;
  8. /**
  9.  * AbstractLogger
  10.  *
  11.  */
  12. public abstract class AbstractLogger {
  14.   protected abstract Logger getLogger();
  16.   private String preProcessMessage(String message) {
  17.     return StringUtils.isBlank(message) ? "" : message;
  18.   }
  20.   protected void putMDCItem(String key, Object value) {
  21.     if (!Assert.isNull(key) && !Assert.isNull(value)) {
  22.       MDC.put(key, String.valueOf(value));
  23.     }
  24.   }
  26.   protected void doInfo(String message, Object... args) {
  27.     getLogger().info(preProcessMessage(message), args);
  28.     cleanMDC();
  29.   }
  31.   protected void doWarn(String message, Object... args) {
  32.     getLogger().warn(preProcessMessage(message), args);
  33.     cleanMDC();
  34.   }
  36.   protected void doDebug(String message, Object... args) {
  37.     getLogger().debug(preProcessMessage(message), args);
  38.     cleanMDC();
  39.   }
  41.   protected void doError(String message, Object... args) {
  42.     getLogger().error(preProcessMessage(message), args);
  43.     cleanMDC();
  44.   }
  46.   protected void doError(String message, Throwable throwable) {
  47.     getLogger().error(message, throwable);
  48.     cleanMDC();
  49.   }
  51.   protected void doTrace(String message, Object... args) {
  52.     getLogger().trace(preProcessMessage(message), args);
  53.     cleanMDC();
  54.   }
  56.   public boolean isTraceEnabled() {
  57.     return getLogger().isTraceEnabled();
  58.   }
  60.   public boolean isDebugEnabled() {
  61.     return getLogger().isDebugEnabled();
  62.   }
  64.   public boolean isInfoEnabled() {
  65.     return getLogger().isInfoEnabled();
  66.   }
  68.   public boolean isWarnEnabled() {
  69.     return getLogger().isWarnEnabled();
  70.   }
  72.   public boolean isErrorEnabled() {
  73.     return getLogger().isErrorEnabled();
  74.   }
  76.   protected void cleanMDC() {
  77.   }
  78. }

BizLogger, 业务日志类

  1. 其他业务自行定义日志结构, 比如MallLogger等
  2. 此处采用通过路径获取Logger, 效果如下, 如果是通过Clazz获取Logger, 路径为全路径类名
    1. 10:06:52.396 INFO  [http-nio-40001-exec-1] oa.biz.user - 1334318150742269954, 新增
    ```java package top.xinzhang0618.oa.logger;

import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.slf4j.MDC; import top.xinzhang0618.oa.BizContext;

/**

  • 业务日志. *
  • @author buer */ public class BizLogger extends AbstractLogger {
  1. private static final String BIZ_ID = "bizId";
  2. private static final String ACTION = "action";
  3. private static final String OPERATOR = "operator";
  4. private static final String TENANT_ID = "tenantId";
  5. private final Logger logger;
  7. public BizLogger(final OaModule module) {
  8.     this.logger = getLogger(module.getLogPath());
  9. }
  11. private Logger getLogger(String type) {
  12.     return LoggerFactory.getLogger("oa.biz." + type.toLowerCase());
  13. }
  15. public void log(Long bizId, String action) {
  16.     log(bizId, action, bizId + ", " + action);
  17. }
  19. public void log(Long bizId, String action, String message, Object... args) {
  20.     log(BizContext.getTenantId(), bizId, BizContext.getUserName(), action, message, args);
  21. }
  23. public void log(Long tenantId, Long bizId, String nickname, String action, String message, Object... args) {
  24.     putMDC(tenantId, bizId, nickname, action);
  25.     this.doInfo(message, args);
  26. }
  28. protected void putMDC(Long tenantId, Long bizId, String nickname, String action) {
  29.     putMDCItem(TENANT_ID, tenantId);
  30.     putMDCItem(BIZ_ID, bizId);
  31.     putMDCItem(OPERATOR, nickname);
  32.     putMDCItem(ACTION, action);
  33. }
  35. @Override
  36. protected Logger getLogger() {
  37.     return this.logger;
  38. }
  40. @Override
  41. protected void cleanMDC() {
  42.     super.cleanMDC();
  43.     MDC.remove(TENANT_ID);
  44.     MDC.remove(BIZ_ID);
  45.     MDC.remove(ACTION);
  46.     MDC.remove(OPERATOR);
  47. }

}

  1. **OaLoggerFactory, 日志工厂类**
  2. ```java
  3. package top.xinzhang0618.oa.logger;
  5. import org.slf4j.Logger;
  6. import org.slf4j.LoggerFactory;
  8. /**
  9.  * OaLoggerFactory
  10.  */
  11. public class OaLoggerFactory {
  13.     /**
  14.      * 获取日志记录器
  15.      *
  16.      * @param clazz 类型
  17.      */
  18.     public static Logger getLogger(Class<?> clazz) {
  19.         return LoggerFactory.getLogger(clazz);
  20.     }
  22.     /**
  23.      * 获取日志记录器
  24.      *
  25.      * @param logName 日志名称
  26.      */
  27.     public static Logger getLogger(String logName) {
  28.         return LoggerFactory.getLogger(logName);
  29.     }
  31.     /**
  32.      * 获取业务日志记录类
  33.      *
  34.      * @param module 模块
  35.      * @return 日志实例
  36.      */
  37.     public static BizLogger getBizLogger(final OaModule module) {
  38.         return new BizLogger(module);
  39.     }
  41. }

其他
ActionConstants

  1. package top.xinzhang0618.oa.logger;
  3. /**
  4.  * 操作常量
  5.  *
  6.  */
  7. public class ActionConstants {
  9.   public static final String ADD = "新增";
  10.   public static final String AUDIT = "审核";
  11.   public static final String REVIEW = "复核";
  12.   public static final String MODIFY = "修改";
  13.   public static final String DELETE = "删除";
  14.   public static final String CANCEL = "取消";
  15.   public static final String ENABLE = "启用";
  16.   public static final String DISABLE = "禁用";
  17.   public static final String INVALID = "作废";
  18.   public static final String BEGIN = "开始";
  19.   public static final String END = "结束";
  20. }

OaModule

  1. package top.xinzhang0618.oa.logger;
  3. /**
  4.  * OAModule
  5.  */
  6. public enum OaModule {
  8.   /**
  9.    * 角色管理
  10.    */
  11.   ROLE("角色管理", "role"),
  12.   /**
  13.    * 用户角色
  14.    */
  15.   USER_ROLE("角色用户", "user.role"),
  16.   /**
  17.    * 用户管理
  18.    */
  19.   USER("用户管理", "user"),
  20.   /**
  21.    * 授权
  22.    */
  23.   PRIVILEGE("授权","privilege");
  25.   private String caption;
  26.   private String logPath;
  28.   OaModule(String caption, String logPath) {
  29.     this.caption = caption;
  30.     this.logPath = logPath;
  31.   }
  33.   public String getCaption() {
  34.     return caption;
  35.   }
  37.   public String getLogPath() {
  38.     return logPath;
  39.   }
  40. }

服务配置

例如web服务, 需配置resources/config/logback-spring.xml

  1. <?xml version="1.0" encoding="UTF-8"?>
  3. <configuration>
  4.   <property name="log_file" value="log/web.log"/>
  5.   <property name="log_file_pattern" value="log/service.%d{yyyy-MM-dd}.%i.log"/>
  6.   <include resource="top/xinzhang0618/oa/logger/base.xml"/>
  8.   <springProfile name="dev,test">
  9.     <logger name="top.xinzhang0618.oa" level="debug" additivity="false">
  10.       <appender-ref ref="file_out"/>
  11.       <appender-ref ref="stdout"/>
  12.     </logger>
  13.   </springProfile>
  15.   <springProfile name="prod">
  16.     <logger name="top.xinzhang0618.oa" level="info" additivity="false">
  17.       <appender-ref ref="file_out"/>
  18.     </logger>
  19.   </springProfile>
  20. </configuration>

此外在yml中也需指定配置文件位置

  1. server:
  2.   port: 40001
  3.   servlet:
  4.     context-path: /api
  5. logging:
  6.   config: classpath:config/logback-spring.xml

BIZ接口处理

BizService, 这里提出了一些通用接口, 可以根据业务情况进一步优化

  1. package top.xinzhang0618.oa.service;
  3. import com.baomidou.mybatisplus.core.conditions.Wrapper;
  4. import com.baomidou.mybatisplus.core.metadata.IPage;
  5. import top.xinzhang0618.oa.BaseDO;
  7. import java.util.List;
  9. /**
  10.  * @author xinzhang
  11.  * @date 2020/12/2 16:35
  12.  */
  13. public interface BizService<T extends BaseDO, W extends Wrapper<T>> {
  14.     /**
  15.      * 新写入数据库记录.
  16.      *
  17.      * @return 影响的记录数
  18.      */
  19.     int create(T entity);
  21.     /**
  22.      * 根据主键来更新符合条件的数据库记录.
  23.      *
  24.      * @return 影响的记录数
  25.      */
  26.     int modify(T entity);
  28.     /**
  29.      * 根据主键删除记录.
  30.      *
  31.      * @return 影响的记录数
  32.      */
  33.     int remove(Long id);
  35.     /**
  36.      * 根据主键查询数据.
  37.      *
  38.      * @return 实体对象
  39.      */
  40.     T get(Long id);
  42.     /**
  43.      * 根据示例获取单条数据.
  44.      *
  45.      * @return 实体对象
  46.      */
  47.     T get(W w);
  49.     /**
  50.      * 查询列表.
  51.      *
  52.      * @return 实体对象列表
  53.      */
  54.     List<T> list();
  56.     /**
  57.      * 根据条件查询实体对象.
  58.      *
  59.      * @return 实体对象列表
  60.      */
  61.     List<T> list(W w);
  63.     /**
  64.      * 查询分页.
  65.      *
  66.      * @return 分页的实体对象列表
  67.      */
  68.     IPage<T> listPage( int page, int pageSize);
  70.     /**
  71.      * 根据条件查询实体对象返回分页结果.
  72.      *
  73.      * @return 分页的实体对象列表
  74.      */
  75.     IPage<T> listPage(W w, int page, int pageSize);
  76. }

AbstractService, 提供了接口的默认实现, 其中添加了日志记录

  1. package top.xinzhang0618.oa.service;
  3. import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
  4. import com.baomidou.mybatisplus.core.mapper.BaseMapper;
  5. import com.baomidou.mybatisplus.core.metadata.IPage;
  6. import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
  7. import org.springframework.beans.factory.annotation.Autowired;
  8. import top.xinzhang0618.oa.BaseDO;
  9. import top.xinzhang0618.oa.logger.ActionConstants;
  10. import top.xinzhang0618.oa.logger.BizLogger;
  12. import java.util.List;
  14. /**
  15.  * @author xinzhang
  16.  * @date 2020/12/2 15:13
  17.  */
  18. public abstract class AbstractService<M extends BaseMapper<T>, T extends BaseDO> implements BizService<T,
  19.         LambdaQueryWrapper<T>> {
  20.     @Autowired
  21.     protected M baseMapper;
  23.     /**
  24.      * 获取业务日志记录器
  25.      *
  26.      * @return 日志记录器
  27.      */
  28.     protected BizLogger getBizLogger() {
  29.         return null;
  30.     }
  32.     @Override
  33.     public int create(T entity) {
  34.         int count = baseMapper.insert(entity);
  35.         getBizLogger().log(entity.getPrimaryKey(), ActionConstants.ADD);
  36.         return count;
  37.     }
  39.     @Override
  40.     public int modify(T entity) {
  41.         int count = baseMapper.updateById(entity);
  42.         getBizLogger().log(entity.getPrimaryKey(), ActionConstants.MODIFY);
  43.         return count;
  44.     }
  46.     @Override
  47.     public int remove(Long id) {
  48.         int count = baseMapper.deleteById(id);
  49.         getBizLogger().log(id, ActionConstants.DELETE);
  50.         return count;
  51.     }
  53.     @Override
  54.     public T get(Long id) {
  55.         return baseMapper.selectById(id);
  56.     }
  58.     @Override
  59.     public T get(LambdaQueryWrapper<T> wrapper) {
  60.         return baseMapper.selectOne(wrapper);
  61.     }
  63.     @Override
  64.     public List<T> list() {
  65.         return baseMapper.selectList(new LambdaQueryWrapper<>());
  66.     }
  68.     @Override
  69.     public List<T> list(LambdaQueryWrapper<T> wrapper) {
  70.         return baseMapper.selectList(wrapper);
  71.     }
  73.     @Override
  74.     public IPage<T> listPage(int page, int pageSize) {
  75.         return baseMapper.selectPage(new Page<>(page,pageSize),new LambdaQueryWrapper<>());
  76.     }
  78.     @Override
  79.     public IPage<T> listPage(LambdaQueryWrapper<T> wrapper, int page, int pageSize) {
  80.         return baseMapper.selectPage(new Page<>(page,pageSize),wrapper);
  81.     }
  82. }

实现示例

  1. /**
  2.  * ClientService
  3.  *
  4.  * @author autoGenerate
  5.  * @version 2020-12-02
  6.  */
  7. public interface ClientService extends BizService<Client, LambdaQueryWrapper<Client>> {
  9. }
  1. /**
  2.  *  ClientServiceImpl
  3.  *
  4.  * @author autoGenerate
  5.  * @version 2020-12-02
  6.  */
  7. @Service
  8. public class ClientServiceImpl extends AbstractService<ClientMapper, Client> implements ClientService {
  10. }

日志写入ES

待补充