Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bddjr/gzipstatic-gin
🎉使用静态gzip或br压缩文件响应，减少服务器性能占用。Use static gzip or br compression file response to reduce server performance consumption.
https://github.com/bddjr/gzipstatic-gin
brotli gin gin-contrib gin-framework gin-gonic go go-mod golang gzip http-server static
Last synced: about 1 month ago
JSON representation
🎉使用静态gzip或br压缩文件响应，减少服务器性能占用。Use static gzip or br compression file response to reduce server performance consumption.
- Host: GitHub
- URL: https://github.com/bddjr/gzipstatic-gin
- Owner: bddjr
- License: bsd-3-clause
- Created: 2024-09-25T15:27:16.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-09-30T06:16:41.000Z (about 2 months ago)
- Last Synced: 2024-10-01T09:05:10.495Z (about 2 months ago)
- Topics: brotli, gin, gin-contrib, gin-framework, gin-gonic, go, go-mod, golang, gzip, http-server, static
- Language: Go
- Homepage:
- Size: 15.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# gzipstatic-gin
使用静态 gzip 或 br 压缩文件响应，减少服务器性能占用。
Use static gzip or br compression file response to reduce server performance consumption.
---
## Get
```
go get github.com/bddjr/gzipstatic-gin
```
---
## Example
### NoRoute
```go
noRoute := func(ctx *gin.Context) {
f, _ := os.ReadFile("frontend/dist/404.html")
ctx.Data(404, gin.MIMEHTML, f)
}
Router.NoRoute(noRoute)
gzipstatic.NoRoute = noRoute
```
### Static
```go
// router.Static("/", "frontend/dist")
gzipstatic.Static(router, "/", "frontend/dist")
```
### StaticFile
```go
// router.StaticFile("/", "frontend/dist/index.html")
gzipstatic.StaticFile(router, "/", "frontend/dist/index.html")
```
### File
```go
// ctx.File("frontend/dist/index.html")
gzipstatic.File(ctx, "frontend/dist/index.html")
```
### StaticFS
```go
// router.StaticFS("/", "/", fs)
gzipstatic.StaticFS(router, "/", "/", fs)
```
### StaticFileFS
```go
// router.StaticFileFS("/", "index.html", fs)
gzipstatic.StaticFileFS(router, "/", "index.html", fs)
```
### FileFromFS
```go
// ctx.FileFromFS("index.html", fs)
gzipstatic.FileFromFS(ctx, "index.html", fs)
```
### ExtFillter
```go
gzipstatic.ExtFillter = regexp.MustCompile(`\.(html|htm|js|json|css)$`)
```
### EncodeList
```go
// Priority from high to low
gzipstatic.EncodeList = []*gzipstatic.EncodeListItem{
{
name: "br",
ext: ".br",
}, {
name: "gzip",
ext: ".gz",
},
}
```
### EnableDebugHeader
```go
// Encoding-By: gzipstatic-gin
gzipstatic.EnableDebugHeader = true
```
---
## Source Code
[gzipstatic.go](gzipstatic.go)
---
## Reference
https://developer.mozilla.org/docs/Web/HTTP/Headers/Content-Encoding
https://developer.mozilla.org/docs/Web/HTTP/Headers/Accept-Encoding
https://developer.mozilla.org/docs/Web/HTTP/Headers/Vary
https://github.com/gin-gonic/gin
https://github.com/BCSPanel/BCSPanel/blob/main/src/httprouter/init.go
https://github.com/lpar/gzipped
https://github.com/nanmu42/gzip
https://github.com/vbenjs/vite-plugin-compression
---
## License
[BSD-3-clause license](LICENSE.txt)