C++系统相关操作1 - 调用命令行并获取返回值

• 1. 关键词
  
• 2. sysutil.h
  
• 3. sysutil.cpp
  
  
  
  • 3.1. system_util_unix.cpp
    
  • 3.2. system_util_win.cpp
    
  
  
• 4. 测试代码
  
• 5. 运行结果
  
• 6. 源码地点
  

1. 关键词

关键词：
C++ 系统调用 system popen 跨平台
应用场景：
盼望直接调用操作系统的某些命令，并获取命令的返回值。
2. sysutil.h

1. #pragma once
3. #include <cstdint>
4. #include <string>
6. namespace cutl
7. {
8.     /**
9.      * @brief Execute a system command.
10.      *
11.      * @param cmd the command to be executed.
12.      * @return true if the command is executed successfully, false otherwise.
13.      */
14.     bool system(const std::string &cmd);
15.     /**
16.      * @brief Execute a system command and get the output.
17.      *
18.      * @param cmd the command to be executed.
19.      * @param result the output of the command.
20.      * @return true if the command is executed successfully, false otherwise.
21.      */
22.     bool callcmd(const std::string &cmd, std::string &result);
23. } // namespace cutl

复制代码

不需要返回值时，可以直接使用system， 需要获取返回值时，可以调用callcmd。
3. sysutil.cpp

1. #include <map>
2. #include <iostream>
3. #include <strutil.h>
4. #include <cstdlib>
5. #include "sysutil.h"
6. #include "inner/logger.h"
7. #include "inner/system_util.h"
8. #include "inner/filesystem.h"
10. namespace cutl
11. {
12.     bool system(const std::string &cmd)
13.     {
14.         return call_system(cmd);
15.     }
17.     bool callcmd(const std::string &cmd, std::string &result)
18.     {
19.         // 读取命令执行结果的最大Buffer长度
20.         constexpr int MAX_CMD_BUF_LEN = 1024;
21.         FILE *fp = pipline_open(cmd);
22.         if (fp == NULL)
23.         {
24.             CUTL_ERROR("pipline_open error for cmd:" + cmd);
25.             return false;
26.         }
28.         // 　读取命令执行结果
29.         char buffer[MAX_CMD_BUF_LEN] = {0};
30.         char *res = fgets(buffer, sizeof(buffer), fp);
31.         if (res == NULL)
32.         {
33.             CUTL_ERROR("read result error for cmd:" + cmd);
34.             if (pipline_close(fp) != 0)
35.             {
36.                 CUTL_ERROR("pipline_close error for cmd:" + cmd);
37.             }
38.             return false;
39.         }
41.         if (pipline_close(fp) != 0)
42.         {
43.             CUTL_ERROR("pipline_close error for cmd:" + cmd);
44.         }
46.         result = strip(std::string(buffer));
48.         return true;
49.     }
50. } // namespace cutl

复制代码

3.1. system_util_unix.cpp

1. #if defined(_WIN32) || defined(__WIN32__)
2. // do nothing
3. #else
5. #include "system_util.h"
6. #include "inner/logger.h"
8. namespace cutl
9. {
11.     bool call_system(const std::string &cmd)
12.     {
13.         if (cmd.empty())
14.         {
15.             CUTL_ERROR("cmd is empty!");
16.             return false;
17.         }
19.         pid_t status;
20.         status = std::system(cmd.c_str());
22.         if (-1 == status)
23.         {
24.             CUTL_ERROR("system error!");
25.             return false;
26.         }
28.         if (!WIFEXITED(status))
29.         {
30.             CUTL_ERROR("exit status:" + std::to_string(WEXITSTATUS(status)));
31.             return false;
32.         }
34.         if (0 != WEXITSTATUS(status))
35.         {
36.             CUTL_ERROR("run shell script fail, script exit code:" + std::to_string(WEXITSTATUS(status)));
37.             return false;
38.         }
40.         return true;
41.     }
43.     FILE *pipline_open(const std::string &cmd)
44.     {
45.         return popen(cmd.c_str(), "r");
46.     }
48.     int pipline_close(FILE *stream)
49.     {
50.         return pclose(stream);
51.     }
53. } // namespace cutl
55. #endif // defined(_WIN32) || defined(__WIN32__)

复制代码

3.2. system_util_win.cpp

1. #if defined(_WIN32) || defined(__WIN32__)
3. #include <cstdlib>
4. #include "system_util.h"
5. #include "inner/logger.h"
7. namespace cutl
8. {
10.     // https://learn.microsoft.com/zh-cn/cpp/c-runtime-library/reference/system-wsystem?view=msvc-170
11.     bool call_system(const std::string &cmd)
12.     {
13.         if (cmd.empty())
14.         {
15.             CUTL_ERROR("cmd is empty!");
16.             return false;
17.         }
19.         int ret = system(cmd.c_str());
20.         if (ret != 0)
21.         {
22.             CUTL_ERROR(std::string("system failure, error") + strerror(errno));
23.             return false;
24.         }
26.         return true;
27.     }
29.     // https://learn.microsoft.com/zh-cn/cpp/c-runtime-library/reference/popen-wpopen?view=msvc-170
30.     FILE *pipline_open(const std::string &cmd)
31.     {
32.         return _popen(cmd.c_str(), "r");
33.     }
35.     // https://learn.microsoft.com/zh-cn/cpp/c-runtime-library/reference/pclose?view=msvc-170
36.     int pipline_close(FILE *stream)
37.     {
38.         return _pclose(stream);
39.     }
41. } // namespace cutl
43. #endif // defined(_WIN32) || defined(__WIN32__)

复制代码

4. 测试代码

[code]#include "common.hpp"#include "sysutil.h"void TestSystemCall(){    PrintSubTitle("TestSystemCall");    bool ret = cutl::system("echo hello");    std::cout