在 Golang 中,如何在根目录之外提供静态内容,同时仍然拥有用于提供主页的根目录处理程序。
以下面的简单 Web 服务器为例:
package main
import (
"fmt"
"net/http"
)
func main() {
http.HandleFunc("/", HomeHandler) // homepage
http.ListenAndServe(":8080", nil)
}
func HomeHandler(w http.ResponseWriter, r *http.Request) {
fmt.Fprintf(w, "HomeHandler")
}
如果我这样做
http.Handle("/", http.FileServer(http.Dir("./")))
我收到一条恐慌消息,说我有两个“/”注册。我在互联网上找到的每个 Golang 示例都建议从不同的目录中提供静态内容,但这对于 sitemap.xml、favicon.ico、robots.txt 和其他实践或实践的文件没有多大帮助。强制要求始终从根目录提供服务。
我寻求的行为是在大多数 Web 服务器(例如 Apache、Nginx 或 IIS)中发现的行为,它首先遍历您的规则,如果没有找到规则,它会查找实际文件,如果没有找到文件是404s。我的猜测是,我需要编写一个
http.HandlerFunc
,而不是编写一个 http.Handler
,它检查我是否正在引用带有扩展名的文件,如果是,则检查文件是否存在并提供该文件,否则它会 404s 或提供主页是针对“/”的请求。不幸的是,我不确定如何开始这样的任务。
我的一部分说我把情况过于复杂化了,这让我觉得我错过了什么?任何指导将不胜感激。
另一种(不使用 ServeMux)解决方案是显式地提供位于根目录中的每个文件。背后的想法是保持基于根的文件数量非常少。 sitemap.xml、favicon.ico、robots.txt 确实被要求从根目录提供服务:
package main
import (
"fmt"
"net/http"
)
func HomeHandler(w http.ResponseWriter, r *http.Request) {
fmt.Fprintf(w, "HomeHandler")
}
func serveSingle(pattern string, filename string) {
http.HandleFunc(pattern, func(w http.ResponseWriter, r *http.Request) {
http.ServeFile(w, r, filename)
})
}
func main() {
http.HandleFunc("/", HomeHandler) // homepage
// Mandatory root-based resources
serveSingle("/sitemap.xml", "./sitemap.xml")
serveSingle("/favicon.ico", "./favicon.ico")
serveSingle("/robots.txt", "./robots.txt")
// Normal resources
http.Handle("/static", http.FileServer(http.Dir("./static/")))
http.ListenAndServe(":8080", nil)
}
请将所有其他资源(CSS、JS 等)移动到适当的子目录,例如
/static/
.
我想到的一件事可能对你有帮助,那就是你可以创建自己的 ServeMux。我添加到您的示例中,以便 chttp 是一个 ServeMux,您可以使用它来提供静态文件。然后 HomeHandler 检查是否应该提供文件。我只是检查一个“。”但你可以做很多事情。只是一个想法,可能不是您正在寻找的。
package main
import (
"fmt"
"net/http"
"strings"
)
var chttp = http.NewServeMux()
func main() {
chttp.Handle("/", http.FileServer(http.Dir("./")))
http.HandleFunc("/", HomeHandler) // homepage
http.ListenAndServe(":8080", nil)
}
func HomeHandler(w http.ResponseWriter, r *http.Request) {
if (strings.Contains(r.URL.Path, ".")) {
chttp.ServeHTTP(w, r)
} else {
fmt.Fprintf(w, "HomeHandler")
}
}
使用 Gorilla mux 包 :
r := mux.NewRouter()
//put your regular handlers here
//then comes root handler
r.HandleFunc("/", homePageHandler)
//if a path not found until now, e.g. "/image/tiny.png"
//this will look at "./public/image/tiny.png" at filesystem
r.PathPrefix("/").Handler(http.FileServer(http.Dir("./public/")))
http.Handle("/", r)
http.ListenAndServe(":8080", nil)
我建议使用中间件将其分为两个更容易解决的问题:
为了解决问题#1,使用serveStaticFilesMiddleware(参见下面的代码)来提供Web 根目录中名为“www”的目录的内容。例如,如果我们在 www 中创建一个名为 test.txt 的文件,则将从以下位置提供该文件:http://localhost:8000/test.txt
为了解决问题#2,我们创建一个名为serveIndexMiddleware 的中间件(参见下面的代码)。该中间件将处理任何对“/”的请求。如果请求不是针对“/”,则该中间件会将控制权传递给链中的下一个中间件(如果有)。在我们的例子中,如果文件存在,serveStaticFilesMiddleware 将执行并提供来自 www 的文件。
package main
import (
"io"
"log/slog"
"net/http"
"strings"
)
func main() {
mux := http.NewServeMux()
mux.Handle("GET /", serveIndexMiddleware(serveStaticFilesMiddleware("./www/", true)))
err := http.ListenAndServe("127.0.0.1:8000", mux)
if err != nil {
slog.Error("Http Server Error", "Message", err.Error())
}
}
func serveStaticFilesMiddleware(path http.Dir, disableDirectoryBrowsing bool) http.Handler {
fs := http.FileServer(path)
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if disableDirectoryBrowsing && strings.HasSuffix(r.URL.Path, "/") {
http.NotFound(w, r)
return
}
fs.ServeHTTP(w, r)
})
}
func serveIndexMiddleware(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if r.URL.Path == "/" {
io.WriteString(w, "Serve your web page here...")
return
}
next.ServeHTTP(w, r)
})
}
以上代码使用 go 1.23 进行测试,除了标准库之外没有任何依赖项。它利用了一些较新的 http 包功能,这些功能是在 go 1.22 中引入的。