mgin

package module

v1.21.2 Latest Latest Go to latest Published: Jun 23, 2025 License: MIT Imports: 31 Imported by: 2

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/maczh/mgin

Links

Open Source Insights

README ¶

MGin 微服务框架

MGin微服务框架，用于快速创建基于MGin微服务框架的RESTful微服务程序

SDK使用说明

SDK使用说明

Get Start

简单案例

package main

import (
	"github.com/maczh/mgin"
)

func main() {
	app := mgin.NewApp("", "测试mgin项目", "1.0.0", false)
	app.Run()
}

创建一个yml配置文件，即可运行

MGin框架功能

Web服务框架

Gin

内置基础系统管理框架后端组件

开启方式 (v1.20.3之后版本)

go:
  sys:
    enabled: true    #是否开启内置系统管理组件
    initdb: true     #是否自动创建数据库表结构和基础数据
    baseUri: /api/v1   #基础组件接口地址前缀
    casbin: true    #是否开启casbin作为接口权限控制
    swagger:
      enabled: true       #是否开启sys基础模块的swagger接口文档
      uri: /swagger/sys   #swagger接口文档地址,此时地址为 /api/v1/swagger/sys/index.html
  casbin:
    enabled: true             #是否全局开启asbin,用于 middleware/casbin对外中间件使用
    model_file: casbin.conf   #casbin模型路径
  jwt:
    secret: 1234567890abcdef            #jwt密钥

内置模块
- 用户管理 sys_user
- 角色管理 sys_role
- 部门管理 sys_dept
- 岗位管理 sys_post
- API接口管理 sys_api
- 菜单管理 sys_menu for Vue前端
- 字典管理 sys_dict
- 系统配置管理 sys_config
- 接口权限管理 sys_role_api
- 菜单权限管理 sys_role_menu
- JWT token认证
- Casbin接口权限控制
- 角色接口表模式接口权限控制

支持统一的配置中心

Nacos
Consul
SpringCloud Config
Etcd
Polaris
File 本地文件

支持的服务发现与注册中心

Nacos
Consul
Etcd
Polaris

内置支持自动连接的数据库

MySQL (GORM v2)
MongoDB (官网驱动仿mgo.v2)
Redis (go-redis)
ElasitcSearch (olivere/elastic)
Kafka
SQLite
其他各类的数据库、消息队列等计划与中间件模式实现自动加载
Mysql/mongodb/redis已经支持多库连接

内置缓存

内存式缓存，带过期
本地持久化缓存 (bitcask),说明:Get返回string类型，自己转化目标类型

支持通过插件自动加载外部数据库、消息队列模块

func (m *mgin) Use(dbConfigName string, dbInit dbInitFunc, dbClose dbCloseFunc, dbCheck dbCheckFunc)
// 范例
import "github.com/maczh/mgrabbit"
...
//加载RabbitMQ消息队列
mgin.MGin.Use("rabbitmq", mgrabbit.Rabbit.Init, mgrabbit.Rabbit.Close, nil)

支持的接口协议

http
https
gRPC (计划)

支持的接口参数规范

x-form (x-form-urlencoded)
json (url query string + json body, POST + GET)
restful

安装

go get -u github.com/maczh/mgin

使用方法

本地配置文件

默认文件名为模块名.yml，可自定义名称，配置内容如下

go:
  application:
    name: myapp         #应用名称,用于自动注册微服务时的服务名
    port: 8080          #端口号
    project: myproj     #所属项目名称
    port_ssl:           #https端口号
    cert:               #ssl证书文件地址
    key:                #ssl证书私钥文件地址
    debug:              #本地调试模式，可注册到nacos，可调用其他微服务，调试实例不可被其他实例调用
    ip: xxx.xxx.xxx.xxx  #微服务注册时登记的本地IP，不配可自动获取，如需指定外网IP或Docker之外的IP时配置
  discovery:                      
    registry: nacos                    #微服务的服务发现与注册中心类型 nacos,consul,etcd,默认是 nacos
    callType: json                     #微服务调用参数模式 x-form,json,restful 三种模式可选
  config:                               #统一配置服务器相关
    server: http://192.168.1.5:8848/    #配置服务器地址
    server_type: nacos                  #配置服务器类型 nacos,consul,springconfig,etcd,polaris,file; 
                                        #nacos地址 http://{go.config.server}/nacos/v1/cs/configs?group={go.application.project}&&dataId={go.config.prefix.nacos}-{go.config.env}.yml
                                        #etcd key /config/{go.application.project}/{go.config.prefix.etcd}-{go.config.env}.yml
                                        #consul key /{go.application.project}/{go.config.prefix.consul}-{go.config.env}.yml
                                        #polaris key /config/v1/GetConfigFile?namespace=default&group={go.application.project}&fileName={go.config.prefix.consul}-{go.config.env}.yml
    env: test                           #配置环境 一般常用test/prod/dev等，跟相应配置文件匹配
    used: nacos,mysql,mongodb,redis,kafka     #当前应用启用的配置
    prefix:                             #配置文件名前缀定义
      mysql: mysql                      #mysql对应的配置文件名前缀，如当前配置中对应的配置文件名为 mysql-test.yml
      mongodb: mongodb
      redis: redis
      nacos: nacos
      sqlite: mytest.db                 #SQLite本地文件名
      elasticsearch: elasticsearch
      kafka: kafka
  jwt:
    secret: 1234567890abcdef            #jwt密钥
  logger:                 #控制台日志与文件日志输出，logs包的输出
    level: debug
    out: console,file          #日志输出到控制台与文件
    file: /opt/logs/myapp      #日志文件路径与前缀，后面自动加上.yyyy-MM-dd.log，目录必须已创建
  log:                    #controller接口访问日志与微服务调用请求日志
    db: mongodb           #日志库，支持mongodb与elasticsearch
    dbName: Partner-Id    #多库使用时，从http header中获取参数名作为库名标签
    req: MyappRequestLog  #接口访问日志表名称，在es中使用工程名称${go.application.project}_${go.log.req}作为索引名
    call: MyappCallLog    #微服务调用日志表，表名规则同上
    kafka:
      use: true           #接口日志是否发送到kafka
      topic: myapp        #kafka消息主题,支持多个topic，以逗号分隔

mysql配置范例 mysql-test.yml

go:
  data:
    mysql: user:pwd@tcp(xxx.xxx.xxx.xxx:3306)/dbname?charset=utf8&parseTime=True&loc=Local
    mysql_debug: true   #打开调试模式
    mysql_pool:     #连接池设置,若无此项则使用单一长连接
      max: 200      #实际最大连接数
      total: 1000   #最大并发数,不填默认为最大连接数5倍
      timeout: 30   #空闲连接超时，秒，默认60秒
      life: 5       #连接生命周期，分钟，默认60分钟

mysql多库连接配置范例 mysql-multidb-test.yml

go:
  data:
    mysql: 
      multidb: true
      dbNames: test1,test2
      test1: user1:pwd1@tcp(xxx.xxx.xxx.xxx:3306)/dbname1?charset=utf8&parseTime=True&loc=Local
      test2: user2:pwd2@tcp(xxx.xxx.xxx.xxx:3306)/dbname2?charset=utf8&parseTime=True&loc=Local
    mysql_debug: true   #打开调试模式
    mysql_pool:     #连接池设置,若无此项则使用单一长连接
      max: 200      #实际最大连接数
      total: 1000   #最大并发数,不填默认为最大连接数5倍
      timeout: 30   #空闲连接超时，秒，默认60秒
      life: 5       #连接生命周期，分钟，默认60分钟

mongodb配置范例 mongodb-test.yml

go:
  data:
    mongodb:
      uri: mongodb://user:pwd@xxx.xxx.xxx.xxx:port/dbname #当使用复制集时 mongodb://user:pwd@192.168..3.5:27017,192.168.3.6:27017/dbname?replicaSet=replsetname
      db: dbname
      debug: true   #打开调试模式
    mongo_pool:     #连接池设置,若无此项则使用单一长连接
      max: 20       #最大连接数

mongodb多库连接配置范例 mongodb-multidb-test.yml

go:
  data:
    mongodb:
      multidb: true
      dbNames: test1,test2
      test1:
          uri: mongodb://user1:pwd1@xxx.xxx.xxx.xxx:port/dbname1 #当使用复制集时 mongodb://user:pwd@192.168..3.5:27017,192.168.3.6:27017/dbname?replicaSet=replsetname
          db: dbname1
      test2:
        uri: mongodb://user2:pwd2@xxx.xxx.xxx.xxx:port/dbname2 #当使用复制集时 mongodb://user:pwd@192.168..3.5:27017,192.168.3.6:27017/dbname?replicaSet=replsetname
        db: dbname2
      debug: true   #打开调试模式
    mongo_pool:     #连接池设置,若无此项则使用单一长连接
      max: 20       #最大连接数

redis配置范例 redis-test.yml,支持集群模式与哨兵模式

go:
  data:
    redis:
      uri: xxx.xxx.xxx.xxx:6379[,xxx.xxx.xxx.xxx:6379,xxx.xxx.xxx.xxx:6379]    #uri与host+port选一种配置即可，多个ip+port就是集群模式
      host: xxx.xxx.xxx.xxx[,xxx.xxx.xxx.xxx,xxx.xxx.xxx.xxx]
      port: 6379[,6379,6379]
      password: password
      database: 1
      master: mymaster               #哨兵模式的master名称
      timeout: 1000
    redis_pool:
      min: 3        #最小空闲连接数,默认2
      max: 200      #连接池大小，最小默认10
      idle: 10      #空闲超时，分钟,默认5分钟
      timeout: 300  #连接超时，秒，默认60秒

redis多库连接配置范例 redis-multidb-test.yml,支持集群模式与哨兵模式

go:
  data:
    redis:
      multidb: true
      dbNames: test1,test2
      test1:
        uri: xxx.xxx.xxx.xxx:6379[,xxx.xxx.xxx.xxx:6379,xxx.xxx.xxx.xxx:6379]    #uri与host+port选一种配置即可，多个ip+port就是集群模式
        host: xxx.xxx.xxx.xxx[,xxx.xxx.xxx.xxx,xxx.xxx.xxx.xxx]
        port: 6379[,6379,6379]
        password: password
        database: 1
        master: mymaster               #哨兵模式的master名称
      test2:
        host: xxx.xxx.xxx.xxx
        port: 6379
        password: password
        database: 2
    redis_pool:
      min: 3        #最小空闲连接数,默认2
      max: 200      #连接池大小，最小默认10
      idle: 10      #空闲超时，分钟,默认5分钟
      timeout: 300  #连接超时，秒，默认60秒

nacos配置范例 nacos-test.yml

go:
  nacos:
    server: xxx.xxx.xxx   #nacos服务IP
    port: 8848            #nacos端口
    clusterName: DEFAULT
    group: OpenApi    #根据项目不同配置不同分组
    weight: 1
    lan: true   #以内网地址注册，否则以公网地址注册
    lanNet: 192.168.3.    #网段前缀

etcd配置范例 etcd-test.yml

go:
  etcd:
    server: xxx.xxx.xxx   #etcd服务IP
    port: 2379            #etcd端口
    clusterName: DEFAULT
    group: OpenApi    #根据项目不同配置不同分组
    weight: 1
    lan: true   #以内网地址注册，否则以公网地址注册
    lanNet: 192.168.3.    #网段前缀

consul配置范例 consul-test.yml

go:
  consul:
    server: xxx.xxx.xxx   #consul服务IP
    port: 2379            #consul端口
    clusterName: DEFAULT
    group: OpenApi    #根据项目不同配置不同分组
    weight: 1
    lan: true   #以内网地址注册，否则以公网地址注册
    lanNet: 192.168.3.    #网段前缀

polaris配置范例 polaris-test.yml

go:
  polaris:
    server: xxx.xxx.xxx   #polaris服务IP
    port: 8090            #polaris api端口
    namespace: default    #命名空间
    token: xxxxxxxxxxxx    #polaris token
    weight: 1
    lan: true   #以内网地址注册，否则以公网地址注册
    lanNet: 192.168.3.    #网段前缀

Elasticsearch配置范例 elasticsearch-test.yml

go:
  elasticsearch:
    uri: http://xxx.xxx.xxx.xxx:9200
    user: elastic
    password: ***********

Kafka连接配置范例 Kafka-test.yml

go:
  data:
    kafka:
      servers: "xxx.xxx.xxx.xxx:9092,xxx.xxx.xxx.xxx:9092"   #集群多个服务器之间用逗号分隔
      ack: all    #ack模式 no,local,all
      auto_commit: true   #是否自动提交
      partitioner: hash   #分区选择模式 hash,random,round-robin
      version: 2.8.1    #kafka版本

kafka发送消息

    db.Kafka.Send("my_topic", "测试消息")

kafka侦听主题消息并处理

定义消息处理函数

func handleMsg(msg string) error {
	logs.Debug("收到Kafka消息:{}",msg)
	return nil
}

在main.go中添加侦听代码

	//侦听kafka消息，说明，一个topic对应一个groupId
	err := db.Kafka.MessageListener("my_group_id","my_topic",handleMsg)
	if err != nil {
		logs.Error("侦听kafka消息失败")
	}

微服务工程范例

服务端参见 examples/mgin-server项目
客户端参见 examples/mgin-client项目

版本更新

v1.20.3 内置系统管理模块，仅需yml配置开启，自动建表，自带swagger文档
v1.20.1 新增App对象，极大简化创建一个新MGin应用
v1.19.42 持久化缓存改成bitcask，并且与内存缓存通过接口标准化处理
v1.19.38 新增支持断线重连的Redis.PSubscribe(dbName string, handler func(msg *redis.Message), channels ...string)函数,Kafka消费者增加断线重连功能
v1.19.36 redis支持cluster集群、哨兵模式集群与单机模式
v1.19.35 x-lang部分从POST改成GET，支持当前nacos注册分组
v1.19.21 dao层查询单条无记录时不返回error,返回数据为nil
v1.19.19 增加了mongo和mysql的dao，并且做了一些优化与修复了一些bug，并且新增了CopyStruct函数
v1.19.10 mysql/mongo/redis多库新增IsMultiDB与ListConnNames函数
v1.19.9 postlog支持多库根据header中的指定参数切库
v1.19.8 client.Options各参数改成any类型
v1.19.7 新增Struct2Map与AnyToMap函数
v1.19.5 nacos订阅统一管理与统一退订
v1.19.4 nacos sdk升级成1.1.4
v1.19.3 增加跨域自定义标头支持
v1.19.1 Result实现any与泛型T互转函数
v1.19.0 支持go 1.19，Result改用泛型,重构client.Call函数，支持泛型返回

Documentation ¶

Index ¶

func Init(configFile string)
type App
- func NewApp(configFile, appName, version string, xlang bool) *App
- func (app *App) Run()
type MginPlugin

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Init ¶

func Init(configFile string)

Types ¶

type App ¶ added in v1.20.1

type App struct {
	Router *gin.Engine
	MGin   *mgin
	// contains filtered or unexported fields
}

func NewApp ¶ added in v1.20.1

func NewApp(configFile, appName, version string, xlang bool) *App

NewApp 创建一个新的 MGin App 实例。参数:

configFile: 配置文件的路径。如果为空，将尝试从命令行参数获取。
appName: 应用程序的名称。
version: 应用程序的版本号。
xlang: 是否启用国际化支持。

返回值:

*App: 新创建的 App 实例指针。

func (*App) Run ¶ added in v1.20.1

func (app *App) Run()

Run 方法用于启动 HTTP 和 HTTPS 服务器，并监听系统信号以实现优雅关闭。

type MginPlugin ¶ added in v1.0.9

type MginPlugin interface {
	Init(configData []byte)
	Close()
	Check() error
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cache
casbin
client
config
db
dao
es
kafka
mongo
mysql
redis
sqlite
docs Package docs Code generated by swaggo/swag.	Package docs Code generated by swaggo/swag.
errcode
examples
mgin-server module
i18n
logs
middleware
casbin
cors
iplimit
jwt
limit
postlog
session
trace
xlang
xss XssMw provides an "auto remove XSS" from all user submitted input.	XssMw provides an "auto remove XSS" from all user submitted input.
models
sys
sys/request
sys/vo
registry
consul
etcd
nacos
polaris
sys
controller
dao
middle
route
service
utils

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL