go-chi/cors 开源项目使用教程

go-chi/cors 开源项目使用教程

项目地址:https://gitcode.com/gh_mirrors/cors2/cors

1. 项目的目录结构及介绍

go-chi/cors 项目的目录结构相对简单，主要包含以下几个部分：

go-chi/cors/
├── cors.go
├── cors_test.go
├── example/
│   ├── main.go
│   └── README.md
├── LICENSE
└── README.md

• cors.go: 这是项目的主要文件，包含了 CORS 中间件的实现。
• cors_test.go: 包含了对 CORS 中间件的单元测试。
• example/: 这个目录下包含了一个示例项目，展示了如何使用 CORS 中间件。
  • main.go: 示例项目的启动文件。
  • README.md: 示例项目的说明文档。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的说明文档。

2. 项目的启动文件介绍

在 example 目录下的 main.go 文件是示例项目的启动文件。以下是该文件的主要内容：

package main

import (
	"net/http"
	"github.com/go-chi/chi"
	"github.com/go-chi/cors"
)

func main() {
	r := chi.NewRouter()

	// 添加 CORS 中间件
	r.Use(cors.Handler(cors.Options{
		AllowedOrigins:   []string{"https://foo.com"},
		AllowedMethods:   []string{"GET", "POST", "PUT", "DELETE", "OPTIONS"},
		AllowedHeaders:   []string{"Accept", "Authorization", "Content-Type", "X-CSRF-Token"},
		ExposedHeaders:   []string{"Link"},
		AllowCredentials: false,
		MaxAge:           300, // Maximum value not ignored by any of major browsers
	}))

	r.Get("/", func(w http.ResponseWriter, r *http.Request) {
		w.Write([]byte("welcome"))
	})

	http.ListenAndServe(":3000", r)
}

这个文件展示了如何使用 go-chi/cors 中间件来处理跨域请求。通过 cors.Handler 函数配置 CORS 选项，然后将中间件应用到路由器上。

3. 项目的配置文件介绍

go-chi/cors 项目本身没有独立的配置文件，其配置是通过代码中的 cors.Options 结构体来完成的。以下是 cors.Options 结构体的主要字段：

type Options struct {
	AllowedOrigins   []string
	AllowedMethods   []string
	AllowedHeaders   []string
	ExposedHeaders   []string
	AllowCredentials bool
	MaxAge           int
}

• AllowedOrigins: 允许的源列表，例如 []string{"https://foo.com"}。
• AllowedMethods: 允许的 HTTP 方法列表，例如 []string{"GET", "POST", "PUT", "DELETE", "OPTIONS"}。
• AllowedHeaders: 允许的请求头列表，例如 []string{"Accept", "Authorization", "Content-Type", "X-CSRF-Token"}。
• ExposedHeaders: 允许暴露的响应头列表，例如 []string{"Link"}。
• AllowCredentials: 是否允许发送凭证（如 Cookies）。
• MaxAge: 预检请求的缓存时间，单位为秒。

通过配置这些选项，可以灵活地控制 CORS 中间件的行为。

cors CORS net/http middleware for Go 项目地址: https://gitcode.com/gh_mirrors/cors2/cors