基于 xorm 的服务端框架 XGoServer

简介: 作者:林冠宏 / 指尖下的幽灵 掘金:https://juejin.im/user/587f0dfe128fe100570ce2d8 博客:http://www.cnblogs.com/linguanh/ GitHub : https://github.

作者:林冠宏 / 指尖下的幽灵

掘金:https://juejin.im/user/587f0dfe128fe100570ce2d8

博客:http://www.cnblogs.com/linguanh/

GitHub : https://github.com/af913337456/

腾讯云专栏: https://cloud.tencent.com/developer/user/1148436/activities


开源地址:https://github.com/af913337456/XGoServer

你可以使用它

  • 简单快速搭建自己的服务端
  • 高级模块拓展,例如 jwt,token模块。数据加密传输等

具备的

  • 日志模块,alecthomas/log4go
  • 路由模块,gorilla/mux
  • 硬存储 / 软存储 采用 xorm 框架
  • 服务端通用的输出数据结构的整合,例如 json
如果你想直接输出一条 json 给客户端,这样子
func main()  {
    router := new (mux.Router)
    router.HandleFunc("/",test2).Methods("GET")
    core.HttpListen(router) 
}
func test2(w http.ResponseWriter,r *http.Request)  {
    // 非常简单的例子, 操作放在内部 , 可以使用 request 来获取自己的参数,再直接组织输出
    core.HandlerMapWithOutputJson(w, func() map[string]interface{} {
        m :=  map[string]interface{}{}
        m["msg"] = "blow me a kiss"
        return m
    })
}
// 结果 : {"msg":"blow me a kiss"}
与数据库交互
func test3(w http.ResponseWriter,r *http.Request)  {
    core.HandlerMapWithOutputJson(w, func() map[string]interface{} {
        // 插入一条评论
        item := &model.Comment{
            Id  :util.NewId(),         // 评论 id
            UserId  :"123456",             // 评论人 id
            Name    :"LinGuanHong",        // 评论人名称
            Content :"hello word",         // 评论内容
        }
        affect,_ := core.Engine.Insert(item)  // 执行插入,传入 struct 引用
        m :=  map[string]interface{}{}
        if affect > 0 {
            m["ret"] = "insert success"
            comments := make([]model.Comment, 0)
            core.Engine.Find(&comments)   // select 出来,获取所有评论输出
            m["msg"] = comments
        }else{
            m["ret"] = "insert failed"
        }
        return m
    })
}

输出的结果是:
{
  "msg": [
    {
      "id": "1kubpgh9pprrucy11e456fyytw",
      "UserId": "123456",
      "name": "LinGuanHong",
      "content": "hello word"
    }
  ],
  "ret": "insert success"
}

使用流程

目录如下

---- config
---- core
---- model
---- threeLibs
---- util
---- server.go

1 在 config 放置配置文件

  • 服务端配置 json 文件 -- server.json,
  • 日志配置文件 -- log.json 例如下面的,他们都会在运行程序后会自动解析和读取

2 threeLibs 目录放置了依赖的第三方库,例如 xorm,不需要你再去 go get

3 model 放置数据实体 struct

{
  "Host": "127.0.0.1",
  "Port": ":8884",
  "FilePort":":8885",
  "DbName":"lgh",
  "DbUser":"root",
  "DbPw":"123456",
  "DbPort":"3306"
}
{
  "EnableConsole": true,
  "ConsoleLevel": "DEBUG",
  "EnableFile": true,
  "FileLevel": "INFO",
  "FileFormat": "",
  "FileLocation": ""
}

从一个最基础的例子开始:

func main()  {
    router := new (mux.Router)
    router.HandleFunc("/",test).Methods("GET")
    /** 在下面添加你的路由 */
    /** add your routine func below */ 
    core.HttpListen(router)  // 简单的 http 监听,当然也提供了 https
}
func test(w http.ResponseWriter,r *http.Request)  {
    fmt.Fprintf(w,"======= hello world! =======")
}
// http 监听
func HttpListen(router *mux.Router)  {
    SimpleInit()  // 此处自动初始化 ---------- ①
    url := config.ServerConfig.Host+config.ServerConfig.Port
    util.LogInfo("服务启动于 : "+url)
    err := http.ListenAndServe(url,router)
    if err !=nil {
        util.LogInfo("http error ===> : "+err.Error())
        return
    }
}
// 绑定配置 json 的信息 以及 初始化 xorm mysql数据库引擎
func SimpleInit() bool {
    if config.BindServerConfig() {
        fmt.Println("BindServerConfig ==================> success")
        config.ConfigureLog(&config.LogConfig)
        CreateDefaultMysqlEngine(
            "mysql",
            config.ServerConfig.DbUser,
            config.ServerConfig.DbPw,
            config.ServerConfig.DbName)
        return true
    }else{
        fmt.Println("BindServerConfig ===> failed")
        return false
    }
}

服务端通用的输出数据结构的整合函数

type FinalResult struct {
    Data interface{}
}

type RetChannel chan FinalResult

func HandlerStruct(handle func() interface{}) *interface{} {
    RetChannel := make(RetChannel, 1)
    go func() {
        result := FinalResult{}
        data := handle()
        result.Data = &data
        RetChannel <- result
        close(RetChannel)
    }()
    ret := <-RetChannel
    return ret.Data.(*interface{})
}

func HandlerMap(handle func() map[string]interface{}) *map[string]interface{} {
    RetChannel := make(RetChannel, 1)
    go func() {
        result := FinalResult{}
        data := handle()
        result.Data = &data
        RetChannel <- result
        close(RetChannel)
    }()
    ret := <-RetChannel
    return ret.Data.(*map[string]interface{})
}

func HandlerStructWithOutputJson(w http.ResponseWriter,handle func() interface{})  {
    RetChannel := make(RetChannel, 1)
    go func() {
        result := FinalResult{}
        data := handle()
        result.Data = &data
        RetChannel <- result
        close(RetChannel)
    }()
    ret := <-RetChannel
    mapRet := ret.Data.(*interface{})
    util.RenderJson(w,mapRet)
}

func HandlerMapWithOutputJson(w http.ResponseWriter,handle func() map[string]interface{}){
    RetChannel := make(RetChannel, 1)
    go func() {
        result := FinalResult{}
        data := handle()
        result.Data = &data
        RetChannel <- result
        close(RetChannel)
    }()
    ret := <-RetChannel
    mapRet := ret.Data.(*map[string]interface{})
    util.RenderJson(w,mapRet)
}

就介绍这么多了

如果您认为这篇文章还不错或者有所收获,您可以通过扫描一下下面的支付宝二维码 打赏我一杯咖啡【物质支持】,也可以点击右下角的【推荐】按钮【精神支持】,因为这两种支持都是我继续写作,分享的最大动力


img_12e3f54d4d0f70f0eb14f20548e3d781.png
目录
相关文章
|
3月前
|
Go
【平台开发】基于 config、gencode_* 生成服务端ORM框架代码
【平台开发】基于 config、gencode_* 生成服务端ORM框架代码
26 1
|
6月前
|
Python
Django进行grpc通信
Django进行grpc通信
|
4月前
|
移动开发 JavaScript 网络协议
SpringBoot:Netty-SocketIO + VUE:SocketIO实现前后端实时双向通信
SpringBoot:Netty-SocketIO + VUE:SocketIO实现前后端实时双向通信
131 0
|
1月前
|
缓存 中间件 API
|
5月前
|
JSON 前端开发 API
json-server模拟后端接口
json-server模拟后端接口
38 0
|
10月前
|
JSON 中间件 Go
给Go的Gin web框架增加 WebSocket 功能,让WebSocket 更好用
给Go的Gin web框架增加 WebSocket 功能,让WebSocket 更好用
|
JSON 前端开发 JavaScript
使用NestJS搭建服务端应用(下)
使用NestJS搭建服务端应用(下)
使用NestJS搭建服务端应用(下)
|
JSON 资源调度 JavaScript
使用NestJS搭建服务端应用(上)
使用NestJS搭建服务端应用(上)
使用NestJS搭建服务端应用(上)
|
网络协议 前端开发 安全
Go 实现 WebSockets:1. 什么是 WebSockets
日常工作中,在不刷新页面的情况下发送消息并获得即时响应是我们认为理所当然的事情。但在过去,启用实时功能对开发人员来说是一个真正的挑战。开发者社区从 HTTP 长轮询和 AJAX 走过了漫长的道路,终于找到了构建真正实时应用程序的解决方案。
Go 实现 WebSockets:1. 什么是 WebSockets
|
存储 Java
【Groovy】使用 Groovy 语言开发服务器 Server 和客户端 Client 套接字程序 ( 服务器端开发 )
【Groovy】使用 Groovy 语言开发服务器 Server 和客户端 Client 套接字程序 ( 服务器端开发 )
125 0