在 Go 中使用 http.FileServer 禁用目录列表的好方法

Posted 2023-03-07

【中文标题】在 Go 中使用 http.FileServer 禁用目录列表的好方法

【英文标题】：Good way to disable directory listing with http.FileServer in Go

【发布时间】：2018-09-10 09:30:01

【问题描述】：

如果你在 Go 中使用 http.FileServer 像：

func main() 
    port := flag.String("p", "8100", "port to serve on")
    directory := flag.String("d", ".", "the directory of static file to host")
    flag.Parse()

    http.Handle("/", http.FileServer(http.Dir(*directory)))

    log.Printf("Serving %s on HTTP port: %s\n", *directory, *port)
    log.Fatal(http.ListenAndServe(":"+*port, nil))

然后访问一个目录会给你一个文件列表。通常这对于 Web 服务是禁用的，而是以 404 响应，我也想要这种行为。

http.FileServer 对此 AFAIK 没有选项，我在这里看到了解决此问题的建议方法https://groups.google.com/forum/#!topic/golang-nuts/bStLPdIVM6w 他们所做的是包装 http.FileSystem 类型并实现自己的 Open 方法。但是，当路径是目录时，这不会给出 404，它只是给出一个空白页，并且不清楚如何修改它以适应这一点。他们就是这样做的：

type justFilesFilesystem struct 
    fs http.FileSystem


func (fs justFilesFilesystem) Open(name string) (http.File, error) 
    f, err := fs.fs.Open(name)
    if err != nil 
        return nil, err
    
    return neuteredReaddirFilef, nil


type neuteredReaddirFile struct 
    http.File


func (f neuteredReaddirFile) Readdir(count int) ([]os.FileInfo, error) 
    return nil, nil


func main() 
    fs := justFilesFilesystemhttp.Dir("/tmp/")
    http.ListenAndServe(":8080", http.FileServer(fs))

注意：如果您将 Readdir return nil, os.ErrNotExist 设为“读取目录错误”，则会收到 500 响应，而不是 404。

关于如何巧妙地呈现 404 并且仍然保留自动查找 index.html（如果存在）的功能的任何想法？

【问题讨论】：

如果从 Readdir 返回 nil, os.ErrNotExist 会发生什么？我希望这会导致 404 响应。

@Peter 在帖子中添加了关于当你这样做时会发生什么的注释。基本上，它返回 500，而不是 404。

要么包装处理程序以返回 404，要么编写一个简单的处理程序，使用 http.ServeContent 进行繁重的工作。

如果确实是文件并且如果 dir -> 404，可能只是回退一个级别和http.ServeFile()。更多的代码，但是，会工作。

【参考方案1】：

如果您替换的不是Readdir 方法，而是Stat，则可以更改此行为。 请看下面的工作代码。如果 index.html 文件在请求的目录中，它支持服务，如果没有 index.html 并且它是一个目录，则返回 404。

    package main

    import (
        "io"
        "net/http"
        "os"
    )

    type justFilesFilesystem struct 
        fs               http.FileSystem
        // readDirBatchSize - configuration parameter for `Readdir` func  
        readDirBatchSize int
    

    func (fs justFilesFilesystem) Open(name string) (http.File, error) 
        f, err := fs.fs.Open(name)
        if err != nil 
            return nil, err
        
        return neuteredStatFileFile: f, readDirBatchSize: fs.readDirBatchSize, nil
    

    type neuteredStatFile struct 
        http.File
        readDirBatchSize int
    

    func (e neuteredStatFile) Stat() (os.FileInfo, error) 
        s, err := e.File.Stat()
        if err != nil 
            return nil, err
        
        if s.IsDir() 
        LOOP:
            for 
                fl, err := e.File.Readdir(e.readDirBatchSize)
                switch err 
                case io.EOF:
                    break LOOP
                case nil:
                    for _, f := range fl 
                        if f.Name() == "index.html" 
                            return s, err
                        
                    
                default:
                    return nil, err
                
            
            return nil, os.ErrNotExist
        
        return s, err
    

    func main() 
        fs := justFilesFilesystemfs: http.Dir("/tmp/"), readDirBatchSize: 2
        fss := http.FileServer(fs)
        http.ListenAndServe(":8080", fss)