go-zero微服务实战系列（CRUD热热身）

go-zero微服务实战系列（CRUD热热身）

日志定义

go-zero的 ​ ​logx​​ 包提供了日志功能，默认不需要做任何配置就可以在stdout中输出日志。当我们请求/v1/order/list接口的时候输出日志如下，默认是json格式输出，包括时间戳，http请求的基本信息，接口耗时，以及链路追踪的span和trace信息。

{"@timestamp":"2022-06-11T08:23:36.342+08:00","caller":"handler/loghandler.go:197","content":"[HTTP] 200 - GET /v1/order/list?uid=123 - 127.0.0.1:59998 - Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.0.0 Safari/537.36","duration":"21.2ms","level":"info","span":"23c4deaa3432fd03","trace":"091ffcb0eafe7818b294e4d8122cf8a1"}

程序启动后，框架会默认输出level为stat的统计日志，用于输出当前资源的使用情况，主要为cpu和内存，内容如下：

{"@timestamp":"2022-06-11T08:34:58.402+08:00","caller":"stat/usage.go:61","content":"CPU: 0m, MEMORY: Alloc=3.3Mi, TotalAlloc=7.0Mi, Sys=16.3Mi, NumGC=8","level":"stat"}

.
当我们不需要这类日志的时候，我们可以通过如下方式关闭该类日志的输出：

logx.DisableStat()

有的时候我们只需要记录错误日志，可以通过设置日志等级来取消level为info级别日志的输出：

logx.SetLevel(logx.ErrorLevel)
.
可以扩展日志输出的字段，添加了uid字段记录请求的用户的uid，日志打印内容如下：

logx.Infow("order list", logx.Field("uid",req.UID))

.

{"@timestamp":"2022-06-11T08:53:50.609+08:00","caller":"logic/orderlistlogic.go:31","content":"order list","level":"info","uid":123}

我们还可以扩展其他第三方日志库，通过logx.SetWriter来进行设置

writer := logrusx.NewLogrusWriter(func(logger *logrus.Logger) {
    logger.SetFormatter(&logrus.JSONFormatter{})
})
logx.SetWriter(writer)

同时logx还提供了丰富的配置，可以配置日志输出模式，时间格式，输出路径，是否压缩，日志保存时间等

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"`
}

可以看到logx提供的日志功能还是非常丰富的，同时支持了各种自定义的方式。日志是我们排查线上问题非常重要的依赖，我们还会根据日志做各种告警，所以这里我们先做了一些日志使用的介绍。

服务依赖

在BFF服务中会依赖多个RPC服务，默认情况下，如果依赖的RPC服务没有启动，BFF服务也会启动异常，报错如下，通过日志可以知道是因为order.rpc没有启动，因为order.rpc是整个商城系统的核心服务，BFF对order.rpc是强依赖，在强依赖的情况下如果被依赖服务异常，那么依赖服务也无法正常启动。

{"@timestamp":"2022-06-11T10:21:56.711+08:00","caller":"internal/discovbuilder.go:34","content":"bad resolver state","level":"error"}
2022/06/11 10:21:59 rpc dial: discov://127.0.0.1:2379/order.rpc, error: context deadline exceeded, make sure rpc service "order.rpc" is already started
exit status 1

再看如下的场景，BFF依赖reply.rpc，因为reply.rpc异常导致BFF无法正常启动，由于reply.rpc并不是商城系统的核心依赖，就算reply.rpc挂掉也不影响商城的核心流程，所以对于BFF来说reply.rpc是弱依赖，在弱依赖的情况下不应该影响依赖方的启动。

{"@timestamp":"2022-06-11T11:26:51.711+08:00","caller":"internal/discovbuilder.go:34","content":"bad resolver state","level":"error"}
2022/06/11 11:26:54 rpc dial: discov://127.0.0.1:2379/reply.rpc, error: context deadline exceeded, make sure rpc service "reply.rpc" is already started
exit status 1

.
在go-zero中提供了弱依赖的配置，配置后BFF即可正常启动，可以看到order.rpc和product.rpc都是强依赖，而reply.rpc配置了NonBlock:true为弱依赖

OrderRPC:
    Etcd:
        Hosts:
          - 127.0.0.1:2379
        Key: order.rpc
ProductRPC:
  Etcd:
    Hosts:
      - 127.0.0.1:2379
    Key: product.rpc
ReplyRPC:
  Etcd:
    Hosts:
      - 127.0.0.1:2379
    Key: reply.rpc
  NonBlock: true

.
并行调用
在高并发的系统中，接口耗时是我们非常关注的点，接口快速响应可以提升用户体验，长时间的等待会让用户体验很差，用户也就会慢慢的离开我们。这里我们介绍简单但很实用的提升接口响应时间的方法，那就是并行的依赖调用。

下图展示了串行调用和并行调用的区别，串行调用依赖的话，耗时等于所有依赖耗时的和，并行调用依赖的话，耗时等于所有依赖中耗时最大的一个依赖的耗时。

在获取商品详情的接口中，参数ProductIds为逗号分隔的多个商品id，在这里我们使用go-zero提供的mapreduce来并行的根据商品id获取商品详情，代码如下，详细代码请参考product-rpc服务：

func (l *ProductsLogic) Products(in *product.ProductRequest) (*product.ProductResponse, error) {
    products := make(map[int64]*product.ProductItem)
    pdis := strings.Split(in.ProductIds, ",")
    ps, err := mr.MapReduce(func(source chan<- interface{}) {
        for _, pid := range pdis {
            source <- pid
        }
    }, func(item interface{}, writer mr.Writer, cancel func(error)) {
        pid := item.(int64)
        p, err := l.svcCtx.ProductModel.FindOne(l.ctx, pid)
        if err != nil {
            cancel(err)
            return
        }
        writer.Write(p)
    }, func(pipe <-chan interface{}, writer mr.Writer, cancel func(error)) {
        var r []*model.Product
        for p := range pipe {
            r = append(r, p.(*model.Product))
        }
        writer.Write(r)
    })
    if err != nil {
        return nil, err
    }
    for _, p := range ps.([]*model.Product) {
        products[p.Id] = &product.ProductItem{
            ProductId: p.Id,
            Name:      p.Name,
        }
    }
    return &product.ProductResponse{Products: products}, nil
}

.
在商品详情页，不仅展示了商品的详情，同时页展示了商品评价的第一页，然后点击评价详情可以跳转到评价详情页，为了避免客户端同时请求多个接口，所以我们在商品详情页把评论首页的内容一并返回，因为评论内容并不是核心内容所以在这里我们还做了降级，即请求reply.rpc接口报错我们会忽略这个错误，从而能让商品详情正常的展示。因为获取商品详情和商品评价没有前后依赖关系，所以这里我们使用mr.Finish来并行的请求来降低接口的耗时。

func (l *ProductDetailLogic) ProductDetail(req *types.ProductDetailRequest) (resp *types.ProductDetailResponse, err error) {
    var (
        p *product.ProductItem
        cs *reply.CommentsResponse
    )
    if err := mr.Finish(func() error {
        var err error
        if p, err = l.svcCtx.ProductRPC.Product(l.ctx, &product.ProductItemRequest{ProductId: req.ProductID}); err != nil {
            return err
        }
        return nil
    }, func() error {
        var err error
        if cs, err = l.svcCtx.ReplyRPC.Comments(l.ctx, &reply.CommentsRequest{TargetId: req.ProductID}); err != nil {
            logx.Errorf("get comments error: %v", err)
        }
        return nil
    }); err != nil {
        return nil, err
    }
    var comments []*types.Comment
    for _, c := range cs.Comments {
        comments = append(comments, &types.Comment{
            ID: c.Id,
            Content:   c.Content,
        })
    }
    return &types.ProductDetailResponse{
        Product: &types.Product{
            ID:        p.ProductId,
            Name:      p.Name,
        },
        Comments: comments,
    }, nil
}

图片上传

图片上传是非常常用的功能，我们在product-admin中需要上传商品图片，这里我们把商品图片上传到阿里云OSS中，api定义如下

syntax = "v1"

type UploadImageResponse {
    Success bool `json:"success"`
}

service admin-api {
    @handler UploadImageHandler
    post /v1/upload/image() returns (UploadImageResponse)
}

在admin-api.yaml中添加如下配置

Name: admin-api
Host: 0.0.0.0
Port: 8888
OSSEndpoint: https://oss-cn-hangzhou.aliyuncs.com
AccessKeyID: xxxxxxxxxxxxxxxxxxxxxxxx
AccessKeySecret: xxxxxxxxxxxxxxxxxxxxxxxx

复制代码

添加OSS客户端

type ServiceContext struct {
    Config config.Config
    OssClient *oss.Client
}

func NewServiceContext(c config.Config) *ServiceContext {
    oc, err := oss.New(c.OSSEndpoint, c.AccessKeyID, c.AccessKeySecret)
    if err != nil {
        panic(err)
    }
    return &ServiceContext{
        Config: c,
        OssClient: oc,
    }
}

上传逻辑需要先获取bucket，该bucket为预先定义的bucket，可以通过api调用创建，也可以在阿里云工作台手动创建

func (l *UploadImageLogic) UploadImage() (resp *types.UploadImageResponse, err error) {
    file, header, err := l.r.FormFile(imageFileName)
    if err != nil {
        return nil, err
    }
    defer file.Close()
    bucket, err := l.svcCtx.OssClient.Bucket(bucketName)
    if err != nil {
        return nil, err
    }
    if err = bucket.PutObject(header.Filename, file); err != nil {
        return nil, err
    }
    return &types.UploadImageResponse{Success: true}, nil
}