mirror of
https://gitee.com/johng/gf
synced 2026-07-06 21:45:34 +08:00
78 lines
2.3 KiB
Go
78 lines
2.3 KiB
Go
// Copyright 2018 gf Author(https://github.com/gogf/gf). All Rights Reserved.
|
|
//
|
|
// This Source Code Form is subject to the terms of the MIT License.
|
|
// If a copy of the MIT was not distributed with this file,
|
|
// You can obtain one at https://github.com/gogf/gf.
|
|
|
|
// Package gfcache provides reading and caching for file contents.
|
|
package gfcache
|
|
|
|
import (
|
|
"time"
|
|
|
|
"github.com/gogf/gf/internal/cmdenv"
|
|
"github.com/gogf/gf/os/gcache"
|
|
"github.com/gogf/gf/os/gfile"
|
|
"github.com/gogf/gf/os/gfsnotify"
|
|
)
|
|
|
|
const (
|
|
// Default expire time for file content caching in seconds.
|
|
gDEFAULT_CACHE_EXPIRE = 60
|
|
)
|
|
|
|
var (
|
|
// Default expire time for file content caching in seconds.
|
|
cacheExpire = cmdenv.Get("gf.gfcache.expire", gDEFAULT_CACHE_EXPIRE).Int() * 1000
|
|
)
|
|
|
|
// GetContents returns string content of given file by <path> from cache.
|
|
// If there's no content in the cache, it will read it from disk file specified by <path>.
|
|
// The parameter <expire> specifies the caching time for this file content in seconds.
|
|
func GetContents(path string, duration ...interface{}) string {
|
|
return string(GetBinContents(path, duration...))
|
|
}
|
|
|
|
// GetBinContents returns []byte content of given file by <path> from cache.
|
|
// If there's no content in the cache, it will read it from disk file specified by <path>.
|
|
// The parameter <expire> specifies the caching time for this file content in seconds.
|
|
func GetBinContents(path string, duration ...interface{}) []byte {
|
|
k := cacheKey(path)
|
|
e := cacheExpire
|
|
if len(duration) > 0 {
|
|
e = getSecondExpire(duration[0])
|
|
}
|
|
r := gcache.GetOrSetFuncLock(k, func() interface{} {
|
|
b := gfile.GetBytes(path)
|
|
if b != nil {
|
|
// Adding this <path> to gfsnotify,
|
|
// it will clear its cache if there's any changes of the file.
|
|
_, _ = gfsnotify.Add(path, func(event *gfsnotify.Event) {
|
|
gcache.Remove(k)
|
|
gfsnotify.Exit()
|
|
})
|
|
}
|
|
return b
|
|
}, e*1000)
|
|
if r != nil {
|
|
return r.([]byte)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// getSecondExpire converts parameter <duration> to int type in seconds.
|
|
//
|
|
// Note that there's some performance cost in type assertion here, but it's valuable.
|
|
func getSecondExpire(duration interface{}) int {
|
|
if d, ok := duration.(time.Duration); ok {
|
|
return int(d.Nanoseconds() / 1000000000)
|
|
} else {
|
|
return duration.(int)
|
|
}
|
|
}
|
|
|
|
// cacheKey produces the cache key for gcache.
|
|
func cacheKey(path string) string {
|
|
return "gf.gfcache:" + path
|
|
}
|