SkillAgentSearch skills...

Regin

封装go-gin框架

GenerateConvertImprove

Install / Use

/learn @go-touch/Regin
About this skill

Quality Score

0/100

Supported Platforms

Universal

README

regin框架

regin是一款基于go-gin框架封装的web框架,用于快速构建web应用和后端服务.

目录

<a id="安装与配置">安装与配置</a>

1. 安装Go (version 1.10+), 然后可使用下面命令进行安装regin

$ go get github.com/go-touch/regin

2. 设置系统环境变量

REGIN_RUNMODE = dev | test | prod

3. 依赖包安装(已安装可忽略)

$ go get github.com/gin-gonic/gin
$ go get github.com/unrolled/secure
$ go get github.com/go-sql-driver/mysql
$ go get github.com/garyburd/redigo/redis
$ go get gopkg.in/ini.v1
$ go get github.com/go-touch/mtype

4. 如使用go mod包依赖管理工具, 请参考下面命令

Windows 下开启 GO111MODULE 并设置 GOPROXY 的命令为：
$ set GO111MODULE=on
$ go env -w GOPROXY=https://goproxy.cn,direct
MacOS 或者 Linux 下开启 GO111MODULE 并设置 GOPROXY 的命令为：
$ export GO111MODULE=on
$ export GOPROXY=https://goproxy.cn

<a id="快速开始">快速开始</a>

入口文件: xxx/main.go (xxx 代表项目名称,后面也是)

package main

import (
	"github.com/go-touch/regin"
	_ "xxx/application/router"
)

func main() {
	regin.Guide.HttpService()
}

$ go run main.go
或者:
$ go build main.go
$ ./xxx

<a id="项目结构">项目结构</a>

  • application
    • modules // action存放目录,
      • demo // 模块名
    • model
      • bussiness // 业务类
      • common // 公共处理函数
      • dao // 抽象数据模型
      • form // 校验数据模型
      • mysql // mysql表字段映射模型
      • redis // redis数据模型
    • router // 注册路由, 主要通过map存储modules对应的action实例的映射
  • config
    • dev // 必要配置项(通过系统环境变量选择配置路径)
      • database.ini
      • server.ini
      • redis.ini
    • test
    • prod
  • runtime
    • log // 存储系统错误日志
  • main.go // 入口文件

<a id="路由配置">路由配置</a>

举例: xxx/application/router/demo.go

package router

import (
	"github.com/go-touch/regin/base"
	"mygin/application/modules/api/role"
	"mygin/application/modules/demo"
)

func init() {
	base.Router.General("demo", base.GeneralMap{
		"v1.index":      &demo.Index{}, // demo包下的action：Index
		"role.checkapi": &role.CheckApi{}, // role包下的action：CheckApi
	})
}

访问:
http://127.0.0.1/module/controller/action

示例:
http://127.0.0.1/demo/v1/index
http://127.0.0.1/demo/role/checkapi

Note: regin中的路由比较松散,url中pathinfo采用三段路径, 通过获取三段路由信息,使用 . 拼接作为key,读取路由map里面对应的action(action定义可查看web应用介绍). 因此路径的含义可依据路由配置定义,并无严格规定.

<a id="路由配置">服务配置</a>

配置项 xxx/config/server.ini

; 主配置
[main]
httpHost = 127.0.0.1:8080 // http服务地址端口
httpsHost = 127.0.0.1:443 // https服务地址端口

; 错误配置
[error]
log = true // 是否开启错误日志
读取format = {date}-Error // 日志文件名格式
pattern = local // 日志存储方式 local:本地 remote:远程

项目中使用配置

读取方式： (不会直接获取对应值,而是返回一个regin的configValue结构体指针，可实现对应类型转换)
config ：= service.App.GetConfig("xxx.xxx.xxx")

调用示例:
config := service.App.GetConfig("server.main.httpHost").ToString()

备注: server.ini、database.ini、redis.ini等必要配置项,文件和字段名均为regin使用,不可修改.

<a id="Web应用">Web应用</a>

基类action的代码示例: regin/base/app.action.go

package base

// action接口
type AppAction interface {
	BeforeExec(request *Request) (result *Result) // 调用方法 Exec 前执行, 可通过其实现token验证、鉴权等业务
	Exec(request *Request) (result *Result) // 用于实现具体的业务逻辑
}

// action接口的一个实现
type Action struct {
	AppAction
}

// Before action method
func (a *Action) BeforeExec(request *Request) (result *Result) {
	return
}

// Action method.
func (a *Action) Exec(request *Request) (result *Result) {
	return
}

项目action的代码示例: xxx/application/modules/demo/mysql_select.go

package demo

import (
	"github.com/go-touch/regin/app/db"
	"github.com/go-touch/regin/base"
)

type MysqlSelect struct {
	base.Action // 继承基类action
}

// 执行方法(重载方法)
func (this *MysqlSelect) Exec(request *base.Request) *base.Result {
	result := base.JsonResult()

	// 查询一条数据
	ret := db.Model("PlusArticle").FetchRow(func(dao *db.Dao) {
		dao.Where("id", 202)
	})

	// 错误处理
	if err := ret.ToError(); err != nil {
		result.SetData("code", 1000)
		result.SetData("msg", "系统出了点问题~")
		return result
	}

	// json输出数据库查询结果
	result.SetData("data", ret.ToStringMap())
	return result
}

*base.Request实例(封装param、get、post方法,自动json、xml解析)

获取请求方式
func GetMethod() string
获取error信息
func GetError() error
获取pathinfo数据. 参数key:路径名 defaultValue:默认值
func Param(key string, defaultValue ...string)
获取pathinfo数据map. 返回值: map[string]string
func ParamAll() map[string]string
获取GET数据. 参数key:路径名 defaultValue:默认值
func (r *Request) Get(key string, defaultValue ...string) string
获取GET数据map. 返回值: map[string]string

func GetAll() map[string]string

获取Post数据, json、xml等数据也用此方法. 返回值: *mtype.AnyMap(对应基础类型map[string]interface{} ,mtype更多使用可参考文档 https://github.com/go-touch/regin)
func Post() *mtype.AnyMap
获取上传文件io句柄. 返回值: []*multipart.FileHeader
PostFile(name string) []*multipart.FileHeader
获取POST元数据. 返回值: []byte
func (r *Request) Raw() []byte
映射请求数据为结构体. [参数]object: 要转换的结构体指针 method: 请求方式,默认post(可选参数).(内部采用json转换,可参考 encoding/json包的使用)
func (r *Request) ToStruct(object interface{}, method ...string) error
更多方法使用 request 调用
...

*base.Result实例(用于响应客户端)

type Result struct {
	Type   string // 可选值为:String、Json、Html、
	Page   string // 响应页面(Type = Html时必填)
	Status int    // 状态码 200正常状态
	Msg    string // 提示消息
	Data   AnyMap // 业务数据
}

// 定义RespResult
var ResultInvoker *Result

func init() {
	ResultInvoker = &Result{}
}

// 创建Json result
func (r *Result) CreateJson(status int, msg string) *Result {
	return &Result{
		Type:   "Json",
		Page:   "",
		Status: status,
		Msg:    msg,
		Data:   AnyMap{"code": 0, "msg": "", "data": ""},
	}
}

// 创建Html result
func (r *Result) CreateHtml(page string, status int, msg string) *Result {
	return &Result{
		Type:   "Html",
		Page:   page,
		Status: status,
		Msg:    msg,
		Data:   AnyMap{},
	}
}
获取一个可响应json的 *base.Result 实例
base.ResultInvoker.CreateJson(status int, msg string) *Result
获取一个可响应html的 *base.Result 实例
base.ResultInvoker.CreateHtml(status int, msg string) *Result
快速获取一个可响应json的 *base.Result 实例
base.JsonResult() *Result
修改业务数据即 *base.Result 的 Data 字段
func (r *Result) SetData(key string, value interface{})
获取业务数据即 *base.Result 的 Data 字段
func (r *Result) GetData(key string) interface{}

*base.AnyValue值类型（用于数据转换,对于不确定类型interfa{}比较适用)

获取 *base.AnyValue. 参数value:interface{}(可传任意值)
func base.Eval(value interface{}) *AnyValue
返回错误信息
func (av *AnyValue) ToError() error
返回原值
func (av *AnyValue) ToValue() interface{}
转成int类型
func (av *AnyValue) ToInt() int
转成byte类型
func (av *AnyValue) ToByte() byte
转成string类型
func (av *AnyValue) ToString() string
转成bool类型
func (av *AnyValue) ToBool() bool
转成map[string]string类型
func (av *AnyValue) ToStringMap() map[string]string
更多方法使用 *base.AnyValue 调用
...

<a id="数据库">数据库</a>

配置项 xxx/config/dev/database.ini

[plus_center] // 配置分组,必填
; 主库
master.driverName = mysql // 驱动名称
master.dataSourceName = root:root@tcp(127.0.0.1:3306)/dbName?charset=utf8 // 连接参数
master.maxIdleConn = 100 // 空闲连接数
master.maxOpenConn = 100 // 最大连接数

; 从库
slave.driverName = mysql
slave.dataSourceName = root:root@tcp(127.0.0.1:3306)/dbName?charset=utf8
slave.maxIdleConn = 100
slave.maxOpenConn = 100

Model的示例

package mysql

import (
	"github.com/go-touch/regin/app/db"
)

type Users struct{
	Id       string `field:id`
	Username string `field:"username"`
}

// 注册model
func init() {
	db.RegisterModel(&Users{}, "Users")
}

// 数据库标识(此方法可重构,用于切换数据库,默认master)
func (this *Users) Identify() string {
	return "plus_center.master"
}

// 数据库表名(此方法可重构,用于切换数据表)
func (this *Users) TableName() string {
	return "users"
}

// 自定义方法
func (this *Users) Method() string {
	ret := db.Model("Users").FetchAll(func(dao *db.Dao) {
		dao.Where("id", 202)
	})
}

(this *Users) Identify() string //设置数据库连接标识,对应数据库配置的key链关系

(this *Users) TableName() string // 设置真实数据表名,如未设置则默认结构体名称(注: AdminUser 会转成 admin_user)

使用Model查询一条记录示例:

第一种方式:
row := db.Model(&Users{}).FetchRow(func(dao *db.Dao) {
	dao.Where("id", 1)
})

第二种方式:
// 注册 Model, 第一个参数传入model实例化的指针, 第二个可选参数,用于起别名方便调用,不传名称默认为 mysql.Users .
db.RegisterModel(&Users{}, "Users")

// 使用别名获取 Dao 数据对象并使用 FetchRow 方法查询
row := db.Model("Users").FetchRow(func(dao *db.Dao) {
	dao.Where("id", 1)
})

Node: 推荐使用第二种方式,可以在初始化函数 init 批量注册model,这样在系统加载的时候仅调用一次注入容器.

db.Dao方法(举例均采用上述的第二种方式)

获取Dao数据对象.
db.Model(userModel interface{})

调用示例:
dao := db.Model(&Users{})
或
db.RegisterModel(&Users{}, "Users")
dao := db.Model("Users")
设置表名.(通常无需调用,注册model时已获取表名)
(d *Dao) Table(tableName string) *Dao

示例:
db.Model("Users").Table("message")
设置表字段.参数field: 可为string或[]string
(d *Dao) Field(field interface{}) *Dao

示例:
db.Model("Users").Field("a,b,c,d")
db.Model("Users").Field([]string{"a,b,c,d"})
设置查询条件. 参数field:字段名,参数value:字段值,参数linkSymbol:连接符(and[or] 默认and)
(d *Dao) Where(field interface{}, value interface{}, linkSymbol ...string) *Dao

示例:
db.Model("Users").Where("id", 1)
批量设置查询条件,和where类似. 参数是 key-value 的 map
(d *Dao) WhereMap(fieldMap map[string]interface{}, linkSymbol ...string) *Dao

示例:
db.Model("Users").WhereMap(map[string]interface{}{"id":1})
绑定数据,insert[update]时使用到.
(d *Dao) Values(valueMap map[string]interface{}) *Dao

示例:
db.Model("Users").Values(map[string]interface{}{"username":"zhangsan"})
设置排序. 参数不定
(d *Dao) Order(expr ...string) *Dao

示例:
db.Model("Users").Order("id ASC","username Desc")
批量设置排序. 与Order类似,参数为[]string
(d *Dao) OrderSlice(expr []string) *Dao

示例:
db.Model("Users").OrderSlice([]string{"id ASC","username Desc"})
设置查询检索记录行. 参数不定,对应sql语句 limit m,n
(d *Dao) Limit(limit ...int) *Dao

示例:
db.Model("Users").Limit(1,10)
是否返回sql. 需要在执行增删改查方法前调用
(d *Dao) Sql() *Dao

示例:
ret := db.Model("Users").FetchRow(func(dao *db.Dao) {
	dao.Sql()
})
fmt.Println(ret.ToStrin

go-touch

View profile

View on GitHub
GitHub Stars10
CategoryDevelopment
Updated5y ago
Forks3
go-touch/regin

Languages

Go

Security Score

55/100

Audited on Feb 3, 2021

No findings