字节微服务HTTP框架Hertz使用与源码分析
2022/12/2 5:25:11
本文主要是介绍字节微服务HTTP框架Hertz使用与源码分析,对大家解决编程问题具有一定的参考价值,需要的程序猿们随着小编来一起学习吧!
一、前言
Hertz[həːts] 是一个 Golang 微服务 HTTP 框架,在设计之初参考了其他开源框架 fasthttp、gin、echo 的优势, 并结合字节跳动内部的需求,使其具有高易用性、高性能、高扩展性等特点,目前在字节跳动内部已广泛使用。 如今越来越多的微服务选择使用 Golang,如果对微服务性能有要求,又希望框架能够充分满足内部的可定制化需求,Hertz 会是一个不错的选择。
对于源码该如何阅读,本身就值得思考。这篇文章我将以第一次阅读Hertz源码的视角,分享自己的思考过程,也借此梳理一下自己阅读源码的方法论。
接下来需要你对应打开Hertz的官方文档,以及在本地克隆Hertz的代码仓库,我们开始吧。
二、架构设计
这是一张Hertz官方文档的架构设计图,图中的一个个组件对应hertz
源码包内的一个个package
文件夹,实现了对应的功能,如下:
三、快速开始
接下来按照文档的指示,通过hertz
的命令行工具初始化一个最简单的hertz
项目,先观其形,再会其意。
# 安装hertz的命令行工具,用于生成hertz初始代码 go install github.com/cloudwego/hertz/cmd/hz@latest # 通过hz工具生成代码,如果创建的项目不在GOPATH/src路径下,则需要额外声明-module参数 hz new -module hertz-study
此时按照文档指示,对项目进行编译运行可以访问这个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() }
接口服务,它所声明的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描述了接口交互的结构。
标签:Hertz,Golang,微服务,架构,package,命令,Default 来源:
本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享; 2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关; 3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关; 4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除; 5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。
这篇关于字节微服务HTTP框架Hertz使用与源码分析的文章就介绍到这儿,希望我们推荐的文章对大家有所帮助,也希望大家多多支持为之网!
- 2024-09-07面向对象编程基础:初学者指南
- 2024-09-07数据结构入门:了解基础概念与简单应用
- 2024-09-07面向对象编程入门:掌握基本概念与实践
- 2024-09-07数据结构入门:从基础概念到基本操作
- 2024-09-07从零开始学数据库:入门级指南与实操技巧
- 2024-09-07综合设备故障分析与预防:实例代码与优化策略
- 2024-09-07数据库入门:轻松掌握数据管理基础
- 2024-09-07面向对象入门:快速掌握对象编程基础
- 2024-09-07数据库教程:入门与实践指南
- 2024-09-07面向对象开发教程 - 从零基础到实践应用的进阶之路