手动用cpp实现http(三)

创建于 2020-07-31，最终修订于 2020-08-06

在之前的课程(二)中我们讲了有关 HTTP 头部，请求体和返回结构在 cpp中的定义，今天我们来说一些很不相关，但是也很重要的内容：

今天的任务是 “[易]引入cpptoml从文件读取配置，引入spdlog尝试打log，帮助调试”。

所有的代码都在 https://github.com/dashjay/http_demo/tree/3-cpptoml-spdlog 中

Let’s do it

# 0x1 为什么要载入配置文件

众所周知，编译类的程序，编译一次，可运行n次，在通过一些测试后，即可常年工作。但是有些情况下，我们会尝试通过一些方法修改程序的行为，例如：

程序的配置项除了监听端口之外，其实还有很多其他的例如，tls证书位置。
平时日常使用时只会打印出一小部分log，防止大量log堆积导致一些问题，但是当程序出现异常的时候，希望能多打印一些程序，需要调整log程序的打印级别。

当遇到这些内容修改时，我们是不希望再编译一遍的。

而如果这些命令通过标准输入，或者运行时作为参数传入都不是很方便，因此我们会使用配置文件。

我推荐使用 TOML 格式来作为配置，不用再因为担心缩进，支持的格式也很丰富，数组，浮点数，字符串，等等。

经过一些选择之后我找到一个库，叫 cpptoml

# 0x2 cpptoml

A header-only library for parsing TOML configuration files.

# 安装

1
2
3


git clone https://github.com/toml-lang/toml.git
cd toml; mkdir build; cd build
cmake .. && make && make install

看到这里你即便不知道cmake有什么用，但是你也知道他有多常见了吧？到目前为止我们电脑里已经安装了sockpp, cpptoml. 他们一个是有链接库的，一个是header only的。

# 小尝试

本次的所有代码都基于上次课程的开始。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12


#include<iostream>
#include "cxxhttp.h"
#include "cpptoml.h"

int main() {
    auto config = cpptoml::parse_file("./config.toml");
    auto port = config->get_qualified_as<in_addr_t>("ENV.port");
    std::cout << "server will start at port " << *port << '\n';

    Request req("GET", "/", "body");
    ...
}

当你写成这样尝试 make 的时候，你会发现

1
2
3
4


» make
[ 25%] Building CXX object CMakeFiles/main.dir/main.cpp.o
/Users/dashjay/CLionProjects/http_demo/main.cpp:4:10: fatal error: 'cpptoml.h' file not found
#include "cpptoml.h"

和之前的原因一样，你得在 CMakeLists.txt 中加上 include_directories(/usr/local/include) 或者你的 cpptoml 安装的位置。

当你运行会得到如下的结果

1
2


server will start at port 8083
....

前提是，运行目录下方有一个 config.toml 文件，

1
2


[ENV]
port = 8083

为什么使用*port来取值： 通过源代码我们发现 auto port = .... 的得到的不是目标类型的对象，而是一个叫做 option 的对象，下面有一些代码解释。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20


template <class T>
class option
{
  public:
    ......  
    explicit operator bool() const
    {
        return !empty_;
    }

    const T& operator*() const
    {
        return value_;
    }

    const T* operator->() const
    {
        return &value_;
    }
    ...

我们可以看到，返回的对象被重载了 bool(), *, -> 三种操作符：分别可以得到， 对象是否为空，对象的引用，指向对象的指针三个值。

# 0x3 为什么不使用std::cout或std::cerr 来输出日志

输出到标准输出和标准错误的日志，会因为多线程的原因，产生一些堆叠，在这里我就不进行演示了，你可以想象，100个线程毫无避讳的使用 std::cout << ... 时，会产生大量重叠，丢失，的情况。

虽然使用log程序会产生一些锁的开销，但是目前看来是值得的：

帮助我们debug，有不同的颜色，层级来标注
不会因为多线程的使用而错乱¹

# 0x4 spdlog

Very fast, header-only/compiled, C++ logging library.

在搜索查询了不少 log 库，诸如什么 log4cpp 之类的，发现他们都比较臃肿，有的还需要单独的配置文件，没有这个库容易使用。

spdlog

安装什么的应该不用我说吧，它有cmake，和之前的操作一样即可。这个也是一个纯header的库，无需链接。

写了一些代码修改之后的主文件如下

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21


#include<iostream>
#include "spdlog/spdlog.h"
#include "cxxhttp.h"
#include "cpptoml.h"

int main() {
    auto config = cpptoml::parse_file("./config.toml");
    auto port = config->get_qualified_as<in_addr_t>("ENV.port");
    std::cout << "server will start at port " << *port << '\n';

    Request req("GET", "/", "body");

    spdlog::info("request: {}", req.to_string());

    Response resp;
    resp.proto = "HTTP/1.1";
    resp.status = "200 OK";
    resp.body = "body";

    spdlog::info("response: {}", resp.to_string());
}

request: {} 中的 {} 是一个占位符，他没有选择用常见的 %s %d，来完成格式化字符串，而是使用了 {}，该库介绍说性能很高，不应该指定类型性能会更高么，不是很明白，不过不影响我们使用它。

这样全局调用即可，如果我们没有什么更高级的需求。

今天的内容有点水了，这可是为了我们下面最难的一节做一些铺垫，我可不想看到以为重新编译一遍就能解决问题的你，疯狂make……

在这一点上我并没有写代码确认，也没有阅读源代码，在这里这么描述是不负责的，但是多线程使用 std::cout << 或 std::cerr << 是肯定会产生一些错误的。 ↩︎