簡介

• 在百度Apollo中gflag被廣泛的應用在各種全域性變數中，例如節點名，變數名，各種狀態標誌中。
• gflags 是google開源的一套命令列引數解析工具，比 getopt 功能更加強大，使用起來更加方便。
• 什麼是 命令列引數解析工具 呢? 這裡拿python做例子，例如：python test.py cmd1 cmd2
  其中cmd1和cmd2 就是命令列引數，gflags就是用來解析cmd1 cmd2 到程式中的。
• ps: 在cpp中命令列引數就是字串

1. 安裝 gflags

build和安裝教程在INSTALL檔案中有， 該教程支援pkg-config, CMake, 以及 Bazel.

1.1 cmake

如果gflags不是安裝在預設路徑下，則環境變數gflags_DIR 需要是 <prefix>/lib/cmake/gflags 該資料夾下需要是有 gflags-config.cmake 的檔案。

如果gflags安裝在預設路徑下CMake 可以通過 find_package(gflags REQUIRED)

或者新增單執行緒靜態庫：
find_package(gflags COMPONENTS nothreads_static)
自動找到 gflags 。

新增dependency和execute
add_executable(foo main.cc)

1.2 Bazel

在WORKSPACE中新增以下語句

git_repository(
    name   = "com_github_gflags_gflags",
    commit = "<INSERT COMMIT SHA HERE>",
    remote = "https://github.com/gflags/gflags.git",
)

bind(
    name = "gflags",
    actual = "@com_github_gflags_gflags//:gflags"
 
,
)

bind(
    name = "gflags_nothreads",
    actual = "@com_github_gflags_gflags//:gflags_nothreads",
)

ps
gflags_nothreads 強制單執行緒
gflags 多執行緒

然後新增到BUILD中：

cc_binary(
    name = "foo",
    srcs = ["main.cc"],
    deps = ["//external:gflags"],
)

2. 使用 gflags

2.1. 首先需要#include "gflags.h"

#include <gflags/gflags.h>

2.2. 巨集定義

將需要的命令列引數使用gflags的巨集來定義，例如：DEFINE_xxxxx(變數名，預設值，help-string) 定義在檔案當中，注意：是全域性的， 例如Apollo中的FLAGS_control_node_name就是一個全域性的一個string。gflags支援以下型別：

DEFINE_bool: boolean
DEFINE_int32: 32-bit integer
DEFINE_int64: 64-bit integer
DEFINE_uint64: unsigned 64-bit integer
DEFINE_double: double
DEFINE_string: C++ string

2.3. main函式新增

在main函式中開始的地方加入，以下這句話：

google::ParseCommandLineFlags(&argc, &argv, true);
//如果設為true，則該函式處理完成後，argv中只保留argv[0]，argc會被設定為1。
//如果為false，則argv和argc會被保留，但是注意函式會調整argv中的順序。

2.4 呼叫

在後續程式碼中使用FLAGS_變數名訪問對應的命令列引數方法如下：

printf("%s", FLAGS_mystr);

2.5 測試

在編譯成可執行檔案之後，使用：./exe --引數1=值1 --引數2=值2 ... 來為這些命令列引數賦值。

./mycmd --var1="test" --var2=3.141592654 --var3=32767 --mybool1=true --mybool2 --nomybool3

3. gflags進階使用

3.1. 在其他檔案中使用定義的flags變數

• 有些時候需要在main之外的檔案使用定義的flags變數，這時候可以使用巨集定義DECLARE_xxx(變數名)宣告一下（就和c++中全域性變數的使用是一樣的，extern一下一樣）

DECLARE_bool: boolean
DECLARE_int32: 32-bit integer
DECLARE_int64: 64-bit integer
DECLARE_uint64: unsigned 64-bit integer
DECLARE_double: double
DECLARE_string: C++ string

在對應的.h檔案中進行DECLARE_xxx宣告，需要使用的檔案直接include就行了。
檢驗輸入引數是否合法：gflags庫支援定製自己的輸入引數檢查的函式，如下：

static bool ValidatePort(const char* flagname, int32 value) {
   if (value > 0 && value < 32768)   // value is ok
     return true;
   printf("Invalid value for --%s: %d\n", flagname, (int)value);
   return false;
}
DEFINE_int32(port, 0, "What port to listen on");
static const bool port_dummy = RegisterFlagValidator(&FLAGS_port, &ValidatePort);

3.2 判斷flags變數是否被使用者使用

在gflags.h中，還定義了一些平常用不到的函式和結構體。這裡舉一個例子，判斷引數port有沒有被使用者設定過

    google::CommandLineFlagInfo info;
    if(GetCommandLineFlagInfo("port" ,&info) && info.is_default) {
        FLAGS_port = 27015;
    }

3.3 定製你自己的help資訊與version資訊

• version資訊：使用google::SetVersionString設定，使用google::VersionString訪問
• help資訊：使用google::SetUsageMessage設定，使用google::ProgramUsage訪問
• 注意：google::SetUsageMessage和google::SetVersionString這兩個函式的呼叫必須在google::ParseCommandLineFlags之前執行