Golang文件服务器中index.html的异常问题

Golang文件服务器中index.html的异常问题 我正在学习Go的文件服务器，在处理index.html时发现了一个让我困惑的小问题。情况是这样的……

文件结构

|— cmd/
|    |— main.go
|— resources/
     |— hello/
     |    |— hello.html
     |    |— hello.js
     |— index/
          |— index.html
          |— index.js

main.go

func newRouter() *mux.Router {
	r := mux.NewRouter()
	r.HandleFunc("/", indexHandler).Methods("GET")
	r.HandleFunc("/hello", helloHandler).Methods("GET")
	r.PathPrefix("/static/").Handler(staticFileHandler()).Methods("GET")
	return r
}

func indexHandler(w http.ResponseWriter, r *http.Request) {
	b, err := os.ReadFile("../resources/index/index.html")
	if err != nil {
		http.Error(w, err.Error(), http.StatusInternalServerError)
	}
	fmt.Fprintf(w, string(b))
}

func helloHandler(w http.ResponseWriter, r *http.Request) {
	b, err := os.ReadFile("../resources/hello/hello.html")
	if err != nil {
		http.Error(w, err.Error(), http.StatusInternalServerError)
	}
	fmt.Fprintf(w, string(b))
}

func staticFileHandler() http.Handler {
	dir := http.Dir("../")
	return http.StripPrefix("/static/", http.FileServer(dir))
}

func main() {
	r := newRouter()
	http.ListenAndServe(":8080", r)
}

如果我们运行main.go，并向 http://localhost:8080/static/resources/hello 发送一个GET请求，我们将从响应中得到以下内容……

<pre>
<a href="hello.html">hello.html</a>
<a href="hello.js">hello.js</a>
</pre>

……这正是“hello”文件夹中的文件列表，符合预期。

那么，如果我们再向 http://localhost:8080/static/resources/index 发送另一个GET请求，猜猜会怎样？我们会直接得到index.html的内容。例如：

<!DOCTYPE html>
<html lang="en">
	<head>
		<meta charset="UTF-8">
		<title>index</title>
	</head>
	<body>
		<h1>index</h1>
		<script src="/static/resources/index/index.js"></script>
	</body>
</html>

为了进一步证实这一点，我把index.html的名字改成了，比如说，default.html。 然后我只得到了这个……

<pre>
<a href="default.html">default.html</a>
<a href="index.js">index.js</a>
</pre>

所以我的问题是，index.html有什么特别之处？我原以为index.html只是一个命名约定。为什么Go的http.FileServer()会区别对待它？这背后有什么原因吗？

谢谢。


更多关于Golang文件服务器中index.html的异常问题的实战教程也可以访问 https://www.itying.com/category-94-b0.html

4 回复

看来我因为对网络服务的基础知识理解不足，问了一个愚蠢的问题。 感谢你的回复，Christoph。

更多关于Golang文件服务器中index.html的异常问题的实战系列教程也可以访问 https://www.itying.com/category-94-b0.html


这完全不是你的错！没有人能把所有历史上形成的IT工具和协议的独特性都记在脑子里。在我看来，net/http 的文档应该提到这种行为。

// 代码示例：net/http 包的使用
package main

import (
    "fmt"
    "net/http"
)

func main() {
    http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
        fmt.Fprintf(w, "Hello, World!")
    })
    
    http.ListenAndServe(":8080", nil)
}

嗨 @naixyeur，

确实，这是 ServeFile() 的一个行为，FileServer 在内部会调用它。

这是一种历史悠久的 Web 服务器行为。如果 URL 映射到一个目录，标准的操作是检查目录内是否存在 index.html 文件，并返回该文件而不是目录内容。

例如，参见 Webserver directory index - Wikipedia：

当 HTTP 客户端（通常是 Web 浏览器）请求一个指向目录结构（而不是目录内的实际网页）的 URL 时，Web 服务器通常会提供一个默认页面，该页面通常被称为主页或“索引”页面。

在Go的http.FileServer中，index.html确实有特殊处理。这是由http.Dir类型实现的，它会自动将目录请求重定向到该目录下的index.html文件。

具体来说，当请求一个目录路径时，http.FileServer会检查该目录下是否存在名为index.html的文件。如果存在，它会自动返回该文件的内容，而不是显示目录列表。

这个行为是由http.serveFile函数实现的，它被http.FileServer内部调用。以下是相关的代码逻辑：

// 简化的逻辑示例
if d.IsDir() {
    index := filepath.Join(d.Name(), "index.html")
    if f, err := fs.Open(index); err == nil {
        defer f.Close()
        // 返回index.html的内容
        return
    }
    // 否则显示目录列表
}

你可以通过自定义http.FileSystem来改变这个行为。以下是一个示例，展示如何禁用自动提供index.html：

type noIndexFileSystem struct {
    fs http.FileSystem
}

func (nfs noIndexFileSystem) Open(name string) (http.File, error) {
    f, err := nfs.fs.Open(name)
    if err != nil {
        return nil, err
    }
    
    // 如果是目录，检查是否有index.html
    stat, err := f.Stat()
    if err != nil {
        return nil, err
    }
    
    if stat.IsDir() {
        // 关闭当前文件，返回一个自定义的文件对象
        f.Close()
        // 这里可以返回一个不包含index.html特殊处理的文件对象
        // 或者直接返回错误来禁止目录访问
        return nfs.fs.Open(name + "/") // 保持目录访问
    }
    
    return f, nil
}

// 修改你的staticFileHandler函数
func staticFileHandler() http.Handler {
    dir := http.Dir("../")
    noIndexFS := noIndexFileSystem{fs: dir}
    return http.StripPrefix("/static/", http.FileServer(noIndexFS))
}

如果你想要完全控制目录列表的行为，可以实现自己的http.FileSystem接口：

type customFileSystem struct {
    root string
}

func (cfs customFileSystem) Open(name string) (http.File, error) {
    path := filepath.Join(cfs.root, name)
    f, err := os.Open(path)
    if err != nil {
        return nil, err
    }
    
    stat, err := f.Stat()
    if err != nil {
        f.Close()
        return nil, err
    }
    
    // 如果是目录，总是返回目录列表，不自动提供index.html
    if stat.IsDir() {
        // 这里可以自定义目录列表的显示方式
        return f, nil
    }
    
    return f, nil
}

这个行为是HTTP服务器的常见约定，许多Web服务器（如Apache、Nginx）都有类似的功能。它允许用户访问目录时自动显示默认页面，而不是显示文件列表。

回到顶部