reverseproxy

README

reverseproxy (This is a community driven project)

reserve proxy extension for Hertz

Install

go get github.com/hertz-contrib/reverseproxy

Quick Start

package main

import (
	"github.com/cloudwego/hertz/pkg/app/server"
	"github.com/hertz-contrib/reverseproxy"
)

func main() {
	h := server.New()
	rp, _ := reverseproxy.NewSingleHostReverseProxy("http://localhost:8082/test")
	h.GET("/ping", rp.ServeHTTP)
	h.Spin()
}

Use tls

Currently netpoll does not support tls，we need to use the net (standard library)

package main

import (
	"github.com/cloudwego/hertz/pkg/app/client"
	"github.com/cloudwego/hertz/pkg/app/server"
	"github.com/cloudwego/hertz/pkg/network/standard"
	"github.com/hertz-contrib/reverseproxy"
)

func main() {
	h := server.New()
	rp, _ := reverseproxy.NewSingleHostReverseProxy("https://localhost:8082/test",client.WithDialer(standard.NewDialer()))
	h.GET("/ping", rp.ServeHTTP)
	h.Spin()
}

Use service discovery

Use nacos as example and more information refer to registry

package main

import (
	"github.com/cloudwego/hertz/pkg/app/client"
	"github.com/cloudwego/hertz/pkg/app/middlewares/client/sd"
	"github.com/cloudwego/hertz/pkg/app/server"
	"github.com/cloudwego/hertz/pkg/common/config"
	"github.com/cloudwego/hertz/pkg/protocol"
	"github.com/hertz-contrib/registry/nacos"
	"github.com/hertz-contrib/reverseproxy"
)

func main() {
	cli, err := client.NewClient()
	if err != nil{
		panic(err)
	}
	r, err := nacos.NewDefaultNacosResolver()
	if err != nil{
		panic(err)
	}
	cli.Use(sd.Discovery(r))
	h := server.New()
	rp, _ := reverseproxy.NewSingleHostReverseProxy("http://test.demo.api/test")
	rp.SetClient(cli)
	rp.SetDirector(func(req *protocol.Request){
		req.SetRequestURI(string(reverseproxy.JoinURLPath(req, rp.Target)))
		req.Header.SetHostBytes(req.URI().Host())
		req.Options().Apply([]config.RequestOption{config.WithSD(true)})
	})
	h.GET("/ping", rp.ServeHTTP)
	h.Spin()
}

Request/Response

ReverseProxy provides SetDirector、SetModifyResponse、SetErrorHandler to modify Request and Response.

Websocket Reverse Proxy

Websocket reverse proxy for Hertz, inspired by fasthttp-reverse-proxy

package main

import (
	"github.com/cloudwego/hertz/pkg/app/server"
	"github.com/hertz-contrib/reverseproxy"
)

func main() {
	h := server.Default()
	h.GET("/backend", reverseproxy.NewWSReverseProxy("ws://example.com").ServeHTTP)
	h.Spin()
}

Configuration	Default	Description
WithDirector	nil	customize the forward header
WithDialer	gorillaws.DefaultDialer	for dialer customization
WithUpgrader	hzws.HertzUpgrader	for upgrader customization

More info

See example

Documentation

Index

• Variables
• func ClientDo() clientBehavior
• func ClientDoDeadline(param time.Time) clientBehavior
• func ClientDoRedirects(param int) clientBehavior
• func ClientDoTimeout(param time.Duration) clientBehavior
• func JoinURLPath(req *protocol.Request, target string) (path []byte)
• type Director
• type Option
  • func WithDialer(dialer *websocket.Dialer) Option
  • func WithDirector(director Director) Option
  • func WithUpgrader(upgrader *hzws.HertzUpgrader) Option
• type Options
• type ReverseProxy
  • func NewSingleHostReverseProxy(target string, options ...config.ClientOption) (*ReverseProxy, error)
  • func (r *ReverseProxy) ServeHTTP(c context.Context, ctx *app.RequestContext)
  • func (r *ReverseProxy) SetClient(client *client.Client)
  • func (r *ReverseProxy) SetClientBehavior(cb clientBehavior)
  • func (r *ReverseProxy) SetDirector(director func(req *protocol.Request))
  • func (r *ReverseProxy) SetErrorHandler(eh func(c *app.RequestContext, err error))
  • func (r *ReverseProxy) SetModifyResponse(mr func(*protocol.Response) error)
  • func (r *ReverseProxy) SetSaveOriginResHeader(b bool)
  • func (r *ReverseProxy) SetTransferTrailer(b bool)
• type WSReverseProxy
  • func NewWSReverseProxy(target string, opts ...Option) *WSReverseProxy
  • func (w *WSReverseProxy) ServeHTTP(ctx context.Context, c *app.RequestContext)

Variables

var DefaultOptions = &Options{
	Director: nil,
	Dialer:   websocket.DefaultDialer,
	Upgrader: &hzws.HertzUpgrader{
		ReadBufferSize:  1024,
		WriteBufferSize: 1024,
	},
}

Functions

func ClientDo

func ClientDo() clientBehavior

func ClientDoDeadline

func ClientDoDeadline(param time.Time) clientBehavior

func ClientDoRedirects

func ClientDoRedirects(param int) clientBehavior

func ClientDoTimeout

func ClientDoTimeout(param time.Duration) clientBehavior

func JoinURLPath

func JoinURLPath(req *protocol.Request, target string) (path []byte)

Types

type Director

type Director func(ctx context.Context, c *app.RequestContext, forwardHeader http.Header)

type Option

type Option func(o *Options)

func WithDialer

func WithDialer(dialer *websocket.Dialer) Option

WithDialer for dialer customization

func WithDirector

func WithDirector(director Director) Option

WithDirector user can edit the forward header by using custom Director NOTE: custom Director will overwrite default forward header field if they have the same key

func WithUpgrader

func WithUpgrader(upgrader *hzws.HertzUpgrader) Option

WithUpgrader for upgrader customization

type Options

type Options struct {
	Director Director
	Dialer   *websocket.Dialer
	Upgrader *hzws.HertzUpgrader
}

type ReverseProxy

type ReverseProxy struct {

	// target is set as a reverse proxy address
	Target string
	// contains filtered or unexported fields
}

func NewSingleHostReverseProxy

func NewSingleHostReverseProxy(target string, options ...config.ClientOption) (*ReverseProxy, error)

NewSingleHostReverseProxy returns a new ReverseProxy that routes URLs to the scheme, host, and base path provided in target. If the target's path is "/base" and the incoming request was for "/dir", the target request will be for /base/dir. NewSingleHostReverseProxy does not rewrite the Host header. To rewrite Host headers, use ReverseProxy directly with a custom director policy.

When passing config.ClientOption it will initialize a local client.Client instance. Using ReverseProxy.SetClient if there is need for shared customized client.Client instance.

func (*ReverseProxy) ServeHTTP

func (r *ReverseProxy) ServeHTTP(c context.Context, ctx *app.RequestContext)

func (*ReverseProxy) SetClient

func (r *ReverseProxy) SetClient(client *client.Client)

SetClient use to customize client

func (*ReverseProxy) SetClientBehavior

func (r *ReverseProxy) SetClientBehavior(cb clientBehavior)

func (*ReverseProxy) SetDirector

func (r *ReverseProxy) SetDirector(director func(req *protocol.Request))

SetDirector use to customize protocol.Request

func (*ReverseProxy) SetErrorHandler

func (r *ReverseProxy) SetErrorHandler(eh func(c *app.RequestContext, err error))

SetErrorHandler use to customize error handler

func (*ReverseProxy) SetModifyResponse

func (r *ReverseProxy) SetModifyResponse(mr func(*protocol.Response) error)

SetModifyResponse use to modify response

func (*ReverseProxy) SetSaveOriginResHeader

func (r *ReverseProxy) SetSaveOriginResHeader(b bool)

func (*ReverseProxy) SetTransferTrailer

func (r *ReverseProxy) SetTransferTrailer(b bool)

type WSReverseProxy

type WSReverseProxy struct {
	// contains filtered or unexported fields
}

func NewWSReverseProxy

func NewWSReverseProxy(target string, opts ...Option) *WSReverseProxy

NewWSReverseProxy new a proxy which will provide handler for websocket reverse proxy

func (*WSReverseProxy) ServeHTTP

func (w *WSReverseProxy) ServeHTTP(ctx context.Context, c *app.RequestContext)

ServeHTTP provides websocket reverse proxy service