快速开始

GoAdmin通过各种适配器使得你在各个web框架中使用都十分的方便。目前支持的web框架有：

你可以选择你拿手的或者业务项目正在用的框架开始，如果上述没有你喜欢的框架，欢迎给我们提issue！

下面以gin这个框架为例子，演示搭建过程。

main.go

在你的项目文件夹下新建一个main.go文件，内容如下：

  1. package main
  3. import (
  4.     _ "github.com/GoAdminGroup/go-admin/adapter/gin" // 引入适配器，必须引入，如若不引入，则需要自己定义
  5.     _ "github.com/GoAdminGroup/themes/adminlte" // 引入主题，必须引入，不然报错
  6.     _ "github.com/GoAdminGroup/go-admin/modules/db/drivers/mysql" // 引入对应数据库引擎
  8.     "github.com/GoAdminGroup/go-admin/engine"
  9.     "github.com/GoAdminGroup/go-admin/examples/datamodel"
  10.     "github.com/GoAdminGroup/go-admin/modules/config"
  11.     "github.com/GoAdminGroup/go-admin/modules/language"
  12.     "github.com/GoAdminGroup/go-admin/plugins/admin"
  13.     "github.com/gin-gonic/gin"
  14. )
  16. func main() {
  17.     r := gin.Default()
  19.     // 实例化一个GoAdmin引擎对象
  20.     eng := engine.Default()
  22.     // GoAdmin全局配置，也可以写成一个json，通过json引入
  23.     cfg := config.Config{
  24.         Databases: config.DatabaseList{
  25.             "default": {
  26.                 Host:       "127.0.0.1",
  27.                 Port:       "3306",
  28.                 User:       "root",
  29.                 Pwd:        "root",
  30.                 Name:       "godmin",
  31.                 MaxIdleCon: 50,
  32.                 MaxOpenCon: 150,
  33.                 Driver:     config.DriverMysql,
  34.             },
  35.         },
  36.         UrlPrefix: "admin", // 访问网站的前缀
  37.         // Store 必须设置且保证有写权限，否则增加不了新的管理员用户
  38.         Store: config.Store{
  39.             Path:   "./uploads",
  40.             Prefix: "uploads",
  41.         },
  42.         Language: language.CN,
  43.     }
  45.     // 这里引入你需要管理的业务表配置
  46.     // 关于Generators，详见 https://github.com/GoAdminGroup/go-admin/blob/master/examples/datamodel/tables.go
  47.     adminPlugin := admin.NewAdmin(datamodel.Generators)
  49.     // 增加配置与插件，使用Use方法挂载到Web框架中
  50.     _ = eng.AddConfig(cfg).AddPlugins(adminPlugin).Use(r)
  52.     _ = r.Run(":9033")
  53. }

请留意以上代码与注释，对应的步骤都加上了注释，使用十分简单，只需要：

  • 引入适配器，主题与数据库驱动
  • 设置全局的配置项
  • 初始化插件
  • 设置插件与配置
  • 挂载到Web框架中

接着执行go run main.go运行代码，访问：http://localhost:9033/admin/login 默认登录账号：admin默认登录密码：admin

注意：golang版本高于1.11强烈建议开启GO111MODULE=on，如果运行下载依赖有问题，这里提供了依赖包下载：

其他框架的例子可以参考：https://github.com/GoAdminGroup/go-admin/tree/master/examples

添加自己的业务表进行管理

详见：

{% page-ref page=”plugins/plugins.md” %}

{% page-ref page=”plugins/admin.md” %}

全局配置项说明

https://github.com/GoAdminGroup/go-admin/blob/master/modules/config/config.go

  1. package config
  3. import (
  4.     "html/template"
  5. )
  7. type Database struct {
  8.     Host         string  // 地址
  9.     Port         string  // 端口
  10.     User         string  // 用户名
  11.     Pwd          string  // 密码
  12.     Name         string  // 数据库名
  13.     MaxIdleCon   int     // 最大闲置连接数
  14.     MaxOpenCon   int     // 最大打开连接数
  15.     Driver       string  // 驱动名
  16.     File         string  // 文件名
  17. }
  19. // 数据库配置
  20. // 为一个map，其中key为数据库连接的名字，value为对应的数据配置
  21. // 注意：key为default的数据库是默认数据库，也是框架所用的数据库，而你可以
  22. // 配置多个数据库，提供给你的业务表使用，实现对不同数据库的管理。
  23. type DatabaseList map[string]Database
  25. // 存储目录：存储头像等上传文件
  26. type Store struct {
  27.     Path   string
  28.     Prefix string
  29. }
  31. type Config struct {
  32.     // 数据库配置
  33.     Databases DatabaseList `json:"database"`
  35.     // 登录域名
  36.     Domain string `json:"domain"`
  38.     // 网站语言
  39.     Language string `json:"language"`
  41.     // 全局的管理前缀
  42.     UrlPrefix string `json:"prefix"`
  44.     // 主题名
  45.     Theme string `json:"theme"`
  47.     // 上传文件存储的位置
  48.     Store Store `json:"store"`
  50.     // 网站的标题
  51.     Title string `json:"title"`
  53.     // 侧边栏上的Logo
  54.     Logo template.HTML `json:"logo"`
  56.     // 侧边栏上的Logo缩小版
  57.     MiniLogo template.HTML `json:"mini_logo"`
  59.     // 登录后跳转的路由
  60.     IndexUrl string `json:"index"`
  62.     // 是否开始debug模式
  63.     Debug bool `json:"debug"`
  65.     // Info日志路径
  66.     InfoLogPath string `json:"info_log"`
  68.     // Error log日志路径
  69.     ErrorLogPath string `json:"error_log"`
  71.     // Access log日志路径
  72.     AccessLogPath string `json:"access_log"`
  74.     // 是否开始数据库Sql操作日志
  75.     SqlLog bool `json:"sql_log"`
  77.     // 是否关闭access日志
  78.     AccessLogOff bool `json:"access_log_off"`
  79.     // 是否关闭info日志
  80.     InfoLogOff   bool `json:"info_log_off"`
  81.     // 是否关闭error日志
  82.     ErrorLogOff  bool `json:"error_log_off"`
  84.     // 网站颜色主题
  85.     ColorScheme string `json:"color_scheme"`
  87.     // Session的有效时间，单位为秒
  88.     SessionLifeTime int `json:"session_life_time"`
  90.     // Cdn链接，为全局js/css配置cdn链接
  91.     AssetUrl string `json:"asset_url"`
  93.     // 文件上传引擎
  94.     FileUploadEngine FileUploadEngine `json:"file_upload_engine"`
  96.     // 自定义头部js/css
  97.     CustomHeadHtml template.HTML `json:"custom_head_html"`
  99.     // 自定义尾部js/css
  100.     CustomFootHtml template.HTML `json:"custom_foot_html"`
  102.     // 登录页面标题
  103.     LoginTitle string `json:"login_title"`
  105.     // 登录页面logo
  106.     LoginLogo template.HTML `json:"login_logo"`
  107. }