Cadmin golang 服务端

项目地址: [github] [gitee]

在线文档地址: https://baiy.github.io/Cadmin/

特点

  1. 为便于给现有系统加入后台管理功能和加快新系统开发, 后台核心系统尽可能的减少依赖, 不侵入外层业务系统.
  2. 对请求处理按照请求类型可自定义请求调度类,便于不用业务系统使用和开发.

安装

  1. go get -u github.com/baiy/Cadmin-server-go

数据库

详见 数据库结构 一章

使用方法

在代码安装和数据库导入完毕后, 接下来需要将后台系统的入口代码嵌入当前系统的合适位置, 并进行相应的配置

原生

  1. package main
  3. import (
  4.     "database/sql"
  5.     "fmt"
  6.     "github.com/baiy/Cadmin-server-go/admin"
  7.     _ "github.com/baiy/Cadmin-server-go/system" // 注册内置请求处理方法
  8.     _ "github.com/go-sql-driver/mysql"
  9.     "net/http"
  10. )
  12. var db *sql.DB
  15. // 初始化数据库
  16. func initDb() {
  17.     var err error
  18.     db, err = sql.Open("mysql", "root:root@/admin_api_new?charset=utf8mb4&parseTime=True&loc=Local")
  19.     if err != nil {
  20.         panic(err)
  21.     }
  22. }
  24. func main() {
  25.     initDb()
  27.     // 设置数据库操作对象
  28.     admin.SetDb(db)
  29.     // [可选] 注册自定义调度器
  30.     // admin.RegisterDispatch()
  31.     // [可选] 设置自定义密码生成器
  32.     // admin.RegisterPassword()
  33.     // [可选] 无需校验权限的api
  34.     // admin.AddNoCheckLoginRequestId()
  35.     // [可选] 只需登录即可访问的api
  36.     // admin.AddOnlyLoginRequestId()
  37.     // [可选] 设置请求标识变量名
  38.     // admin.ActionName = ""
  39.     // [可选] 设置请求token变量名
  40.     // admin.TokenName = ""
  41.     // [可选] 设置请求日志记录回调函数
  42.     //admin.RegisterLogCallback()
  44.     http.HandleFunc("/api/admin/", func(writer http.ResponseWriter, request *http.Request) {
  45.         // 前后端分离项目一般会有跨域问题 自行处理
  46.         writer.Header().Add("Access-Control-Allow-Origin", "*")
  47.         writer.Header().Add("Access-Control-Allow-Headers", "Content-Type")
  49.         context := admin.NewContext(writer, request)
  50.         if err := context.Output(); err != nil {
  51.             fmt.Println(err)
  52.         }
  53.     })
  54.     _ = http.ListenAndServe("127.0.0.1:8001", nil)
  55. }

Beego

  1. package main
  3. import (
  4.     "fmt"
  5.     "github.com/astaxie/beego"
  6.     "github.com/astaxie/beego/context"
  7.     "github.com/astaxie/beego/orm"
  8.     "github.com/baiy/Cadmin-server-go/admin"
  9.     _ "github.com/baiy/Cadmin-server-go/system" // 注册内置请求处理方法
  10.     _ "github.com/go-sql-driver/mysql"          // import your used driver
  11. )
  13. func main() {
  14.     orm.RegisterDataBase("default", "mysql", "root:root@/admin_api_new?charset=utf8mb4&parseTime=True&loc=Local", 30)
  15.     db, _ := orm.GetDB("default")
  16.     admin.SetDb(db)
  17.     // 省略其他配置代码 查看原生示例代码
  19.     beego.Any("/api/admin/", func(ctx *context.Context) {
  20.         ctx.ResponseWriter.ResponseWriter.Header().Add("Access-Control-Allow-Origin", "*")
  21.         ctx.ResponseWriter.ResponseWriter.Header().Add("Access-Control-Allow-Headers", "Content-Type")
  22.         c := admin.NewContext(ctx.ResponseWriter.ResponseWriter, ctx.Request)
  23.         if err := c.Output(); err != nil {
  24.             fmt.Println(err)
  25.         }
  26.     })
  27.     beego.Run("127.0.0.1:8001")
  28. }

Gorm

  1. package main
  3. import (
  4.     "fmt"
  5.     "github.com/baiy/Cadmin-server-go/admin"
  6.     _ "github.com/baiy/Cadmin-server-go/system" // 注册内置请求处理方法
  7.     _ "github.com/go-sql-driver/mysql"
  8.     "github.com/jinzhu/gorm"
  9.     "net/http"
  10. )
  12. func main() {
  13.     db, _ := gorm.Open("mysql", "root:root@/admin_api_new?charset=utf8mb4&parseTime=True&loc=Local")
  14.     defer db.Close()
  16.     admin.SetDb(db.DB())
  17.     // 省略其他配置代码 查看原生示例代码
  18.     http.HandleFunc("/api/admin/", func(writer http.ResponseWriter, request *http.Request) {
  19.         // 前后端分离项目一般会有跨域问题 自行处理
  20.         writer.Header().Add("Access-Control-Allow-Origin", "*")
  21.         writer.Header().Add("Access-Control-Allow-Headers", "Content-Type")
  23.         context := admin.NewContext(writer, request)
  24.         if err := context.Output(); err != nil {
  25.             fmt.Println(err)
  26.         }
  27.     })
  28.     _ = http.ListenAndServe("127.0.0.1:8001", nil)
  30. }

Xorm

  1. package main
  3. import (
  4.     "fmt"
  5.     "github.com/baiy/Cadmin-server-go/admin"
  6.     _ "github.com/baiy/Cadmin-server-go/system" // 注册内置请求处理方法
  7.     _ "github.com/go-sql-driver/mysql"
  8.     "github.com/go-xorm/xorm"
  9.     "net/http"
  10. )
  12. func main() {
  13.     engine, _ := xorm.NewEngine("mysql", "root:root@/admin_api_new?charset=utf8mb4&parseTime=True&loc=Local")
  14.     admin.SetDb(engine.DB().DB)
  15.     // 省略其他配置代码 查看原生示例代码
  16.     http.HandleFunc("/api/admin/", func(writer http.ResponseWriter, request *http.Request) {
  17.         // 前后端分离项目一般会有跨域问题 自行处理
  18.         writer.Header().Add("Access-Control-Allow-Origin", "*")
  19.         writer.Header().Add("Access-Control-Allow-Headers", "Content-Type")
  21.         context := admin.NewContext(writer, request)
  22.         if err := context.Output(); err != nil {
  23.             fmt.Println(err)
  24.         }
  25.     })
  26.     _ = http.ListenAndServe("127.0.0.1:8001", nil)
  27. }

自定义用户密码生成策略

  1. 实现 github.com/baiy/Cadmin-service-go/admin.Passwrod 接口
  2. 注册密码生成器,使用github.com/baiy/Cadmin-service-go/admin.RegisterPassword()

系统内置密码生成器: https://github.com/baiy/Cadmin-server-go/blob/master/admin/password.go

请求调度器开发

  1. 实现 github.com/baiy/Cadmin-service-go/admin.Dispatch 接口
  2. 注册调度器,使用github.com/baiy/Cadmin-service-go/admin.RegisterDispatch()

内置调度器: https://github.com/baiy/Cadmin-server-go/blob/master/admin/dispatch.go

使用默认调度器开发

  1. package router
  3. import (
  4.     "github.com/baiy/Cadmin-service-go/admin"
  5. )
  7. func init(){
  8.     admin.RegisterDefaultDispatcherHandleMethod(map[string]admin.DefaultDispatcherHandleMethod{
  9.         "request.call":func (context *admin.Context) (interface{}, error) {return nil,nil},
  10.     })
  11. }

request.call 对应后台请求中的类型配置值