build.gn：你必須了解的構建文件

在編寫軟件程序時，最終的目標是將代碼編譯成可執行的二進制文件。雖然編譯器是執行此任務的核心，但構建（build）文件也是非常重要並且必需的一部分。build.gn 是 Google 的構建文件格式之一，它可以讓程序員使用它來描述軟件系統的構建過程並自動生成構建代碼。本文將介紹 build.gn 文件的主要特點，以及如何使用它完成軟件的自動化構建過程。

一、build.gn 文件

build.gn 是一個文本文件，它用來描述一個特定項目的構建流程。在 Google 中，它是 Google’s Ninja build system 的一部分。具體來說，它是一種基於 Python 的類似於 Makefile 的構建系統，可以更快地執行並行化構建任務。build.gn 的特點是使用簡單且易於擴展，並且可以生成快速，透明和可重現的構建。

build.gn 文件的特點如下：

使用簡單，易於維護。
易於擴展和修改。
構建結果可重現性高。
支持並行化構建。
具有跨平台的特性。

二、build.gn 頭文件共享

build.gn 文件可以包含一個或多個頭文件。頭文件是指包含常用定義和函數的文件，以避免意義相同的代碼重複編寫。使用共享頭文件可以更好地組織代碼並提高代碼的可讀性。在 build.gn 文件中使用頭文件共享可以通過 include 定義來實現。下面是一個示例：


# 聲明共享頭文件：common.gni
define include_common
  import("//common.gni")
endef

# build.gn 文件中包含共享頭文件
import("//common.gni")

三、build.gn 編寫

編寫 build.gn 文件時，需要注意以下幾點：

文件頂部應該包含當前項目的元數據信息。可以選擇定義變量，使其易於維護。
使用 import 指令來導入其他文件或模塊。
在 build.gn 文件中，使用 variables 定義變量，方便以後的管理。
定義 target，target 之間可以有依賴的關係。
定義 action 函數，可以執行一系列的 shell 命令。

除了這些常規指南外，還有如下的一些編寫 tips 值得注意：

使用 explain 函數提供更好的用戶體驗。
提供錯誤信息和調試信息以便調試。
為特定平台和產品構建不同的目標。
使用 generator_functions 功能來實現高級的構建自動化。

四、build.gn 教程

Google 提供了完整的 build.gn 教程，旨在幫助開發人員快速學習該文件的主要特點，如何編寫和使用它來構建項目。教程提供了許多示例和練習，用戶可以跟隨教程一步一步地完成。

下面是一個例子，展示如何使用 build.gn 構建一個名為 Jokes 的閃存卡遊戲：


# build.gn 文件
{
  name = "Jokes"
  products = [ "Jokes-Mobile", "Jokes-Desktop" ]

  # 手機 Jokes 的構建
  executable("Jokes-Mobile") {
    sources = [ "source/*" ]
    defines = [ "JOKES_MOBILE" ]
    output_name = "jokes-mobile"

    # 將圖塊抖動優化通用性
    cflags = [ "-O3", "-fno-strict-aliasing" ]
  }

  # desktop jokes 的構建
  executable("Jokes-Desktop") {
    sources = [ "source/*" ]
    defines = [ "JOKES_DESKTOP" ]
    output_name = "jokes-desktop"

    # 沒有抖動優化
    cflags = [ "-O2" ]
  }
}

五、build.gn 是什麼

build.gn 是 Google 的一種開源項目構建工具，用於自動化構建軟件系統並生成可執行文件。也可以說，它是一種 Makefile 的替代品。build.gn 是 Ninja 構建系統的一部分，它廣泛用於 Google 內部的項目構建和管理。

六、build.gn 語法解析

build.gn 文件的基本語法如下：

每個語句必須以分號結尾。
使用空格或縮進來表示代碼塊。
使用 # 來注釋。
支持 String，List 和 Dictionary 數據類型。

下面是一個簡單的示例：


example_variable = 'Hello, world!'

example_target('foo') {
    sources = [ 'main.c', 'common.c' ]
    defines = [ 'USE_COMMON' ]
    includes = [ '//path/to/common/includes' ]
    cflags = [ '-Wall', '-Werror' ]
}

七、build.gn 指定頭文件

可以使用 include_dirs 變量指定搜索頭文件的目錄。下面是一個示例：


example_dir = "//path/to/includes"
my_targets = [ 'foo', 'bar', 'baz' ]

foreach(target, my_targets) {
    sources = [ 'main.c' ]
    include_dirs = [ example_dir ]
    cflags = [ '-Wall', '-Werror' ]
}

八、build.gn 不寫能否 include

如果在 build.gn 文件中沒有包含任何頭文件，那也是合法的。當僅使用預定義操作和變量時，不需要包含任何其他文件或包。

下面是一個簡單的示例：


ninja_required_version = 1.3

cflags_cc = [ "-Wall", "-std=c++11" ]
ldflags = [ "-lm", "-lpthread" ]

executable("example") {
  sources = [ "main.cc" ]
}

九、build.gn 的作用

build.gn 可以用於自動化構建項目，即通過描述項目的編譯和構建過程，自動生成完整的構建代碼。使用 build.gn 可以輕鬆管理龐大的代碼庫以及依賴系統，並且可以自動化構建和測試操作。

十、build.gn config選取

在 build.gn 文件中可以使用 config 模塊來定義平台和產品特定的構建變量。例如，下面的 build.gn 文件使用 config 模塊定義了特定於 Windows/ChromeOS 平台的變量：


use_staging_server = !is_chromeos && value_of("is_debug") == "true"
is_chromeos = defined("chromeos")
is_windows = defined("win")

if (is_chromeos) {
    my_sources += [ "chromeos/*.c" ]
    my_defines += [ "USE_CHROMEOS" ]
    my_cflags += [ "-Os" ]
}

if (is_windows) {
    my_sources += [ "win32/*.c" ]
    my_defines += [ "USE_WINDOWS" ]
    my_cflags += [ "-O2" ]
}

使用 config 模塊可以更好地定義和管理平台和產品的特定構建選項。

結語

通過本文的介紹，相信讀者們已經了解了 build.gn 文件的主要特點以及使用它進行自動化軟件構建的方法。在軟件工程中，自動化構建是非常重要的一部分，使用 build.gn 可以提高軟件開發的效率和質量。希望本文能夠幫助讀者更好地掌握 build.gn 文件的使用，更加高效地完成軟件開發任務。

原創文章，作者：小藍，如若轉載，請註明出處：https://www.506064.com/zh-hk/n/306521.html