README.md · salad/EasyLog

![输入图片说明](easy-log/src/main/resources/logo/EasyLog.png)

<a href="https://gitee.com/liuhao3169/easy-log/stargazers"><img src='https://gitee.com/liuhao3169/easy-log/badge/star.svg?theme=dark' alt='star'></img></a>
<a href="https://gitee.com/liuhao3169/easy-log/members"><img src='https://gitee.com/liuhao3169/easy-log/badge/fork.svg?theme=dark' alt='fork'></img></a>
>**gitee地址**：[https://gitee.com/liuhao3169/easy-log](https://gitee.com/liuhao3169/easy-log)

**本项目已不再维护，该项目已迁移至：https://gitee.com/liuhao3169/relax/tree/master/relax-log**
# 什么是Easy Log？

Easy Log是基于Spring Boot 2.6.7开发的一款轻量级的日志脚手架，实际的业务开发中，日志是必不可少的，引入Easy Log会为你的系统提供 **接口请求日志**、**错误日志**，并且可以基于编程的方式实现 **操作的记录日志**。

Easy Log可以提供如下三种日志：

* 接口请求日志 
    * 方便开发环境中调试接口
    * 基于注解实现，可选择性的持久化接口请求日志
* 错误日志
    * 生产环境的系统错误信息会被持久化，方便排错
* 操作记录日志
    * 可以实现对业务代码0入侵的操作日志
    * 在需要的代码中调用Api即可实现操作日志

# 快速开始

## 引入pom坐标

* pom坐标
```java
<groupId>com.idea</groupId>
<artifactId>easy-log</artifactId>
<version>{easy-log.version}</version>
```

## 初始化数据库

easy_log_api表

```java
SET NAMES utf8mb4;
SET FOREIGN_KEY_CHECKS = 0;

-- ----------------------------
-- Table structure for easy_log_api
-- ----------------------------
DROP TABLE IF EXISTS `easy_log_api`;
CREATE TABLE `easy_log_api`  (
  `id` bigint(20) NOT NULL COMMENT '主键',
  `app_name` varchar(32) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci DEFAULT NULL COMMENT '服务名',
  `server_name` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci DEFAULT NULL COMMENT '服务器名',
  `app_port` int(11) DEFAULT NULL COMMENT '应用端口',
  `server_ip` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci DEFAULT NULL COMMENT '服务器IP地址',
  `env` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci DEFAULT NULL COMMENT '环境',
  `request_method` varchar(10) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci DEFAULT NULL COMMENT '请求方式',
  `request_uri` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci DEFAULT NULL COMMENT '请求URI',
  `user_agent` varchar(1000) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci DEFAULT NULL COMMENT '用户代理',
  `visitor_ip` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci DEFAULT NULL COMMENT '操作IP地址',
  `method_class` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci DEFAULT NULL COMMENT '方法类',
  `method_name` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci DEFAULT NULL COMMENT '方法名',
  `params` text CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci COMMENT '操作提交的数据',
  `time` varchar(64) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci DEFAULT NULL COMMENT '执行时间',
  `create_user` varchar(64) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci DEFAULT NULL COMMENT '创建者',
  `create_time` datetime(0) DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
  `title` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci DEFAULT '' COMMENT '日志标题',
  PRIMARY KEY (`id`) USING BTREE
) ENGINE = InnoDB CHARACTER SET = utf8mb4 COLLATE = utf8mb4_general_ci ROW_FORMAT = Dynamic;

SET FOREIGN_KEY_CHECKS = 1;

```
easy_log_error表
```sql
SET NAMES utf8mb4;
SET FOREIGN_KEY_CHECKS = 0;

-- ----------------------------
-- Table structure for easy_log_error
-- ----------------------------
DROP TABLE IF EXISTS `easy_log_error`;
CREATE TABLE `easy_log_error`  (
  `id` bigint(20) NOT NULL COMMENT '主键',
  `app_name` varchar(32) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci DEFAULT NULL COMMENT '应用名',
  `server_name` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci DEFAULT NULL COMMENT '服务器名',
  `app_port` int(11) DEFAULT NULL COMMENT '应用端口',
  `server_ip` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci DEFAULT NULL COMMENT '服务器IP地址',
  `env` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci DEFAULT NULL COMMENT '环境',
  `request_method` varchar(10) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci DEFAULT NULL COMMENT '操作方式',
  `request_uri` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci DEFAULT NULL COMMENT '请求URI',
  `user_agent` varchar(1000) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci DEFAULT NULL COMMENT '用户代理',
  `visitor_ip` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci DEFAULT NULL COMMENT '操作IP地址',
  `method_class` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci DEFAULT NULL COMMENT '方法类',
  `method_name` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci DEFAULT NULL COMMENT '方法名',
  `params` text CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci COMMENT '操作提交的数据',
  `create_user` varchar(64) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci DEFAULT NULL COMMENT '创建者',
  `create_time` datetime(0) DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
  `stack_info` text CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci COMMENT '堆栈',
  `error_name` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci DEFAULT NULL COMMENT '异常名',
  `error_message` text CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci COMMENT '异常信息',
  `error_line_number` int(11) DEFAULT NULL COMMENT '错误行数',
  `error_file_name` varchar(1000) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci DEFAULT NULL COMMENT '报错的Java文件名',
  PRIMARY KEY (`id`) USING BTREE
) ENGINE = InnoDB CHARACTER SET = utf8mb4 COLLATE = utf8mb4_general_ci ROW_FORMAT = Dynamic;

SET FOREIGN_KEY_CHECKS = 1;
```
easy_log_custom表
```java
SET NAMES utf8mb4;
SET FOREIGN_KEY_CHECKS = 0;

-- ----------------------------
-- Table structure for easy_log_custom
-- ----------------------------
DROP TABLE IF EXISTS `easy_log_custom`;
CREATE TABLE `easy_log_custom`  (
  `id` bigint(20) NOT NULL COMMENT '主键',
  `app_name` varchar(32) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci DEFAULT NULL COMMENT '服务名',
  `server_name` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci DEFAULT NULL COMMENT '服务器名',
  `app_port` int(11) DEFAULT NULL COMMENT '应用端口',
  `server_ip` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci DEFAULT NULL COMMENT '服务器IP地址',
  `env` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci DEFAULT NULL COMMENT '环境',
  `request_method` varchar(10) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci DEFAULT NULL COMMENT '操作方式',
  `request_uri` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci DEFAULT NULL COMMENT '请求URI',
  `visitor_ip` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci DEFAULT NULL COMMENT '操作IP地址',
  `method_class` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci DEFAULT NULL COMMENT '方法类',
  `method_name` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci DEFAULT NULL COMMENT '方法名',
  `user_agent` varchar(1000) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci DEFAULT NULL COMMENT '用户代理',
  `params` text CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci COMMENT '操作提交的数据',
  `create_user` varchar(64) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci DEFAULT NULL COMMENT '创建者',
  `create_time` datetime(0) DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
  `log_level` varchar(10) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci DEFAULT NULL COMMENT '日志级别',
  `log_id` varchar(100) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci DEFAULT NULL COMMENT '日志业务id',
  `log_data` text CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci COMMENT '日志数据',
  PRIMARY KEY (`id`) USING BTREE
) ENGINE = InnoDB CHARACTER SET = utf8mb4 COLLATE = utf8mb4_general_ci ROW_FORMAT = Dynamic;

SET FOREIGN_KEY_CHECKS = 1;
```
## 在application.yml文件中配置easy-log

* 开启easy log，默认为关闭状态
```java
easy-log:
  enabled: true
```

## 在项目中实现持久化日志的接口

**目前Easy Log有两种日志持久化接口：**

支持Mybatis Plus的接口 （[ v1.2.0.MP](https://gitee.com/liuhao3169/easy-log/tree/v1.2.0.MP) 版本及以上才支持该接口）

* 如果日志数据只需要简单的入库，并且项目中使用了MP的话，推荐使用该方式
* 通用接口
    * 如果不是简单的入库操作或者需要额外的扩展的话，可以使用该方式
### **支持Mybatis Plus的接口**

如果不需要额外的日志数据需要进行入库，并且项目中使用了Mybatis Plus的话，那么建议直接使用这种接口来实现日志信息持久化的逻辑。

需要分别实现如下接口：

```java
com.idea.easy.log.service.mp.IApiLogService //接口请求日志持久化接口
com.idea.easy.log.service.mp.ICustomLogService //自定义日志（操作日志）持久化接口
com.idea.easy.log.service.mp.IErrorLogService //错误日志持久化接口
```
**案例代码：**
```java
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.idea.easy.log.model.ApiLog;
import com.idea.easy.log.service.mp.IApiLogService;
import org.springframework.stereotype.Service;
/**
 * @className: ApiLogService
 * @description: 
 * @author: salad
 * @date: 2022/7/2
 **/
@Service
public class ApiLogService extends ServiceImpl<ApiLogMapper,ApiLog> implements IApiLogService {

@Override
    public void saveApiLog(ApiLog apiLog) {
        apiLog.setCreateUser("salad");
        //调用MP提供的save方法直接入库即可
        save(apiLog);
    }
}

```

### 通用接口

>[ v1.2.0.MP](https://gitee.com/liuhao3169/easy-log/tree/v1.2.0.MP)版本及以上才支持该接口
如果不是简单的入库操作或者需要额外的扩展的话，可以使用该方式

这种方式需要实现如下接口：

```java
com.idea.easy.log.service.IEasyLogService
```
**案例代码：**
```java
@Service
public class LogServiceImpl implements IEasyLogService{
    @Override
    public void saveApiLog(ApiLogModel apiLogModel) {
        //保存接口请求日志
        System.out.println("saveApiLog---->存入数据库"+apiLogModel);
    }
    @Override
    public void saveErrorLog(ErrorLogModel errorLogModel) {
        //保存错误日志
        System.out.println("saveErrorLog---->存入数据库"+errorLogModel);
    }
    @Override
    public void saveCustomLog(CustomLogModel customLogModel) {
        //保存自定义操作日志
        System.out.println("saveCustomLog---->存入数据库"+customLogModel);
    }
}
```

## 接口请求日志

**接口请求日志有两种：**

1. 控制台接口请求日志
2. 持久化接口请求日志
### 控制台接口请求日志

**介绍**

控制台接口请求日志，控制台上面打印的接口请求日志，这种日志不会持久化到数据库中，只是在控制台输出，方便在开发环境中调试接口。

**模式选择**

Easy Log对该日志提供了一些模式选择，用户可以在必要的情况下，通过选择模式来控制这种日志的输出信息量。

* 一共有四种模式
    * ALL 模式：全量模式，控制台输出请求接口地址、请求方法、请求头、请求参数、响应结果；
    * BASIC 模式：基本模式，控制台输出请求接口地址、请求方法、请求参数、响应结果；
    * SIMPLE 模式：简单模式，控制台输出请求地址、请求方法、响应结果；
    * CLOSE 模式：关闭模式，即停用该功能。
我们可以在application.yml文件中配置，来进行模式的切换，如下：

```yaml
easy-log:
  enabled: true
  console-log-mode: simple #控制台日志模式：简单模式
```

### 持久化接口请求日志

**介绍**

如果想记录某个接口的日志信息到数据库中，Easy Log提供了注解（该注解作用在方法上），用户可以选择性的将接口的日志信息持久化，注解如下：

```java
@ApiLog(value)
```
>该注解接收一个value值，一般用来描述接口的功能，但这并没有固定写法，用户可以自行定义规范
* 示例
```java
@PostMapping("/user")
@ApiLog("用户新增")
public R save(@在RequestBody User user){
    //....
    //....
    return R.success("保存成功！");
}
```

## 错误日志

正常情况下错误日志并不是手动去记录的，而是通过捕获异常的方法去自动记录日志，所以Easy Log提供了一个内置的全局异常处理器RestExceptionTranslator类，用来处理系统中的一些异常，具体的逻辑可以看下源码，该类位于如下位置：

```java
com.idea.easy.log.translator.RestExceptionTranslator;
```

## 操作日志

对于我们的业务系统，难免会需要一些操作日志，使用Easy Log如何添加操作日志呢？

Easy Log有两种添加日志的方式：

* 编程式的操作日志
* 对业务代码0入侵，基于配置文件的方式的操作日志
### **编程式的操作日志**

如果想要在系统中加入操作日志，我们可以使用如下Api：

```java
//info级别日志
EasyLogger.info("日志标识","日志信息");
//debug级别日志
EasyLogger.debug("日志标识","日志信息");
//warn级别日志
EasyLogger.warn("日志标识","日志信息");
//error级别日志
EasyLogger.error("日志标识","日志信息");
```
>日志标识：该参数没有固定的写法，一般建议为 模块名:操作名称，用户可以自行定义规则
* 示例
```java
@RestController
@RequestMapping("/user")
public class UserController {
    @Autowired
    private EasyLogger logger; //注入EasyLogger对象
    
    @PostMapping("/save")
    @ApiLog("用户新增")
    public R save(@RequestBody User user){
        //保存info级别日志
        logger.info("用户模块:新增操作","测试接口。。。。");
        return R.success("保存成功！");
    }
}
```

### **对业务代码0入侵的操作日志**

有时候我们并不想使用编程式添加操作日志，因为这样对于我们的项目有一定的耦合，而且在项目后期突然要加入操作日志，需要修改业务代码，工作量比较大。Easy Log基于配置文件的方式可以实现对业务代码0入侵的操作日志。

>该功能将于V1.3.0版本发布....

# 全部配置的属性说明

以下列出的是Easy Log全部的配置内容

```yaml
easy-log:
  enabled: true #是否启用Easy Log，默认false，如果禁用其它配置都将不生效
  error-processor: true #是否启用全局异常处理器，这个异常处理器是负责存储错误日志的，默认true
  console-log-mode: #控制台日志的模式选择，默认是ALL(全量模式)
  default-app-name: easy-log #日志记录表中应用名的备用值，当应用的spring.application.name属性不设置时将会使用它，默认是easy-log
  default-env: dev #日志记录表中默认的应用环境，当应用的spring.profiles.active属性不设置时将会使用它，默认是dev
  banner: true #是否开启控制台打印的EasyLog的Logo,默认true
```

salad/EasyLog

简介

发行版

贡献者

近期动态

salad/EasyLog .gitee-modal { width: 500px !important; }

简介

发行版

开源评估指数源自 OSS-Compass 评估体系，评估体系围绕以下三个维度对项目展开评估：

贡献者

近期动态

搜索帮助

salad/EasyLog