使用libevent編寫高併發HTTP server
阿新 • • 發佈：2019-02-10
libevent庫使得高併發響應HTTP Server的編寫變得很容易。整個過程包括如下幾部：初始化，建立HTTP Server, 指定callback, 進入事件迴圈。另外在回撥函式中，可以獲取客戶端請求(request的HTTP Header和引數等)，進行響應的處理，再將結果傳送給客戶端(response的HTTP Header和內容，如html程式碼)。
libevent除了設定generic的callback，還可以對特定的請求路徑設定對應的callback(回撥/處理函式)。
示例程式碼(方便日後參考編寫需要的HTTP server)
#include <stdio.h> #include <stdlib.h> #include <unistd.h> //for getopt, fork #include <string.h> //for strcat //for struct evkeyvalq #include <sys/queue.h> #include <event.h> //for http #include <evhttp.h> #include <signal.h> #define MYHTTPD_SIGNATURE "myhttpd v 0.0.1" //處理模組 void httpd_handler(struct evhttp_request *req, void *arg) { char output[2048] = "\0"; char tmp[1024]; //獲取客戶端請求的URI(使用evhttp_request_uri或直接req->uri) const char *uri; uri = evhttp_request_uri(req); sprintf(tmp, "uri=%s\n", uri); strcat(output, tmp); sprintf(tmp, "uri=%s\n", req->uri); strcat(output, tmp); //decoded uri char *decoded_uri; decoded_uri = evhttp_decode_uri(uri); sprintf(tmp, "decoded_uri=%s\n", decoded_uri); strcat(output, tmp); //解析URI的引數(即GET方法的引數) struct evkeyvalq params; evhttp_parse_query(decoded_uri, ¶ms); sprintf(tmp, "q=%s\n", evhttp_find_header(¶ms, "q")); strcat(output, tmp); sprintf(tmp, "s=%s\n", evhttp_find_header(¶ms, "s")); strcat(output, tmp); free(decoded_uri); //獲取POST方法的資料 char *post_data = (char *) EVBUFFER_DATA(req->input_buffer); sprintf(tmp, "post_data=%s\n", post_data); strcat(output, tmp); /* 具體的：可以根據GET/POST的引數執行相應操作，然後將結果輸出 ... */ /* 輸出到客戶端 */ //HTTP header evhttp_add_header(req->output_headers, "Server", MYHTTPD_SIGNATURE); evhttp_add_header(req->output_headers, "Content-Type", "text/plain; charset=UTF-8"); evhttp_add_header(req->output_headers, "Connection", "close"); //輸出的內容 struct evbuffer *buf; buf = evbuffer_new(); evbuffer_add_printf(buf, "It works!\n%s\n", output); evhttp_send_reply(req, HTTP_OK, "OK", buf); evbuffer_free(buf); } void show_help() { char *help = "written by Min (http://54min.com)\n\n" "-l <ip_addr> interface to listen on, default is 0.0.0.0\n" "-p <num> port number to listen on, default is 1984\n" "-d run as a deamon\n" "-t <second> timeout for a http request, default is 120 seconds\n" "-h print this help and exit\n" "\n"; fprintf(stderr, help); } //當向程序發出SIGTERM/SIGHUP/SIGINT/SIGQUIT的時候，終止event的事件偵聽迴圈 void signal_handler(int sig) { switch (sig) { case SIGTERM: case SIGHUP: case SIGQUIT: case SIGINT: event_loopbreak(); //終止偵聽event_dispatch()的事件偵聽迴圈，執行之後的程式碼 break; } } int main(int argc, char *argv[]) { //自定義訊號處理函式 signal(SIGHUP, signal_handler); signal(SIGTERM, signal_handler); signal(SIGINT, signal_handler); signal(SIGQUIT, signal_handler); //預設引數 char *httpd_option_listen = "0.0.0.0"; int httpd_option_port = 8080; int httpd_option_daemon = 0; int httpd_option_timeout = 120; //in seconds //獲取引數 int c; while ((c = getopt(argc, argv, "l:p:dt:h")) != -1) { switch (c) { case 'l' : httpd_option_listen = optarg; break; case 'p' : httpd_option_port = atoi(optarg); break; case 'd' : httpd_option_daemon = 1; break; case 't' : httpd_option_timeout = atoi(optarg); break; case 'h' : default : show_help(); exit(EXIT_SUCCESS); } } //判斷是否設定了-d，以daemon執行 if (httpd_option_daemon) { pid_t pid; pid = fork(); if (pid < 0) { perror("fork failed"); exit(EXIT_FAILURE); } if (pid > 0) { //生成子程序成功，退出父程序 exit(EXIT_SUCCESS); } } /* 使用libevent建立HTTP Server */ //初始化event API event_init(); //建立一個http server struct evhttp *httpd; httpd = evhttp_start(httpd_option_listen, httpd_option_port); evhttp_set_timeout(httpd, httpd_option_timeout); //指定generic callback evhttp_set_gencb(httpd, httpd_handler, NULL); //也可以為特定的URI指定callback //evhttp_set_cb(httpd, "/", specific_handler, NULL); //迴圈處理events event_dispatch(); evhttp_free(httpd); return 0; }
- 編譯：
gcc -o myhttpd -Wall -levent myhttpd.c - 執行：
./test - 測試：
在瀏覽器中輸入http://54min.com:8080/index.php?q=test&s=some thing，顯示內容如下：
It works! uri=/index.php?q=test&s=some%20thing uri=/index.php?q=test&s=some%20thing decoded_uri=/index.php?q=test&s=some thing q=test s=some thing post_data=(null)
並使用Live Http Headers(Firefox addons)檢視HTTP headers。
HTTP/1.1 200 OK
Server: myhttpd v 0.0.1
Content-Type: text/plain; charset=UTF-8
Connection: close
Date: Tue, 21 Jun 2011 06:30:30 GMT
Content-Length: 72使用libevent庫進行HTTP封裝方法的 應用
libevent庫使得編寫高併發高效能的HTTP Server變得很簡單。因此實際中，使用libevent可以為任何應用(如資料庫)提供一個HTTP based的網路介面，方便多個clients採用任何支援HTTP protocol的語言與server進行互動。例如：
對不支援HTTP協議的資料庫(RDBMS/NoSQL)封裝HTTP介面
- Memcached Server預設支援的是Memcached Protocol，通過libmemcached庫和libevent庫，可以為Memcached Server封裝一個HTTP介面，從而client端可通過HTTP協議和Memcached Server進行互動；參考。
- 可為Tokyo Cabinet/Tokyo Tyrant資料庫封裝HTTP介面，方便client端與其互動。參考
- 相同的，也可為其他資料庫如MySQL, Redis, MongoDB等封裝HTTP介面；
也可以為某些應用封裝HTTP介面，從而實現以client/server方式使用該應用
- HTTPCWS，以libevent封裝中文分詞程式，實現client/server方式使用分詞功能
附：涉及的資料結構和主要函式
資料結構
- struct evhttp_request
表示客戶端請求，定義參看：http://monkey.org/~provos/libevent/doxygen-1.4.10/structevhttp__request.html，其中包含的主要域：
struct evkeyvalq *input_headers; //儲存客戶端請求的HTTP headers(key-value pairs)
struct evkeyvalq *output_headers; //儲存將要傳送到客戶端的HTTP headers(key-value pairs)
//客戶端的ip和port
char *remote_host;
u_short remote_port;
enum evhttp_request_kind kind; //可以是EVHTTP_REQUEST或EVHTTP_RESPONSE
enum evhttp_cmd_type type; //可以是EVHTTP_REQ_GET, EVHTTP_REQ_POST或EVHTTP_REQ_HEAD
char *uri; //客戶端請求的uri
char major; //HTTP major number
char minor; //HTTP major number
int response_code; //HTTP response code
char *response_code_line; //readable response
struct evbuffer *input_buffer; //客戶端POST的資料
struct evbuffer *output_buffer; //輸出到客戶端的資料- struct evkeyvalq
定義參看：http://monkey.org/~provos/libevent/doxygen-1.4.10/event_8h-source.html。struct evkeyvalq被定義為TAILQ_HEAD (evkeyvalq, evkeyval);，即struct evkeyval型別的tail queue。需要在程式碼之前包含
#include <sys/queue.h>
#include <event.h>
struct evkeyval為key-value queue(佇列結構)，主要用來儲存HTTP headers，也可以被用來儲存parse uri引數的結果。
/* Key-Value pairs. Can be used for HTTP headers but also for query argument parsing. */
struct evkeyval {
TAILQ_ENTRY(evkeyval) next; //佇列
char *key;
char *value;
};
巨集TAILQ_ENTRY(evkeyval)被定義為：
#define TAILQ_ENTRY(type)
struct {
struct type *tqe_next; //next element
struct type **tqe_prev; //address of previous next element
}- stuct evbuffer
定義參看：http://monkey.org/~provos/libevent/doxygen-1.4.10/event_8h-source.html。該結構體用於input和output的buffer。
/* These functions deal with buffering input and output */
struct evbuffer {
u_char *buffer;
u_char *orig_buffer;
size_t misalign;
size_t totallen;
size_t off;
void (*cb)(struct evbuffer *, size_t, size_t, void *);
void *cbarg;
};另外定義巨集方便獲取evbuffer中儲存的內容和大小：
#define EVBUFFER_LENGTH(x) (x)->off
#define EVBUFFER_DATA(x) (x)->buffer例如，獲取客戶端POST資料的內容和大小：
EVBUFFER_DATA(res->input_buffer);
EVBUFFER_LENGTH(res->input_buffer);
另外struct evbuffer用如下函式建立新增和釋放：
struct evbuffer *buf;
buf = evbuffer_new();
//往buffer中新增內容
evbuffer_add_printf(buf, "It works! you just requested: %s\n", req->uri); //Append a formatted string to the end of an evbuffer.
//將內容輸出到客戶端
evhttp_send_reply(req, HTTP_OK, "OK", buf);
//釋放掉buf
evbuffer_free(buf);關鍵函式
- 獲取客戶端請求的URI
使用req->uri或使用函式const char *evhttp_request_uri(struct evhttp_request *req);即(evhttp_request_uri(req);)。
- 對獲取的URI進行解析和其他操作
使用函式void evhttp_parse_query(const char *uri, struct evkeyvalq *args);可對uri的引數進行解析，結果儲存在struct evkeyvalq的key-value pairs中，例如：
char *uri = "http://foo.com/?q=test&s=some+thing";
struct evkeyvalq args;
evhttp_parse_query(uri, &args);
//然後通過evhttp_find_header等函式獲取各個引數及對應的值
evhttp_find_header(&args, "q"); //得到test
evhttp_find_header(&args, "s"); //得到some thing 如下兩個函式對URI進行encode和decode：
char *evhttp_encode_uri(const char *uri);
char *evhttp_decode_uri(const char *uri);
URI encode的結果是所有非alphanumeric及-_的字元都被類似於%和一個2位16進位制字元替換(其中空格被+號替換)。如上兩個函式返回的字串需要free掉。
- 處理HTTP headers相關的函式
HTTP headers儲存在struct evkeyvalq的結構體中(key-value pairs)，使用如下函式可對其進行修改：
const char *evhttp_find_header(const struct evkeyvalq *, const char *);
int evhttp_remove_header(struct evkeyvalq *, const char *);
int evhttp_add_header(struct evkeyvalq *, const char *, const char *);
void evhttp_clear_headers(struct evkeyvalq *);- Escape特殊的HTML字元
char *evhttp_htmlescape(const char *html);
特殊字元：&被替換為&；"被替換為"；'被替換為'; <被替換為<；>被替換為>。該函式返回的字串需要free掉。
轉載自:http://note.sdo.com/u/1730579924/n/D9ETk~jLB38MLX0a8000TB