文章目錄

• • • • • • 1. 導入依賴
          • 2. aop攔截器
          • 3. logback配置
          • 4. 測試類
          • 5. 關鍵點
          • 6. 效果圖

1. 導入依賴

<!-- AOP --><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-aop</artifactId></dependency><!-- 數據序列化--><dependency><groupId>com.alibaba</groupId><artifactId>fastjson</artifactId><version>1.2.78</version></dependency>

2. aop攔截器

package com.course.server.config;import com.alibaba.fastjson.JSONObject; import com.alibaba.fastjson.support.spring.PropertyPreFilters; import com.course.server.util.UuidUtil; import org.aspectj.lang.JoinPoint; import org.aspectj.lang.ProceedingJoinPoint; import org.aspectj.lang.Signature; import org.aspectj.lang.annotation.Around; import org.aspectj.lang.annotation.Aspect; import org.aspectj.lang.annotation.Before; import org.aspectj.lang.annotation.Pointcut; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.slf4j.MDC; import org.springframework.stereotype.Component; import org.springframework.util.StringUtils; import org.springframework.web.context.request.RequestContextHolder; import org.springframework.web.context.request.ServletRequestAttributes; import org.springframework.web.multipart.MultipartFile;import javax.servlet.ServletRequest; import javax.servlet.ServletResponse; import javax.servlet.http.HttpServletRequest; import java.lang.reflect.Field;@Aspect @Component public class LogAspect {private final static Logger LOG = LoggerFactory.getLogger(LogAspect.class);/** 定義一個切點 */@Pointcut("execution(public * com.course.*.controller..*Controller.*(..))")public void controllerPointcut() {}@Before("controllerPointcut()")public void doBefore(JoinPoint joinPoint) throws Throwable {// 日志編號MDC.put("UUID", UuidUtil.getShortUuid());// 開始打印請求日志ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();HttpServletRequest request = attributes.getRequest();Signature signature = joinPoint.getSignature();String name = signature.getName();// 打印業務操作String nameCn = "";if (name.contains("list") || name.contains("query")) {nameCn = "查詢";} else if (name.contains("save")) {nameCn = "保存";} else if (name.contains("delete")) {nameCn = "刪除";} else {nameCn = "操作";}// 使用反射，獲取業務名稱Class clazz = signature.getDeclaringType();Field field;String businessName = "";try {field = clazz.getField("BUSINESS_NAME");if (!StringUtils.isEmpty(field)) {businessName = (String) field.get(clazz);}} catch (NoSuchFieldException e) {LOG.error("未獲取到業務名稱");} catch (SecurityException e) {LOG.error("獲取業務名稱失敗", e);}// 打印請求信息LOG.info("------------- 【{}】{}開始 -------------", businessName, nameCn);LOG.info("請求地址: {} {}", request.getRequestURL().toString(), request.getMethod());LOG.info("類名方法: {}.{}", signature.getDeclaringTypeName(), name);LOG.info("遠程地址: {}", request.getRemoteAddr());// 打印請求參數Object[] args = joinPoint.getArgs();Object[] arguments = new Object[args.length];for (int i = 0; i < args.length; i++) {if (args[i] instanceof ServletRequest|| args[i] instanceof ServletResponse|| args[i] instanceof MultipartFile) {continue;}arguments[i] = args[i];}// 排除字段，敏感字段或太長的字段不顯示String[] excludeProperties = {"shard"};PropertyPreFilters filters = new PropertyPreFilters();PropertyPreFilters.MySimplePropertyPreFilter excludefilter = filters.addFilter();excludefilter.addExcludes(excludeProperties);LOG.info("請求參數: {}", JSONObject.toJSONString(arguments, excludefilter)); // 為空的會不打印，但是像圖片等長字段也會打印}@Around("controllerPointcut()")public Object doAround(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {long startTime = System.currentTimeMillis();Object result = proceedingJoinPoint.proceed();// 排除字段，敏感字段或太長的字段不顯示String[] excludeProperties = {"password", "shard"};PropertyPreFilters filters = new PropertyPreFilters();PropertyPreFilters.MySimplePropertyPreFilter excludefilter = filters.addFilter();excludefilter.addExcludes(excludeProperties);LOG.info("返回結果: {}", JSONObject.toJSONString(result, excludefilter));LOG.info("------------- 結束 耗時：{} ms -------------", System.currentTimeMillis() - startTime);return result;}}

3. logback配置

logback.xml

<?xml version="1.0" encoding="UTF-8"?> <configuration><!-- 修改一下路徑--><property name="PATH" value="/log/imooc/course/business"></property><appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"><encoder> <!-- <Pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %highlight(%-5level) %blue(%-50logger{50}:%-4line) %green(%-8X{UUID}) %msg%n</Pattern>--><Pattern>%d{ss.SSS} %highlight(%-5level) %blue(%-30logger{30}:%-4line) %green(%-8X{UUID}) %msg%n</Pattern></encoder></appender><appender name="TRACE_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"><file>${PATH}/trace.log</file><rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"><FileNamePattern>${PATH}/trace.%d{yyyy-MM-dd}.%i.log</FileNamePattern><timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"><maxFileSize>10MB</maxFileSize></timeBasedFileNamingAndTriggeringPolicy></rollingPolicy><layout><pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %-50logger{50}:%-4line %green(%-8X{UUID}) %msg%n</pattern></layout></appender><appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"><file>${PATH}/error.log</file><rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"><FileNamePattern>${PATH}/error.%d{yyyy-MM-dd}.%i.log</FileNamePattern><timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"><maxFileSize>10MB</maxFileSize></timeBasedFileNamingAndTriggeringPolicy></rollingPolicy><layout><pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %-50logger{50}:%-4line %green(%-8X{UUID}) %msg%n</pattern></layout><filter class="ch.qos.logback.classic.filter.LevelFilter"><level>ERROR</level><onMatch>ACCEPT</onMatch><onMismatch>DENY</onMismatch></filter></appender><root level="ERROR"><appender-ref ref="ERROR_FILE" /></root><root level="TRACE"><appender-ref ref="TRACE_FILE" /></root><root level="INFO"><appender-ref ref="STDOUT" /></root> </configuration>

4. 測試類

package com.course.business.controller.admin;import com.course.server.dto.ChapterDto; import com.course.server.dto.PageDto; import com.course.server.dto.ResponseDto; import com.course.server.service.ChapterService; import com.course.server.util.ValidatorUtil; import org.springframework.web.bind.annotation.*;import javax.annotation.Resource;@RestController @RequestMapping("/admin/chapter") public class ChapterController {// 業務標識public static final String BUSINESS_NAME = "大章";@Resourceprivate ChapterService chapterService;//http://127.0.0.1:9002/business/admin/chapter/list@PostMapping("/list")public ResponseDto list(@RequestBody PageDto pageDto) {ResponseDto responseDto = new ResponseDto();chapterService.list(pageDto);responseDto.setContent(pageDto);return responseDto;}@PostMapping("/save")public ResponseDto save(@RequestBody ChapterDto chapterDto) {// 保存校驗ValidatorUtil.require(chapterDto.getName(), "名稱");ValidatorUtil.require(chapterDto.getCourseId(), "課程ID");ValidatorUtil.length(chapterDto.getCourseId(), "課程ID", 1, 8);ResponseDto responseDto = new ResponseDto();chapterService.save(chapterDto);responseDto.setContent(chapterDto);return responseDto;}@DeleteMapping("/delete/{id}")public ResponseDto delete(@PathVariable String id) {ResponseDto responseDto = new ResponseDto();chapterService.delete(id);return responseDto;} }

5. 關鍵點

LogAspect中日志key “UUID”要和logback.xml中的獲取的key UUID要一致，UUID生成規則自定義

6. 效果圖

總結

以上是生活随笔為你收集整理的SpringBoot/Cloud AOP 统一日志输出的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。