hairyhenderson/go-fsimpl

此模块包含一系列可通过URL方案动态发现的Go文件系统实现。

这些文件系统实现了Go 1.16中引入的fs.FS接口。这意味着目前所有实现都是只读的，但将来可能会改变（进展请参见golang/go#45757）。

大多数实现都实现了fs.ReadDirFS接口，但httpfs文件系统除外。

提供了一些扩展，以帮助为特定文件系统添加功能：

• WithContextFS - 向文件系统注入上下文，用于传播支持它的文件系统中的取消操作。
• WithHeaderFS - 为文件系统使用的所有HTTP请求设置http.Header。这对于身份验证或请求特定内容类型很有用。
• WithHTTPClientFS - 设置所有HTTP请求使用的*http.Client。

许多文件系统包还有自己的扩展。

该模块还提供了ContentType，这是fs.FileInfo类型的扩展，用于帮助识别给定文件的适当MIME内容类型。对于支持它的文件系统，使用HTTP Content-Type头来实现。否则，根据文件扩展名猜测类型。

历史和项目状态

该模块正在积极开发中，API仍可能发生重大变化。

根据测试，文件系统包应该能正确运行，但可能存在未覆盖的边缘情况。如果发现问题，请提出issue！

这些文件系统大多基于gomplate的代码，gomplate支持所有这些作为数据源。该模块最终将在gomplate中使用。

支持的文件系统

以下是该模块支持的文件系统和URL方案列表：

更多详细信息请参阅各个包的文档。

安装

使用go get安装最新版本的go-fsimpl：

$ go get -u github.com/hairyhenderson/go-fsimpl

使用

如果你确定需要HTTP文件系统，例如：

import (
	"net/url"

	"github.com/hairyhenderson/go-fsimpl/httpfs"
)

func main() {
	base, _ := url.Parse("https://example.com")
	fsys, _ := httpfs.New(base)

	f, _ := fsys.Open("hello.txt")
	defer f.Close()

	// 现在可以对文件进行操作...
}

如果不确定需要哪种文件系统类型（例如，处理用户提供的URL时），可以使用文件系统多路复用器：

import (
	"github.com/hairyhenderson/go-fsimpl"
	"github.com/hairyhenderson/go-fsimpl/blobfs"
	"github.com/hairyhenderson/go-fsimpl/filefs"
	"github.com/hairyhenderson/go-fsimpl/gitfs"
	"github.com/hairyhenderson/go-fsimpl/httpfs"
)

func main() {
	mux := fsimpl.NewMux()
	mux.Add(filefs.FS)
	mux.Add(httpfs.FS)
	mux.Add(blobfs.FS)
	mux.Add(gitfs.FS)

	// 例如，指向GitHub上托管的特定git仓库中某个标签的子目录的URL，使用SSH进行身份验证...
	fsys, err := mux.Lookup("git+ssh://git@github.com/foo/bar.git//baz#refs/tags/v1.0.0")
	if err != nil {
		log.Fatal(err)
	}

	f, _ := fsys.Open("hello.txt")
	defer f.Close()

	// 现在可以对文件进行操作...
}

开发

运行测试需要在路径中包含git（包括git daemon）和consul可执行文件。

许可证

MIT许可证

版权所有 (c) 2021-2024 Dave Henderson