凯发k8天生赢家一触即发

如何用springcloud alibaba实现业务日志组件 -凯发k8天生赢家一触即发

2024-01-22

这篇文章主要介绍“如何用springcloud alibaba实现业务日志组件”,在日常操作中,相信很多人在如何用springcloud alibaba实现业务日志组件问题上存在疑惑,小编查阅了各式资料,整理出简单好用的操作方法,希望对大家解答”如何用springcloud alibaba实现业务日志组件”的疑惑有所帮助!接下来,请跟着小编一起来学习吧!

 

概述

在单体项目中如果我们需要记录操作日志一般会通过如下手段实现:

  • 建立一个自定义注解,标注业务操作类型

  • 通过aop组装日志实体,完成日志的收集工作

但是在微服务架构中我们不可能每个服务都写一个自定义注解,再写一个aop,这很明显违反了 don’t repeat yourself  精神。所以这时候我们一般都会建立一个公共的组件,在公共组件中完成日志的收集,后端服务只需要引入这个公共的组件即可。

springboot starter

要实现上述的功能我们需要借助sringboot starter来实现,springboot  的一大优势就是starter,通过starter我们可以封装公共的业务逻辑以及参数的初始化,如果你在进行微服务开发,starter的编写是一定要掌握的。

这里我们简单提一下springboot starter实现自动化配置的流程

  • spring-boot启动的时候会找到starterjar包中的resources/meta-inf/spring.factories文件,根据spring.factories文件中的配置,找到需要自动配置的类,xxxautoconfigure

  • 通过xxxautoconfigure上的注解@enableconfigurationproperties将当前模块的属性绑定到「environment」  上(若有)。

  • 通过xxxautoconfigure中定义的bean自动装配到ioc容器中。

实战

过程如下:

首先我们在项目中建立一个starter的module,如cloud-component-logging-starter

编写配置类syslogautoconfigure

@configuration public class syslogautoconfigure {      @bean     public syslogaspect controllerlogaspect(){         return new syslogaspect();     }  }

在syslogautoconfigure中我们注入了一个日志切面syslogaspect,由于日志收集工具不需要额外配置属性,所以我们也就不需要定义属性配置类了。

自定义日志注解 syslog

@target(elementtype.method) @retention(retentionpolicy.runtime) @documented public @interface syslog {  /**   * 日志内容   * @return {string}   */  string value(); }

定义日志切面 syslogaspect

@aspect public class syslogaspect {      private final logger log = loggerfactory.getlogger(this.getclass());      @pointcut("@annotation(com.javadaily.component.logging.annotation.syslog)")     public void logpointcut() {      }      @around("logpointcut()")     public object around(proceedingjoinpoint pjp) throws throwable {         methodsignature signature = (methodsignature) pjp.getsignature();         method method = signature.getmethod();        //类名         string classname = pjp.gettarget().getclass().getname();         //方法名         string methodname = signature.getname();              syslog syslog = method.getannotation(syslog.class);         //操作         string operator =syslog.value();          long begintime = system.currenttimemillis();          object returnvalue = null;         exception ex = null;         try {             returnvalue = pjp.proceed();             return returnvalue;         } catch (exception e) {             ex = e;             throw e;         } finally {             long cost = system.currenttimemillis() - begintime;             if (ex != null) {                 log.error("[class: {}][method: {}][operator: {}][cost: {}ms][args: {}][发生异常]",                         classname, methodname, operator, pjp.getargs(), ex);             } else {                 log.info("[class: {}][method: {}][operator: {}][cost: {}ms][args: {}][return: {}]",                         classname, methodname, operator, cost, pjp.getargs(), returnvalue);             }         }      } }

上面的切面表示,对于使用了@syslog注解的方法自动进行日志收集,将日志输入到日志文件。

在resource/meta-inf目录下建立spring.factories文件,加载配置类syslogautoconfigure

org.springframework.boot.autoconfigure.enableautoconfiguration=\ com.javadaily.component.logging.configure.syslogautoconfigure

在微服务中引入日志组件

     com.jianzh6.cloud     cloud-component-logging-starter     1.0.0 

在需要进行日志收集的方法上添加@syslog注解

@syslog("查找用户") public resultdata getbycode(@pathvariable(value = "accountcode") string accountcode){     log.warn("get account detail,accountcode is :{}",accountcode);      securityuser securityuser = securityutils.getuser();     log.info(securityuser);      accountdto accountdto = accountservice.selectbycode(accountcode);     return resultdata.success(accountdto); }

到此,关于“如何用springcloud alibaba实现业务日志组件”的学习就结束了,希望能够解决大家的疑惑。理论与实践的搭配能更好的帮助大家学习,快去试试吧!若想继续学习更多相关知识,请继续关注本站网站,小编会继续努力为大家带来更多实用的文章!

网站地图