update document

Author: zhufuyi

.github/RELEASE.md

@@ -1,11 +1,5 @@
 ## Change log
 
-- Added generate database initialization code command.
-- 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.
-- Add encryption and decryption library.
-- Add scheduled task library.
+- Add model, dao, handler, service, web service, and grpc service code generated from mongodb sql.
+- Add test generation code command script.
+- Update document.

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-your_db_driver, replace "your_db_driver" with mysql, postgresql, tidb, sqlite
+# 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, mongodb, postgresql, tidb, sqlite
 patch:
 	@bash scripts/patch.sh $(TYPE)
 

README.md

@@ -19,15 +19,15 @@
 
 <br>
 
-If you are developing a RESTful web service or microservice with a simple CRUD API interface, you don't need to write a single line of Go code to compile and deploy to servers, dockers, k8s, and the complete service code is generated by sponge.
+If you are develop RESTful web service or microservice with a simple CRUD API interface, you don't need to write any Go code can be compiled and deployed to the linux server, docker, k8s, just need to connect to the database (mysql、mongodb、postgresql、tidb、sqlite) to generate a complete service code.
 
-If you develop a generic RESTful web service or microservice, you need to manually write code in addition to defining the data table, defining the api interface in the proto file, and filling in the specific business logic code in the generated template file. Other Go codes are generated by sponge.
+If you develop generic web or microservices, just focus on the three core parts of `define database tables`, `define api interfaces in proto files`, `fill in business logic code in the generated template files`, and the rest of the go code is automatically generated by sponge.
 
 <br>
 
 ### Sponge Generates the Code Framework
 
-sponge is mainly based on `SQL` and `Protobuf` two ways to generate code, each way has to generate code for different functions. `SQL` supports databases **mysql**, **postgresql**, **tidb**, **sqlite**.
+sponge is mainly based on `SQL` and `Protobuf` two ways to generate code, each way has to generate code for different functions. `SQL` supports databases **mysql**, **mongodb**, **postgresql**, **tidb**, **sqlite**.
 
 #### Generate Code Framework
 
@@ -47,9 +47,9 @@ sponge is mainly based on `SQL` and `Protobuf` two ways to generate code, each w
 
 #### Generate Code for Egg Model
 
-The sponge code generation process strips away the business logic and non-business logic of the two major parts of the code, sponge generated a complete web service back-end code as a complete egg:
+The sponge code generation process strips away the business logic and non-business logic of the two major parts of the code. Sponge's code generation function as a hen, the generated service code is the egg, take the generated web service backend code as an example:
 
-- `Eggshell` represents the web service framework code, `yolk` and `Albumen` both represent the business logic code.
+- `Eggshell` is web service framework code (automatically generated without manual writing).
 - `Yolk` is the core of business logic. For example, defining mysql tables, defining api interfaces, and writing specific logic codes all belong to yolk (code that needs to be written manually).
 - `Albumen` is a bridge connecting the core code of business logic and the web framework code. For example, the registration route code, handler code, parameter verification code, error code, and swagger document generated according to the proto file belong to the albumen (code that automatically generated without manual writing).
 
@@ -75,9 +75,6 @@ Sponge is essentially a microservice framework that includes code generation cap
 
 ### Key Features
 
-- User-friendly UI for code generation commands.
-- Not only generate code template examples, but also automatically merge the new template code to achieve api interface "low-code development".
-- Modular and decoupled code design with rich functional components readily available, you can also easily use their own components.
 - Web framework [gin](https://github.com/gin-gonic/gin)
 - RPC framework [grpc](https://github.com/grpc/grpc-go)
 - Configuration parsing [viper](https://github.com/spf13/viper)
@@ -115,23 +112,23 @@ The project code directory structure created by sponge follows the [project-layo
 │         ├── initial     # Program initialization, consisting of three files: initApp initializes configurations, registerServers registers services (HTTP or grpc), and registerClose registers resource cleanup.
 │         └── main.go     # Program entry file
 ├── configs        # Directory for configuration files
-├── deployments    # Directory for deployment scripts, supporting binary, Docker, and Kubernetes deployments.
+├── deployments    # Directory for deployment scripts, supporting binary, Docker and Kubernetes deployments.
 ├─ docs            # Directory for API interface Swagger documentation.
 ├── internal       # Directory for code of private applications and libraries.
 │    ├── cache        # Cache directory wrapped around business logic.
 │    ├── config       # Directory for Go structure configuration files.
-│    ├── dao          # Data access directory, e.g., interfaces for CRUD operations on MySQL tables.
+│    ├── dao          # Data access directory.
 │    ├── ecode        # Directory for system error codes and custom business error codes.
 │    ├── handler      # Directory for implementing HTTP business functionality (specific to web services).
 │    ├── model        # Database model directory.
 │    ├── routers      # HTTP routing directory.
 │    ├── rpcclient    # Directory for client-side code that connects to grpc services.
 │    ├── server       # Directory for creating services, including HTTP and grpc.
-│    ├── service      # Directory for implementing grpc business functionality (specific to microservices).
+│    ├── service      # Directory for implementing grpc business functionality (specific to grpc services).
 │    └── types        # Directory for defining request and response parameter structures for HTTP.
 ├── pkg            # Directory for shared libraries.
 ├── scripts        # Directory for scripts, including compilation, execution, code generation, and deployment scripts.
-├── test           # Directory for scripts required for testing services, such as scripts to start dependencies (e.g., MySQL, Redis) and test data (SQL).
+├── test           # Directory for scripts required for testing services  and test SQL.
 └── third_party    # Directory for external helper programs, forked code, and other third-party tools.
 ```
 

assets/readme-cn.md

@@ -1,17 +1,17 @@
 
-[sponge](https://github.com/zhufuyi/sponge) 是一个集成了 `自动生成代码`、`Gin和GRPC` 的基础开发框架。sponge拥有丰富的生成代码命令，生成不同的功能代码可以组合成完整的服务(类似人为打散的海绵细胞可以自动重组成一个新的海绵)。代码解耦模块化设计，很容易构建出从开发到部署的完整工程项目，只需在生成的模板代码上填充具体业务逻辑代码，极大的提高了开发效率和降低了开发难度，使用go也可以"低代码开发"。
+[sponge](https://github.com/zhufuyi/sponge) 是一个集成了 `自动生成代码`、`Gin和GRPC` 的基础开发框架。sponge拥有丰富的生成代码命令，生成不同的功能代码可以组合成完整的服务(类似人为打散的海绵细胞可以自动重组成一个新的海绵)。代码解耦模块化设计，很容易构建出从开发到部署的完整工程项目，只需在生成的模板代码上填充业务逻辑代码，极大的提高了开发效率和降低了开发难度，使用go也可以"低代码开发"。
 
 <br>
 
-如果开发只有简单CRUD api接口的web或微服务，不需要编写一行go代码就可以编译并部署到服务器、docker、k8s上，完整的服务代码由sponge一键生成。
+如果开发只有简单CRUD api接口的web或微服务，不需要编写任何go代码就可以编译并部署到linux服务器、docker、k8s上，只需要连接到数据库(mysql、mongodb、postgresql、tidb、sqlite)就可以一键自动生成完整的服务代码。
 
-如果开发通用的web或微服务，除了`定义数据库表`、`在proto文件定义api接口`、`在生成的模板文件填写业务逻辑代码`这三个部分需要人工编写，其他go代码都由sponge生成。
+如果开发通用的web或微服务，只需聚焦在`定义数据库表`、`在proto文件定义api接口`、`在生成的模板文件填写业务逻辑代码`三个核心部分，其他go代码都由sponge自动生成。
 
 <br>
 
 ### 生成代码框架
 
-sponge主要基于`SQL`和`Protobuf`两种方式生成代码，每种方式拥有生成不同用途的代码。其中`SQL`支持数据库**mysql**、**postgresql**、**tidb**、**sqlite**。
+sponge主要基于`SQL`和`Protobuf`两种方式生成代码，每种方式拥有生成不同用途的代码。其中`SQL`支持数据库**mysql**、**mongodb**、**postgresql**、**tidb**、**sqlite**。
 
 #### 生成代码的框架图
 
@@ -31,10 +31,10 @@ sponge主要基于`SQL`和`Protobuf`两种方式生成代码，每种方式拥
 
 #### 生成代码的鸡蛋模型
 
-sponge生成代码过程中剥离了业务逻辑与非业务逻辑两大部分代码，把sponge生成的一个完整web服务后端代码看作是一个完整的鸡蛋：
+sponge生成代码过程中剥离了业务逻辑与非业务逻辑两大部分代码，把sponge的生成代码功能看作是母鸡，生成的服务代码就是鸡蛋，以生成的一个web服务后端代码为例：
 
-- `蛋壳`表示web服务框架代码，`蛋白`和`蛋黄`都表示业务逻辑代码。
-- `蛋黄`是业务逻辑的核心，例如定义mysql表、定义api接口、编写具体逻辑代码都属于蛋黄部分(需要人工编写的代码)。
+- `蛋壳`是web服务框架代码(自动生成，不需要人工编写)。
+- `蛋黄`是业务逻辑的核心，例如定义mysql表、在proto定义api接口、编写具体逻辑代码都属于蛋黄部分(需要人工编写的代码)。
 - `蛋白`是业务逻辑核心代码与web框架代码连接的桥梁，例如根据proto文件生成的注册路由代码、handler代码、dao代码、参数校验代码、错误码、swagger文档等都属于蛋白部分(自动生成，不需要人工编写)。
 
 下面是`⓷基于protobuf创建的web服务`代码的鸡蛋模型剖析图：
@@ -61,9 +61,6 @@ sponge本质是一个包含了生成代码功能的微服务框架，微服务
 
 sponge包含丰富的组件(按需使用)：
 
-- 生成代码命令UI界面化，简单易用。
-- 不仅生成代码模板示例，而且自动合并新增模板代码，实现api接口"低代码开发"。
-- 代码解耦模块化设计，丰富功能组件开箱即用，也可以很方便使用自己的组件。
 - Web 框架 [gin](https://github.com/gin-gonic/gin)
 - RPC 框架 [grpc](https://github.com/grpc/grpc-go)
 - 配置解析 [viper](https://github.com/spf13/viper)

configs/serverNameExample.yml

@@ -88,7 +88,7 @@ database:
   driver: "mysql"           # database driver, currently support mysql, postgres, tidb, sqlite
   # mysql settings
   mysql:
-    # dsn format,  <user>:<pass>@(127.0.0.1:3306)/<db>?[k=v& ......]
+    # dsn format,  <username>:<password>@(<hostname>:<port>)/<db>?[k=v& ......]
     dsn: "root:123456@(192.168.3.37:3306)/account?parseTime=true&loc=Local&charset=utf8,utf8mb4"
     enableLog: true         # whether to turn on printing of all logs
     maxIdleConns: 10        # set the maximum number of connections in the idle connection pool
@@ -102,7 +102,7 @@ database:
 
   # postgresql settings
   postgresql:
-    # dsn format,  <user>:<pass>@127.0.0.1:5432/<db>?[k=v& ......]
+    # dsn format,  <username>:<password>@<hostname>:<port>/<db>?[k=v& ......]
     dsn: "root:123456@192.168.3.37:5432/account?sslmode=disable"
     enableLog: true         # whether to turn on printing of all logs
     maxIdleConns: 10        # set the maximum number of connections in the idle connection pool
@@ -117,6 +117,12 @@ database:
     maxOpenConns: 100       # set the maximum number of open database connections
     connMaxLifetime: 10     # sets the maximum time for which the connection can be reused, in minutes
 
+  # mongodb settings
+  mongodb:
+    # dsn format,  <username>:<password>@<hostname1>:<port1>[,<hostname2>:<port2>,......]/<db>?[k=v& ......]
+    # parameter k=v see https://www.mongodb.com/docs/drivers/go/current/fundamentals/connections/connection-guide/#connection-options
+    dsn: "root:123456@192.168.3.37:27017/account?connectTimeoutMS=15000"
+
 # delete the templates code end
 
 # redis settings

scripts/patch.sh

@@ -3,8 +3,10 @@
 patchType=$1
 typesPb="types-pb"
 initMysql="init-mysql"
+initMongodb="init-mongodb"
 initTidb="init-tidb"
 initPostgresql="init-postgresql"
+initSqlite="init-sqlite"
 
 function checkResult() {
     result=$1
@@ -28,6 +30,12 @@ function generateInitMysqlCode() {
     importPkg
 }
 
+function generateInitMongodbCode() {
+    sponge patch gen-db-init --db-driver=mongodb --out=./
+    checkResult $?
+    importPkg
+}
+
 function generateInitTidbCode() {
     sponge patch gen-db-init --db-driver=tidb --out=./
     checkResult $?
@@ -40,17 +48,28 @@ function generateInitPostgresqlCode() {
     importPkg
 }
 
+function generateInitSqliteCode() {
+    sponge patch gen-db-init --db-driver=sqlite --out=./
+    checkResult $?
+    importPkg
+}
+
 if [  "$patchType" = "$typesPb"  ]; then
     generateTypesPbCode
 elif [ "$patchType" = "$initMysql" ]; then
     generateInitMysqlCode
+elif [ "$patchType" = "$initMongodb" ]; then
+    generateInitMongodbCode
 elif [ "$patchType" = "$initTidb" ]; then
     generateInitTidbCode
 elif [ "$patchType" = "$initPostgresql" ]; then
     generateInitPostgresqlCode
+elif [ "$patchType" = "$initSqlite" ]; then
+    generateInitSqliteCode
 else
     echo "invalid patch type: '$patchType'"
-    echo "supported types: $initMysql, $initTidb, $initPostgresql, $typesPb"
+    echo "supported types: $initMysql, $initMongodb, $initTidb, $initPostgresql, $initSqlite, $typesPb"
     echo "e.g. make patch TYPE=init-mysql"
+    echo ""
     exit 1
 fi