gtoken 项目使用教程

gtoken 项目使用教程

gtoken基于gf框架的token插件，通过服务端验证方式实现token认证；项目地址:https://gitcode.com/gh_mirrors/gt/gtoken

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

gtoken 项目的目录结构如下：

gtoken/
├── example/
│   └── ...
├── gtoken/
│   ├── gitignore
│   ├── ChangeLog.md
│   ├── LICENSE
│   ├── README.md
│   ├── go.mod
│   ├── go.sum
│   └── ...
├── .gitignore
├── ChangeLog.md
├── LICENSE
├── README.md
├── go.mod
└── go.sum

目录结构介绍

• example/: 包含一些示例代码，展示如何使用 gtoken。
• gtoken/: 核心代码目录，包含 gtoken 的主要实现。
  • gitignore: Git 忽略文件。
  • ChangeLog.md: 变更日志。
  • LICENSE: 项目许可证。
  • README.md: 项目说明文档。
  • go.mod: Go 模块文件。
  • go.sum: Go 模块依赖校验文件。
• .gitignore: 根目录下的 Git 忽略文件。
• ChangeLog.md: 根目录下的变更日志。
• LICENSE: 根目录下的项目许可证。
• README.md: 根目录下的项目说明文档。
• go.mod: 根目录下的 Go 模块文件。
• go.sum: 根目录下的 Go 模块依赖校验文件。

2. 项目的启动文件介绍

gtoken 项目的启动文件通常位于 example/ 目录下，具体文件名可能会有所不同，但一般会包含一个 main.go 文件。以下是一个示例的 main.go 文件内容：

package main

import (
    "github.com/goflyfox/gtoken"
    "github.com/gogf/gf/frame/g"
    "github.com/gogf/gf/net/ghttp"
)

func main() {
    s := g.Server()
    s.Group("/", func(group *ghttp.RouterGroup) {
        group.Middleware(gtoken.Middleware)
        group.ALL("/user", func(r *ghttp.Request) {
            r.Response.Write("Hello, World!")
        })
    })
    s.SetPort(8199)
    s.Run()
}

启动文件介绍

• main.go: 主程序文件，包含服务器的初始化和路由配置。
  • import: 导入必要的包。
  • main 函数: 程序入口，初始化服务器并配置路由。
  • s.Group: 定义路由组，并应用 gtoken 中间件。
  • group.ALL: 定义具体的路由处理函数。
  • s.SetPort: 设置服务器端口。
  • s.Run: 启动服务器。

3. 项目的配置文件介绍

gtoken 项目的配置文件通常是一个 config.toml 或 config.yaml 文件，具体文件名和格式可能会有所不同。以下是一个示例的 config.toml 文件内容：

[server]
    address = "0.0.0.0"
    port = 8199

[gtoken]
    timeout = 864000 # 10 days
    maxRefresh = 432000 # 5 days
    cacheMode = 2 # gredis

配置文件介绍

• server: 服务器配置。
  • address: 服务器监听地址。
  • port: 服务器监听端口。
• gtoken: gtoken 配置。
  • timeout: token 超时时间（秒）。
  • maxRefresh: token 刷新时间（秒）。
  • cacheMode: 缓存模式（1: gcache, 2: gredis）。

以上是 gtoken 项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助！

gtoken基于gf框架的token插件，通过服务端验证方式实现token认证；项目地址:https://gitcode.com/gh_mirrors/gt/gtoken