Gin-OAuth2 开源项目教程

41 0 0

Gin-OAuth2 开源项目教程

gin-oauth2Middleware for Gin Framework users who also want to use OAuth2项目地址:https://gitcode.com/gh_mirrors/gi/gin-oauth2

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

Gin-OAuth2 项目的目录结构如下：




gin-oauth2/


├── LICENSE


├── README.md


├── client.go


├── client_test.go


├── config.go


├── config_test.go


├── example/


│   ├── main.go


│   └── oauth.go


├── go.mod


├── go.sum


├── middleware.go


├── middleware_test.go


├── token.go


└── token_test.go

目录结构介绍

LICENSE: 项目的许可证文件。README.md: 项目的说明文档。client.go: 包含 OAuth2 客户端的相关逻辑。client_test.go: 客户端逻辑的测试文件。config.go: 项目的配置文件处理逻辑。config_test.go: 配置文件处理逻辑的测试文件。example/: 包含示例代码的目录。
main.go: 示例程序的入口文件。oauth.go: 示例程序中的 OAuth2 相关逻辑。 go.mod 和 go.sum: Go 模块文件，用于管理项目的依赖。middleware.go: 包含 Gin 中间件的实现。middleware_test.go: 中间件的测试文件。token.go: 包含令牌处理的相关逻辑。token_test.go: 令牌处理逻辑的测试文件。

2. 项目的启动文件介绍

项目的启动文件位于 example/main.go。该文件是示例程序的入口点，展示了如何使用 Gin-OAuth2 中间件来保护 Gin 路由。

启动文件内容概览




package main


 


import (


    "log"


    "net/http"


    "github.com/gin-gonic/gin"


    "github.com/zalando/gin-oauth2"


)


 


func main() {


    router := gin.Default()


 


    // 配置 OAuth2 中间件


    router.Use(ginoauth2.RequestLogger([]string{"uid"}, "data"))


    router.Use(ginoauth2.Auth(ginoauth2.UidCheck))


 


    // 定义受保护的路由


    router.GET("/protected", func(c *gin.Context) {


        c.JSON(http.StatusOK, gin.H{"message": "Hello from protected route"})


    })


 


    // 启动服务器


    if err := router.Run(":8080"); err != nil {


        log.Fatalf("Server failed to start: %v", err)


    }


}

启动文件功能介绍

导入必要的包。创建 Gin 路由器实例。配置 OAuth2 中间件，包括请求日志和身份验证。定义受保护的路由 /protected。启动 HTTP 服务器并监听端口 8080。

3. 项目的配置文件介绍

Gin-OAuth2 项目没有显式的配置文件，但可以通过代码中的 config.go 文件进行配置。该文件定义了如何加载和处理配置。

配置文件内容概览




package main


 


import (


    "log"


    "os"


)


 


type Config struct {


    ClientID     string


    ClientSecret string


    TokenURL     string


}


 


func LoadConfig() *Config {


    return &Config{


        ClientID:     os.Getenv("CLIENT_ID"),


        ClientSecret: os.Getenv("CLIENT_SECRET"),


        TokenURL:     os.Getenv("TOKEN_URL"),


    }


}


 


func main() {


    config := LoadConfig()


    log.Printf("Loaded config: %+v", config)


}