使用evpp支持XMLHttpRequest的一个坑

背景

因为项目需求,需要使用360的evpp库,来实现一个接口,支持文件上传。

实际操作过程中,发现了一些问题,记录下来。

前端文件上传方式

  • 简单的使用input标签
<body>
    <form action="http://xxx/AI/sysBackstage/fileUpload" method="post" enctype="multipart/form-data">
    <input type="file" name="fileUpload" />
    <input type="submit" value="upload" />
    </form>
</body>

如果前端直接使用这样的上传方法,则evpp的实现会比较简单,直接注册一个handler即可,但是这样实现上传进度等功能比较麻烦,所以最终没有选择这种方法

  • 使用XMLHttpRequest
    这个是H5里新增的东西,用法就不说了,网上很多
    前端大致的代码如下
<html>
<head>
<meta charset="UTF-8">
    <script type="text/javascript">
        var xhr;
        //上传文件方法
        function UploadFile() {
            var fileObj = document.getElementById("file").files[0]; // js 获取文件对象
            var url = "http://xxx:9009/file_upload"; // 接收上传文件的后台地址 
            
            var form = new FormData(); // FormData 对象
            form.append("mf", fileObj); // 文件对象
            
            xhr = new XMLHttpRequest();  // XMLHttpRequest 对象
            xhr.open("POST", url, true); //post方式,url为服务器请求地址,true 该参数规定请求是否异步处理。
            xhr.upload.addEventListener("progress", updateProgress, false);
            xhr.upload.addEventListener("load", uploadComplete, false);
            xhr.send(form); //开始上传,发送form数据
        }
        //上传进度实现方法,上传过程中会频繁调用该方法
        function updateProgress(evt) {
            var percentComplete = evt.loaded / evt.total;
            console.log(percentComplete);
        }
        function uploadComplete(evt) {
            console.log("上传成功!");
        }
    </script>
</head>
<body>
    <input type="file" id="file" name="myfile" />
    <input type="button" onclick="UploadFile()" value="上传" />
</body>
</html>

最终前端的同学使用的就是这种方式

遇到的问题

关于跨域

主要是要在evpp注册的handler里调用类似于如下的代码

ctx->AddResponseHeader("Access-Control-Allow-Origin", "*");

或者只想对某一个地址开放权限

ctx->AddResponseHeader("Access-Control-Allow-Origin", "http://xxxx:8080");

关于OPTIONS预请求

实际操作过程中发现,如果前端注册了upload的progress消息,则在POST消息之前,会先发一个OPTIONS请求。
这里还要注意下面两个的区别,参考:Using_XMLHttpRequest

xhr.addEventListener("progress", updateProgress);         //下载进度(不会导致OPTIONS请求)
xhr.upload.addEventListener("progress", updateProgress);  //上传进度(会导致OPTIONS请求)

详细讨论参考

这个是浏览器自动触发的OPTIONS请求,前端的同学好像并不能避免该请求。
这时会导致下面的错误

1.html:23 OPTIONS http://xxxx:9009/file_upload 501 (Not Implemented)

错误很明显,我们用evpp写的服务器不支持OPTIONS请求

问题原因

因为evpp是通过libevent实现的,google一遍之后,发现是libevent默认拒绝了OPTIONS请求,参考:Requests with OPTIONS type being rejected by libevent

解决办法

  • 对于evpp的修改
    参考上面的说明,主要是要调用evhttp_set_allowed_methods()函数来支持OPTIONS请求。但在evpp注册接口的地方已经无法获取到evhttp结构体了。所以我们最终采取的方案,是在evpp/http/service.cc文件的Service构造函数中加上
evhttp_set_allowed_methods(evhttp_, EVHTTP_REQ_GET | EVHTTP_REQ_POST | EVHTTP_REQ_OPTIONS);
  • 对于注册接口的修改
    因为OPTIONS和POST请求会访问同一个接口,所以接口代码要做相应的调整,大致如下
void FileUploadHandler(evpp::EventLoop* loop,
                    const evpp::http::ContextPtr& ctx,
                    const evpp::http::HTTPSendResponseCallback& cb) {
    auto type = ctx->req()->type;
    if(type == EVHTTP_REQ_OPTIONS)
    {
        ctx->AddResponseHeader("Access-Control-Allow-Method", "POST");
        ctx->AddResponseHeader("Access-Control-Allow-Origin", "*");
        ctx->set_response_http_code(204);
        cb("options success");
    }
    else if(type == EVHTTP_REQ_POST)
    {
        ctx->AddResponseHeader("Access-Control-Allow-Origin", "*");
        FormatBody(ctx->body().ToString());
        cb("post success");
    }

关于收到请求,如何保存文件

其实,一直对于文件上传是的过程是不太了解,感觉这篇文章讲的还比较清楚:http:文件上传背后发生了什么?'

在收到POST请求之后,body的格式大致如下(以chrome为例,其他浏览器类似)

------WebKitFormBoundaryJ4NgI6NUdHc020aI
Content-Disposition: form-data; name="fileUpload"; filename="1234.txt"
Content-Type: text/plain

1234567890
------WebKitFormBoundaryJ4NgI6NUdHc020aI--

总而言之,就是在文件内容之外,还有boundary等其他信息,需要把文件内容部分“摘”出来
我的实现

void SaveFile(const std::string &file_path, const std::string &file_content)
{
    std::ifstream infile(file_path);
    if(infile)
    {
        infile.close();
        LOG(WARNING)<< "file : " << file_path << " already exist";
        return;
    }
    infile.close();

    std::ofstream outfile;
    outfile.open(file_path);
    if(outfile.is_open())
    {
        outfile<< file_content;
        LOG(INFO)<< "Save file " << file_path << " success";
    }
    else
        LOG(WARNING)<< "Save file " << file_path << " fail";
    outfile.close();
}

void FormatBody(const std::string &body)
{
    LOG(INFO)<< body;
    //g++4.8 do not support regex very well, so we can not use it.
    std::string file_name_pat = "filename=\"";
    size_t start_pos = body.find(file_name_pat);
    if(start_pos == std::string::npos)
    {
        LOG(WARNING)<< "Cannot find 'filename' key in body";
        return;
    }
    //start_pos is the pos of 'f', so we should add to the character after '"'
    start_pos += file_name_pat.size();
    
    size_t end_pos = body.find("\"", start_pos);
    if(end_pos == std::string::npos)
    {
        LOG(WARNING)<< "Do not have '\"' in the end of filename";
        return;
    }
    std::string file_name = body.substr(start_pos, end_pos - start_pos);
    LOG(INFO)<< "filename : " << file_name;

    std::string content_type_pat = "Content-Type:";
    start_pos = body.find("\r\n", end_pos + content_type_pat.size());
    if(start_pos == std::string::npos)
    {
        LOG(WARNING)<< "Find character after Content-Type fail";
        return;
    }
    //skip the next empty row '\r\n', so there is two of '\r\n'
    start_pos += 4;
    
    end_pos = body.rfind("\r\n---");
    if(end_pos == std::string::npos && end_pos > start_pos)
    {
        LOG(WARNING)<< "Find last '---' fail";
        return;
    }
    std::string file_content = body.substr(start_pos, end_pos - start_pos);
    LOG(INFO)<< "file content : " << file_content;
  
    std::string file_path = "/tmp/" + file_name;
    SaveFile(file_path, file_content);
}

参考别人用c做的库:multipart_parser.c
差距还是很大的-_-||

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,717评论 6 496
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,501评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,311评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,417评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,500评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,538评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,557评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,310评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,759评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,065评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,233评论 1 343
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,909评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,548评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,172评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,420评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,103评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,098评论 2 352

推荐阅读更多精彩内容