feat: 数据库类型支持sqlite3 (#1)

Author: eryajf

.gitignore

@@ -11,6 +11,7 @@
 build.sh
 logs
 xirang
+xirang.db
 
 # Test binary, built with `go test -c`
 *.test

README.md

@@ -35,7 +35,7 @@
 
 只需要根据情况修改配置`config.yml`，然后配置里边的数据库配置信息，即可开始开发。
 
-数据表会自动创建，也可以通过docs下的sql自行创建。
+数据库支持MySQL与sqlite3，如果你的系统仅为运维内部一个小系统，则推荐你使用sqlite3。数据表会自动映射并创建。
 
 ## 👨‍💻 项目地址
 

config.yml

@@ -27,6 +27,12 @@ logs:
   # 是否压缩
   compress: false
 
+database:
+  # 数据库类型 mysql/sqlite3
+  driver: sqlite3
+  # 数据库连接sqlite3数据文件的路径
+  source: xirang.db
+
 mysql:
   # 用户名
   username: root

config/config.go

@@ -18,6 +18,7 @@ var Conf = new(config)
 type config struct {
 	System    *SystemConfig    `mapstructure:"system" json:"system"`
 	Logs      *LogsConfig      `mapstructure:"logs" json:"logs"`
+	Database  *Database        `mapstructure:"database" json:"database"`
 	Mysql     *MysqlConfig     `mapstructure:"mysql" json:"mysql"`
 	Casbin    *CasbinConfig    `mapstructure:"casbin" json:"casbin"`
 	Jwt       *JwtConfig       `mapstructure:"jwt" json:"jwt"`
@@ -99,6 +100,11 @@ type LogsConfig struct {
 	Compress   bool          `mapstructure:"compress" json:"compress"`
 }
 
+type Database struct {
+	Driver string `mapstructure:"driver" json:"driver"`
+	Source string `mapstructure:"source" json:"source"`
+}
+
 type MysqlConfig struct {
 	Username    string `mapstructure:"username" json:"username"`
 	Password    string `mapstructure:"password" json:"password"`

go.mod

@@ -18,14 +18,16 @@ require (
 	go.uber.org/zap v1.19.1
 	gopkg.in/natefinch/lumberjack.v2 v2.0.0
 	gorm.io/driver/mysql v1.3.2
-	gorm.io/gorm v1.23.6
+	gorm.io/driver/sqlite v1.3.6
+	gorm.io/gorm v1.23.8
 )
 
 require (
 	github.com/BurntSushi/toml v1.1.0 // indirect
 	github.com/golang-sql/sqlexp v0.0.0-20170517235910-f1bb20e5a188 // indirect
 	github.com/golang/mock v1.6.0 // indirect
 	github.com/lib/pq v1.10.4 // indirect
+	github.com/mattn/go-sqlite3 v1.14.15 // indirect
 	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
 	github.com/modern-go/reflect2 v1.0.2 // indirect
 	github.com/pelletier/go-toml/v2 v2.0.0 // indirect
@@ -53,7 +55,7 @@ require (
 	github.com/jackc/pgtype v1.10.0 // indirect
 	github.com/jackc/pgx/v4 v4.15.0 // indirect
 	github.com/jinzhu/inflection v1.0.0 // indirect
-	github.com/jinzhu/now v1.1.4 // indirect
+	github.com/jinzhu/now v1.1.5 // indirect
 	github.com/json-iterator/go v1.1.12 // indirect
 	github.com/leodido/go-urn v1.2.1 // indirect
 	github.com/magiconair/properties v1.8.6 // indirect

go.sum

@@ -24,7 +24,7 @@ func main() {
 	common.InitLogger()
 
 	// 初始化数据库(mysql)
-	common.InitMysql()
+	common.InitDB()
 
 	// 初始化casbin策略管理器
 	common.InitCasbinEnforcer()

main.go

@@ -1,6 +1,7 @@
 package middleware
 
 import (
+	"fmt"
 	"strings"
 	"time"
 
@@ -56,9 +57,9 @@ func OperationLogMiddleware() gin.HandlerFunc {
 			Path:       path,
 			Remark:     api.Remark,
 			Status:     c.Writer.Status(),
-			StartTime:  startTime,
+			StartTime:  fmt.Sprintf("%v", startTime),
 			TimeCost:   timeCost,
-			//UserAgent:  c.Request.UserAgent(),
+			UserAgent:  c.Request.UserAgent(),
 		}
 
 		// 最好是将日志发送到rabbitmq或者kafka中

middleware/OperationLogMiddleware.go

@@ -12,7 +12,7 @@ type Menu struct {
 	Path       string  `gorm:"type:varchar(100);comment:'菜单访问路径'" json:"path"`
 	Redirect   string  `gorm:"type:varchar(100);comment:'重定向路径'" json:"redirect"`
 	Component  string  `gorm:"type:varchar(100);comment:'前端组件路径'" json:"component"`
-	Sort       uint    `gorm:"type:int(3) unsigned;default:999;comment:'菜单顺序(1-999)'" json:"sort"`
+	Sort       uint    `gorm:"type:int(3);default:999;comment:'菜单顺序(1-999)'" json:"sort"`
 	Status     uint    `gorm:"type:tinyint(1);default:1;comment:'菜单状态(正常/禁用, 默认正常)'" json:"status"`
 	Hidden     uint    `gorm:"type:tinyint(1);default:2;comment:'菜单在侧边栏隐藏(1隐藏，2显示)'" json:"hidden"`
 	NoCache    uint    `gorm:"type:tinyint(1);default:2;comment:'菜单是否被 <keep-alive> 缓存(1不缓存，2缓存)'" json:"noCache"`

model/menu.go

@@ -1,21 +1,19 @@
 package model
 
 import (
-	"time"
-
 	"gorm.io/gorm"
 )
 
 type OperationLog struct {
 	gorm.Model
-	Username   string    `gorm:"type:varchar(20);comment:'用户登录名'" json:"username"`
-	Ip         string    `gorm:"type:varchar(20);comment:'Ip地址'" json:"ip"`
-	IpLocation string    `gorm:"type:varchar(20);comment:'Ip所在地'" json:"ipLocation"`
-	Method     string    `gorm:"type:varchar(20);comment:'请求方式'" json:"method"`
-	Path       string    `gorm:"type:varchar(100);comment:'访问路径'" json:"path"`
-	Remark     string    `gorm:"type:varchar(100);comment:'备注'" json:"remark"`
-	Status     int       `gorm:"type:int(4);comment:'响应状态码'" json:"status"`
-	StartTime  time.Time `gorm:"type:datetime(3);comment:'发起时间'" json:"startTime"`
-	TimeCost   int64     `gorm:"type:int(6);comment:'请求耗时(ms)'" json:"timeCost"`
-	UserAgent  string    `gorm:"type:varchar(20);comment:'浏览器标识'" json:"userAgent"`
+	Username   string `gorm:"type:varchar(20);comment:'用户登录名'" json:"username"`
+	Ip         string `gorm:"type:varchar(20);comment:'Ip地址'" json:"ip"`
+	IpLocation string `gorm:"type:varchar(20);comment:'Ip所在地'" json:"ipLocation"`
+	Method     string `gorm:"type:varchar(20);comment:'请求方式'" json:"method"`
+	Path       string `gorm:"type:varchar(100);comment:'访问路径'" json:"path"`
+	Remark     string `gorm:"type:varchar(100);comment:'备注'" json:"remark"`
+	Status     int    `gorm:"type:int(4);comment:'响应状态码'" json:"status"`
+	StartTime  string `gorm:"type:varchar(2048);comment:'发起时间'" json:"startTime"`
+	TimeCost   int64  `gorm:"type:int(6);comment:'请求耗时(ms)'" json:"timeCost"`
+	UserAgent  string `gorm:"type:varchar(2048);comment:'浏览器标识'" json:"userAgent"`
 }

model/operation_log.go

@@ -7,14 +7,38 @@ import (
 	"github.com/eryajf/xirang/model"
 
 	"gorm.io/driver/mysql"
+	"gorm.io/driver/sqlite"
 	"gorm.io/gorm"
 )
 
-// 全局mysql数据库变量
+// 全局数据库对象
 var DB *gorm.DB
 
-// 初始化mysql数据库
-func InitMysql() {
+// 初始化数据库
+func InitDB() {
+	if config.Conf.Database.Driver == "mysql" {
+		initMysql()
+	} else if config.Conf.Database.Driver == "sqlite3" {
+		initSqlite3()
+	}
+}
+
+func initSqlite3() {
+	db, err := gorm.Open(sqlite.Open(config.Conf.Database.Source+"?charset=utf8mb4&parseTime=True&loc=Local"), &gorm.Config{
+		// 禁用外键(指定外键时不会在mysql创建真实的外键约束)
+		DisableForeignKeyConstraintWhenMigrating: true,
+	})
+	if err != nil {
+		Log.Panicf("failed to connect sqlite3: %v", err)
+	}
+
+	DB = db
+	// 自动迁移表结构
+	dbAutoMigrate()
+	Log.Infof("初始化 sqlite3 数据库完成!")
+}
+
+func initMysql() {
 	dsn := fmt.Sprintf("%s:%s@tcp(%s:%d)/%s?charset=%s&collation=%s&%s",
 		config.Conf.Mysql.Username,
 		config.Conf.Mysql.Password,
@@ -40,10 +64,6 @@ func InitMysql() {
 	db, err := gorm.Open(mysql.Open(dsn), &gorm.Config{
 		// 禁用外键(指定外键时不会在mysql创建真实的外键约束)
 		DisableForeignKeyConstraintWhenMigrating: true,
-		//// 指定表前缀
-		//NamingStrategy: schema.NamingStrategy{
-		//	TablePrefix: config.Conf.Mysql.TablePrefix + "_",
-		//},
 	})
 	if err != nil {
 		Log.Panicf("初始化mysql数据库异常: %v", err)

public/common/database.go

@@ -117,6 +117,7 @@ func InitData() {
 			Component: "/personnel/group/index",
 			Sort:      7,
 			ParentId:  uint1,
+			NoCache:   1,
 			Roles:     roles[:1],
 			Creator:   "系统",
 		},

public/common/init_mysql_data.go

@@ -48,7 +48,7 @@ func (s OperationLogService) SaveOperationLogChannel(olc <-chan *model.Operation
 // List 获取数据列表
 func (s OperationLogService) List(req *request.OperationLogListReq) ([]*model.OperationLog, error) {
 	var list []*model.OperationLog
-	db := common.DB.Model(&model.OperationLog{}).Order("start_time DESC")
+	db := common.DB.Model(&model.OperationLog{}).Order("id DESC")
 
 	username := strings.TrimSpace(req.Username)
 	if username != "" {

service/isql/operation_log_isql.go

@@ -18,7 +18,7 @@ func InitConfig() {
 	common.InitLogger()
 
 	// 初始化数据库(mysql)
-	common.InitMysql()
+	common.InitDB()
 
 	// 初始化casbin策略管理器
 	common.InitCasbinEnforcer()