Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/3job/httpfileserver
Wrapper for Golang http.FileServer that is faster (serving from memory) and uses less bandwidth (gzip, zstd, br's when possible)
https://github.com/3job/httpfileserver
golang golang-http golang-http-handler golang-library golang-stdlib
Last synced: 13 days ago
JSON representation
Wrapper for Golang http.FileServer that is faster (serving from memory) and uses less bandwidth (gzip, zstd, br's when possible)
- Host: GitHub
- URL: https://github.com/3job/httpfileserver
- Owner: 3JoB
- License: mit
- Created: 2023-01-19T09:40:40.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-07-17T10:41:12.000Z (over 1 year ago)
- Last Synced: 2024-10-28T13:11:55.923Z (about 2 months ago)
- Topics: golang, golang-http, golang-http-handler, golang-library, golang-stdlib
- Language: Go
- Homepage:
- Size: 43.9 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# httpfileserver
[](https://goreportcard.com/report/github.com/3JoB/httpfileserver)
[](https://godoc.org/github.com/3JoB/httpfileserver)
Fork from https://github.com/schollz/httpfileserver . This branch supports deflate, brotli, zstd, gzip and other methods.
This is a drop-in replacement for the stdlib `http.FileServer` that automatically provides gzipping as well as serving from memory instead of from disk. This library wraps the stdlib `http.FileServer` so you get all the benefits of that code, while also providing gzipping and keeping track of bytes and storing served files from memory when they come available.
To use, you can just replace the `http.Fileserver` in your `http.Handle` or `http.HandlerFunc` with `httpfileserver.New(route,directory)`. For example, to serve static assets, you can replace the std lib version
http.Handle("/static/", http.FileServer(http.Dir(".")))
with this version
http.Handle("/static/", httpfileserver.New("/static/", "."))
## Usage
```
go get -u github.com/3JoB/httpfileserver
```
In order to serve files from a different directory other than specified by the route, you need to include the route when specifying a file server. For example, if you want to serve `/static` files from a local directory called `/tmp/myassets` then you can specify a new file server in the following:
http.Handle("/static/", httpfileserver.New("/static/", "/tmp/myassets"))
The route is in the handle as well as the instance of the file server so that it can trim it and then server from the directory as intended.
## Example
see [example](example)
## Benchmarks
Using the `example` in this repo I tested both the stdlib and this version for serving a file. This version is about 22% faster (since it is reading from memory) and automatically uses `gzip` when capable.
Using the Go stdlib (`http.Handle("/", http.FileServer(http.Dir(".")))`):
```
$ ab -n 20000 -H "Accept-Encoding: gzip,deflate" http://localhost:1113/main.go # stdlib
...
HTML transferred: 4640000 bytes
Requests per second: 3575.56 [#/sec] (mean)
...
```
Using this library `http.Handle("/new/", httpfileserver.New("/new", "."))`:
```
$ ab -n 20000 -H "Accept-Encoding: gzip,deflate" http://localhost:1113/new/main.go # this lib
...
HTML transferred: 3680000 bytes
Requests per second: 4544.44 [#/sec] (mean)
...
```
## License
MIT