程序员的快乐如此简单

简介: 程序员的快乐如此简单

最近在GitHub上发起了一个关于Beego框架的小插件的开源仓库,这一举动虽然看似微小,但其中的快乐和意义却是无法用言语表达的。

Beego是一个开源的Go语言Web框架,它采用了MVC架构模式,并集成了很多常用的功能和中间件。小插件是指与Beego框架配套使用的、可扩展的、独立的软件模块或组件。通过开发小插件,可以扩展Beego框架的功能,提高开发效率和代码可维护性。

Beego-Requestid是一种中间件(Middleware),用于在处理HTTP请求时,为每个请求生成一个唯一的ID,并将其附加到请求上下文中。这样,您可以在应用程序的其他地方方便地访问这个唯一的请求ID,从而更好地跟踪和调试应用程序。

使用RequestId中间件可以帮助您解决以下问题:

  1. 跟踪请求:通过在每个请求中添加唯一的ID,您可以轻松地在应用程序中跟踪请求的来源和路径。这对于调试和性能优化非常有用。
  2. 日志记录:您可以使用请求ID将日志记录与特定请求关联起来。这样,当您在日志中查找特定请求的信息时,可以更方便地定位相关的日志条目。
  3. 错误处理:如果应用程序中出现错误,请求ID可以帮助您识别是哪个请求引发了错误。这对于故障排查和问题报告非常有帮助。
代码

话不多说直接看源码:

package beego_requestid
import (
  "github.com/beego/beego"
  "github.com/beego/beego/context"
  "github.com/google/uuid"
)
const DefaultHeaderReqIdKey = "X-Request-Id"
type Option func(config *Config)
type GenRequestIdFunc func() string
type Config struct {
  genRequestIdFunc               GenRequestIdFunc
  headerReqIdKey, customReqIdKey string
}
func NewFilter(opts ...Option) beego.FilterFunc {
  cnf := &Config{
    genRequestIdFunc: DefaultGenRequestIdFunc,
    headerReqIdKey:   DefaultHeaderReqIdKey,
  }
  for _, opt := range opts {
    opt(cnf)
  }
  return func(c *context.Context) {
    reqId := c.Request.Header.Get(cnf.headerReqIdKey)
    if reqId == "" {
      reqId = cnf.genRequestIdFunc()
      c.Request.Header.Add(cnf.headerReqIdKey, reqId)
    }
    if cnf.customReqIdKey != "" {
      c.Input.SetData(cnf.customReqIdKey, reqId)
    }
  }
}
func WithGenRequestIdFunc(genFunc GenRequestIdFunc) Option {
  return func(config *Config) {
    config.genRequestIdFunc = genFunc
  }
}
func WithHeaderReqIdKey(key string) Option {
  return func(config *Config) {
    config.headerReqIdKey = key
  }
}
func WithCustomReqIdKey(key string) Option {
  return func(config *Config) {
    config.customReqIdKey = key
  }
}
func DefaultGenRequestIdFunc() string {
  return uuid.NewString()
}

使用示例:

package main
import (
  "log"
  "time"
  "github.com/spf13/cast"
  "github.com/beego/beego"
  "github.com/beego/beego/context"
  beego_requestid "github.com/ibarryyan/beego-requestid"
)
func example1() {
  beego.InsertFilter("/*", beego.BeforeRouter, beego_requestid.NewFilter())
  beego.Get("/hello", func(c *context.Context) {
    reqId := c.Request.Header.Get("X-Request-Id")
    log.Printf("reqestid = %s", reqId)
    _, _ = c.ResponseWriter.Write([]byte("hello..."))
    return
  })
  beego.Run(":9900")
}
func example2() {
  beego.InsertFilter("/*", beego.BeforeRouter, beego_requestid.NewFilter(
    beego_requestid.WithGenRequestIdFunc(func() string {
      return cast.ToString(time.Now().Unix())
    }),
    beego_requestid.WithHeaderReqIdKey("my_header_reqid"),
    beego_requestid.WithCustomReqIdKey("my_reqid"),
  ))
  beego.Get("/hello", func(c *context.Context) {
    reqId := c.Request.Header.Get("my_header_reqid")
    log.Printf("reqestid = %s", reqId)
    cReqId := c.Input.GetData("my_reqid")
    log.Printf("my reqestid = %s", cReqId)
    _, _ = c.ResponseWriter.Write([]byte("hello..."))
    return
  })
  beego.Run(":9900")
}

此外,前端请求时需要带上header key要与后端的一致

获得快乐

发完代码后我就直接去Beego的GitHub仓库下提了一个issue,来分享的研究的中间件,地址:https://github.com/beego/beego/issues/5419,后来没想到竟然收到了回复,哈哈哈

然后我立马就去新的issue分享了我的插件

https://github.com/beego/beego/issues/5421

再后来,我就有两个star了~

仓库地址

https://github.com/ibarryyan/beego-requestid

相关实践学习
日志服务之使用Nginx模式采集日志
本文介绍如何通过日志服务控制台创建Nginx模式的Logtail配置快速采集Nginx日志并进行多维度分析。
相关文章
|
5月前
|
JavaScript Java 大数据
转行程序员4年半,被裁了
转行程序员4年半,被裁了
|
运维 程序员
Hi程序员,你幸福吗?
Hi程序员,你幸福吗?
学习使我快乐
那么就可以通过对两个序列进行遍历,把遍历过的数据存放在另一个空间中,而剩下来的序列直接就可以放进另一个空间内,是因为它是有序的特点,决定它可以直接放进去。
65 0
|
开发框架 安全 程序员
我编程,我快乐,献给所有的程序员
  最近读了《我编程,我快乐》,里面有一些观点给我了不少启发,特别是一些职业规划的方面的内容。   我编程,我快乐,献给所有的程序员   如果生活的大部分时间都被工作占据着,那么热爱工作就是热爱生活。 比起那些枯燥的简单任务,充满挑战、有驱动力、有回报的工作更能让你有动力在清晨从温暖的被窝里爬起来。工作做得好意味着你在充分发挥着才能。相反,如果工作做得不好,就证明你大部分时间都只能在懊悔,懊悔自己碌碌无为。
146 0
程序员的快乐就是这么朴素无华且枯燥
前言 只有光头才能变强。 文本已收录至我的GitHub仓库,欢迎Star:https://github.com/ZhongFuCheng3y/3y 我是一个程序员,外行人都以为我是修电脑的,我笑了笑,随意ctrl c+ctrl v了一把,想象着你们因为我的文章而开心不止,我感到充实而欣慰。
1022 0
|
新零售 架构师 程序员
|
大数据 Java 程序员
程序员,为什么如此迷茫?
作为程序员,一个是担心年纪大了以后找工作比较麻烦,毕竟国内不像国外,企业都希望年轻力壮的小伙子去扛,因为他们身体好,能熬夜。
1015 0

相关实验场景

更多