Golang轻松为API添加跨域资源共享功能的插件库CORS的使用

简介

CORS是一个net/http处理程序，实现了Golang中的跨域资源共享W3规范。

快速开始

安装Go并设置好GOPATH后，创建第一个.go文件，我们称之为server.go：

package main

import (
    "net/http"

    "github.com/rs/cors"
)

func main() {
    mux := http.NewServeMux()
    mux.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
        w.Header().Set("Content-Type", "application/json")
        w.Write([]byte("{\"hello\": \"world\"}"))
    })

    // cors.Default() setup the middleware with default options being
    // all origins accepted with simple methods (GET, POST). See
    // documentation below for more options.
    handler := cors.Default().Handler(mux)
    http.ListenAndServe(":8080", handler)
}

安装cors库：

go get github.com/rs/cors

然后运行服务器：

go run server.go

服务器现在运行在localhost:8080上：

$ curl -D - -H 'Origin: http://foo.com' http://localhost:8080/
HTTP/1.1 200 OK
Access-Control-Allow-Origin: foo.com
Content-Type: application/json
Date: Sat, 25 Oct 2014 03:43:57 GMT
Content-Length: 18

{"hello": "world"}

参数配置

参数通过cors.New方法传递给中间件：

c := cors.New(cors.Options{
    AllowedOrigins: []string{"http://foo.com", "http://foo.com:8080"},
    AllowCredentials: true,
    // Enable Debugging for testing, consider disabling in production
    Debug: true,
})

// Insert the middleware
handler = c.Handler(handler)

可用参数：

• AllowedOrigins []string: 允许跨域请求的源列表。如果包含特殊值*，则允许所有源。源可以包含通配符(*)。
• AllowOriginFunc func (origin string) bool: 验证源的自定义函数。
• AllowedMethods []string: 客户端允许使用的跨域请求方法。默认值是简单方法(GET和POST)。
• AllowedHeaders []string: 客户端允许使用的非简单头部列表。
• ExposedHeaders []string: 指示哪些头部可以安全地暴露给CORS API规范。
• AllowCredentials bool: 指示请求是否可以包含用户凭据如cookies等。默认为false。
• MaxAge int: 预检请求结果可以缓存的时间(秒)。默认是0(不缓存)。
• OptionsPassthrough bool: 让其他潜在的下一个处理程序处理OPTIONS方法。
• OptionsSuccessStatus int: 用于成功OPTIONS请求的状态码。默认值是http.StatusNoContent(204)。
• Debug bool: 调试标志，为服务器端CORS问题添加额外输出。

更多示例

// 更详细的配置示例
c := cors.New(cors.Options{
    AllowedOrigins: []string{"https://www.example.com", "http://localhost:3000"},
    AllowedMethods: []string{"GET", "POST", "PUT", "DELETE", "OPTIONS"},
    AllowedHeaders: []string{"Accept", "Content-Type", "Authorization"},
    ExposedHeaders: []string{"Link"},
    AllowCredentials: false,
    MaxAge: 300,
})

性能基准

goos: darwin
goarch: arm64
pkg: github.com/rs/cors
BenchmarkWithout-10            135325480         8.124 ns/op       0 B/op       0 allocs/op
BenchmarkDefault-10            24082140        51.40 ns/op       0 B/op       0 allocs/op
BenchmarkAllowedOrigin-10      16424518        88.25 ns/op       0 B/op       0 allocs/op
BenchmarkPreflight-10          8010259       147.3 ns/op       0 B/op       0 allocs/op
BenchmarkPreflightHeader-10    6850962       175.0 ns/op       0 B/op       0 allocs/op

所有源代码均根据MIT许可证授权。