gogo

package module
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 28, 2019 License: MIT Imports: 14 Imported by: 0

README

GoGo Logo

Go语言轻量web开发框架，特点是一行代码搞定RESTFul，不依赖第三方ORM，也不需要生成一堆的controllers和models文件，快速使用。

背景

公司数据库有100多张表，用BeeGo等框架，需要生成controllers和models等文件共200多个，鼠标滑都滑不过来。每次表字段一有修改，代码就要统统跟着修改，想想都恐怖，于是就有了这个项目。支持增删改查的同时，针对増查支持批量操作，并集成了轻量的web开发框架。

快速使用

package main

import (
	"net/http"
	"strconv"

	"gitee.com/hequan2020/gogo"
)

func main() {

	// 初始化数据库连接
	if err := gogo.SQLInit("mysql", "数据库用户名:数据库密码@tcp(数据库地址:数据库端口)/表名?charset=utf8", 10, 1); err != nil {
	err != nil {
		gogo.Log().Error(err.Error())
		return
	}

	// 增
	gogo.POST("/restful/:tablename", func(ctx *gogo.HTTPContext) {
		affect, err := gogo.SQLInsert(
			ctx.GetPathParam(":tablename"),
			ctx.GetPostBody())

		if err != nil {
			gogo.Log().Error(err.Error())
			ctx.WriteString(err.Error())
		} else {
			ctx.WriteString(strconv.FormatInt(affect, 10))
		}
	})

	// 删
	gogo.DELETE("/restful/:tablename/:id", func(ctx *gogo.HTTPContext) {
		affect, err := gogo.SQLDelete(
			ctx.GetPathParam(":tablename"),
			"id="+ctx.GetPathParam(":id"))

		if err != nil {
			gogo.Log().Error(err.Error())
			ctx.WriteString(err.Error())
		} else {
			ctx.WriteString(strconv.FormatInt(affect, 10))
		}
	})

	// 改
	gogo.PUT("/restful/:tablename/:id", func(ctx *gogo.HTTPContext) {
		affect, err := gogo.SQLUpdate(
			ctx.GetPathParam(":tablename"),
			"id="+ctx.GetPathParam(":id"),
			ctx.GetPostBody())

		if err != nil {
			gogo.Log().Error(err.Error())
			ctx.WriteString(err.Error())
		} else {
			ctx.WriteString(strconv.FormatInt(affect, 10))
		}
	})

	// 查
	gogo.GET("/restful/:tablename/:id", func(ctx *gogo.HTTPContext) {
		queryData, err := gogo.SQLQueryByMap(
			"",
			ctx.GetString("feilds"),
			ctx.GetPathParam(":tablename"),
			"id="+ctx.GetPathParam(":id"),
			"", 0, 1)

		if err != nil {
			gogo.Log().Error(err.Error())
			ctx.WriteString(err.Error())
		} else {
			ctx.WriteJSON(queryData)
		}
	})

	// 查
	gogo.GET("/restful/:tablename", func(ctx *gogo.HTTPContext) {
		queryData, err := gogo.SQLQueryByMap(
			ctx.GetString("columnname"),
			ctx.GetString("feilds"),
			ctx.GetPathParam(":tablename"),
			ctx.GetString("where"),
			ctx.GetString("order"),
			ctx.GetInt("offset", 0),
			ctx.GetInt("count", 10))

		if err != nil {
			gogo.Log().Error(err.Error())
			ctx.WriteString(err.Error())
		} else {
			ctx.WriteJSON(queryData)
		}
	})

	// 404页面
	gogo.STATUS(http.StatusNotFound, func(ctx *gogo.HTTPContext) {
		ctx.WriteHeader(http.StatusNotFound)

		l, err := gogo.SQLQueryByMap("webname", "*", "dede_flink", "", "", 0, 100)
		if err == nil {
			ctx.WriteExecute(l,
				"views/notfound.tmpl")
			return
		}
	})

	// 启动HTTP服务
	gogo.Run(":3009")
}

数据库表结构

mysql> desc dede_flink;
+----------+----------------------+------+-----+---------+----------------+
| Field    | Type                 | Null | Key | Default | Extra          |
+----------+----------------------+------+-----+---------+----------------+
| id       | smallint(5) unsigned | NO   | PRI | NULL    | auto_increment |
| sortrank | smallint(6)          | NO   |     | 0       |                |
| url      | char(60)             | NO   |     |         |                |
| webname  | char(30)             | NO   |     |         |                |
| msg      | char(200)            | NO   |     |         |                |
| email    | char(50)             | NO   |     |         |                |
| logo     | char(60)             | NO   |     |         |                |
| dtime    | int(10) unsigned     | NO   |     | 0       |                |
| typeid   | smallint(5) unsigned | NO   |     | 0       |                |
| ischeck  | smallint(6)          | NO   |     | 1       |                |
+----------+----------------------+------+-----+---------+----------------+
10 rows in set

Windows

go build -o app.exe
app.exe

Linux/MacOS

go build -o app
./app

浏览器访问测试

  • 增
POST http://localhost:3009/restful/dede_flink

以下是application/json内容，可以批量添加多条数据

[
	{
    	"id": 20,
    	"ischeck": 1,
    	"webname": "hxyw",
    	"url":"http://www.hxyw.org"
	},
	{
    	"id": 21,
    	"ischeck": 1,
    	"webname": "bejson",
    	"url":"http://www.bejson.com"
	}
]
  • 改
PUT http://localhost:3009/restful/dede_flink/21

以下是application/json内容，这里只将id=21的数据，webname字段修改为"hello"

{
    "webname": "hello"
}
  • 查
GET http://localhost:3009/restful/dede_flink/21
GET http://localhost:3009/restful/dede_flink?order=-id
GET http://localhost:3009/restful/dede_flink?offset=10&&count=100&&columnname=webname
  • 删
DELETE http://localhost:3009/restful/dede_flink/1
  • 404
GET http://localhost:3009/weqwe

Start using it

  1. Download and install it:
$ go get github.com/go-sql-driver/mysql
$ go get github.com/phachon/go-logger
$ go get gitee.com/konyshe/gogo
  1. Import it in your code:
import "gitee.com/konyshe/gogo"
  1. (Optional) Import net/http. This is required for example if using constants such as http.StatusNotFound.
import "net/http"

示例中的方法介绍，更全的请看代码中的注释

// 系统会优先判断是否命中固定URL，当固定URL无法命中的情况下，才会去判断是否命中正则URL(开发中部分支持)
gogo.GET("/restful/:tablename/:columnname", func(ctx *gogo.HTTPContext)

// 注册没有命中任何URL规则时进入的函数
gogo.STATUS(http.StatusNotFound, func(ctx *gogo.HTTPContext)

// SQLInit 初始化数据库操作句柄，这里要提供:
// driverName string: 数据库类型，例如mysql、sqlite等，参考github.com/go-sql-driver/mysql官方介绍
// dataSourceName string: 数据库地址，参考github.com/go-sql-driver/mysql官方介绍
// MaxOpenConns int: 最大缓存连接数，这个数值包含了MaxIdleConns
// MaxIdleConns int：预备的最大空闲连接数
gogo.SQLInit(driverName string, dataSourceName string, maxOpenConns int, maxIdleConns int) error

// SQLInsert 增加一条数据
// tableName string: 操作的表名
// data []byte: 需要更新的内容，用string转换后是json格式
gogo.SQLInsert(tableName string, data []byte) (int64, error)

// SQLDelete 根据where条件删除数据
// tableName string: 操作的表名
// where string: 过滤条件，就是where后面跟着的部分
gogo.SQLDelete(tableName, where string) (int64, error)

// SQLUpdate 更新一条数据
// tableName string: 操作的表名
// where string: 过滤条件，就是where后面跟着的部分
// data []byte: 需要更新的内容，用string转换后是json格式
gogo.SQLUpdate(tableName, where string, data []byte) (int64, error)

// SQLQueryByMap 将查询到的数据，按照指定字段的值做为索引构建map并返回
// columnName string: 作为索引的字段名称
// feilds string: 查询需要获取哪些字段的值，就是select后面跟着的部分，一般用"*"
// tableName string: 查询的表名
// where string: 过滤条件，就是where后面跟着的部分
// order string: 排序条件，就是order by后面跟着的部分。默认是ASC排序，除非"-"开头则DESC排序
// offset string: limit后面逗号相隔的两个数值，前者就是offset，后者就是count
// count string: limit后面逗号相隔的两个数值，前者就是offset，后者就是count
gogo.SQLQueryByMap(columname, feilds, tableName, where, order string, offset, count int) (interface{}, error)

// 输出日志到运行目录下的log目录下，同时控制台输出，还会根据日志级别显示不同颜色
// gogo.Log()返回的是go-logger的指针，后面的.Error()是go-logger的方法，具体使用参考github.com/phachon/go-logger
// content string: 需要输出的日志内容
// 如果你不喜欢，可以直接删掉LOGUtils.go文件
gogo.Log().Error(content string)

// 3009就是端口号了，这里和官方HTTP接口方法一致
gogo.Run(":3009")

// GetResponseWriter 获取原始的http.ResponseWriter指针
(ctx *HTTPContext) GetResponseWriter() http.ResponseWriter

// GetRequest 获取原始的http.Request指针
(ctx *HTTPContext) GetRequest() *http.Request

// GetPathParam 获取GET请求路径中的String格式参数值，例如/restful/:table_name/:id
// key string: 参数名称
(ctx *HTTPContext) GetPathParam(key string) string

// GetPostBody 获取POST请求的内容
(ctx *HTTPContext) GetPostBody() []byte

// WriteExecute 将官方原始的ParseFiles和Execute接口做了合并
// data interface{}: 渲染模板需要的数据
// filenames ...string: 模板文件路径
(ctx *HTTPContext) WriteExecute(data interface{}, filenames ...string) error

// WriteByte 将[]byte格式的数据输出给HTTP客户端
// content []byte: 需要输出HTTP客户端的[]byte格式数据
(ctx *HTTPContext) WriteByte(content []byte)

// WriteString 将String格式的数据输出给HTTP客户端
// content string: 需要输出HTTP客户端的String格式数据
(ctx *HTTPContext) WriteString(content string)

// WriteJSON 将Struct结构体的数据转换成Json输出给HTTP客户端
// v interface{}: 需要输出HTTP客户端的Struct结构体数据
(ctx *HTTPContext) WriteJSON(v interface{}) error

GoGo v1.1.2

  • add sql for 支持SQL，一行代码搞定RESTFul，无需一堆的controllers和models文件。还支持以表中任何一个字段作为MAP索引输出，方便客户端调用

GoGo v1.0.0

  • add router for GET, POST
  • add router for STATUS
  • add router for 解析URL，例如: /:table_name/:id

欢迎贡献者加入

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DELETE 

func DELETE(pattern string, handler func(*HTTPContext))

DELETE 注册DELETE请求函数，注册固定URL、解析URL函数 pattern string：触发路径 handler httpProcFunc: 触发函数

func GET 

func GET(pattern string, handler func(*HTTPContext))

GET 注册GET请求函数，注册固定URL、解析URL函数 pattern string：触发路径 handler httpProcFunc: 触发函数

func Log 

func Log() *go_logger.Logger

Log GoGo使用的第三方go_logger库，输出到日志文件的同时还会在控制台输出，并根据日志级别显示不同颜色 这里返回go_logger的指针，使用方法参考github.com/phachon/go-logger

func POST 

func POST(pattern string, handler func(*HTTPContext))

POST 注册POST请求函数，注册固定URL、解析URL函数 pattern string：触发路径 handler httpProcFunc: 触发函数

func PUT 

func PUT(pattern string, handler func(*HTTPContext))

PUT 注册PUT请求函数，注册固定URL、解析URL函数 pattern string：触发路径 handler httpProcFunc: 触发函数

func Run 

func Run(addr string)

Run gorouter application. gorouter.Run() default run on HttpPort gorouter.Run("localhost") gorouter.Run(":8089") gorouter.Run("127.0.0.1:8089")

func SQLDelete 

func SQLDelete(tableName, where string) (int64, error)

SQLDelete 根据where条件删除数据 tableName string: 操作的表名 where string: 过滤条件，就是where后面跟着的部分

func SQLInit 

func SQLInit(driverName, dataSourceName string, maxOpenConns, maxIdleConns int) error

SQLInit 初始化数据库操作句柄，这里要提供: driverName string: 数据库类型，例如mysql、sqlite等，参考github.com/go-sql-driver/mysql官方介绍 dataSourceName string: 数据库地址，参考github.com/go-sql-driver/mysql官方介绍 MaxOpenConns int: 最大缓存连接数，这个数值包含了MaxIdleConns MaxIdleConns int：预备的最大空闲连接数

func SQLInsert 

func SQLInsert(tableName string, data []byte) (int64, error)

SQLInsert 增加一条数据 tableName string: 操作的表名 data []byte: 需要更新的内容，用string转换后是json格式

func SQLQueryByMap 

func SQLQueryByMap(columnName, feilds, tableName, where, order string, offset, count int) (interface{}, error)

SQLQueryByMap 将查询到的数据，按照指定字段的值做为索引构建map并返回 columnName string: 作为索引的字段名称 feilds string: 查询需要获取哪些字段的值，就是select后面跟着的部分，一般用"*" tableName string: 查询的表名 where string: 过滤条件，就是where后面跟着的部分 order string: 排序条件，就是order by后面跟着的部分。默认是ASC排序，除非"-"开头则DESC排序 offset string: limit后面逗号相隔的两个数值，前者就是offset，后者就是count count string: limit后面逗号相隔的两个数值，前者就是offset，后者就是count

func SQLUpdate 

func SQLUpdate(tableName, where string, data []byte) (int64, error)

SQLUpdate 更新一条数据 tableName string: 操作的表名 where string: 过滤条件，就是where后面跟着的部分 data []byte: 需要更新的内容，用string转换后是json格式

func STATUS 

func STATUS(status int, handler func(*HTTPContext))

STATUS 注册指定HTTP状态触发的函数 status int：触发状态 handler httpProcFunc: 触发函数

Types

type HTTPContext 

type HTTPContext struct {
	// contains filtered or unexported fields
}

HTTPContext 提供给客户使用的扩展指针，包含了原始的http.ResponseWriter和http.Request，同时还提供了封装好的一系列方便函数

func (*HTTPContext) GetInt 

func (ctx *HTTPContext) GetInt(key string, def ...int) int

GetInt 获取GET请求?后面的int参数值 key string: 参数名称 def ...int: 参数可选，当获取参数值无效的时候，便返回这里提供的值

func (*HTTPContext) GetInt64 

func (ctx *HTTPContext) GetInt64(key string, def ...int64) int64

GetInt64 获取GET请求?后面的int64参数值 key string: 参数名称 def ...int64: 参数可选，当获取参数值无效的时候，便返回这里提供的值

func (*HTTPContext) GetPathParam 

func (ctx *HTTPContext) GetPathParam(key string) string

GetPathParam 获取GET请求路径中的String格式参数值，例如/restful/:table_name/:id key string: 参数名称

func (*HTTPContext) GetPostBody 

func (ctx *HTTPContext) GetPostBody() []byte

GetPostBody 获取POST请求的内容

func (*HTTPContext) GetR 

func (ctx *HTTPContext) GetR() *http.Request

GetR 获取原始的http.Request

func (*HTTPContext) GetRequest 

func (ctx *HTTPContext) GetRequest() *http.Request

GetRequest 获取原始的http.Request

func (*HTTPContext) GetResponseWriter 

func (ctx *HTTPContext) GetResponseWriter() http.ResponseWriter

GetResponseWriter 获取原始的http.ResponseWriter

func (*HTTPContext) GetString 

func (ctx *HTTPContext) GetString(key string, def ...string) string

GetString 获取GET请求?后面的String参数值, key string: 参数名称 def ...string: 参数可选，当获取参数值无效的时候，便返回这里提供的值

func (*HTTPContext) GetW 

func (ctx *HTTPContext) GetW() http.ResponseWriter

GetW 获取原始的http.ResponseWriter

func (*HTTPContext) Redirect 

func (ctx *HTTPContext) Redirect(url string, status int)

Redirect 网页跳转 url string: 跳转的url status int: 需要写入头部的状态，例如http.StatusOK

func (*HTTPContext) WriteByte 

func (ctx *HTTPContext) WriteByte(content []byte)

WriteByte 将[]byte格式的数据输出给HTTP客户端 content []byte: 需要输出HTTP客户端的[]byte格式数据

func (*HTTPContext) WriteExecute 

func (ctx *HTTPContext) WriteExecute(data interface{}, filenames ...string) error

WriteExecute 将官方原始的ParseFiles和Execute接口做了合并 data interface{}: 渲染模板需要的数据 filenames ...string: 模板文件路径

func (*HTTPContext) WriteHeader 

func (ctx *HTTPContext) WriteHeader(status int)

WriteHeader 指定Status到头部输出给HTTP客户端 status int: HTTP状态, 参考net\http\status.go

func (*HTTPContext) WriteJSON 

func (ctx *HTTPContext) WriteJSON(v interface{}) error

WriteJSON 将Struct结构体的数据转换成Json输出给HTTP客户端 v interface{}: 需要输出HTTP客户端的Struct结构体数据

func (*HTTPContext) WriteString 

func (ctx *HTTPContext) WriteString(content string)

WriteString 将String格式的数据输出给HTTP客户端 content string: 需要输出HTTP客户端的String格式数据

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.