README
¶
cachefs
介绍
通过go的http.FileServer（http.Dir(path)）可以很方便的创建文件服务器 go的http.Dir如果没有错误每次Open调用都会进行一次os.Open调用，os.Stat调用,至少一次的(*os.File).Read调用，这些最终会调用syscall包的函数进行系统调用，即使文件没有修改，这可以优化。 本包提供 HttpCacheFs ,可以将 http.Dir(path) 替换为 cachefs.HttpCacheFs(path) ,在被读取文件没有修改（当前通过比较修改时间判断），可以减少系统调用（具体是避免os.Open,(*os.File).Read），提高性能。
实现原理
实现了http.FileSystem 接口 内部有一个哈希表 key是path value的类型是*CacheFs，用作缓存 如果path已经被哈希表缓存，直接返回缓存，从而避免os.Open
实现了http.File接口 内部用Buf保存文件数据,保留文件的（*os.File）句柄 当Read或Seek方法被调用时，先通过比较修改时间判断文件有没有修改
- 如果没有修改，调用Buf的Read或Seek方法，避免(*os.File).Read或(*os.File).Seek
- 如果有修改，重新读取文件数据，并更新HttpCacheFs的缓存,再调用Read或Seek方法
Close方法为了配合http.FileServer，永远返回nil,并且不关闭文件句柄
当Readdir或Stat方法被调用时，先通过比较修改时间判断文件有没有修改
- 如果没有修改，调用os.File的Readdir或Stat
- 如果有修改，重新读取文件数据，并更新HttpCacheFs的缓存,再调用Readdir或Stat方法
实现了io.Reader接口 实现了io.Seeker接口 Buf将[]byte封装成数据流，读取到末尾返回 io.EOF 后下次读取会从头开始
参与贡献
- 创建一个issue
- Fork 本仓库
- 新建 Fork_xxx 分支
- 提交代码
- 新建 Pull Request
Documentation
¶
Overview ¶
Package cachefs 实现了缓存文件系统
缓存文件系统用于在 http.FileSystem 默认实现需要优化 通过比较修改时间，缓存文件系统在Open和Read时如果没有修改，减少系统调用（具体是避免os.Open,(*os.File).Read）
Index ¶
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Buf ¶
type Buf struct {
// contains filtered or unexported fields
}
Buf 循环缓存
type CacheFs ¶
type CacheFs struct {
// contains filtered or unexported fields
}
CacheFs 缓存文件系统
通过比较修改时间，在Open和Read时如果没有修改，减少系统调用（具体是避免os.Open,(*os.File).Read）
type HttpCacheFs ¶
type HttpCacheFs struct {
// contains filtered or unexported fields
}
HttpCacheFs Http缓存文件系统
Example ¶
path := "path"
http.Handle("/", http.FileServer(NewHttpCacheFs(path)))
Example (Onefile) ¶
http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
path := "path"
fs := NewHttpCacheFs(path)
f, err := fs.Open("index.html")
if err != nil {
panic(err)
}
i, err := f.Stat()
if err != nil {
panic(err)
}
http.ServeContent(w, r, "index.html", i.ModTime(), f)
})
func NewHttpCacheFs ¶
func NewHttpCacheFs(path string) *HttpCacheFs
NewHttpCacheFs 创建NewHttpCacheFs
- path 是相对的路径 相当于 http.Dir
func (*HttpCacheFs) Open ¶
func (fs *HttpCacheFs) Open(name string) (http.File, error)
Open 实现 http.FileSystem 接口
Source Files