Go 应用 Debian 打包指南

1. Go 应用 Debian 打包概述

Go 语言以其出色的跨平台编译能力和静态链接特性而闻名，通常编译后会生成一个不依赖外部库的独立二进制文件。这使得 Go 应用程序的部署变得非常简单，但在将其封装为 Debian 软件包时，可能会遇到一些与传统动态链接程序不同的挑战。传统的 Debian 打包工具链，如 debuild，通常期望源代码能够在其构建环境中被编译，并对包的结构和内容进行严格的 lintian 检查。对于一个已经编译好的 Go 二进制文件，这些检查有时显得过于繁琐或不适用。

2. 传统方法与 dpkg-buildpackage

在 dh-golang 出现之前，或者在某些特定场景下，开发者可能会选择绕过 debuild 的某些默认行为。debuild 本质上是调用 dpkg-buildpackage 来执行实际的打包工作，并在此之后运行 lintian 进行包质量检查。lintian 可能会对静态链接的 Go 二进制文件或不遵循传统构建流程的包提出警告。

绕过 lintian 检查： 如果不想在构建过程中运行 lintian，可以直接使用 dpkg-buildpackage 命令：

dpkg-buildpackage -us -uc -b

• -us: 不签署源代码包。
• -uc: 不签署更改日志。
• -b: 仅构建二进制包。

这种方法允许将预编译的 Go 二进制文件直接封装到 Debian 包中，而无需在打包过程中重新编译。

lintian override 的使用： 另一种方法是使用 lintian override。这允许在 debian/changelog 文件中添加特定注释，指示 lintian 忽略某些特定的警告或错误。例如：

your-package (1.0.0-1) unstable; urgency=low

  * Initial release.
  * [lintian-override] your-package: binary-without-manpage
    Please ignore this warning, as this is a simple utility.

 -- Your Name   Mon, 01 Jan 2023 12:00:00 +0000

这在某些情况下可以解决 lintian 的误报，但通常不推荐滥用。

这两种方法都意味着将 Go 二进制文件视为一个“预编译的 blob”，而不是通过 Debian 打包工具链来构建它。这意味着 debian/rules 文件需要相应地进行调整，以避免尝试重新构建应用程序。

3. 现代与推荐方法：使用 dh-golang

随着 Go 语言生态的成熟，Debian 社区也为 Go 应用程序的打包提供了更完善的工具和基础设施。dh-golang 是当前推荐的用于打包 Go 应用程序（使用 gc 编译器，即 Google 官方 Go 编译器）的关键工具。它极大地简化了 Go 应用的 Debian 打包流程，使其更加符合 Debian 的打包标准。

dh-golang 简介及其优势：dh-golang 是一个 debhelper 序列插件，它为 Go 语言项目提供了专门的构建和安装规则。它能够自动处理 Go 模块依赖、构建二进制文件、安装到正确路径等任务，使打包过程更加自动化和规范。

WeMuseum博物馆微门户小程序

WeMuseum博物馆微门户小程序主要功能包括展厅展馆、当前展览、馆藏文物、服务指南、活动讲座预约、参观预约等。具有“即开即用，用完即走”特点的微信小程序，创新了博物馆行业的服务方式，是传播博物馆服务和文化的便捷高效途径之一。微信小程序在博物馆中的应用，将会为博物馆文化的传播开辟出新渠道、新路径。我们的思路就是：轻量化前端，深度开发后台。

下载

dh-golang 在 debian/rules 中的应用示例： 一个典型的 debian/rules 文件在使用 dh-golang 时会非常简洁：

#!/usr/bin/make -f

# Uncomment this to turn on verbose mode.
# export DH_VERBOSE = 1

export GOPATH := $(CURDIR)/.gopath
export GOBIN := $(CURDIR)/bin

# Build the binary using dh-golang
%:
    dh $@ --with golang

override_dh_auto_install:
    # Install the built binary to the correct location
    dh_golang_install
    # If you have additional resource files, install them here
    # dh_install -X.go -X.mod -X.sum

override_dh_auto_clean:
    dh_auto_clean
    rm -rf $(GOPATH) $(GOBIN)

在这个 debian/rules 文件中：

• export GOPATH := $(CURDIR)/.gopath 和 export GOBIN := $(CURDIR)/bin 设置了临时的 Go 工作区和二进制输出路径，以避免污染系统环境。
• dh $@ --with golang 是核心，它调用 debhelper 并加载 dh-golang 插件，dh-golang 会自动处理 Go 项目的构建。
• override_dh_auto_install 覆盖了默认的安装行为，使用 dh_golang_install 来安装 Go 应用程序的二进制文件。如果有其他资源文件（如配置文件、静态网页等），可以在此添加 dh_install 命令来安装它们。

debian/control 文件示例：debian/control 文件定义了软件包的元数据和依赖关系。对于 Go 应用，通常需要添加 Build-Depends: dh-golang。

Source: your-go-app
Section: utils
Priority: optional
Maintainer: Your Name 
Build-Depends: debhelper-compat (= 13),
               dh-golang,
               golang-go,
               # Add any other build dependencies your Go app might have
Standards-Version: 4.6.0
Homepage: https://github.com/your/go-app
Vcs-Browser: https://github.com/your/go-app
Vcs-Git: https://github.com/your/go-app.git

Package: your-go-app
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}
Description: A brief description of your Go application.
 This is a more detailed description of your Go application.
 It should explain what the application does and its main features.

打包流程概览： 使用 dh-golang 打包 Go 应用的典型步骤如下：

1. 准备源代码： 将 Go 应用程序的源代码放在项目根目录。
2. 创建 debian/ 目录： 在项目根目录创建 debian/ 文件夹。
3. 创建核心文件： 在 debian/ 目录下创建 control、changelog、copyright、rules 等文件。
4. 配置 debian/rules： 按照上述示例配置 debian/rules 以使用 dh-golang。
5. 配置 debian/control： 定义包的元数据和构建依赖。
6. 配置 debian/install (可选): 如果除了主二进制文件外还需要安装其他文件，例如配置文件、静态资源等，可以在 debian/install 中列出它们。例如：

   your-go-app /usr/bin/
   path/to/config.toml /etc/your-go-app/
   path/to/static/ /usr/share/your-go-app/static/

7. 构建软件包： 在项目根目录运行 debuild -us -uc 或 dpkg-buildpackage -us -uc -b。

4. gcc-go 方案（了解即可）

除了 Google 官方的 gc 编译器，Debian 还提供了 gcc-go，它是 GCC 的一个 Go 语言前端。与 gc 编译器生成静态链接二进制文件不同，gcc-go 编译的应用程序通常是动态链接的，依赖于 libgo 等共享库。

这种方法更符合传统 Debian 软件包的构建哲学，因为它生成的是动态链接的二进制文件。然而，对于大多数 Go 应用程序而言，其静态链接的特性正是其优势所在，且 gcc-go 的使用场景通常限于那些希望将 Go 应用程序深度集成到 Debian 官方仓库，并遵循严格动态链接策略的开发者。对于日常的应用打包，dh-golang 配合 gc 编译器是更直接、更推荐的选择。

5. 核心 Debian 打包文件

无论采用哪种方法，以下是一些在 Debian 打包过程中必不可少的核心文件：

• debian/control: 定义了软件包的元数据，包括源代码包名、维护者、构建依赖（Build-Depends）、运行时依赖（Depends）、描述等。
• debian/changelog: 记录了软件包的所有版本更新历史，包括版本号、发布日期、维护者信息以及每次更新的详细内容。这是 Debian 软件包管理的重要组成部分。
• debian/copyright: 包含软件包的版权信息和许可证详情。对于 Go 应用程序，通常需要列出应用程序本身的许可证以及其依赖的 Go 模块的许可证。
• debian/rules: 这是软件包的构建脚本，通常是一个 Makefile。它定义了如何构建、安装和清理软件包。dh-golang 的集成主要体现在这个文件中。
• *debian/install (或 `debian/.install)**: 列出需要安装到目标系统中的文件和目录，以及它们在目标系统中的安装路径。例如，Go 二进制文件通常安装到/usr/bin/`。
• debian/compat: 指定 debhelper 兼容级别。通常设置为 13 或最新版本。

6. 注意事项与总结

• 优先使用 dh-golang: 对于使用 Google 官方 gc 编译器的 Go 应用程序，dh-golang 是当前最推荐且最便捷的打包方式。它能够很好地处理 Go 模块依赖和构建流程。
• 理解静态链接: Go 应用程序的静态链接特性是其优势，它使得部署更简单，但在打包时需要注意 lintian 可能产生的警告。dh-golang 已经很好地解决了这些问题。
• 保持包的简洁性: 尽量只打包应用程序所需的二进制文件和必要的资源文件。避免将整个 Go 模块缓存或源代码包含在最终的 Debian 包中，除非有特殊需求。
• 完善 debian/control 和 debian/copyright: 确保这些文件中的信息准确、完整，特别是依赖关系和许可证信息，这对于包的质量和合规性至关重要。
• 测试你的包: 在发布之前，务必在目标 Debian/Ubuntu 环境中安装并测试你的 .deb 包，确保所有文件都安装在正确的位置，并且应用程序能够正常运行。

通过遵循上述指南，你可以高效且专业地将 Go 应用程序打包成 Debian 格式，使其在 Debian 及其衍生发行版上得到良好的分发和管理。