Skip to content

Latest commit

 

History

History
147 lines (93 loc) · 4.4 KB

install-cn.md

File metadata and controls

147 lines (93 loc) · 4.4 KB

要求使用go 1.22以上版本： https://studygolang.com/dl

注：如果不能科学上网，获取github的库可能会遇到超时失败问题，建议设置为国内代理，执行命令 go env -w GOPROXY=https://goproxy.cn,direct



Windows环境

安装sponge之前确保已安装go语言环境，并把GOBIN添加到系统环境变量path，如果已经设置过可以跳过此步骤：

    # 检查GOBIN目录是否存在
    go env GOBIN
    
    # 如果为空，设置GOBIN(例如：D:\go\bin)，可能需要管理员权限
    go env -w GOBIN=D:\go\bin
    # 然后并把GOBIN目录添加到系统path环境变量

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

为了安装方便，已经把sponge及其依赖的程序打包在一起，下载地址(选择一个下载即可)：

下载文件后：

(1) 解压文件，双击 install.bat 进行安装，安装git过程一直默认即可(如果已经安装过git，可以跳过安装git这个步骤)。

(2) 在任意文件夹下右键(显示更多选项)，选择【Open Git Bash here】打开git bash终端：

# 初始化sponge
sponge init

注意：

  • 使用sponge开发项目时，请使用git bash终端，不要使用系统默认的cmd，否则会出现找不到命令的错误。
  • 不要在GOBIN目录(sponge可执行文件所在的目录)下打开终端来执行命令sponge run。
  • 如果当前使用sponge的版本低于v1.11.1，并且需要升级，请执行命令更新到最新版本的sponge： go install github.com/go-dev-frame/sponge/cmd/sponge@latest && sponge init。

在windows除了上面安装sponge方式，还提供了原生安装，点击查看【安装 sponge】 --> 【windows环境】安装文档。



Linux或MacOS环境

(1) 把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

(2) 把sponge及其依赖的插件安装到 GOBIN 目录。

✅ 安装 protoc

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

根据系统类型下载对应的 protoc 可执行文件，把 protoc 可执行文件移动到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

注：不要在GOBIN目录下打开终端来执行命令sponge run。



Docker环境

⚠ 使用docker启动的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。