README
¶
Hertz
什么是Hertz?
Hertz[həːts] 是一个 Golang 微服务 HTTP 框架，在设计之初参考了其他开源框架 fasthttp、gin、echo 的优势， 并结合字节跳动内部的需求，使其具有高易用性、高性能、高扩展性等特点，目前在字节跳动内部已广泛使用。 如今越来越多的微服务选择使用 Golang，如果对微服务性能有要求，又希望框架能够充分满足内部的可定制化需求，Hertz 会是一个不错的选择。
Hertz特点
高易用性
在开发过程中，快速写出来正确的代码往往是更重要的。因此，在 Hertz 在迭代过程中，积极听取用户意见，持续打磨框架，希望为用户提供一个更好的使用体验，帮助用户更快的写出正确的代码。
高性能
Hertz 默认使用自研的高性能网络库 Netpoll，在一些特殊场景相较于 go net，Hertz 在 QPS、时延上均具有一定优势。关于性能数据，可参考下图 Echo 数据。 Performance 关于详细的性能数据，可参考 https://github.com/cloudwego/hertz-benchmark。
高扩展性
Hertz 采用了分层设计，提供了较多的接口以及默认的扩展实现，用户也可以自行扩展。同时得益于框架的分层设计，框架的扩展性也会大很多。目前仅将稳定的能力开源给社区，更多的规划参考 RoadMap。
多协议支持
Hertz 框架原生提供 HTTP1.1、ALPN 协议支持。除此之外，由于分层设计，Hertz 甚至支持自定义构建协议解析逻辑，以满足协议层扩展的任意需求。
网络层切换能力
Hertz 实现了 Netpoll 和 Golang 原生网络库 间按需切换能力，用户可以针对不同的场景选择合适的网络库，同时也支持以插件的方式为 Hertz 扩展网络库实现。
参考资料
Documentation
¶
Index ¶
- Constants
- func SetOperation(ctx context.Context, op string)
- type Server
- type ServerOption
- func WithAddress(addr string) ServerOption
- func WithErrorEncoder(en kHttp.EncodeErrorFunc) ServerOption
- func WithFilter(filters ...kHttp.FilterFunc) ServerOption
- func WithMiddleware(m ...middleware.Middleware) ServerOption
- func WithRequestDecoder(dec kHttp.DecodeRequestFunc) ServerOption
- func WithResponseEncoder(en kHttp.EncodeResponseFunc) ServerOption
- func WithStrictSlash(strictSlash bool) ServerOption
- func WithTLSConfig(c *tls.Config) ServerOption
- func WithTimeout(timeout time.Duration) ServerOption
- type Transport
- func (tr *Transport) Endpoint() string
- func (tr *Transport) Kind() transport.Kind
- func (tr *Transport) Operation() string
- func (tr *Transport) PathTemplate() string
- func (tr *Transport) ReplyHeader() transport.Header
- func (tr *Transport) Request() *http.Request
- func (tr *Transport) RequestHeader() transport.Header
- type Transporter
Constants ¶
const (
KindHertz transport.Kind = "hertz"
)
Variables ¶
This section is empty.
Functions ¶
func SetOperation ¶
SetOperation sets the transport operation.
Types ¶
type ServerOption ¶
type ServerOption func(*Server)
func WithAddress ¶
func WithAddress(addr string) ServerOption
func WithErrorEncoder ¶
func WithErrorEncoder(en kHttp.EncodeErrorFunc) ServerOption
func WithFilter ¶
func WithFilter(filters ...kHttp.FilterFunc) ServerOption
func WithMiddleware ¶
func WithMiddleware(m ...middleware.Middleware) ServerOption
func WithRequestDecoder ¶
func WithRequestDecoder(dec kHttp.DecodeRequestFunc) ServerOption
func WithResponseEncoder ¶
func WithResponseEncoder(en kHttp.EncodeResponseFunc) ServerOption
func WithStrictSlash ¶
func WithStrictSlash(strictSlash bool) ServerOption
func WithTLSConfig ¶
func WithTLSConfig(c *tls.Config) ServerOption
func WithTimeout ¶
func WithTimeout(timeout time.Duration) ServerOption
type Transport ¶
type Transport struct {
// contains filtered or unexported fields
}
Transport is an HTTP transport.
func (*Transport) PathTemplate ¶
PathTemplate returns the http path template.
func (*Transport) ReplyHeader ¶
ReplyHeader returns the reply header.
func (*Transport) RequestHeader ¶
RequestHeader returns the request header.
type Transporter ¶
type Transporter interface {
transport.Transporter
Request() *http.Request
PathTemplate() string
}
Transporter is http Transporter
Source Files