安装 sponge

Vison2025/5/14大约 5 分钟快速开始goprotocsponge安装

安装 sponge 之前先安装依赖 go 和 protoc，如果已安装可以跳过这个步骤。

安装 Go

要求go 1.23+版本，下载地址：https://studygolang.com/dl

提示

Go下载第三方包时可能会遇到依赖下载超时问题，建议设置国内代理：

go env -w GOPROXY=https://goproxy.cn,direct

安装 protoc

下载 protoc 地址： https://github.com/protocolbuffers/protobuf/releases/tag/v25.2

根据系统类型下载对应的 protoc 可执行文件，把 protoc 可执行文件移动到环境变量 PATH 目录下。

安装 sponge

安装完 go 和 protoc 之后，接下来安装 sponge 及其插件，支持在 Windows、Linux、Mac 和 Docker 环境安装。

Windows 环境

在 Windows 环境，有两种方式安装 sponge。

方式一：直接下载安装包(推荐)

点击查看安装说明。

方式二：手动安装

sponge 依赖一些 linux 命令，因此在 windows 环境中需要安装 git bash、make 来支持 linux 命令环境。

✅ 安装 git for windows

如果已经安装过，可以跳过安装 git 步骤。

下载 git 地址： Git-2.44.0-64-bit.exe

下载后安装 git，安装过程一直默认即可。安装 git 之后在任意文件夹下右键(显示更多选项)，如果有选择【Open Git Bash here】打开 git bash 终端，说明已经安装 git 成功。

解决 git bash 显示中文乱码，右键 git bash 终端，选择菜单【options】 → 【Text】，找到 character set，选择 UTF-8后保存。

✅ 安装 make

下载 mingw64地址： x86_64-8.1.0-release-posix-seh-rt_v6-rev0.7z

解压文件，在bin目录下的找到mingw32-make.exe可执行文件，复制并改名为make.exe，把make.exe可执行文件移动到GOBIN目录(go env GOBIN 查看，如果为空，下面有GOBIN设置说明)。

查看 make 版本：make -v

✅ 安装 sponge 及其插件

打开 git bash 终端(不是 windows 自带的 cmd)。

把GOBIN添加到系统环境变量 path，如果已经设置过可以跳过此步骤。

# 设置 go get 命令下载第三方包的目录
setx GOPATH "D:\你的目录"
# 设置 go install 命令编译后生成可执行文件的存放目录
setx GOBIN "D:\你的目录\bin"

# 关闭当前终端，然后开启一个新的终端，查看 GOBIN 目录
go env GOBIN

把 sponge 及其依赖插件安装到GOBIN目录下。

# 安装 sponge
go install github.com/go-dev-frame/sponge/cmd/sponge@latest

# 初始化 sponge，自动安装 sponge 依赖插件
sponge init

# 查看插件是否都安装成功，如果发现有插件没有安装成功，执行命令重试 sponge plugins --install
sponge plugins

# 查看 sponge 版本
sponge -v

Linux 环境

在 linux 环境安装 sponge。

把$GOBIN添加到系统环境变量 path，如果已经设置过可以跳过此步骤。

# 打开 .bashrc 文件
vim ~/.bashrc

# 复制下面命令到.bashrc
export GOROOT="/opt/go"     # 你的 go 安装目录
export GOPATH=$HOME/go      # 设置 go get 命令下载第三方包的目录
export GOBIN=$GOPATH/bin    # 设置 go install 命令编译后生成可执行文件的存放目录
export PATH=$PATH:$GOBIN:$GOROOT/bin   # 把$GOBIN 目录添加到系统环境变量 path

# 保存 .bashrc 文件后，使设置生效
source ~/.bashrc

# 查看 GOBIN 目录
go env GOBIN

执行命令安装 sponge，sponge 和依赖插件将安装到 $GOBIN 目录下。

# 安装 sponge
go install github.com/go-dev-frame/sponge/cmd/sponge@latest

# 初始化 sponge，自动安装 sponge 依赖插件
sponge init

# 查看插件是否都安装成功，如果发现有插件没有安装成功，执行命令重试 sponge plugins --install
sponge plugins

# 查看 sponge 版本
sponge -v

Mac 环境

在 mac 环境安装 sponge。

把$GOBIN添加到系统环境变量 path，如果已经设置过可以跳过此步骤。

# 打开 .bashrc 文件
vim ~/.bashrc

# 复制下面命令到.bashrc
export GOROOT="/opt/go"     # 你的 go 安装目录
export GOPATH=$HOME/go      # 设置 go get 命令下载第三方包的目录
export GOBIN=$GOPATH/bin    # 设置 go install 命令编译后生成可执行文件的存放目录
export PATH=$PATH:$GOBIN:$GOROOT/bin   # 把$GOBIN 目录添加到系统环境变量 path

# 保存 .bashrc 文件后，使设置生效
source ~/.bashrc

# 查看 GOBIN 目录
go env GOBIN

执行命令安装 sponge，sponge 和依赖插件将安装到 $GOBIN 目录下。

# 安装 sponge
go install github.com/go-dev-frame/sponge/cmd/sponge@latest

# 初始化 sponge，自动安装 sponge 依赖插件
sponge init

# 查看插件是否都安装成功，如果发现有插件没有安装成功，执行命令重试 sponge plugins --install
sponge plugins

# 查看 sponge 版本
sponge -v

Docker 环境

使用 docker 安装的 sponge 只是 sponge ui 界面服务，如果需要在生成的服务代码基础上进行开发，还是需要在本地安装 sponge 和依赖插件。

方式一：Docker 启动

docker run -d --name sponge -p 24631:24631 zhufuyi/sponge:latest -a http://<你的宿主机 ip>:24631

方式二：docker-compose 启动

docker-compose.yaml 文件内容如下：

version: "3.7"

services:
  sponge:
    image: zhufuyi/sponge:latest
    container_name: sponge
    restart: always
    command: ["-a","http://<你的宿主机 ip>:24631"]
    ports:
      - "24631:24631"

启动服务：

docker-compose up -d

在 docker 部署成功后，在浏览器访问 http://<你的宿主机 ip>:24631。

打开 sponge 生成代码页面

sponge 提供了丰富的代码生成功能，其中常用命令均配有直观的 UI 界面。该界面具有以下优势：

记忆功能：自动保存历史操作记录
详细说明：每个参数均附带解释说明
操作指引：生成代码后提供完整的使用步骤

操作步骤:

打开终端，执行以下命令：
```
sponge run
```
在浏览器访问 http://localhost:24631 即可进入代码生成页面。

升级 sponge

升级到最新 sponge 版本，执行命令：

sponge upgrade