使用 Makefile 管理和部署 Go 项目

简介: 在软件开发中,`Makefile` 用于自动化任务,提升效率。在Go项目中,它简化构建和部署。`Makefile`集成了编译、打包、清理和部署等任务,减少错误,提高效率。通过定义规则和依赖,`make`工具执行任务。示例展示了如何创建`Makefile`进行Go应用的自动化部署,包括构建、传输、停启服务。通过`make deploy-dev`一键执行部署流程。`Makefile`不仅简化部署,还可扩展实现更多复杂自动化,提升开发流程的专业性和效率。

在软件开发的世界里,自动化是提升效率的关键。Makefile 尽管是一个历史悠久的工具,但它在任务管理和自动化方面的能力依然不可小觑。

对于 Go 语言项目来说,利用 Makefile 来管理和自动化构建、部署过程能极大地简化开发流程。本文将引导你如何使用 Makefile 在本地开发 Go 项目后,将其更新到服务器上。

为什么使用 Makefile?

Makefile 提供了一个中心化的脚本集合,用于自动化执行各种任务,如编译源代码、打包软件、清理临时文件、部署到服务器等。使用 Makefile 可以让复杂的任务序列化、一键化,从而减少人为错误,提升工作效率。

Makefile 基础

Makefile 是一个特殊格式的文件,它被 make 工具使用来管理和自动化软件的构建过程。每个 Makefile 包含一系列的规则和依赖,make 根据这些规则来执行任务。

创建 Makefile

首先,在项目根目录下创建 Makefile 文件:

vim Makefile

接着,我们定义一系列的任务来管理和部署我们的 Go 项目。

任务脚本解析

以下是 Makefile 的内容示例:


# 预定义变量
REMOTE=127.0.0.1
APPNAME=alex-blog

# 声明 .PHONY 目标
.PHONY: deploy-dev

# deploy-dev 任务
deploy-dev:
    @echo "\n--- 开始构建可执行文件 ---"
    # 设置目标操作系统为 linux,架构为 amd64,并构建项目
    GOOS=linux GOARCH=amd64 go build -ldflags="-s -w" -v -o tmp/$(APPNAME)_tmp

    @echo "\n--- 上传可执行文件 ---"
    # 将构建的文件上传到服务器
    scp tmp/$(APPNAME)_tmp root@$(REMOTE):/data/www/blog.com/

    @echo "\n--- 停止服务 ---"
    # 使用 SSH 执行命令,停止服务
    ssh root@$(REMOTE) "supervisorctl stop $(APPNAME)"

    @echo "\n--- 替换新文件 ---"
    # 使用 SSH 执行一系列命令,更新应用程序
    ssh root@$(REMOTE) "cd /data/www/blog.com/ \
                            && rm $(APPNAME) \
                            && mv $(APPNAME)_tmp $(APPNAME) \
                            && chown www-data:www-data $(APPNAME)"

    @echo "\n--- 开始服务 ---"
    # 使用 SSH 执行命令,启动服务
    ssh root@$(REMOTE) "supervisorctl start $(APPNAME)"

    @echo "\n--- 部署完毕 ---\n"

.PHONY: <任务名称>

.PHONY 用于声明一个目标是“伪目标”,而非文件名。这意呤着即使在当前目录下存在与任务同名的文件,执行 make <任务名称> 时,仍会执行该任务。这个声明可以避免由于存在同名文件而导致的任务不被执行。

执行任务

要运行上面定义的 deploy-dev 任务,只需要在项目根目录下运行以下命令:

make deploy-dev

这条命令会依次执行构建可执行文件、上传至服务器、停止服务、替换新文件并重新启动服务等一系列操作,极大地简化了手动部署的过程。

总结

通过使用 Makefile 管理和自动化 Go 项目的构建和部署过程,我们可以节省大量时间,避免在重复性操作中出错。

本文介绍的 Makefile 示例展示了如何利用这种强大工具简化开发工作,但 Makefile 的潜力远不止于此。随着你对 Makefile 更深入的理解和掌握,你将能够创建更加复杂和强大的自动化脚本,使你的开发流程更加高效、专业。

相关文章
|
8天前
|
JSON 中间件 Go
go语言后端开发学习(四) —— 在go项目中使用Zap日志库
本文详细介绍了如何在Go项目中集成并配置Zap日志库。首先通过`go get -u go.uber.org/zap`命令安装Zap,接着展示了`Logger`与`Sugared Logger`两种日志记录器的基本用法。随后深入探讨了Zap的高级配置,包括如何将日志输出至文件、调整时间格式、记录调用者信息以及日志分割等。最后,文章演示了如何在gin框架中集成Zap,通过自定义中间件实现了日志记录和异常恢复功能。通过这些步骤,读者可以掌握Zap在实际项目中的应用与定制方法
go语言后端开发学习(四) —— 在go项目中使用Zap日志库
|
6天前
|
JSON 缓存 监控
go语言后端开发学习(五)——如何在项目中使用Viper来配置环境
Viper 是一个强大的 Go 语言配置管理库,适用于各类应用,包括 Twelve-Factor Apps。相比仅支持 `.ini` 格式的 `go-ini`,Viper 支持更多配置格式如 JSON、TOML、YAML
go语言后端开发学习(五)——如何在项目中使用Viper来配置环境
|
11天前
|
算法 程序员 编译器
Go deadcode:查找没意义的死代码,对于维护项目挺有用!
Go deadcode:查找没意义的死代码,对于维护项目挺有用!
|
16天前
|
缓存 JavaScript 前端开发
为开源项目 go-gin-api 增加 WebSocket 模块
为开源项目 go-gin-api 增加 WebSocket 模块
24 2
|
16天前
|
Prometheus Cloud Native NoSQL
Go - 一个对新手很友好的项目(带界面)
Go - 一个对新手很友好的项目(带界面)
25 1
|
16天前
|
SQL NoSQL Go
Go - 实现项目内链路追踪(二)
Go - 实现项目内链路追踪(二)
22 1
|
16天前
|
消息中间件 关系型数据库 MySQL
为开源项目 go-gin-api 增加后台任务模块
为开源项目 go-gin-api 增加后台任务模块
13 0
|
16天前
|
缓存 NoSQL 关系型数据库
Go - 开箱即用,WEB 界面一键安装,没有项目经验,可以拿这个练手
Go - 开箱即用,WEB 界面一键安装,没有项目经验,可以拿这个练手
31 0
|
16天前
|
SQL JSON NoSQL
Go - 实现项目内链路追踪
Go - 实现项目内链路追踪
21 0
|
21天前
|
关系型数据库 MySQL Go
go项目实现mysql接入以及web api
go项目实现mysql接入以及web api
23 0