字节微服务HTTP框架Hertz使用与源码分析|拥抱开源

这篇具有很好参考价值的文章主要介绍了字节微服务HTTP框架Hertz使用与源码分析|拥抱开源。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

一、前言

大家好,这里是白泽,今天介绍一个自己参与过一些维护的 HTTP 框架。

Hertz[həːts] 是一个 Golang 微服务 HTTP 框架,在设计之初参考了其他开源框架 fasthttp、gin、echo 的优势, 并结合字节跳动内部的需求,使其具有高易用性、高性能、高扩展性等特点,目前在字节跳动内部已广泛使用。 如今越来越多的微服务选择使用 Golang,如果对微服务性能有要求,又希望框架能够充分满足内部的可定制化需求,Hertz 会是一个不错的选择。

对于源码该如何阅读,本身就值得思考。这篇文章我将以第一次阅读Hertz源码的视角,分享自己的思考过程,也借此梳理一下自己阅读源码的方法论。

接下来需要你对应打开Hertz的官方文档,以及在本地克隆Hertz的代码仓库,我们开始吧。

Hertz仓库地址:https://github.com/cloudwego/hertz

Hertz文档地址:https://www.cloudwego.io/zh/docs/hertz/getting-started/

二、架构设计

字节微服务HTTP框架Hertz使用与源码分析|拥抱开源,golang,微服务,http,开源

这是一张Hertz官方文档的架构设计图,图中的一个个组件对应hertz源码包内的一个个package文件夹,实现了对应的功能,如下:

字节微服务HTTP框架Hertz使用与源码分析|拥抱开源,golang,微服务,http,开源

三、快速开始

接下来按照文档的指示,通过hertz的命令行工具初始化一个最简单的hertz项目,先观其形,再会其意。

对应文档地址:https://www.cloudwego.io/zh/docs/hertz/getting-started/

# 安装hertz的命令行工具,用于生成hertz初始代码
go install github.com/cloudwego/hertz/cmd/hz@latest
# 通过hz工具生成代码,如果创建的项目不在GOPATH/src路径下,则需要额外声明-module参数
hz new -module hertz-study

字节微服务HTTP框架Hertz使用与源码分析|拥抱开源,golang,微服务,http,开源

此时按照文档指示,对项目进行编译运行可以访问这个HTTP服务了,它默认实现了一个/ping接口。

curl http://127.0.0.1:8888/ping
# 响应
{"message":"pong"}% 

四、源码解析

server概览

首先看一下main.go函数,这是hertz服务的启动入口,大概可以猜测内容是:1. 初始化了一个默认的hz服务;2. 完成了一些注册工作;3. 启动hz服务(HTTP服务)。

func main() {
   h := server.Default()register(h)
   h.Spin()
}

回想刚刚这个 http://127.0.0.1:8888/ping 的接口服务,它所声明的IP和Port并未由你手动指定,并且/ping接口也不是你编写的,或许是这个server.Default()的作用。

反之我如果需要指定HTTP服务启动的各种定制化的配置,是否是给这个server.Default()传参数?又或者是换一个创建h的方法?

Default()

// Default creates a hertz instance with default middlewares.
func Default(opts ...config.Option) *Hertz {
   h := New(opts...)
   h.Use(recovery.Recovery())return h
}

查看Default()方法,发现确实可以传入参数(猜测就是可以自定义配置的内容),然后我们进一步分析New方法的内容,它接受了一个不定长度的Option数组为参。

// Option is the only struct that can be used to set Options.
type Option struct {
  F func(o *Options)
}// New creates a hertz instance without any default config.
func New(opts ...config.Option) *Hertz {
  options := config.NewOptions(opts)
  h := &Hertz{
    Engine: route.NewEngine(options),
  }
  return h
}

接着我们再进入config.NewOptions方法观察这个Option切片将如何把我们自定义的内容应用到Hertz服务的初始化上去。

func NewOptions(opts []Option) *Options {
   options := &Options{
      KeepAliveTimeout: defaultKeepAliveTimeout,
      ReadTimeout: defaultReadTimeout,
      IdleTimeout: defaultReadTimeout,
      RedirectTrailingSlash: true,
      RedirectFixedPath: false,
      HandleMethodNotAllowed: false,
      UseRawPath: false,
      RemoveExtraSlash: false,
      UnescapePathValues: true,
      DisablePreParseMultipartForm: false,
      Network: defaultNetwork,
      Addr: defaultAddr,
      MaxRequestBodySize: defaultMaxRequestBodySize,
      MaxKeepBodySize: defaultMaxRequestBodySize,
      GetOnly: false,
      DisableKeepalive: false,
      StreamRequestBody: false,
      NoDefaultServerHeader: false,
      ExitWaitTimeout: defaultWaitExitTimeout,
      TLS: nil,
      ReadBufferSize: defaultReadBufferSize,
      ALPN: false,
      H2C: false,
      Tracers: []interface{}{},
      TraceLevel: new(interface{}),
      Registry: registry.NoopRegistry,
   }
   // 将自定义配置应用上去的方法
   options.Apply(opts)
   return options
}func (o *Options) Apply(opts []Option) {
  for _, op := range opts {
    op.F(o)
  }
}

通过观察config.NewOptions源码,它首先初始化了一个Options结构,这个结构存放了Hertz服务的各种初始化信息,此时的Options的各个属性都是默认固定的,直到调用了options.Apply(opts)方法,将自定义的配置应用上去。

并且应用上去的方式很特别,它将这个默认创建的Options结构的指针作为参数传递给每一个你声明的Option的F方法,通过F方法的调用去为Options结构赋值,因为是指针,自然能将所有的赋值应用到同一个Options上去。

而具体的Option的F方法如何定义,则可以灵活实现,这也是Hertz拥有良好扩展性的原因之一。

// Default creates a hertz instance with default middlewares.
func Default(opts ...config.Option) *Hertz {
  // h是*Hertz类型,是框架的核心结构
   h := New(opts...)
   h.Use(recovery.Recovery())return h
}

此时注意到还有一个h.Use(recovery.Recovery())方法,写法很像是gin框架的中间件使用方式。

// Recovery returns a middleware that recovers from any panic and writes a 500 if there was one.
func Recovery() app.HandlerFunc {
   return func(c context.Context, ctx *app.RequestContext) {
      defer func() {
         if err := recover(); err != nil {
            stack := stack(3)
​
            hlog.CtxErrorf(c, "[Recovery] %s panic recovered:\n%s\n%s\n",
               timeFormat(time.Now()), err, stack)
            ctx.AbortWithStatus(consts.StatusInternalServerError)
         }
      }()
      ctx.Next(c)
   }
}

通过阅读注释确实发现这是个中间件,用于从panic中recover。

register()

func main() {
   h := server.Default()register(h)
   h.Spin()
}

回到最初的main方法中,经过分析我们知道了Default方法大致完成了默认(自定义)Hertz结构的声明,下面看一下register函数的内容

// register registers all routers.
func register(r *server.Hertz) {
​
   router.GeneratedRegister(r)customizedRegister(r)
}// GeneratedRegister registers routers generated by IDL.
func GeneratedRegister(r *server.Hertz) {
  //INSERT_POINT: DO NOT DELETE THIS LINE!
}// customizeRegister registers customize routers.
func customizedRegister(r *server.Hertz) {
  r.GET("/ping", handler.Ping)// your code ...
}

register(h)的工作是路由注册(也就是接口的声明),内部完成了两种类型的注册,GeneratedRegister()的注释指出这部分路由是由IDL生成的,关于IDL先卖个关子,你只要知道IDL描述了接口交互的结构。

customizedRegister()则是用于注册自定义的路由接口,并且初始化了一个你熟悉的/ping,当然也你可以在这里注册自己需要的路由,使用的方式也与gin很相似。

Spin()

最后分析一下main方法中的的第三部分,Spin方法。

// Spin runs the server until catching os.Signal or error returned by h.Run().
func (h *Hertz) Spin() {
   errCh := make(chan error)
   h.initOnRunHooks(errCh)
   go func() {
      // 核心方法
      errCh <- h.Run()
   }()
​
   signalWaiter := waitSignal
   if h.signalWaiter != nil {
      signalWaiter = h.signalWaiter
   }if err := signalWaiter(errCh); err != nil {
      hlog.Errorf("HERTZ: Receive close signal: error=%v", err)
      if err := h.Engine.Close(); err != nil {
         hlog.Errorf("HERTZ: Close error=%v", err)
      }
      return
   }
​
   hlog.Infof("HERTZ: Begin graceful shutdown, wait at most num=%d seconds...", h.GetOptions().ExitWaitTimeout/time.Second)
​
   ctx, cancel := context.WithTimeout(context.Background(), h.GetOptions().ExitWaitTimeout)
   defer cancel()if err := h.Shutdown(ctx); err != nil {
      hlog.Errorf("HERTZ: Shutdown error=%v", err)
   }
}

完成了一系列的初始化和声明操作之后,Spin()负责触发Hertz的运行,并且处理运行过程中的各种异常。其核心是errCh <- h.Run()

func (engine *Engine) Run() (err error) {
   if err = engine.Init(); err != nil {
      return err
   }if !atomic.CompareAndSwapUint32(&engine.status, statusInitialized, statusRunning) {
      return errAlreadyRunning
   }
   defer atomic.StoreUint32(&engine.status, statusClosed)// trigger hooks if any
   ctx := context.Background()
   for i := range engine.OnRun {
      if err = engine.OnRun[i](ctx); err != nil {
         return err
      }
   }return engine.listenAndServe()
}

再看到末尾的engine.listenAndServe()方法,这是一个接口,查看其实现类,发现可以追溯到standard和netpoll两个包。

字节微服务HTTP框架Hertz使用与源码分析|拥抱开源,golang,微服务,http,开源

作为一个HTTP服务,最重要的就是提供网络通信交互能力,Hertz使用了可插拔的自研网络库netpoll负责网络通信,进一步优化了性能,这部分也将在后续的文章着重分析。

至此Hertz服务开始运行,你可以通过控制台请求:

curl http://127.0.0.1:8888/ping
{"message":"pong"}% 

五、小结

使用hz工具生成最简易的Hertz代码后,本文粗浅地分析了main方法的内容,将其分为三个部分,服务配置声明Default()、路由注册register()、HTTP服务启动Spin()

虽然没有提及Hertz框架架构图当中的各种类型的package,但是其实处处有它们的身影,后续文章将以此文为基础,深入分析框架的各个功能组件,揭开Hertz的神秘面纱。

感兴趣可以关注公众号 「白泽talk」,白泽目前也打算打造一个氛围良好的行业交流群,文章的更新也会提前预告,欢迎加入:622383022。文章来源地址https://www.toymoban.com/news/detail-804388.html

到了这里,关于字节微服务HTTP框架Hertz使用与源码分析|拥抱开源的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • C++轻量级Web服务器TinyWebServer源码分析之http篇

    http类这篇个人觉得是最难同时也是最繁琐的一篇,本篇在基础知识方面,包括epoll、HTTP报文格式、状态码和有限状态机,不做赘述,所有源码分析的篇章基础知识会做单开一篇或者读者可以看 小白一文看懂社长服务器 来补基础知识。真的佩服那个叫社长的男人,我读代码且

    2024年02月10日
    浏览(48)
  • 小研究 - Android 字节码动态分析分布式框架(五)

    安卓平台是个多进程同时运行的系统,它还缺少合适的动态分析接口。因此,在安卓平台上进行全面的动态分析具有高难度和挑战性。已有的研究大多是针对一些安全问题的分析方法或者框架,无法为实现更加灵活、通用的动态分析工具的开发提供支持。此外,很多研究只是

    2024年02月10日
    浏览(43)
  • 小研究 - Android 字节码动态分析分布式框架(四)

    安卓平台是个多进程同时运行的系统,它还缺少合适的动态分析接口。因此,在安卓平台上进行全面的动态分析具有高难度和挑战性。已有的研究大多是针对一些安全问题的分析方法或者框架,无法为实现更加灵活、通用的动态分析工具的开发提供支持。此外,很多研究只是

    2024年02月12日
    浏览(92)
  • 【Tars-go】腾讯微服务框架学习使用02-- http 服务

    官方文档说http这里是在net/http原生包的基础上做了修改。 官方给的案例: 可以看到 在初始化了 TarsHttpMux , 再将 TarsHttpMux 注册到tars框架中作为servant就可以启动http服务。 TarsHttpMux 是什么: 可以看出 TarsHttpMux 确实就只是对 http.ServeMux 做了个包装加入了 Conf 并加入了上报状态信

    2024年04月16日
    浏览(41)
  • http服务(Apache 2.4.57)源码编译及使用

    这里安装的是Apache 2.4.57版本 下载地址

    2024年02月11日
    浏览(39)
  • Android 计时器Chronometer 使用及源码分析(1),android音视频框架

    @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_textview_chronometer);//加载布局文件 initView(); } private void initView() { btn_start = findViewById(R.id.btn_start); btn_stop = findViewById(R.id.btn_stop); btn_reset = findViewById(R.id.btn_reset); chronome

    2024年04月14日
    浏览(49)
  • 基于 Hertz 和 Kitex 的 Go 微服务项目 | 开源项目推荐

    FreeCar 是一个基于 Hertz 与 Kitex 的全栈微服务项目,欢迎 Star。 项目地址:CyanAsterisk/FreeCar Hertz 是一个超大规模的企业级微服务 HTTP 框架,具有高易用性、易扩展、低时延等特点。 Hertz 默认使用自研的高性能网络库 Netpoll,在一些特殊场景中,相较于 go net,Hertz 在 QPS、时延上

    2024年02月07日
    浏览(34)
  • 【微服务】Spring条件注解从使用到源码分析详解

    🎉欢迎来到架构设计专栏~【微服务】Spring条件注解从使用到源码分析详解 ☆* o(≧▽≦)o *☆嗨~我是IT·陈寒🍹 ✨博客主页:IT·陈寒的博客 🎈该系列文章专栏:架构设计 📜其他专栏:Java学习路线 Java面试技巧 Java实战项目 AIGC人工智能 数据结构学习 🍹文章作者技术和水平

    2024年02月08日
    浏览(39)
  • 【微服务】spring 条件注解从使用到源码分析详解

    目录 一、前言 二、spring 条件注解概述 2.1 条件注解@Conditional介绍 2.2 @Conditional扩展注解

    2024年02月11日
    浏览(42)
  • Web端服务器推送技术原理分析及dwr框架简单的使用(1)

    随着 Ajax技术的兴起,让广大开发人员又一次看到了使用浏览器来替代桌面应用的机会,并且这次机会非常大。Ajax将整个页面的刷新变成页面局部的刷新,并且数据的传送是以异步方式进行,这使得网络延迟带来的视觉差异将会消失。 但是,在浏览器中的 Ajax应用中存在一

    2024年04月25日
    浏览(35)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包