Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kezhengjie/go-http-middleware
a simple middleware library for standard go net/http
https://github.com/kezhengjie/go-http-middleware
go golang http middleware middleware-integrations middlewares standard-library web
Last synced: 6 days ago
JSON representation
a simple middleware library for standard go net/http
- Host: GitHub
- URL: https://github.com/kezhengjie/go-http-middleware
- Owner: kezhengjie
- License: mit
- Created: 2024-02-01T09:22:43.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-02-02T10:19:58.000Z (11 months ago)
- Last Synced: 2024-12-25T03:22:19.126Z (10 days ago)
- Topics: go, golang, http, middleware, middleware-integrations, middlewares, standard-library, web
- Language: Go
- Homepage:
- Size: 14.6 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[中文文档](https://github.com/AlpsMonaco/go-http-middleware/blob/main/README_zh_CN.md)
# go-http-middleware
A middleware library for go standard net/http library.
Designed to introduce middleware for net/http with small code modification.
# Features
* no more third-party libraries required.
* core code are easy to learn and understand.
* fully compatible with the `net/http` library.
# Quick Start
```go
package main
import (
"log"
"net/http"
"os"
"github.com/AlpsMonaco/go-http-middleware/middleware"
)
var logger = log.New(os.Stdout, "", log.LstdFlags)
func HttpHandleHello(w http.ResponseWriter, r *http.Request) {
logger.Println("Hello")
w.Write([]byte("Hello"))
}
func HttpHandleWorld(w http.ResponseWriter, r *http.Request) {
logger.Println("World")
w.Write([]byte("World"))
}
func LogMiddleware1(next http.HandlerFunc) http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
logger.Println("log middleware 1 in")
next(w, r)
logger.Println("log middleware 1 out")
}
}
func LogMiddleware2(next http.HandlerFunc) http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
logger.Println("log middleware 2 in")
next(w, r)
logger.Println("log middleware 2 out")
}
}
func main() {
http := middleware.DefaultHTTPBuilder()
http.With(LogMiddleware1, LogMiddleware2)
http.HandleFunc("/hello", HttpHandleHello)
http.HandleFunc("/world", HttpHandleWorld)
http.ListenAndServe(":33333", nil)
}
```
Write your own middleware and add the following two lines of code before registering the HTTP handler in your code.
```go
http := middleware.DefaultHTTPBuilder()
http.With(LogMiddleware1, LogMiddleware2)
```
No further modifications are needed.
## Test
```bash
curl http://127.0.0.1:33333/hello
```
the console will output
```
2024/02/02 14:00:54 log middleware 1 in
2024/02/02 14:00:54 log middleware 2 in
2024/02/02 14:00:54 Hello
2024/02/02 14:00:54 log middleware 2 out
2024/02/02 14:00:54 log middleware 1 out
```
# Middleware Practice
## Logger Middleware
log client addr and request path.
```go
func LogMiddleware(next http.HandlerFunc) http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
fmt.Printf("%s %s\n", r.RemoteAddr, r.RequestURI)
next(w, r)
}
}
```
## Timer Middleware
```go
func TimerMiddleware(next http.HandlerFunc) http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
st := time.Now()
next(w, r)
fmt.Printf("time elapsed:%d\nms",time.Now().Sub(st).Milliseconds())
}
}
```
## Recovery Middleware
recover if panic
```go
func RecoverMiddleware(next http.HandlerFunc) http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
defer func() {
err := recover()
if err != nil {
w.WriteHeader(500)
fmt.Println(err)
}
}()
next(w, r)
}
}
```
# Advance
Use `middleware.NewBuilder` if you use your own mux instead of default mux of net/http.
```go
...
b := middleware.NewBuilder(&http.ServeMux{})
b.With(LogMiddleware1, LogMiddleware2)
b.HandleFunc("/hello", HttpHandleHello)
b.HandleFunc("/world", HttpHandleWorld)
b.ListenAndServe(":33333", nil)
```