GoAdmin 使用教程

GoAdmin 使用教程

go-admingo web api，包含gin+gorm+jwt+rbac等。项目地址:https://gitcode.com/gh_mirrors/goadm/go-admin

1. 项目目录结构及介绍

GoAdmin 的目录结构如下：

├── cmd        // 主程序入口
│   └── server  // 后台服务器启动文件
├── conf       // 配置文件目录
│   ├── app.conf  // 应用配置
│   └── others... // 其他配置
├── internal    // 内部模块，包含服务和处理器
│   ├── services      // 服务层逻辑
│   ├── handlers      // HTTP 请求处理器
│   └── models        // 数据模型
├── static     // 静态资源文件，如前端UI
└── templates   // 模板文件，用于生成HTML

这个结构是典型的Go Web应用组织形式，cmd 包含项目的主执行程序，conf 存放所有配置，internal 用于业务逻辑处理，static 和 templates 分别存放前端静态资源和后端渲染用到的模版。

2. 项目启动文件介绍

项目的后台服务器启动文件位于 cmd/server/main.go。你可以通过运行以下命令来启动服务：

go run cmd/server/main.go

此文件主要负责加载配置并初始化应用程序，然后启动HTTP服务器监听指定端口，处理来自客户端的请求。

3. 项目的配置文件介绍

GoAdmin 使用配置文件进行各种设置，通常放置在 conf 目录下。默认包含 app.conf 文件，这是一个JSON格式的文件，用来定义应用的基本配置，例如数据库连接字符串、服务器端口号等。

以下是 app.conf 示例内容：

{
  "app": {
    "name": "go-admin",
    "version": "1.0.0"
  },
  "server": {
    "host": "0.0.0.0",
    "port": 8080,
    "readTimeout": 15,
    "writeTimeout": 15
  },
  "database": {
    "driver": "mysql",
    "source": "root:password@tcp(localhost:3306)/go_admin?charset=utf8mb4&parseTime=True&loc=Local"
  },
  "session": {
    "provider": "memory",
    "cookieName": "gosessionid",
    "maxAge": 3600
  }
}

• app: 应用的基本信息，如名称和版本。
• server: 服务器配置，包括监听地址、端口以及读写超时时间。
• database: 数据库连接参数，包括驱动类型和连接字符串。
• session: 会话配置，如存储方式、cookie名和有效时间。

根据实际情况，可能还需要其他配置文件，比如日志、邮件服务等。这些配置可以通过相同的方式进行管理和加载。

如果你在安装或配置过程中遇到任何问题，可以查阅项目文档或社区讨论获取帮助。

go-admingo web api，包含gin+gorm+jwt+rbac等。项目地址:https://gitcode.com/gh_mirrors/goadm/go-admin