springboot项目使用@LogRecord注解统一打印日志

我们在工作中无论如何都会使用到日志打印的需求，如果公司没有一个统一的日志采集平台，同时没有相关的规范的话，大家打印日志的话就会是这种方式，五花八门，例如：

对于上面这种日志的话，我们使用起来，如果系统出现问题，我们只能去服务器上查看log，并且这种log文件没有一个统一的标准，因此看起来非常的费劲，那么我们有没有什么好点的办法来统一规划一下日志，后期我们通过工具把这些日志采集到我们的平台里面去，然后通过搜索的功能，把对应的日志找出来即可。是不是很方便呢？

今天我们就来介绍下，使用日志框架统一采集日志，把日志全部做成对应的固定格式，后期我们再通过工具把日志存放到elasticsearch里面通过kibana可视化查询。下面直接进入正题。

使用的框架是：

bizlog-sdk

这个框架已经自定义了切面，我们直接拿过来用即可。下面介绍下如何使用。

一、创建一个类型为spring-boot的maven项目，并且添加如下依赖：

                <dependency>
			<groupId>org.projectlombok</groupId>
			<artifactId>lombok</artifactId>
			<version>1.14.8</version>
			<scope>provided</scope>
		</dependency>
		<dependency>
			<groupId>org.bgee.log4jdbc-log4j2</groupId>
			<artifactId>log4jdbc-log4j2-jdbc4.1</artifactId>
			<version>1.16</version>
		</dependency>

		<dependency>
			<groupId>io.github.mouzt</groupId>
			<artifactId>bizlog-sdk</artifactId>
			<version>3.0.1</version>
		</dependency>
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-context</artifactId>
		</dependency>

上面我们的依赖有点多，其实最主要的是添加bizlog-sdk这个依赖，同时由于可能会涉及到使用spring的el表达式，因此还需要添加spring-context的依赖。

二、向springboot的Application启动类添加注解

@EnableLogRecord(tenant = "com.log.demo")

添加的这个注解里面有一个tennant的值，主要是用来区分我们的项目或者业务的，常用的命名我们一般填写项目名即可。

三、在接口或者方法的地方添加注解

@LogRecord

示例如下：

@RequestMapping("/hello")
	@LogRecord(fail = "用户访问失败了", success = "{{#name}} 访问了hello接口，返回结果是：,{{#result}}", type = LogRecordType.HELLO, bizNo = "{{#requestId}}")
	public String hello(String requestId, String name) {
		String result = name + ",Hello World!";
		LogRecordContext.putVariable("result", result);
		return result;
	}

四、启动项目，进行测试

访问：http://localhost:8080/hello?requestId=1&name=zhangsan

可以看到有具体日志打印出来。

此时我们就很容易的实现了日志打印的效果。

下面我们介绍下bizlog-sdk的详细使用教程。

1、在使用bizlog-sdk的时候，他的核心记录日志的注解是：@LogRecord，这个注解里面有哪些属性呢？

2、打印输出的实体信息

3、关于取值的问题

在使用@LogRecord注解的时候，很多变量我们需要从方法里面去取值，那么怎么取呢？

1）所有的取值都必须添加 {{#变量名}}，即双重大括号再加井号再加变量名为准。

2）如果去方法的传递参数可以直接取即可。

3）如果需要取方法内部的临时变量的值，则取值方式一样，但是需要在方法里面注册变量，例如：

LogRecordContext.putVariable("result", result);

4）如果变量是对象的话，需要取对象的属性值，则这么来取

{{#user.name}}

直接使用对象名.属性名即可。这也是spring的el表达式取值法。

备注：

1、使用此工具类的话，springboot需要使用2.x的版本，不然启动项目会报错 classnotfount。

当然最后我们提供下案例源码的下载，登录下即可看到