HTTP 框架 Hertz 入门

已于 2023-02-07 10:05:56 修改
阅读量1k 收藏 3
点赞数
分类专栏： 青训营笔记 文章标签： http go Powered by 金山文档
于 2023-02-06 09:58:41 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_57209831/article/details/128896875
版权

这是我参与「第五届青训营 」笔记创作活动的第 12 天

前言

从本篇笔记开始将介绍 Go 框架三件套（Web / RPC / ORM），框架的学习有助于后续课程的学习以及大项目的完成。本文主要介绍字节跳动的开源 Golang 微服务 HTTP 框架 Hertz。

重点内容

  • Hertz 简介

  • 快速开始

  • 路由

  • Hertz 代码生成工具 hz

知识点介绍

Hertz 简介

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

架构设计：Hertz采用了4层分层设计（应用层、路由层、协议层、传输层），保证各个层级功能内聚，同时通过层级之间的接口达到灵活扩展的目标。

框架特点：

  • 高易用性：在开发过程中，快速写出来正确的代码往往是更重要的。因此，在 Hertz 在迭代过程中，积极听取用户意见，持续打磨框架，希望为用户提供一个更好的使用体验，帮助用户更快的写出正确的代码。

  • 高性能：Hertz 默认使用自研的高性能网络库 Netpoll，在一些特殊场景相较于 go net，Hertz 在 QPS、时延上均具有一定优势。

  • 高扩展性：Hertz 采用了分层设计，提供了较多的接口以及默认的扩展实现，用户也可以自行扩展。同时得益于框架的分层设计，框架的扩展性也会大很多。

  • 多协议支持：Hertz 框架原生提供 HTTP1.1、ALPN 协议支持。除此之外，由于分层设计，Hertz 甚至支持自定义构建协议解析逻辑，以满足协议层扩展的任意需求。

  • 网络层切换能力：Hertz 实现了 Netpoll 和 Golang 原生网络库 间按需切换能力，用户可以针对不同的场景选择合适的网络库，同时也支持以插件的方式为 Hertz 扩展网络库实现。

快速开始

准备 Golang 开发环境

首先需要安装 Golang，推荐安装最新版本。可参考 golang.org/doc/install

目前，Hertz 支持 Linux、macOS、Windows 系统。

快速上手

  • 安装命令行工具 hz

  • 确保环境变量已经正确定义

  • 安装 hz

go install github.com/cloudwego/hertz/cmd/hz@latest

  • 生成/编写示例代码

  • 在当前目录下创建 hertz_demo 文件夹，进入该目录中

  • 创建 main.go 文件

  • 在 main.go 文件中添加以下代码

package main

import (
    "context""github.com/cloudwego/hertz/pkg/app""github.com/cloudwego/hertz/pkg/app/server""github.com/cloudwego/hertz/pkg/common/utils""github.com/cloudwego/hertz/pkg/protocol/consts"
)

funcmain() {
    h := server.Default()

    h.GET("/ping", func(c context.Context, ctx *app.RequestContext) {
            ctx.JSON(consts.StatusOK, utils.H{"message": "pong"})
    })

    h.Spin()
}

  • 生成 go.mod 文件

go mod init hertz_demo

  • 整理 & 拉取依赖

go mod tidy

  • 运行示例代码

go build -o hertz_demo
go run hertz_demo

如果成功，将看到

2023/01/30 11:26:27.824241 engine.go:617: [Debug] HERTZ: Method=GET    absolutePath=/ping                     --> handlerName=main.main.func1 (num=2 handlers)
2023/01/30 11:26:27.836518 engine.go:389: [Info] HERTZ: Using network library=standard
2023/01/30 11:26:27.837518 transport.go:65: [Info] HERTZ: HERTZ: HTTP server listening on address=[::]:8888

之后对接口进行测试：

curl http://127.0.0.1:8888/ping

如果成功就可以看到以下输出

StatusCode        : 200
StatusDescription : OK
Content           : {"message":"pong"}
RawContent        : HTTP/1.1 200 OK
                    Content-Length: 18
                    Content-Type: application/json; charset=utf-8
                    Date: Mon, 30 Jan 2023 03:26:53 GMT
                    Server: hertz

                    {"message":"pong"}
Forms             : {}
Headers           : {[Content-Length, 18], [Content-Type, application/json; charset=utf-8], [Date, Mon, 30 Jan 2023 03:26:53 GMT], [Server,  
                    hertz]}
Images            : {}
InputFields       : {}
Links             : {}
ParsedHtml        : mshtml.HTMLDocumentClass
RawContentLength  : 18

到此就已经成功启动了 Hertz Server，并完成了一次调用。

路由

路由注册

Hertz 提供了 GET、POST、PUT、DELETE、ANY 等方法用于注册路由。

方法

介绍

Hertz.GET

用于注册 HTTP Method 为 GET 的方法

Hertz.POST

用于注册 HTTP Method 为 POST 的方法

Hertz.DELETE

用于注册 HTTP Method 为 DELETE 的方法

Hertz.PUT

用于注册 HTTP Method 为 PUT 的方法

Hertz.PATCH

用于注册 HTTP Method 为 PATCH 的方法

Hertz.HEAD

用于注册 HTTP Method 为 HEAD 的方法

Hertz.OPTIONS

用于注册 HTTP Method 为 OPTIONS 的方法

Hertz.Handle

这个方法支持用户手动传入 HTTP Method 用来注册方法，当用于注册普通的 HTTP Method 方法时和上述的方法作用是一致的，并且这个方法同时也支持用于注册自定义 HTTP Method 方法

Hertz.Any

用于注册所有 HTTP Method 方法

Hertz.StaticFile/Static/StaticFS

用于注册静态文件

示例代码：

package main

import (
	"context"
	"github.com/cloudwego/hertz/pkg/app"
	"github.com/cloudwego/hertz/pkg/app/server"
	"github.com/cloudwego/hertz/pkg/protocol/consts"
)

funcmain(){
	h := server.Default(server.WithHostPorts("127.0.0.1:8080"))

	h.StaticFS("/", &app.FS{Root: "./", GenerateIndexPages: true})

	h.GET("/get", func(ctx context.Context, c *app.RequestContext) {
		c.String(consts.StatusOK, "get")
	})
	h.POST("/post", func(ctx context.Context, c *app.RequestContext) {
		c.String(consts.StatusOK, "post")
	})
	h.PUT("/put", func(ctx context.Context, c *app.RequestContext) {
		c.String(consts.StatusOK, "put")
	})
	h.DELETE("/delete", func(ctx context.Context, c *app.RequestContext) {
		c.String(consts.StatusOK, "delete")
	})
	h.PATCH("/patch", func(ctx context.Context, c *app.RequestContext) {
		c.String(consts.StatusOK, "patch")
	})
	h.HEAD("/head", func(ctx context.Context, c *app.RequestContext) {
		c.String(consts.StatusOK, "head")
	})
	h.OPTIONS("/options", func(ctx context.Context, c *app.RequestContext) {
		c.String(consts.StatusOK, "options")
	})
	h.Any("/ping_any", func(ctx context.Context, c *app.RequestContext) {
		c.String(consts.StatusOK, "any")
	})
	h.Handle("LOAD","/load", func(ctx context.Context, c *app.RequestContext) {
		c.String(consts.StatusOK, "load")
	})
	h.Spin()
}

路由组

Hertz 提供了路由组( Group )的能力，用于支持路由分组的功能，同时中间件也可以注册到路由组上。

示例代码：

package main

import (
	"context"
	"github.com/cloudwego/hertz/pkg/app"
	"github.com/cloudwego/hertz/pkg/app/server"
	"github.com/cloudwego/hertz/pkg/protocol/consts"
)

funcmain(){
	h := server.Default(server.WithHostPorts("127.0.0.1:8080"))
	v1 := h.Group("/v1")
	v1.GET("/get", func(ctx context.Context, c *app.RequestContext) {
		c.String(consts.StatusOK, "get")
	})
	v1.POST("/post", func(ctx context.Context, c *app.RequestContext) {
		c.String(consts.StatusOK, "post")
	})
	v2 := h.Group("/v2")
	v2.PUT("/put", func(ctx context.Context, c *app.RequestContext) {
		c.String(consts.StatusOK, "put")
	})
	v2.DELETE("/delete", func(ctx context.Context, c *app.RequestContext) {
		c.String(consts.StatusOK, "delete")
	})
	h.Spin()
}

路由类型

Hertz 支持丰富的路由类型用于实现复杂的功能，包括静态路由、参数路由、通配路由。

路由的优先级:静态路由 > 命名路由 > 通配路由

  • 静态路由如上文

  • 参数路由：

  • Hertz 支持使用 :name 这样的命名参数设置路由，并且命名参数只匹配单个路径段。

  • 如果我们设置/user/:name路由，匹配情况如下

路径

是否匹配

/user/gordon

匹配

/user/you

匹配

/user/gordon/profile

不匹配

/user/

不匹配

  • 通过使用 RequestContext.Param 方法，我们可以获取路由中携带的参数。

package main

import (
	"context"
	"github.com/cloudwego/hertz/pkg/app"
	"github.com/cloudwego/hertz/pkg/app/server"
	"github.com/cloudwego/hertz/pkg/protocol/consts"
)

funcmain(){
	h := server.Default(server.WithHostPorts("127.0.0.1:8080"))
	// This handler will match: "/hertz/version", but will not match : "/hertz/" or "/hertz"
	h.GET("/hertz/:version", func(ctx context.Context, c *app.RequestContext) {
		version := c.Param("version")
		c.String(consts.StatusOK, "Hello %s", version)
	})
	h.Spin()
}

  • 通配路由

  • Hertz 支持使用 *path 这样的通配参数设置路由，并且通配参数会匹配所有内容。

  • 如果我们设置/src/*path路由，匹配情况如下

路径

是否匹配

/src/

匹配

/src/somefile.go

匹配

/src/subdir/somefile.go

匹配

  • 通过使用 RequestContext.Param 方法，我们可以获取路由中携带的参数。

package main

import (
	"context"
	"github.com/cloudwego/hertz/pkg/app"
	"github.com/cloudwego/hertz/pkg/app/server"
	"github.com/cloudwego/hertz/pkg/protocol/consts"
)

funcmain(){
	h := server.Default(server.WithHostPorts("127.0.0.1:8080"))
	// However, this one will match "/hertz/v1/" and "/hertz/v2/send"
	h.GET("/hertz/:version/*action", func(ctx context.Context, c *app.RequestContext) {
		version := c.Param("version")
		action := c.Param("action")
		message := version + " is " + action
		c.String(consts.StatusOK, message)
	})
	h.Spin()
}

Hertz 代码生成工具 hz

hz 是 Hertz 框架提供的一个用于生成代码的命令行工具。目前，hz 可以基于 thrift 和 protobuf 的 IDL 生成 Hertz 项目的脚手架。

基本使用：

  • 创建一个 Hertz 新项目

// GOPATH 下执行，go mod 名字默认为当前路径相对GOPATH的路径，也可自己指定
hz new

// 非GOPATH 下执行，需要指定 go mod 名
hz new -mod hertz/demo

// 整理 & 拉取依赖
go mod tidy

  • 编译项目

go build

  • 运行项目

./{{your binary}}

  • 测试

curl 127.0.0.1:8888/ping

如果返回{"message":"pong"}，说明接口调通。

总结

本文主要介绍了 Golang 微服务 HTTP 框架 Hertz，只是简单的入门练习，如果想了解更多内容还是需要仔细研究官方文档，官方文档的内容很清晰全面，后续还需要深入学习。

引用

  1. Hertz 官方文档 Hertz | CloudWeGo

沐雨橙风24
关注
  • 0
    点赞
  • 踩
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Hertz理论--接触分析计算
07-08
Hertz理论，讲述接触变形及接触应力的推导公式
pair_gran_hertz_history_history_Hertz_hertz接触模型Lammps_lammps_接触模
10-02
Lammps中的hertz接触模型，该模型可用于离散元计算的使用
Hertz.rar_Hertz_Hertz理论_接触_接触力学_接触理论
07-14
可实现对hertz接触力学解析解的绘图，是接触力学分析结果理论验证不可缺少的工具。
scripts:HERTZ Bitshares价格Feed脚本
04-14
HERTZ Bitshares价格Feed脚本 该存储库包含参考的Hertz价格供稿脚本和工具。 赫兹（Hertz）是一种基于算法的资产（ABA），它是一种与美元挂钩的市场挂钩资产（MPA），并使用正弦波算法进行了修改，以使用14％的幅度和28天的周期可预测地振荡。 鉴于此回购协议（以及所有其他赫兹价格提要回购协议）均已获得MIT许可，因此每个人都可以使用其他静态变量（不同的幅度，周期，参考时间戳，参考资产，算法等）来复制/修改Hertz背后的概念。 在发布Hertz的价格供稿之前，您需要将其添加到Hertz smartcoin设置中的“价格供稿发布者的批准列表”中。 hertz_feed.py安装与使用 参考赫兹价格供稿Python3脚本是使用python-bitshares库实现的，并且是在考虑到Ubuntu的情况下进行设计和测试的，因此以下说明可能不适用于其他操作系统。 设置U
Hertz接触理论
10-10
详细介绍Hertz应力的基本理论和计算方法，对工程实际中的接触问题有理论分析指导作用
golang入门笔记——Hertz
qq_43716830的博客
01-20 3395
Hertz是字节跳动研发的企业级微服务HTTP框架，具有高易用性、易扩展、低时延等特点。是基于自研网络库Netpoll开发的内部框架Hertz。Hertz框架整体上满足：1.极致性能优化的问题性2.面对未来不可控需求的扩展能力，Hertz采用了4层分层设计（应用层、路由层、协议层、传输层），保证各个层级功能内聚，同时通过层级之间的接口达到灵活扩展的目标。
字节开源WEB框架Hertz太香啦！
xhbzl的博客
08-24 5184
Hertz[həːts] 是一个 Golang 微服务 HTTP 框架，在设计之初参考了其他开源框架、、的优势， 并结合内部的需求，使其具有高易用性、高性能、高扩展性等特点，目前在字节跳动内部已广泛使用。如今越来越多的微服务选择使用 Golang，如果对微服务性能有要求，又希望框架能够充分满足内部的可定制化需求，Hertz 会是一个不错的选择。
Go语言学习指南——HTTP框架Hertz
m0_62275194的博客
09-05 601
Hertz是一个 Golang 微服务 HTTP 框架，在设计之初参考了其他开源框架 fasthttp、gin、echo的优势， 并结合字节跳动内部的需求，使其具有高易用性、高性能、高扩展性等特点，目前在字节跳动内部已广泛使用。如今越来越多的微服务选择使用 Golang，如果对微服务性能有要求，又希望框架能够充分满足内部的可定制化需求，Hertz 会是一个不错的选择。
开源 Golang 微服务入门一： HTTP 框架 Hertz
yumuing‘s bolg
06-06 1709
Hertz 是一个 Golang 微服务 HTTP 框架，在设计之初参考了其他开源框架 fasthttp、gin、echo 的优势， 并结合字节跳动内部的需求，使其具有高易用性、高性能、高扩展性等特点
Go框架三件套Gorm Kitex Hertz基本用法与常见API讲解
ai520wangzha的博客
02-08 1431
为什么使用IDL：要进行 RPC，就需要知道对方的接口是什么，需要传什么参数，同时也需要知道返回值是什么样的，就好比两个人之间交流，需要保证在说的是同一个语言、同一件事。中间件可以在请求到达业务逻辑之前执行，比如执行身份认证和权限认证，当中间件只有初始化（pre-handle）相关逻辑，且没有和 real handler 在一个函数调用栈中的需求时，中间件中可以省略掉最后的。，其第一个参数为调用的 服务名（用于微服务中的服务发现），第二个参数为 options，用于传入参数， 此处的。
字节赫兹 框架教程 一请求上下文之请求
个人博客，记录了本人学习的各种有趣的技术。
10-13 140
该函数的默认行为：若 X-Forwarded-For 或 X-Real-IP Header 中存在 ip，则从这两个 Header 中读 ip 并返回（优先级 X-Forwarded-For 大于 X-Real-IP），否则返回 remote address。注意：该函数支持从 application/x-www-form-urlencoded 和 multipart/form-data 这两种类型的 content-type 中获取 value 值，且不支持获取文件值。(详情请参考 Args 对象)
字节赫兹 框架教程 一 Engine
个人博客，记录了本人学习的各种有趣的技术。
10-02 197
server.Hertz 是 Hertz 的核心类型，它由 route.Engine 以及 signalWaiter 组成，Hertz 服务器的启动、路由注册、中间件注册以及退出等重要方法均包含在 server.Hertz 中。
HTML入门（详细）
热门推荐
qq_63525426的博客
05-03 1万+
HTML（全称为“超文本标记语言”）是一种用于创建Web页面的标记语言。它是Web开发的基础，允许开发者定义页面的结构、内容和样式。HTML使用一些标记或“标签”来描述文本和媒体内容的结构和格式，这些标签可以指示网页浏览器如何显示内容，包括标题、段落、列表、超链接、图像、音频、视频等等。HTML还可以与其他Web技术（如CSS和JavaScript）结合使用，以实现更复杂和交互性的Web应用程序。这篇文章只是介绍HTML的基础标签的使用。
HTTP 框架 Hertz 初体验 (虚拟机环境)
qq_51047851的博客
02-04 839
HTTP 框架 Hertz 初体验
字节跳动开源 Go HTTP 框架 Hertz 设计实践
weixin_44186218的博客
06-23 4508
Hertz 是字节跳动服务框架团队研发的超大规模的企业级微服务 HTTP 框架，具有高易用性、易扩展、低时延等特点。本文将重点关注 Hertz 的架构设计与功能特性。
一分钟使用高性能框架 Hertz
wangsofa的博客
07-21 566
点击上方蓝色字体，选择“设为星标”回复”云原生“获取基础架构实践Hertz 是什么Hertz[həːts] 是字节 CloudWeGo 团队一个 Golang 微服务 HTTP 框架，在设计之初参考了其他开源框架 fasthttp、gin、echo 的优势， 并结合字节跳动内部的需求，使其具有高易用性、高性能、高扩展性等特点，目前在字节跳动内部已广泛使用。如今越来越多的微服务选择使用 Golang...
字节微服务HTTP框架Hertz使用与源码分析｜拥抱开源
最新发布
qq_41468830的博客
01-12 2226
这篇文章我将以第一次阅读Hertz源码的视角，分享自己的思考过程，也借此梳理一下自己阅读源码的方法论。接下来需要你对应打开Hertz的官方文档，以及在本地克隆Hertz的代码仓库，我们开始吧。
解读字节开源 HTTP 框架 Hertz | 核心结构与入口的实现
Lance_Yuan24的博客
08-07 1135
作为一个接触开源社区快要一年的准大二生，对开源社区进行贡献的同时自己也想要造一个属于自己的框架——goffee，在边学边写的过程中发现了很多自己不足，正巧CSG正在举行解析Hertz源码的活动，就趁着这个机会学习一下企业级的框架内部的实现并给我自己的框架提供一点思路。
解读开源 Go HTTP 框架 Hertz | 服务注册拓展实现
Lance_Yuan24的博客
11-13 766
在参与 Hertz 框架的开发迭代过程中，对 Hertz 的主库也越来越熟悉。接下来的几篇文章我将分别解析 Hertz 的服务注册、服务发现和负载均衡拓展，最后会使用适配于 Hertz 的 etcd 拓展进行实战，欢迎大家关注。
matlab Hertz接触
10-18
Hertz接触是指两个弹性球体之间的接触，由于球体表面的凸起和凹陷，使得两个球体之间的接触面积非常小，只有一点或者一条线。在Hertz接触中，接触面积非常小，所以可以近似为刚体接触，而且可以使用弹性力学理论来描述。 在Matlab中，可以使用Symbolic Math Toolbox来求解Hertz接触问题。具体来说，可以使用solve函数来求解接触压力和接触变形等参数。下面是一个求解Hertz接触问题的示例代码： ```matlab syms P R1 R2 E v delta = solve((4/3)*sqrt(R1*R2)*(1-v^2)/E*delta^(3/2) == P, delta); P = subs(P, delta, delta(1)); delta = delta(1); F = (4/3)*sqrt(R1*R2)*delta^(3/2); ``` 其中，P表示接触压力，R1和R2表示两个球体的半径，E表示弹性模量，v表示泊松比，delta表示接触变形，F表示接触力。这段代码中，我们首先定义了这些变量为符号变量，然后使用solve函数求解delta，最后根据delta计算出P和F。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值