support database sqlite

Author: zhufuyi

.github/RELEASE.md

@@ -1,8 +1,9 @@
 ## Change log
 
 - Added generate database initialization code command.
-- Added support for postgresql, tidb generation code.
+- Added support for postgresql, tidb, sqlite generation code.
 - Modify the Sponge UI interface.
 - Adjust database configuration in configuration.
 - Added generate k8s configmap script command.
 - The generated code version matches the local sponge version.
+- Fixed redundant createdAt and updatedAt fields in service and handler.

Makefile

@@ -169,7 +169,7 @@ image-build-rpc-test:
 
 
 .PHONY: patch
-# patch some dependent code, such as types.proto, mysql initialization code. e.g. make patch TYPE=types-pb , make patch TYPE=init-mysql, make patch TYPE=init-postgresql
+# patch some dependent code, such as types.proto, mysql initialization code. e.g. make patch TYPE=types-pb , make patch TYPE=init-your_db_driver, replace "your_db_driver" with mysql, postgresql, tidb, sqlite
 patch:
 	@bash scripts/patch.sh $(TYPE)
 

README.md

@@ -15,7 +15,7 @@
 
 </div>
 
-**Sponge** is a basic development framework that integrates `code auto generation`, `gin and grpc`, sponge has a wealth of generating code commands, generating different functional code can be combined into a complete service (similar to the way that artificially broken sponge cells can automatically recombine into a new sponge). The code is decoupled and modularly designed, it is easy to build a complete project from development to deployment, so that you develop web or microservices project easily, Go can also be "low-code development".
+**Sponge** is a basic development framework that integrates `code auto generation`, `Gin and GRPC`, sponge has a rich set of code generation commands, generating different functional code can be combined into a complete service (similar to the way that artificially broken sponge cells can automatically recombine into a new sponge). The code is decoupled and modularly designed, it is easy to build a complete project from development to deployment, just fill in the business logic code on the generated template code, greatly improved development efficiency and reduced development difficulty, the use of Go can also be "low-code development".
 
 <br>
 

assets/readme-cn.md

@@ -1,7 +1,7 @@
 
 
 
-[sponge](https://github.com/zhufuyi/sponge) 是一个集成了 `自动生成代码`、`gin和grpc` 的基础开发框架。sponge拥有丰富的生成代码命令，生成不同的功能代码可以组合成完整的服务(类似人为打散的海绵细胞可以自动重组成一个新的海绵)。代码解耦模块化设计，很容易构建出从开发到部署的完整工程项目，让你开发web或微服务项目轻而易举、事半功倍，使用go也可以"低代码开发"。
+[sponge](https://github.com/zhufuyi/sponge) 是一个集成了 `自动生成代码`、`Gin和GRPC` 的基础开发框架。sponge拥有丰富的生成代码命令，生成不同的功能代码可以组合成完整的服务(类似人为打散的海绵细胞可以自动重组成一个新的海绵)。代码解耦模块化设计，很容易构建出从开发到部署的完整工程项目，只需在生成的模板代码上填充具体业务逻辑代码，极大的提高了开发效率和降低了开发难度，使用go也可以"低代码开发"。
 
 <br>
 

cmd/sponge/commands/generate/common.go

@@ -27,6 +27,8 @@ const (
 	DBDriverPostgresql = "postgresql"
 	// DBDriverTidb tidb driver
 	DBDriverTidb = "tidb"
+	// DBDriverSqlite sqlite driver
+	DBDriverSqlite = "sqlite"
 )
 
 var (
@@ -88,8 +90,8 @@ var (
 	appConfigFileMark  = "# todo generate http or rpc server configuration here"
 	appConfigFileMark2 = "# todo generate the database configuration here"
 
-	deploymentConfigFile     = "kubernetes/serverNameExample-configmap.yml"
-	deploymentConfigFileMark = "# todo generate the database configuration for deployment here"
+	//deploymentConfigFile     = "kubernetes/serverNameExample-configmap.yml"
+	//deploymentConfigFileMark = "# todo generate the database configuration for deployment here"
 
 	spongeTemplateVersionMark = "// todo generate the local sponge template code version here"
 
@@ -372,27 +374,42 @@ func replacePackage(data []byte, moduleName string, serverName string) []byte {
 	return data
 }
 
-func getDBConfigCode(dbDriver string, forDeployment ...bool) string {
-	isDeployment := false
-	if len(forDeployment) > 0 {
-		isDeployment = forDeployment[0]
-	}
-
+//func getDBConfigCode(dbDriver string, forDeployment ...bool) string {
+//	isDeployment := false
+//	if len(forDeployment) > 0 {
+//		isDeployment = forDeployment[0]
+//	}
+//
+//	dbConfigCode := ""
+//	switch strings.ToLower(dbDriver) {
+//	case DBDriverMysql, DBDriverTidb:
+//		if isDeployment {
+//			dbConfigCode = mysqlConfigForDeploymentCode
+//		} else {
+//			dbConfigCode = mysqlConfigCode
+//		}
+//
+//	case DBDriverPostgresql:
+//		if isDeployment {
+//			dbConfigCode = postgresqlConfigForDeploymentCode
+//		} else {
+//			dbConfigCode = postgresqlConfigCode
+//		}
+//	default:
+//		panic("getDBConfigCode error, unsupported database driver: " + dbDriver)
+//	}
+//	return dbConfigCode
+//}
+
+func getDBConfigCode(dbDriver string) string {
 	dbConfigCode := ""
 	switch strings.ToLower(dbDriver) {
 	case DBDriverMysql, DBDriverTidb:
-		if isDeployment {
-			dbConfigCode = mysqlConfigForDeploymentCode
-		} else {
-			dbConfigCode = mysqlConfigCode
-		}
-
+		dbConfigCode = mysqlConfigCode
 	case DBDriverPostgresql:
-		if isDeployment {
-			dbConfigCode = postgresqlConfigForDeploymentCode
-		} else {
-			dbConfigCode = postgresqlConfigCode
-		}
+		dbConfigCode = postgresqlConfigCode
+	case DBDriverSqlite:
+		dbConfigCode = sqliteConfigCode
 	default:
 		panic("getDBConfigCode error, unsupported database driver: " + dbDriver)
 	}
@@ -406,6 +423,8 @@ func getInitDBCode(dbDriver string) string {
 		initDBCode = modelInitDBFileMysqlCode
 	case DBDriverPostgresql:
 		initDBCode = modelInitDBFilePostgresqlCode
+	case DBDriverSqlite:
+		initDBCode = modelInitDBFileSqliteCode
 	default:
 		panic("getInitDBCode error, unsupported database driver: " + dbDriver)
 	}
@@ -482,3 +501,11 @@ func generateConfigmap(serverName string, outPath string) error {
 	data := strings.ReplaceAll(string(configmapFileData), configmapFileMark, configFileData)
 	return os.WriteFile(configmapFile, []byte(data), 0666)
 }
+
+func sqliteDSNAdaptation(dbDriver string, dsn string) string {
+	if dbDriver == DBDriverSqlite && gofile.IsWindows() {
+		dsn = strings.Replace(dsn, "\\", "\\\\", -1)
+		dsn = strings.Replace(dsn, "/", "\\\\", -1)
+	}
+	return dsn
+}

cmd/sponge/commands/generate/dao.go

@@ -34,16 +34,16 @@ func DaoCommand(parentName string) *cobra.Command {
 
 Examples:
   # generate dao code and embed gorm.model struct.
-  sponge %s dao --module-name=yourModuleName --db-dsn=root:123456@(192.168.3.37:3306)/test --db-table=user
+  sponge %s dao --module-name=yourModuleName --db-driver=mysql --db-dsn=root:123456@(192.168.3.37:3306)/test --db-table=user
 
   # generate dao code with multiple table names.
-  sponge %s dao --module-name=yourModuleName --db-dsn=root:123456@(192.168.3.37:3306)/test --db-table=t1,t2
+  sponge %s dao --module-name=yourModuleName --db-driver=mysql --db-dsn=root:123456@(192.168.3.37:3306)/test --db-table=t1,t2
 
   # generate dao code, structure fields correspond to the column names of the table.
-  sponge %s dao --module-name=yourModuleName --db-dsn=root:123456@(192.168.3.37:3306)/test --db-table=user --embed=false
+  sponge %s dao --module-name=yourModuleName --db-driver=mysql --db-dsn=root:123456@(192.168.3.37:3306)/test --db-table=user --embed=false
 
   # generate dao code and specify the server directory, Note: code generation will be canceled when the latest generated file already exists.
-  sponge %s dao --db-dsn=root:123456@(192.168.3.37:3306)/test --db-table=user --out=./yourServerDir
+  sponge %s dao --db-driver=mysql --db-dsn=root:123456@(192.168.3.37:3306)/test --db-table=user --out=./yourServerDir
 `, parentName, parentName, parentName, parentName),
 		SilenceErrors: true,
 		SilenceUsage:  true,
@@ -96,10 +96,10 @@ using help:
 		},
 	}
 
-	cmd.Flags().StringVarP(&sqlArgs.DBDriver, "db-driver", "k", "mysql", "database driver, support mysql, postgresql")
 	cmd.Flags().StringVarP(&moduleName, "module-name", "m", "", "module-name is the name of the module in the go.mod file")
 	//_ = cmd.MarkFlagRequired("module-name")
-	cmd.Flags().StringVarP(&sqlArgs.DBDsn, "db-dsn", "d", "", "database content address, e.g. user:password@(host:port)/database")
+	cmd.Flags().StringVarP(&sqlArgs.DBDriver, "db-driver", "k", "mysql", "database driver, support mysql, postgresql, tidb, sqlite")
+	cmd.Flags().StringVarP(&sqlArgs.DBDsn, "db-dsn", "d", "", "database content address, e.g. user:password@(host:port)/database. Note: if db-driver=sqlite, db-dsn must be a local sqlite db file, e.g. --db-dsn=/tmp/sponge_sqlite.db") //nolint
 	_ = cmd.MarkFlagRequired("db-dsn")
 	cmd.Flags().StringVarP(&dbTables, "db-table", "t", "", "table name, multiple names separated by commas")
 	_ = cmd.MarkFlagRequired("db-table")
@@ -187,10 +187,6 @@ func (g *daoGenerator) addFields(r replacer.Replacer) []replacer.Field {
 			New:             g.codes[parser.TableName],
 			IsCaseSensitive: true,
 		},
-		{
-			Old: "github.com/zhufuyi/sponge/pkg/ggorm",
-			New: "user/pkg/ggorm",
-		},
 	}...)
 
 	return fields

cmd/sponge/commands/generate/handler-pb.go

@@ -37,16 +37,16 @@ func HandlerPbCommand() *cobra.Command {
 
 Examples:
   # generate handler and protobuf code and embed gorm.model struct.
-  sponge web handler-pb --module-name=yourModuleName --server-name=yourServerName --db-dsn=root:123456@(192.168.3.37:3306)/test --db-table=user
+  sponge web handler-pb --module-name=yourModuleName --server-name=yourServerName --db-driver=mysql --db-dsn=root:123456@(192.168.3.37:3306)/test --db-table=user
 
   # generate handler and protobuf code with multiple table names.
-  sponge web handler-pb --module-name=yourModuleName --server-name=yourServerName --db-dsn=root:123456@(192.168.3.37:3306)/test --db-table=t1,t2
+  sponge web handler-pb --module-name=yourModuleName --server-name=yourServerName --db-driver=mysql --db-dsn=root:123456@(192.168.3.37:3306)/test --db-table=t1,t2
 
   # generate handler and protobuf code, structure fields correspond to the column names of the table.
-  sponge web handler-pb --module-name=yourModuleName --server-name=yourServerName --db-dsn=root:123456@(192.168.3.37:3306)/test --db-table=user --embed=false
+  sponge web handler-pb --module-name=yourModuleName --server-name=yourServerName --db-driver=mysql --db-dsn=root:123456@(192.168.3.37:3306)/test --db-table=user --embed=false
 
   # generate handler and protobuf code and specify the server directory, Note: code generation will be canceled when the latest generated file already exists.
-  sponge web handler-pb --db-dsn=root:123456@(192.168.3.37:3306)/test --db-table=user --out=./yourServerDir
+  sponge web handler-pb --db-driver=mysql --db-dsn=root:123456@(192.168.3.37:3306)/test --db-table=user --out=./yourServerDir
 `,
 		SilenceErrors: true,
 		SilenceUsage:  true,
@@ -103,12 +103,12 @@ using help:
 		},
 	}
 
-	cmd.Flags().StringVarP(&sqlArgs.DBDriver, "db-driver", "k", "mysql", "database driver, support mysql, postgresql")
 	cmd.Flags().StringVarP(&moduleName, "module-name", "m", "", "module-name is the name of the module in the go.mod file")
 	//_ = cmd.MarkFlagRequired("module-name")
 	cmd.Flags().StringVarP(&serverName, "server-name", "s", "", "server name")
 	//_ = cmd.MarkFlagRequired("server-name")
-	cmd.Flags().StringVarP(&sqlArgs.DBDsn, "db-dsn", "d", "", "database content address, e.g. user:password@(host:port)/database")
+	cmd.Flags().StringVarP(&sqlArgs.DBDriver, "db-driver", "k", "mysql", "database driver, support mysql, postgresql, tidb, sqlite")
+	cmd.Flags().StringVarP(&sqlArgs.DBDsn, "db-dsn", "d", "", "database content address, e.g. user:password@(host:port)/database. Note: if db-driver=sqlite, db-dsn must be a local sqlite db file, e.g. --db-dsn=/tmp/sponge_sqlite.db") //nolint
 	_ = cmd.MarkFlagRequired("db-dsn")
 	cmd.Flags().StringVarP(&dbTables, "db-table", "t", "", "table name, multiple names separated by commas")
 	_ = cmd.MarkFlagRequired("db-table")
@@ -237,10 +237,6 @@ func (g *handlerPbGenerator) addFields(r replacer.Replacer) []replacer.Field {
 			New:             g.codes[parser.TableName],
 			IsCaseSensitive: true,
 		},
-		{
-			Old: "github.com/zhufuyi/sponge/pkg/ggorm",
-			New: "user/pkg/ggorm",
-		},
 	}...)
 
 	return fields

cmd/sponge/commands/generate/handler.go

@@ -34,16 +34,16 @@ func HandlerCommand() *cobra.Command {
 
 Examples:
   # generate handler code and embed gorm.model struct.
-  sponge web handler --module-name=yourModuleName --db-dsn=root:123456@(192.168.3.37:3306)/test --db-table=user
+  sponge web handler --module-name=yourModuleName --db-driver=mysql --db-dsn=root:123456@(192.168.3.37:3306)/test --db-table=user
 
   # generate handler code with multiple table names.
-  sponge web handler --module-name=yourModuleName --db-dsn=root:123456@(192.168.3.37:3306)/test --db-table=t1,t2
+  sponge web handler --module-name=yourModuleName --db-driver=mysql --db-dsn=root:123456@(192.168.3.37:3306)/test --db-table=t1,t2
 
   # generate handler code, structure fields correspond to the column names of the table.
-  sponge web handler --module-name=yourModuleName --db-dsn=root:123456@(192.168.3.37:3306)/test --db-table=user --embed=false
+  sponge web handler --module-name=yourModuleName --db-driver=mysql --db-dsn=root:123456@(192.168.3.37:3306)/test --db-table=user --embed=false
 
   # generate handler code and specify the server directory, Note: code generation will be canceled when the latest generated file already exists.
-  sponge web handler --db-dsn=root:123456@(192.168.3.37:3306)/test --db-table=user --out=./yourServerDir
+  sponge web handler --db-driver=mysql --db-dsn=root:123456@(192.168.3.37:3306)/test --db-table=user --out=./yourServerDir
 `,
 		SilenceErrors: true,
 		SilenceUsage:  true,
@@ -91,10 +91,10 @@ using help:
 		},
 	}
 
-	cmd.Flags().StringVarP(&sqlArgs.DBDriver, "db-driver", "k", "mysql", "database driver, support mysql, postgresql")
 	cmd.Flags().StringVarP(&moduleName, "module-name", "m", "", "module-name is the name of the module in the go.mod file")
 	//_ = cmd.MarkFlagRequired("module-name")
-	cmd.Flags().StringVarP(&sqlArgs.DBDsn, "db-dsn", "d", "", "database content address, e.g. user:password@(host:port)/database")
+	cmd.Flags().StringVarP(&sqlArgs.DBDriver, "db-driver", "k", "mysql", "database driver, support mysql, postgresql, tidb, sqlite")
+	cmd.Flags().StringVarP(&sqlArgs.DBDsn, "db-dsn", "d", "", "database content address, e.g. user:password@(host:port)/database. Note: if db-driver=sqlite, db-dsn must be a local sqlite db file, e.g. --db-dsn=/tmp/sponge_sqlite.db") //nolint
 	_ = cmd.MarkFlagRequired("db-dsn")
 	cmd.Flags().StringVarP(&dbTables, "db-table", "t", "", "table name, multiple names separated by commas")
 	_ = cmd.MarkFlagRequired("db-table")
@@ -187,10 +187,6 @@ func (g *handlerGenerator) addFields(r replacer.Replacer) []replacer.Field {
 			New:             g.codes[parser.TableName],
 			IsCaseSensitive: true,
 		},
-		{
-			Old: "github.com/zhufuyi/sponge/pkg/ggorm",
-			New: "user/pkg/ggorm",
-		},
 	}...)
 
 	return fields

cmd/sponge/commands/generate/http-pb.go

@@ -162,7 +162,7 @@ func (g *httpPbGenerator) addFields(r replacer.Replacer) []replacer.Field {
 	fields = append(fields, deleteFieldsMark(r, gitIgnoreFile, wellStartMark, wellEndMark)...)
 	fields = append(fields, deleteAllFieldsMark(r, protoShellFile, wellStartMark, wellEndMark)...)
 	fields = append(fields, deleteAllFieldsMark(r, appConfigFile, wellStartMark, wellEndMark)...)
-	fields = append(fields, deleteFieldsMark(r, deploymentConfigFile, wellStartMark, wellEndMark)...)
+	//fields = append(fields, deleteFieldsMark(r, deploymentConfigFile, wellStartMark, wellEndMark)...)
 	fields = append(fields, replaceFileContentMark(r, readmeFile, "## "+g.serverName)...)
 	fields = append(fields, []replacer.Field{
 		{ // replace the configuration of the *.yml file
@@ -197,10 +197,10 @@ func (g *httpPbGenerator) addFields(r replacer.Replacer) []replacer.Field {
 			Old: dockerComposeFileMark,
 			New: dockerComposeFileHTTPCode,
 		},
-		{ // replace the contents of the *-configmap.yml file
-			Old: deploymentConfigFileMark,
-			New: getDBConfigCode(DBDriverMysql, true),
-		},
+		//{ // replace the contents of the *-configmap.yml file
+		//	Old: deploymentConfigFileMark,
+		//	New: getDBConfigCode(DBDriverMysql, true),
+		//},
 		{ // replace the contents of the *-deployment.yml file
 			Old: k8sDeploymentFileMark,
 			New: k8sDeploymentFileHTTPCode,