Gflags的使用

目录

1. gflags 安装

2. gflags 使用

2.1 基本使用方法

2.2 基本使用实例

2.3 放入配置文件中

3. 融入cmakelists中使用

---

在实际工程代码开发中，发现gflags很好用，可以在运行

1. gflags 安装

gflags的安装使用apt-get install命令安装即可

sudo apt-get install libgflags-dev
sudo apt-get install libgoogle-glog-dev
sudo apt-get install libgtest-dev

当然也可以使用源码安装，我通过命令安装就足够使用了，源码安装就不再赘述。

2. gflags 使用

2.1 基本使用方法

首先看定义方法，在代码中增加下面几类定义，可以在程序中使用相应的flag：

// gflags定义类型	描述
DEFINE_bool(is_test, false, "test for bool");   // bool位整型
DEFINE_int32(int32_test, 0, "test for int32");	// 32位整型
DEFINE_int64(int64_test, -1, "test for int64");	// 64位整型
DEFINE_uint64(uint64_test, 0, "test for uint64");	// 无符号64位整型
DEFINE_double(double_test, 0.1, "test for double");	// 浮点类型
DEFINE_string(string_test, "test", "test for string");	// C++ string类型

gflag中可以定义上述六类类型的flag，以第一个bool类型的定义为例，第一个变量is_test就是flag的名称，第二个变量false是该flag的默认值，第三个变量“test for bool”是对is_test这个bool类型的flag的解释说明，上述三个量在自己使用的时候根据需要修改。

在程序中使用定义的flag之前，首先需要加上如下代码

gflags::ParseCommandLineFlags(&argc, &argv, true);

这行代码用来对命令行中输入的flag值进行拆解，前两个变量分别是命令行输入的参数个数，和参数数组，第三个变量true，false决定了是否在读入flag后，恢复命令行的参数和参数列表。个人认为这里true，false都不影响使用。

在程序结束使用flag之前，需要加入如下代码

gflags::ShutDownCommandLineFlags();

2.2 基本使用实例

定义好flag之后，使用的时候在定义的变量之前加上FLAGS_,如is_test使用时变为FLAGS_is_test。

#include <iostream>
#include <gflags/gflags.h>
using namespace std;

// gflags定义类型	描述
DEFINE_bool(is_test, false, "test for bool");   // bool位整型
DEFINE_int32(int32_test, 0, "test for int32");	// 32位整型
DEFINE_int64(int64_test, -1, "test for int64");	// 64位整型
DEFINE_uint64(uint64_test, 0, "test for uint64");	// 无符号64位整型
DEFINE_double(double_test, 0.1, "test for double");	// 浮点类型
DEFINE_string(string_test, "test", "test for string");	// C++ string类型

// 定义为全局变量，类似于extern
DECLARE_bool(is_test);


int main(int argc, char **argv){

    gflags::ParseCommandLineFlags(&argc, &argv, true);

    if(FLAGS_is_test){
        cout << "FLAGS_is_test is true." << endl;
    }

    cout << FLAGS_string_test << endl;

    gflags::ShutDownCommandLineFlags();
    return 0;
}

编译时注意需要指定gflag的库

g++ Gflags.cpp -lgflags

编译完成后，运行可执行文件时，可以修改对应flag的值

./a.out -is_test=true -string_test="try string test"

运行结果如下：

FLAGS_is_test is true.
try string test

2.3 放入配置文件中

工程上对于配置文件的使用比较频繁，如果定义的flag较多，可以借助配置文件来定义。gflag对这个配置文件的变量名有明确的规定，用flagfile，配置的格式和在命令行中一致。

#flag_config.txt
-is_test=True 
-string_test="try string test"

运行时指定flagfile变量

./a.out -flagfile=flag_config.txt

3. 融入cmakelists中使用

上述编译的时候，要制定gflags库，那么在使用cmakelists的时候，就要对应的增加库

cmake_minimum_required(VERSION 3.10)
project(test)

# 设置C++标准为C++11
set(CMAKE_CXX_STANDARD 11)

# 查找gflags库
find_package(gflags REQUIRED)

add_executable(test Gflags.cpp)

# 链接gflags库到你的项目
target_link_libraries(test gflags)

编译执行即可。