手把手写c++服务器(28)：手撕cgi通用网关接口服务器代码(代码片段)

 本系列文章导航： 手把手写C++服务器(0)：专栏文章-汇总导航【更新中】 

前言：前文《手把手写C++服务器(26)：常用I/O操作、创建文件描述符》《手把手写C++服务器(27)：五大文件描述符零拷贝、控制总结》详细学习了I/O操作，这一讲在前面文章的基础之上，手把手实现一个CGI通用网关接口服务器。虽然通用网关接口已经被主流解决方案所抛弃，但是我们手撕源码的过程中，还是能够加深对I/O编程、网络编程的认识，非常具有现实意义。

目录

预备知识一：什么是CGI通用网关接口？

预备知识二：socket一般框架

响应框架：

请求框架：

预备知识三：dup/dup2

示例源码

预备知识四：更新缓冲区fflush

示例源码

现在正式开始吧！

server.cpp

client.cpp

编译与运行

参考

预备知识一：什么是CGI通用网关接口？

CGI基本已经被淘汰，并且通常有web内部模块来实现，这里简单了解一下背景。

早期的Web服务器，只能响应浏览器发来的HTTP静态资源的请求，并将存储在服务器中的静态资源返回给浏览器。随着Web技术的发展，逐渐出现了动态技术，但是Web服务器并不能够直接运行动态脚本，为了解决Web服务器与外部应用程序（CGI程序）之间数据互通，于是出现了CGI（Common Gateway Interface）通用网关接口。简单理解，可以认为CGI是Web服务器和运行其上的应用程序进行“交流”的一种约定。

CGI是Web服务器和一个独立的进程之间的协议，它会把HTTP请求Request的Header头设置成进程的环境变量，HTTP请求的Body正文设置成进程的标准输入，进程的标准输出设置为HTTP响应Response，包含Header头和Body正文。在系统中的位置如下图所示：

通过CGI接口，Web服务器就能够获取客户端传递的数据，并转交给服务器端的CGI程序处理，然后返回结果给客户端。简单来说，CGI实际上是一个接口标准。而通常所说的CGI指代其实是CGI程序，也就是实现了CGI接口标准的程序，只要编程语言具有标准输入、标准输出和环境变量，就可以用来编写CGI程序。

预备知识二：socket一般框架

前文《手把手写C++服务器(24)：socket响应一般框架、TCP修改缓冲区、内核监听listen最大长度》说过，大部分的代码都大同小异，如果有知识点不太熟欢迎跳转到24讲。

响应框架：

#include <sys/socket.h>
#include <netinet/in.h>
/* 创建监听socket文件描述符 */
int listenfd = socket(PF_INET, SOCK_STREAM, 0);
/* 创建监听socket的TCP/IP的IPV4 socket地址 */
struct sockaddr_in address;
bzero(&address, sizeof(address));
address.sin_family = AF_INET;
address.sin_addr.s_addr = htonl(INADDR_ANY);  /* INADDR_ANY：将套接字绑定到所有可用的接口 */
address.sin_port = htons(port);

int flag = 1;
/* SO_REUSEADDR 允许端口被重复使用 */
setsockopt(listenfd, SOL_SOCKET, SO_REUSEADDR, &flag, sizeof(flag));
/* 绑定socket和它的地址 */
ret = bind(listenfd, (struct sockaddr*)&address, sizeof(address));  
/* 创建监听队列以存放待处理的客户连接，在这些客户连接被accept()之前 */
ret = listen(listenfd, 5);

请求框架：

#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <unistd.h>
#include <arpa/inet.h>
#include <sys/socket.h>

int main()
    //创建套接字
    int sock = socket(AF_INET, SOCK_STREAM, 0);

    //向服务器（特定的IP和端口）发起请求
    struct sockaddr_in serv_addr;
    memset(&serv_addr, 0, sizeof(serv_addr));  //每个字节都用0填充
    serv_addr.sin_family = AF_INET;  //使用IPv4地址
    serv_addr.sin_addr.s_addr = inet_addr("127.0.0.1");  //具体的IP地址
    serv_addr.sin_port = htons(1234);  //端口
    connect(sock, (struct sockaddr*)&serv_addr, sizeof(serv_addr));
   
    //读取服务器传回的数据
    char buffer[40];
    read(sock, buffer, sizeof(buffer)-1);
   
    printf("Message form server: %s\\n", buffer);
   
    //关闭套接字
    close(sock);

    return 0;

预备知识三：dup/dup2

本系列第26讲《手把手写C++服务器(26)：常用I/O操作、创建文件描述符》讲述过这个知识点，不太熟悉的可以跳转到前文温故一下。

 dup()和dup2()在文件重定向中经常使用， 或者可以简单理解为复制一个文件描述符。但是复制的文件描述符并不继承原文件描述符的属性。

#include <unistd.h>
int dup(int file_descriptor);
int dup2(int file_descriptor_one, int file_descriptor_two);

dup函数创建一个新的文件描述符，该新文件描述符合原有文件描述符file_descriptor指向相同的文件、管道或者网络连接。并且dup返回的文件描述符总是取系统当前可用的最小整数值。

dup2将返回第一个不小于file_descriptor_two的整数值。

示例源码

int main(void)

    int fd;
    int new_fd;

    fd = open("./test.file", O_RDWR | O_CREAT | O_TRUNC, 0666);
    printf("fd = %d\\n", fd);

    new_fd = dup(fd);    //复制文件描述符,把fd复制给new_fd
    printf("new_fd = %d\\n", new_fd);
    write(new_fd, "hello", 5);

    close(fd);
    close(new_fd);

    return 0;

预备知识四：更新缓冲区fflush

fflush()会强迫将缓冲区内的数据写回参数stream 指定的文件中. 如果参数stream 为NULL,fflush()会将所有打开的文件数据更新。

#include <stdio.h>
int fflush(FILE *stream)

参数释义：stream是指向 FILE 对象的指针，该 FILE 对象指定了一个缓冲流。

如果成功刷新,fflush返回0。指定的流没有缓冲区或者只读打开时也返回0值。返回EOF指出一个错误。

示例源码

demo1：每次都刷新一次输出缓冲区，理论上每次输出的时候缓冲区都被刷新了，每个数字是一次次出现的。

#include <stdio.h>

int main() 

    for(int i = 0; i < 10; i++) 
        printf("%d", i);
        fflush(stdout);
    

    return 0;

demo2：清理输入缓冲区的无用值

#include <stdio.h>
int main()

    char c;
    scanf("%c", &c);
    printf("%d\\n", c);

    fflush(stdin); // 清理输入缓冲区中的无用值

    scanf("%c", &c);
    printf("%d\\n", c);

    return 0;

现在正式开始吧！

通过上文的分析，我们需要做的事情如下：

• 参照一般架构构建一个响应结构和请求结构
• 关闭标准输出中的文件描述符
• 使用dup，返回系统中最小可用文件描述符，即刚才关闭的标准输出文件描述符
• 服务器的输出与客户连接的socket对接上
• 使用fflush更新缓冲区
• 标准输出的内容会被客户获得，实现简易的CGI服务器

server.cpp

#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <unistd.h>
#include <arpa/inet.h>
#include <sys/socket.h>
#include <assert.h>
#include <errno.h>
#include <netinet/in.h>

int main(int argc, char* argv[])
    if (argc <= 1) 
        printf("error! please input port!\\n");
        return 1;
    
    //创建套接字
    int serv_sock = socket(AF_INET, SOCK_STREAM, IPPROTO_TCP);
    assert(serv_sock);
    int port = atoi(argv[1]);

    //将套接字和IP、端口绑定
    struct sockaddr_in serv_addr;
    memset(&serv_addr, 0, sizeof(serv_addr));  //每个字节都用0填充
    serv_addr.sin_family = AF_INET;  //使用IPv4地址
    serv_addr.sin_addr.s_addr = inet_addr("127.0.0.1");  //具体的IP地址
    serv_addr.sin_port = htons(port);  //端口
    bind(serv_sock, (struct sockaddr*)&serv_addr, sizeof(serv_addr));

    //进入监听状态，等待用户发起请求
    listen(serv_sock, 20);

    //接收客户端请求
    struct sockaddr_in clnt_addr;
    socklen_t clnt_addr_size = sizeof(clnt_addr);
    int connfd = 0;
    for ( ; ; ) 
        if ((connfd = accept(serv_sock, (struct sockaddr*)&clnt_addr, &clnt_addr_size)) < 0) 
            printf("accept error: %s\\n",strerror(errno));
            return 1;
        
        int ret = close(STDOUT_FILENO); // 关闭标准文件描述符
        if (ret < 0) 
            printf("close error: %s",strerror(errno));
            exit(1);
        
        if (dup(connfd) < 0) 
            printf("dup error: %s\\n",strerror(errno));
            return 1;
        
        printf("this is STDOUT_FILENO while be sended");
        fflush(stdout);
        close(connfd);
    
    close(serv_sock);
    /*
    int clnt_sock = accept(serv_sock, (struct sockaddr*)&clnt_addr, &clnt_addr_size);
    if (clnt_sock < 0) 
        printf("error is %d\\n", errno);
     else 
        //向客户端发送数据
        //向客户端发送数据
        char str[] = "bingo from sever";
        write(clnt_sock, str, sizeof(str));
    
    //关闭套接字
    close(clnt_sock);
    close(serv_sock);
    */
    return 0;

client.cpp

#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <unistd.h>
#include <arpa/inet.h>
#include <sys/socket.h>

int main()
    //创建套接字
    int sock = socket(AF_INET, SOCK_STREAM, 0);

    //向服务器（特定的IP和端口）发起请求
    struct sockaddr_in serv_addr;
    memset(&serv_addr, 0, sizeof(serv_addr));  //每个字节都用0填充
    serv_addr.sin_family = AF_INET;  //使用IPv4地址
    serv_addr.sin_addr.s_addr = inet_addr("127.0.0.1");  //具体的IP地址
    serv_addr.sin_port = htons(1234);  //端口
    connect(sock, (struct sockaddr*)&serv_addr, sizeof(serv_addr));

    //读取服务器传回的数据
    char buffer[40];
    read(sock, buffer, sizeof(buffer)-1);

    printf("Message form server: %s\\n", buffer);

    //关闭套接字
    close(sock);

    return 0;

编译与运行

不熟悉Linux编译的同学欢迎查看第六讲《手把手写C++服务器(6)：编译实操——打开gcc/g++世界》

g++ server.cpp -o server

g++ client.cpp -o client

运行

./server 1234

./client
Message form server: this is STDOUT_FILENO while be sended

参考

• https://blog.csdn.net/RGBMarco/article/details/80374477
• 《Linux高性能服务器编程》
• https://www.jianshu.com/p/c4dc22699a42
• https://zhuanlan.zhihu.com/p/25013398
• https://blog.csdn.net/u012349696/article/details/50757110
• https://segmentfault.com/a/1190000010256854