gflags的使用

今天，Mayuyu要向大家介绍一个非常实用的工具，叫做gflags。gflags是google开源的一套命令行参数解析工具，比getopt()函数功能要强大，使用起来更加方便，gflags还支持从环境变量和配置文件中读取参数。目前有C++和Python版本。本文就来详细介绍C++版本gflags的使用，主要分如下两个部分

 

 

Contents

 

    1. gflags的安装

    2. gflags的使用介绍

 

 

1. gflags的安装

 

   上面我们已经对gflags有个大概的认识，接下来开始在Linux环境中安装gflags。首先下载如下安装包

 

   链接：https://github.com/schuhschuh/gflags/releases

 

   在线帮助文档：http://gflags.googlecode.com/svn/trunk/doc/gflags.html

 

   Mayuyu的版本是gflags-1.0rc2.tar.gz，然后进行解压，执行如下3步

 

   （1）./configure

   （2）make

   （3）make install

 

 

   介绍两个比较重要的文件

 

   doc ：         gflags的帮助文件，里面介绍了gflags的一些使用方法。

   src ：         gflags的代码源文件。

 

  

   为了程序在运行时能加载libgflags.so文件，还需要在/usr/lib目录下建立软链接，如下

 

     

 

 

   现在就彻底安装好gflags了，可以安心使用。

 

 

2. gflags的使用介绍

  

  （1）定义参数

 

      使用gflags需要包含头文件#include 。而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

 

      定义方式如下

 

     

 

      即DEFINE_type就可以了，该宏的三个参数分别代表命令行参数名，参数默认值，参数的帮助信息。

 

      gflags不支持列表，但是可以借助string类型实现，比如

 

     

 

  

  （2）参数访问

 

      参数被定义后，可以通过FLAGS_name来访问，比如

 

     

 

     

 

      注意一点，通过DEFINE定义的参数，要保证访问变量的文件和定义参数的文件是同一个文件或者是头文件

      包含关系，否则将会访问不到定义的参数。在其它文件使用定义的参数通过DECLARE实现。

  

 

  （3）参数检查

 

      参数定义后，可以为参数注册一个检查函数，当从命令行指定参数或通过SetCommandLineOption()指定

      参数时，检查函数就会被调用，两个参数分别为命令行参数名，以及设置的参数值。

 

#include 
#include 
#include 
#include 

#include 

using namespace std;
using namespace google;

static bool ValidatePort(const char *flagname, int32_t val)
{
	if(val > 0 && val < 32768)
		return true;
	return false;
}
DEFINE_int32(port, 6379, "what is the port ?");

int main(int argc, char **argv)
{
    ParseCommandLineFlags(&argc, &argv, true);
    bool isPort = RegisterFlagValidator(&FLAGS_port, &ValidatePort);  
	return 0;
}

 

 

      建议在定义参数后，立即注册检查函数。RegisterFlagValidator()在检查函数注册成功时返回true；

      如果参数已经注册了检查函数，或者检查函数类型不匹配，返回false。

 

 

  （4）初始化参数

 

      通过调用ParseCommandLineFlags(&argc, &argv, true)实现，最后一个参数如果为true，gflags

      会移除Parse过的参数，如果为false则会保留。可能会对参数顺序进行调整。

 

 

  （5）在命令行指定参数

 

      可以通过：--参数名=参数值 来指定。例如下面代码

 

#include 
#include 
#include 
#include 

#include 

using namespace std;
using namespace google;

static bool ValidatePort(const char *flagname, int32_t val)
{
	if(val > 0 && val < 32768)
		return true;
	return false;
}
DEFINE_int32(port, 6379, "what is the port ?");
DEFINE_string(ip, "127.0.0.1", "My ip ?");

int main(int argc, char **argv)
{
    ParseCommandLineFlags(&argc, &argv, true);
    bool isPort = RegisterFlagValidator(&FLAGS_port, &ValidatePort);  
	int32_t Port = FLAGS_port;
	string Ip = FLAGS_ip;
	cout << Port << endl;
	cout << Ip << endl;
	return 0;
}

 

         参数可以通过下面方式指定，参数之间可以没有顺序。

 

      

 

 

  （5）一些特殊的参数认识

 

      --help

 

      打印定义过的所有参数的帮助信息

      --version

 

      打印版本信息 通过google::SetVersionString()指定

      --nodefok 

 

      但命令行中出现没有定义的参数时，并不退出（error-exit）

      --fromenv

 

      从环境变量读取参数值 --fromenv=foo,bar表明要从环境变量读取foo，bar两个参数的值。通过

      export FLAGS_foo=xxx; export FLAGS_bar=yyy 程序就可读到foo，bar的值分别为xxx，yyy。

      --tryfromenv

 

      与--fromenv类似，当参数的没有在环境变量定义时，不退出（fatal-exit）

      --flagfile

 

      从文件读取参数值，--flagfile=my.conf表明要从my.conf文件读取参数的值。在配置文件中指定参

      数值与在命令行方式类似，另外在flagfile里可进一步通过--flagfile来包含其他的文件。