
本文详细介绍了在go语言后端服务中处理跨域资源共享(cors)预检(options)请求的最佳实践。通过采用中间件模式,我们能够以优雅且可复用的方式集中管理cors逻辑,避免代码冗余,并确保正确响应浏览器发出的预检请求,从而简化restful api的开发与维护。
理解CORS预检请求
跨域资源共享(CORS)是一种浏览器安全机制,旨在允许网页从不同域加载资源。当浏览器检测到跨域请求并非“简单请求”(例如,使用了PUT、delete方法,或包含自定义头部),它会在实际请求发送之前,自动发送一个http OPTIONS方法请求,即“预检请求”(Preflight Request)。
预检请求的目的是让浏览器查询服务器,了解实际请求是否安全可发送。服务器必须通过响应特定的CORS头部来明确告知浏览器,允许哪些源、哪些HTTP方法以及哪些自定义头部进行访问。如果预检请求未能获得服务器的许可,浏览器将不会发送实际请求。
传统处理方式的局限性
在go语言中,处理预检请求的常见初始思路可能包括以下两种:
-
在每个Handler函数内部使用switch语句判断请求方法:
func AddResourceHandler(rw http.ResponseWriter, r *http.Request) { switch r.Method { case "OPTIONS": // 处理预检请求逻辑 // 设置CORS响应头,例如: rw.Header().Set("access-Control-Allow-Origin", "http://localhost:3000") rw.Header().Set("Access-Control-Allow-Methods", "PUT, OPTIONS") rw.Header().Set("Access-Control-Allow-Headers", "Content-Type") rw.WriteHeader(http.StatusOK) case "PUT": // 处理实际PUT请求 rw.Write([]byte("Resource added")) default: http.Error(rw, "Method Not Allowed", http.StatusMethodNotAllowed) } }这种方式的缺点是,每个需要CORS支持的Handler都需要重复这段预检逻辑,导致代码冗余且难以维护。
-
为每个路径单独注册OPTIONS方法Handler(如使用Gorilla Mux):
// 假设 r 是 mux.Router 实例 r := mux.NewRouter() r.HandleFunc("/someresource/item", AddResourceHandler).Methods("PUT") r.HandleFunc("/someresource/item", PreflightAddResourceHandler).Methods("OPTIONS") func PreflightAddResourceHandler(rw http.ResponseWriter, r *http.Request) { // 处理预检请求逻辑,与上面switch中的OPTIONS分支类似 rw.Header().Set("Access-Control-Allow-Origin", "http://localhost:3000") rw.Header().Set("Access-Control-Allow-Methods", "PUT, OPTIONS") rw.Header().Set("Access-Control-Allow-Headers", "Content-Type") rw.WriteHeader(http.StatusOK) }虽然将预检逻辑分离到一个独立的函数中,但对于每个受CORS影响的路径,仍需手动注册一个对应的OPTIONS Handler,这在大型应用中会变得繁琐且容易出错。
推荐的处理策略:中间件模式
为了更优雅、更具可复用性地处理CORS预检请求,推荐采用中间件(Middleware)模式。中间件是一种函数,它接收一个HTTP Handler作为参数,并返回一个新的HTTP Handler。这个新的Handler可以在执行原始Handler之前或之后执行一些逻辑,或者在特定条件下完全取代原始Handler的执行。
通过中间件模式,我们可以创建一个通用的CORS处理逻辑,将其应用于所有需要CORS支持的路由,从而实现代码的集中管理和高度复用。
示例代码:基于net/http的中间件实现
以下是一个在net/http标准库中实现CORS中间件的示例:
package main import ( "fmt" "net/http" ) // corsMiddleware 是一个HTTP中间件,用于处理CORS预检请求和设置CORS响应头。 func corsMiddleware(next http.Handler) http.HandlerFunc { return func(w http.ResponseWriter, r *http.Request) { // 设置通用的CORS头部 // 注意:在生产环境中,应根据实际需求更精细地控制允许的源、方法和头部。 w.Header().Set("Access-Control-Allow-Origin", "http://localhost:3000") // 允许特定源 w.Header().Set("Access-Control-Allow-Methods", "GET, POST, PUT, DELETE, OPTIONS") w.Header().Set("Access-Control-Allow-Headers", "Content-Type, Authorization") w.Header().Set("Access-Control-Max-Age", "86400") // 预检请求的缓存时间,单位秒 // 如果是OPTIONS请求(预检请求),则直接返回200 OK if r.Method == http.MethodOptions { w.WriteHeader(http.StatusOK) return } // 如果不是OPTIONS请求,则将请求传递给下一个Handler next.ServeHTTP(w, r) } } // actualHandler 是实际处理业务逻辑的Handler func actualHandler(w http.ResponseWriter, r *http.Request) { fmt.Printf("Received %s request for %sn", r.Method, r.URL.Path) w.WriteHeader(http.StatusOK) w.Write([]byte(fmt.Sprintf("Hello from actualHandler! Method: %s", r.Method))) } func main() { // 创建一个实际的Handler实例 myActualHandler := http.HandlerFunc(actualHandler) // 使用corsMiddleware包装实际的Handler http.Handle("/api/resource", corsMiddleware(myActualHandler)) fmt.Println("Server listening on :8080") http.ListenAndServe(":8080", nil) }
在上述代码中:
- corsMiddleware函数接收一个http.Handler作为参数(即下一个要执行的业务逻辑Handler),并返回一个http.HandlerFunc。
- 在返回的HandlerFunc中,首先设置了所有请求都需要的CORS响应头部。
- 接着,它检查请求方法是否为OPTIONS。如果是,它直接返回http.StatusOK,结束请求处理,不再调用next.ServeHTTP(w, r),从而避免执行实际的业务逻辑。
- 如果不是OPTIONS请求,它会将请求传递给被包装的next Handler,让其处理实际的业务逻辑。
通过这种方式,您只需在注册路由时,用corsMiddleware包装您的业务Handler即可,无需在每个Handler内部重复CORS逻辑。
集成到路由框架
对于Gorilla Mux或其他Go路由框架,中间件模式同样适用。大多数现代Go路由框架都内置了中间件支持。例如,使用Gorilla Mux,您可以将中间件添加到路由器链中:
package main import ( "fmt" "net/http" "github.com/gorilla/mux" ) // corsMiddleware 保持不变 // actualHandler 保持不变 func main() { r := mux.NewRouter() // 将corsMiddleware应用于特定的路由 // 或者,如果需要全局应用,可以使用 r.Use(corsMiddleware) r.Handle("/api/resource", corsMiddleware(http.HandlerFunc(actualHandler))).Methods("GET", "POST", "PUT", "DELETE", "OPTIONS") fmt.Println("Server listening on :8080") http.ListenAndServe(":8080", r) }
在Gorilla Mux中,r.Use()方法可以将中间件应用于所有后续注册的路由。如果只想应用于特定路由,则在Handle方法中像上面示例一样包装即可。
注意事项与最佳实践
-
安全性与Access-Control-Allow-Origin:
- 在生产环境中,避免将Access-Control-Allow-Origin设置为*(允许所有源),除非您明确知道并接受其安全风险。
- 最佳实践是明确指定允许的源,例如http://your-frontend-domain.com。如果需要支持多个源,可以根据请求的Origin头部动态设置响应头。
-
可配置性:
-
通用CORS库:
- 对于更复杂的CORS场景,或者为了减少重复造轮子,强烈建议使用成熟的第三方CORS中间件库,例如github.com/rs/cors。这些库通常提供了更全面、更灵活的配置选项,并处理了许多边缘情况。
// 使用 github.com/rs/cors 示例 import ( "net/http" "github.com/rs