首页 > 脚本专栏 > Golang > go zero微服务logx日志组件

go zero微服务框架logx日志组件剖析

2022-09-05 17:23:53 作者：阿兵云原生

这篇文章主要为大家介绍了go zero微服务框架logx日志组件剖析，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪

addTenant api 和 rpc 的实现

上一篇我们说到咱们还剩下 addTenant 功能还未实现，不知道有没有兄弟感兴趣去实验一波的，本篇文章进行简要补充

根据上一篇文章分析，其实我们只需要执行如下几步即可：

编写 tenant.api，提供外部 addTenant 的 http 接口

编写 tenant.api

提供一个 POST http 的接口 / api /tenant/addtenant

type (
        AddTenantReq {
                Name string `json:"name"`
                Addr string `json:"addr"`
        }
        AddTenantRsp {
                Id string `json:"id"`
        }
)
service tenant {
        @handler addTenant
        post /api/tenant/addtenant(AddTenantReq) returns (AddTenantRsp)

goctl 生成 api 代码

goctl api go -api tenant.api  -dir .

修改 api 的配置和逻辑层，让 api 层去调用之前写好的 rpc 接口即可

对于配置可以模仿上一篇文章 order.api 的配置进行修改，另外只需要调整 addTenant 的 logic 层即可

func (l *AddTenantLogic) AddTenant(req *types.AddTenantReq) (*types.AddTenantRsp, error) {
   // todo: add your logic here and delete this line
   rsp,err :=l.svcCtx.TenantRpc.AddTenant(l.ctx, &tenant.AddTenantReq{
      Name: req.Name,
      Addr: req.Addr,
   })
   if err !=nil{
      return nil,err
   }
   return &types.AddTenantRsp{Id: rsp.Id},nil
}

具体的代码案例可以访问地址：github.com/qingconglai…

下面我们来看是 go-zero 中日志组件 logx 的剖析

logx 日志组件剖析

对于 logx 日志组件，分别从如下几个方面来聊一聊我的理解，如果描述有不当的地方，还请多加评论多加交流

Go-zero 中 logx 是如何使用的？

Logx 基本的数据结构

Logx 的默认接口实现

Logx 日志存储位置，以及自定义存储日志位置的实现

Logx 实现自定义接口的方式

Go-zero 中 logx 是如何使用的？

我们以之前的 demo ，关于 tenant 的 rpc 部分作为例子，追踪一下代码，是如何走到日志部分的逻辑的

可以看到在 tenant.go 的文件中，做的是服务的启动

zrpc.MustNewServer 实际上是调用 go-zero 的 zrpc 包的 NewServer 函数，传入的参数是

c RpcServerConf ，我们 rpc 服务的配置，就是咱们项目中的 etc/tenant.yaml

今天不聊关于 RpcServerConf 的结构，咱们重点说说 logx

NewServer 函数做了如下几件事情：

RpcServerConf 配置数据的有效性检查

初始化 metrics 的 options

设置服务名，注册 etcd 服务，服务名就是上述配置文件中的 Name 字段

c.SetUp() 启动整个服务

对于 logx 日志组件的启动就是在 c.SetUp() 中完成

Logx 基本的数据结构

继续看到 logx.SetUp() 中的具体实现，函数需要传入的数据结构是这样的 LogConf

type LogConf struct {
   ServiceName         string `json:",optional"`
   Mode                string `json:",default=console,options=[console,file,volume]"`
   Encoding            string `json:",default=json,options=[json,plain]"`
   TimeFormat          string `json:",optional"`
   Path                string `json:",default=logs"`
   Level               string `json:",default=info,options=[info,error,severe]"`
   Compress            bool   `json:",optional"`
   KeepDays            int    `json:",optional"`
   StackCooldownMillis int    `json:",default=100"`
}