2.引用 lombok 使用 log

2019年10月09日 16:54 · 阅读(911) ·

开发环境

名称 版本
操作系统 Windows 10 X64
JDK JDK1.8（jdk-8u151-windows-x64）
IntelliJ IDEA IntelliJ IDEA 2018.3
Maven Maven 3.6.0
lombok 1.18.6

迁移说明

本文的内容出现了很多多余的内容，不利于快速阅读

快速了解，请参考

使用 Lombok log 管理项目日志

代码说明

本文代码基于 4.Spring Cloud-Hystrix Dashboard监控数据聚合（Turbine） 项目代码进行修改

文件结构

新增/修改下面选中的文件

test-invoice-web

test-invoice-common

pom.xml(test-invoice-clound)

新加入下面内容

  1. <properties>
  2.     <lombok.version>1.18.6</lombok.version>
  3.     <gson.version>2.8.5</gson.version>
  4.     <hutool.version>4.5.1</hutool.version>
  5. </properties>
  7. <dependencies>
  8.     <!--lombok start-->
  9.     <!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
  10.     <dependency>
  11.         <groupId>org.projectlombok</groupId>
  12.         <artifactId>lombok</artifactId>
  13.         <version>${lombok.version}</version>
  14.     </dependency>
  15.     <!--lombok end-->
  17.     <!-- 用于日志切面中，以 json 格式打印出入参（本来使用阿里的 FASTJSON, 但是对于文件上传的接口，打印参数会报错，换为 Gson） -->
  18.     <dependency>
  19.         <groupId>com.google.code.gson</groupId>
  20.         <artifactId>gson</artifactId>
  21.         <version>${gson.version}</version>
  22.     </dependency>
  23.     <dependency>
  24.         <groupId>cn.hutool</groupId>
  25.         <artifactId>hutool-all</artifactId>
  26.         <version>${hutool.version}</version>
  27.     </dependency>    
  28. </dependencies>

test-invoice-common

新增公共类-HttpUtils

  1. package com.test.invoice.util;
  3. import cn.hutool.http.Header;
  4. import cn.hutool.http.HttpRequest;
  5. import cn.hutool.http.HttpUtil;
  6. import com.alibaba.fastjson.JSON;
  7. import lombok.extern.slf4j.Slf4j;
  9. import javax.servlet.http.HttpServletRequest;
  10. import java.net.InetSocketAddress;
  11. import java.net.Proxy;
  12. import java.util.Enumeration;
  13. import java.util.HashMap;
  14. import java.util.Map;
  16. /**
  17.  * HTTP 代理工具类
  18.  * 无业务需要不要使用此代理类,直接使用hutool工具包中的httputil
  19.  *
  20.  * @author:
  21.  * @version:
  22.  * @date: 2019-10-09 16:29
  23.  */
  24. @Slf4j
  25. public class HttpUtils {
  26.     /**
  27.      * send post
  28.      *
  29.      * @param agentHost 代理地址
  30.      * @param agentPort 代理端口
  31.      * @param params    包体
  32.      * @return java.lang.String
  33.      * @author
  34.      * @description //TODO
  35.      * @date 15:42 2019/4/18
  36.      * @params * @param url
  37.      **/
  38.     public static String post(String agentUrl, String agentHost, Integer agentPort, Object params) {
  39.         return HttpRequest.post(agentUrl)
  40.                 .header(Header.USER_AGENT,
  41.                         "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/72.0.3626.121 Safari/537.36")
  42.                 .setProxy(getProxy(agentHost, agentPort)).body(JSON.toJSONString(params)).execute().body();
  43.     }
  45.     /**
  46.      * send post
  47.      *
  48.      * @param agentHost 代理地址
  49.      * @param agentPort 代理端口
  50.      * @return java.lang.String
  51.      * @author
  52.      * @description //TODO
  53.      * @date 15:43 2019/4/18
  54.      * @params * @param url
  55.      **/
  56.     public static String post(String agentUrl, String agentHost, Integer agentPort) {
  57.         return post(agentUrl, agentHost, agentPort, null);
  58.     }
  60.     /**
  61.      * send get
  62.      *
  63.      * @param agentHost 代理地址
  64.      * @param agentPort 代理端口
  65.      * @return java.lang.String
  66.      * @author
  67.      * @description //TODO
  68.      * @date 15:43 2019/4/18
  69.      * @params * @param url
  70.      **/
  71.     public static String get(String agentUrl, String agentHost, Integer agentPort, Object params) {
  72.         return HttpRequest.get(agentUrl)
  73.                 .header(Header.USER_AGENT,
  74.                         "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/72.0.3626.121 Safari/537.36")
  75.                 .setProxy(getProxy(agentHost, agentPort)).body(JSON.toJSONString(params)).execute().body();
  76.     }
  78.     /**
  79.      * send get
  80.      *
  81.      * @param agentHost 代理地址
  82.      * @param agentPort 代理端口
  83.      * @return java.lang.String
  84.      * @author
  85.      * @description //TODO
  86.      * @date 15:43 2019/4/18
  87.      * @params * @param url
  88.      **/
  89.     public static String get(String agentUrl, String agentHost, Integer agentPort) {
  90.         return get(agentUrl, agentHost, agentPort, null);
  91.     }
  93.     private static Proxy getProxy(String agentHost, Integer agentPort) {
  94.         InetSocketAddress addr = new InetSocketAddress(agentHost, agentPort);
  95.         return new Proxy(Proxy.Type.HTTP, addr);
  96.     }
  98.     /**
  99.      * 获取用户真实IP地址，不使用request.getRemoteAddr()的原因是有可能用户使用了代理软件方式避免真实IP地址,
  100.      * 可是，如果通过了多级反向代理的话，X-Forwarded-For的值并不止一个，而是一串IP值
  101.      *
  102.      * @return ip
  103.      */
  104.     public static String getIpAddr(HttpServletRequest request) {
  105.         String ip = request.getHeader("x-forwarded-for");
  106.         log.info("x-forwarded-for ip: " + ip);
  107.         if (ip != null && ip.length() != 0 && !"unknown".equalsIgnoreCase(ip)) {
  108.             // 多次反向代理后会有多个ip值，第一个ip才是真实ip
  109.             if (ip.indexOf(",") != -1) {
  110.                 ip = ip.split(",")[0];
  111.             }
  112.         }
  113.         if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
  114.             ip = request.getHeader("Proxy-Client-IP");
  115.             log.info("Proxy-Client-IP ip: " + ip);
  116.         }
  117.         if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
  118.             ip = request.getHeader("WL-Proxy-Client-IP");
  119.             log.info("WL-Proxy-Client-IP ip: " + ip);
  120.         }
  121.         if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
  122.             ip = request.getHeader("HTTP_CLIENT_IP");
  123.             log.info("HTTP_CLIENT_IP ip: " + ip);
  124.         }
  125.         if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
  126.             ip = request.getHeader("HTTP_X_FORWARDED_FOR");
  127.             log.info("HTTP_X_FORWARDED_FOR ip: " + ip);
  128.         }
  129.         if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
  130.             ip = request.getHeader("X-Real-IP");
  131.             log.info("X-Real-IP ip: " + ip);
  132.         }
  133.         if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
  134.             ip = request.getRemoteAddr();
  135.             log.info("getRemoteAddr ip: " + ip);
  136.         }
  137.         log.info("获取客户端ip: " + ip);
  138.         return ip;
  139.     }
  141.     public static Map<Object, Object> getHeaders(HttpServletRequest request) {
  142.         Map<Object, Object> headers = new HashMap();
  143.         Enumeration<String> headerNames = request.getHeaderNames();
  144.         if (headerNames != null) {
  145.             while (headerNames.hasMoreElements()) {
  146.                 String name = headerNames.nextElement();
  147.                 Enumeration<String> values = request.getHeaders(name);
  148.                 while (values.hasMoreElements()) {
  149.                     String value = values.nextElement();
  150.                     headers.put(name, value);
  151.                 }
  152.             }
  153.         }
  154.         return headers;
  155.     }
  157.     public static void main(String[] args) {
  158.         String url = "https://www.baidu.com";
  159.         String rtn = HttpUtil.get(url);//get(url, "web-proxy.tencent.com", 8080);
  160.         System.out.println("########" + rtn);
  161.     }
  162. }

新增公共类-MapperUtils

  1. package com.test.invoice.util;
  3. import org.dozer.DozerBeanMapperBuilder;
  4. import org.dozer.Mapper;
  5. import org.springframework.util.Assert;
  7. import java.util.ArrayList;
  8. import java.util.List;
  10. /**
  11.  * 对象转换类
  12.  *
  13.  * @author: v_weboyang
  14.  * @version:
  15.  * @date: 2019/3/13 18:13
  16.  */
  17. public class MapperUtils {
  18.     private static final Mapper MAPPER = DozerBeanMapperBuilder.buildDefault();
  20.     public static <T, S> T convert(S source, T target) {
  21.         if (source == null) {
  22.             return null;
  23.         }
  24.         Assert.notNull(target, "target instance required");
  25.         MAPPER.map(source, target);
  26.         return target;
  27.     }
  29.     public static <T, S> T convert(S source, Class<T> targetClass) {
  30.         if (source == null) {
  31.             return null;
  32.         }
  34.         Assert.notNull(targetClass, "targetClass required");
  35.         return MAPPER.map(source, targetClass);
  36.     }
  38.     public static <T, S> List<T> convert(List<S> source, Class<T> targetClass) {
  39.         if (source == null) {
  40.             return null;
  41.         }
  43.         List<T> targetList = new ArrayList<>();
  44.         for (S s : source) {
  45.             T target = MAPPER.map(s, targetClass);
  46.             targetList.add(target);
  47.         }
  48.         return targetList;
  49.     }
  50. }

test-invoice-web

application.yml

添加以下配置

  1. logging:
  2.   config: classpath:logback-dev.xml

新增文件-logback-dev.xml

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <configuration scan="true" scanPeriod="60 seconds" debug="false">
  3.     <contextName>logback</contextName>
  4.     <property name="log.path" value="/v_hwhao/test-invoice-cloud/logs/test-invoice-web/logs"/>
  5.     <!--输出到控制台 -->
  6.     <appender name="console"
  7.               class="ch.qos.logback.core.ConsoleAppender">
  8.         <!-- <filter class="ch.qos.logback.classic.filter.ThresholdFilter"> <level>ERROR</level>
  9.             </filter> -->
  10.         <encoder>
  11.             <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %contextName [%X{requestId}] %-5level %logger{36} - %msg%n</pattern>
  12.         </encoder>
  13.     </appender>
  15.     <!-- info日志 -->
  16.     <appender name="fileInfoLog"
  17.               class="ch.qos.logback.core.rolling.RollingFileAppender">
  18.         <!-- 过滤日志 -->
  19.         <file>${log.path}/blockchain-invoice-api.log</file>
  20.         <filter class="ch.qos.logback.classic.filter.LevelFilter">
  21.             <level>ERROR</level>
  22.             <onMatch>DENY</onMatch>  <!-- 如果命中就禁止这条日志 -->
  23.             <onMismatch>ACCEPT</onMismatch>  <!-- 如果没有命中就使用这条规则 -->
  24.         </filter>
  25.         <encoder>
  26.             <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %contextName [%X{requestId}] %-5level %logger{36} - %msg%n</pattern>
  27.         </encoder>
  28.         <!-- 滚动策略 -->
  29.         <rollingPolicy
  30.                 class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
  31.             <!-- 设置info日志路径 -->
  32.             <fileNamePattern>${log.path}/blockchain-invoice-api.logback.%d{yyyy-MM-dd}.log
  33.             </fileNamePattern>
  34.         </rollingPolicy>
  35.     </appender>
  37.     <!-- error日志 -->
  38.     <appender name="fileErrorLog"
  39.               class="ch.qos.logback.core.rolling.RollingFileAppender">
  40.         <file>${log.path}/blockchain-invoice-api.error.log</file>
  41.         <!-- 过滤日志 -->
  42.         <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
  43.             <level>ERROR</level>
  44.         </filter>
  45.         <encoder>
  46.             <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %contextName [%X{requestId}] %-5level %logger{36} - %msg%n</pattern>
  47.         </encoder>
  48.         <!-- 滚动策略 -->
  49.         <rollingPolicy
  50.                 class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
  51.             <!-- 设置error日志路径 -->
  52.             <fileNamePattern>${log.path}/blockchain-invoice-api.error.logback.%d{yyyy-MM-dd}.log
  53.             </fileNamePattern>
  54.         </rollingPolicy>
  55.     </appender>
  58.     <!-- all日志 -->
  59.     <appender name="fileAllLog"
  60.               class="ch.qos.logback.core.rolling.RollingFileAppender">
  61.         <!-- 过滤日志 -->
  62.         <file>${log.path}/blockchain-invoice-api.all.log</file>
  63.         <encoder>
  64.             <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %contextName [%X{requestId}] %-5level %logger{36} - %msg%n</pattern>
  65.         </encoder>
  66.         <!-- 滚动策略 -->
  67.         <rollingPolicy
  68.                 class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
  69.             <!-- 设置info日志路径 -->
  70.             <fileNamePattern>${log.path}/blockchain-invoice-api.all.logback.%d{yyyy-MM-dd}.log
  71.             </fileNamePattern>
  72.         </rollingPolicy>
  73.     </appender>
  76.     <root level="info">
  77.         <appender-ref ref="console"/>
  78.         <appender-ref ref="fileInfoLog"/>
  79.         <appender-ref ref="fileErrorLog"/>
  80.         <appender-ref ref="fileAllLog"/>
  81.     </root>
  83. </configuration>

TRbtTestController-Get()方法修改

  1. @Slf4j
  2. public class TRbtTestController{
  3.     @PostMapping("/Test/Get")
  4.     @ApiOperation(value = "系统框架测试-获取单个数据", httpMethod = "POST", response = ResponseVO.class, notes = "系统框架测试-获取单个数据")
  5.     public ResponseVO Get(@RequestBody TRbtTestData data){
  6.         GsonBuilder builder = new GsonBuilder();
  7.         Gson gson = builder.create();
  9.         log.info("请求方法 Get()，请求参数："+ gson.toJson(data));
  11.         ResponseVO result = testConsumer.Get(data);
  13.         log.info("请求方法 Get()，返回数据："+ gson.toJson(result));
  15.         return result;
  16.     }
  17. }

新增类-WebLogAspect

  1. package com.test.invoice.aspect;
  3. import com.google.common.collect.Maps;
  4. import com.google.gson.Gson;
  5. import com.google.gson.GsonBuilder;
  6. import com.test.invoice.util.HttpUtils;
  7. import com.test.invoice.util.Serializer;
  8. import lombok.extern.slf4j.Slf4j;
  9. import net.bytebuddy.asm.Advice;
  10. import org.aspectj.lang.JoinPoint;
  11. import org.aspectj.lang.ProceedingJoinPoint;
  12. import org.aspectj.lang.annotation.*;
  13. import org.springframework.stereotype.Component;
  14. import org.springframework.web.context.request.RequestContextHolder;
  15. import org.springframework.web.context.request.ServletRequestAttributes;
  17. import javax.servlet.http.HttpServletRequest;
  18. import java.util.Map;
  20. /**
  21.  * web 请求，响应日志记录类
  22.  *
  23.  * @author: v_hwhao
  24.  * @version:
  25.  * @date: 2019-10-09 16:25
  26.  */
  27. @Aspect
  28. @Component
  29. @Slf4j
  30. public class WebLogAspect {
  31.     ThreadLocal<Long> startTime = new ThreadLocal<>();
  32.     Map params = Maps.newLinkedHashMap();
  35.     /**
  36.      * 以 controller 包下定义的所有请求为切入点
  37.      */
  38.     @Pointcut("execution(public * com.test.invoice.controller..*.*(..))")
  39.     public void webLog() {
  40.     }
  42.     /**
  43.      * 在切点之前织入
  44.      *
  45.      * @param joinPoint
  46.      * @throws Throwable
  47.      */
  48.     @Before("webLog()")
  49.     public void doBefore(JoinPoint joinPoint) throws Throwable {
  50.         // 开始打印请求日志
  51.         startTime.set(System.currentTimeMillis());
  52.         ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
  53.         HttpServletRequest request = attributes.getRequest();
  54.         params.put("【url】", request.getRequestURL()); // 获取请求的url
  55.         params.put("【method】", request.getMethod()); // 获取请求的方式
  56.         params.put("【ip】", HttpUtils.getIpAddr(request)); // 获取请求的ip地址
  57.         params.put("【className】", joinPoint.getSignature().getDeclaringTypeName()); // 获取类名
  58.         params.put("【classMethod】", joinPoint.getSignature().getName()); // 获取类方法
  59.         params.put("【request args】", Serializer.serialize(joinPoint.getArgs())); // 请求参数
  60.     }
  62.     /**
  63.      * 在切点之后织入
  64.      *
  65.      * @throws Throwable
  66.      */
  67.     @After("webLog()")
  68.     public void doAfter() throws Throwable {
  69.         // 输出格式化后的json字符串
  70.         Gson gson = new GsonBuilder().setPrettyPrinting().create();
  71.         log.info(gson.toJson(params));
  72.         //清空每次内容
  73.         params.clear();
  74.         // 每个请求之间空一行
  75.         log.info("");
  76.     }
  78.     /**
  79.      * 环绕
  80.      *
  81.      * @param proceedingJoinPoint
  82.      * @return
  83.      * @throws Throwable
  84.      */
  85.     @Around("webLog()")
  86.     public Object doAround(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
  87.         Object result = proceedingJoinPoint.proceed();
  88.         params.put("【response args】", result); // 响应回包参数
  89.         params.put("【spend time】", (System.currentTimeMillis() - startTime.get()) + "ms"); // 响应回包参数
  90.         return result;
  91.     }
  92.     @AfterReturning(value = "webLog()", returning = "returnValue")
  93.     public void doRetrun(JoinPoint point, Object returnValue){
  95.     }
  96. }

测试

使用 Postman 访问 Get 接口

地址：http://localhost:8080/Inv/Api/Test/Get

Body raw 参数："id":"","name":"测试数据-菲克-1","version":""}

在目录 D:\v_hwhao\test-invoice-cloud\logs\test-invoice-web\logs 生成了下面文件

  1. blockchain-invoice-api.all.log
  2. blockchain-invoice-api.error.log
  3. blockchain-invoice-api.log

打开 blockchain-invoice-api.log，部分内容如下

  1. 2019-10-09 17:09:37.396 logback [] INFO  c.t.i.controller.TRbtTestController - 请求方法 Get()，请求参数：{"id":"","name":"测试数据-菲克-1","version":""}
  2. 2019-10-09 17:09:37.436 logback [] INFO  c.t.i.controller.TRbtTestController - 返回数据：{"code":2000,"msg":"Success","data":{"id":"","name":"测试数据-菲克-1","version":"1.0.1"},"timestamp":1570612177430}
  4. 2019-10-09 16:49:26.429 logback [] INFO  com.test.invoice.aspect.WebLogAspect - {
  5.   "【url】": "http://localhost:8080/Inv/Api/Test/Get",
  6.   "【method】": "POST",
  7.   "【ip】": "127.0.0.1",
  8.   "【className】": "com.test.invoice.controller.TRbtTestController",
  9.   "【classMethod】": "Get",
  10.   "【request args】": "[{\"id\":\"\",\"name\":\"测试数据-菲克-1\",\"version\":\"\"}]",
  11.   "【response args】": {
  12.     "code": 2000,
  13.     "msg": "Success",
  14.     "data": {
  15.       "id": "",
  16.       "name": "测试数据-菲克-1",
  17.       "version": "1.0.1"
  18.     },
  19.     "timestamp": 1570610966375
  20.   },
  21.   "【spend time】": "131ms"
  22. }

可以看到自定义和自动生成的日志都在里面进行记录