图床项目（二） 接口设计

接口设计1 . muduo 网络模型该模型相较于普通的reactor模型复杂一点其中包括mainReactor 和 多个 subReactor其中每一个 subReactor·对应一个线程。其中 mainReactor 负责处理新连接 并将连接均匀分配给 subReactor 后续该新连接有对应的subReactor处理read、send操作。1.1 muduo网络模型核心接口intmain(){std::coutHello, World!std::endl;uint16_thttp_bind_port8081;constchar*http_bind_ip0.0.0.0;int32_tnum_event_loops4;// 4个subReactorEventLoop loop;// 主循环InetAddressaddr(http_bind_ip,http_bind_port);LOG_INFO port :http_bind_port ip :http_bind_ip;// 创建一个HttpServer对象HttpServerserver(loop,addr,HttpServer,num_event_loops);server.start();loop.loop();return0;}此代码和muduo的核心接口之间的关系客户端连接到达时主 EventLoop 的 EpollPoller::poll() 返回activeChannels_ 中包含 Acceptor 的那个 Channel因为 listenfd 可读。Channel::handleEvent() 被调用根据事件类型可读执行注册的回调即 Acceptor::handleRead()。Acceptor::handleRead() 调用 accept 接受新连接得到新 socket connfd。然后 HttpServer 会创建一个 TcpConnection 对象代表新连接并从线程池中选出一个 sub EventLoop根据 num_event_loops 创建的子 Reactor。这个 TcpConnection 对象内部又会创建一个新的 Channel封装 connfd并设置其读回调为 TcpConnection::handleRead()、写回调为 TcpConnection::handleWrite() 等。将该 Channel 注册到选中的 sub EventLoop 的 Poller 中从此该连接的 IO 事件由那个 sub EventLoop 独立处理。1.1.1 EventLoopEventLoop 是事件循环loop.loop() 会进入循环内部使用 Poller如 EpollPoller来监听事件。loop.loop();当进入到此段代码的时候EventLoop会无限循环核心工作就是调用Poller::poll()获取当前活跃的IO事件默认的 Poller 实现就是 EpollPoller它封装了 epoll 的系统调用epoll_create、epoll_ctl、epoll_wait1.1.2 HttpServerHttpServer server(loop, addr, HttpServer, num_event_loops); 创建时内部会初始化一个 Acceptor接受器。Acceptor 负责监听服务端 socket它内部包含一个 Channel该 Channel 封装了监听套接字listenfd并设置其读回调为 Acceptor::handleRead()。当调用 server.start() 时Acceptor 会将这个 Channel 注册到主 EventLoop 上即传入的 loop使得主 loop 能够监听 listenfd 的可读事件。1.1.3 Channel封装了listenfd 描述符 封装read_callback等IO事件1.1.4 EpollPoller负责监听问价描述符是否触发以及返回时间的文加盟描述符及具体时间的模块就是Poller。2. 具体实现思想TcpServer 是 muduo 提供的通用 TCP 服务器类负责处理 TCP 层 的事务监听端口、接受连接、管理连接生命周期、收发原始字节流。而 HTTP 是 应用层协议需要解析请求如 GET/POST、URL、头部、生成响应状态码、内容类型。这部分逻辑与具体的 TCP 细节无关。因此可以在TcpServer 的基础上封装一层HttpServer用来专门处理Http的请求。根据注册的回调事件处理。2.1 封装HttpServer类构造函数参数loop 主线程的eventloopaddr 封装ip portname 服务名字num_event_loops多少个subReactorserver_.setConnectionCallback 调用tcpsrver的对应方法将httpserver的成员函数onConn()注册到连接事件void onConnection(const TcpConnectionPtr conn)httpserver的成员函数TcpServer server_封装的原生的TcpServer对象通过server_.start()启动该服务** EventLoop *loop_ ** 每个IO对象如TcpConnection、Acceptor必须属于一个特定的EventLoop线程所有对该对象的操作如处理读写事件、关闭等都必须在那个EventLoop线程中进行。因此需要保存该EventLoop指针以便后续将任务投递到该线程如调用runInLoop或queueInLoop。// 构建httpserverclassHttpServer{public:// 构造函数 loop主线程的eventloop addr封装ip port name服务名字 num_event_loops多少个subReactorHttpServer(EventLoop*loop,constInetAddressaddr,conststd::stringname,intnum_event_loops):loop_(loop),server_(loop,addr,name){// 对回调函数的绑定server_.setConnectionCallback(std::bind(HttpServer::onConnection,this,std::placeholders::_1));// 对收到数据后回调函数的绑定server_.setMessageCallback(std::bind(HttpServer::onMessage,this,// 三个占位符 -- onmessage函数有三个变量std::placeholders::_1,std::placeholders::_2,std::placeholders::_3));server_.setWriteCompleteCallback(std::bind(HttpServer::onWriteComplete,this,std::placeholders::_1));server_.setThreadNum(num_event_loops);}// 启动voidstart(){server_.start();}private:voidonConnection(constTcpConnectionPtrconn)// 新建连接和断开连接都会执行{LOG_INFO onConnectionconn.get();}voidonMessage(constTcpConnectionPtrconn,Buffer*buf,Timestamp time){LOG_INFO onMessageconn.get();}voidonWriteComplete(constTcpConnectionPtrconn){LOG_INFO onWriteComplete conn.get();}TcpServer server_;// 每个连接的回调数据 新连接/断开连接 收到数据 发送数据 --EventLoop*loop_nullptr;// 这是主线程的enentloopstd::atomicuint32_tconn_uuid_generator0;};2.2 封装HttpConn类注意因为对于httpserver每当触发onConnection的时候就会产生一个TcpConnectionPtr conn为了能够清晰的在对应的TcpConnection处理专属的httpconn所以需要封装一个HttpConn类TcpConnection muduo 网络库提供的 TCP 连接对象负责底层 Socket 的读写、连接状态维护。CHttpConn 自定义的 HTTP 业务处理类负责解析 HTTP 请求、执行具体业务逻辑如注册、登录、生成 HTTP 响应等。绑定就是将这两个对象关联起来使得每个 TcpConnection 都有一个专属的 CHttpConn 来处理它的应用层数据。如果不进行此类的封装就会出现问题数据交叉处理、响应错发等实现思路std::mapuint32_t, CHttpConnPtr s_http_map使用map 维护 key tcpserver中的context valueCHttpConn对象std::atomicuint32_t conn_uuid_generator 0;使用一个原子变量每次建立连接的时候自增用来设置为tcpserver中的context并且在CHttpconn对象中也有一个成员变量uint32_t uuid_ 0; 该标识是从tcpconn中来的这样就能做好标记。具体实现classCHttpConn:publicstd::enable_shared_from_thisCHttpConn{public:// 需要把httpconnectionptr传进来 和 ChttpConn绑定CHttpConn(TcpConnectionPtr tcp_conn){uuid_std::any_castuint32_t(tcp_conn_-getContext());}virtual~CHttpConn();voidOnRead(Buffer*buf);private://根据 不同的数据调用不同的业务逻辑函数// 账号注册处理int_HandleRegisterRequest(stringurl,stringpost_data);// 账号登陆处理int_HandleLoginRequest(stringurl,stringpost_data);TcpConnectionPtr tcp_conn_;uint32_tuuid_0;//该标识是从tcpconn中来的CHttpParserWrapper http_parser_;};usingCHttpConnPtrstd::shared_ptrCHttpConn;//声明称智能指针 别名注意当onMessage触发的时候调用http_conn中的OnRead(buf)方法具体执行逻辑要到CHttpConn中实现voidonMessage(constTcpConnectionPtrconn,Buffer*buf,Timestamp time){// 这里可以根据uuid 获取httpconn(因为在onConnection设置了上下文)uint32_tuuidstd::any_castuint32_t(conn-getContext());// 再根据uuid 获取httpconn的引用CHttpConnPtrhttp_conns_http_map[uuid];// 处理业务http_conn-OnRead(buf);// 直接在io线程处理}onRead()方法实现这里已经是获取到客户端发送来的数据包请求了所以需要引入http协议解析的第三方库进行url和content的解析。voidCHttpConn::OnRead(Buffer*buf){constchar*in_bufbuf-peek();// 获取数据int32_tlenbuf-readableBytes();// 可读数据长度// 使用http协议解析的第三方库CHttpParserWrapper http_parser;http_parser.ParseHttpContent(in_buf,len);if(http_parser.IsReadAll()){string urlhttp_parser.GetUrlString();string contenthttp_parser.GetBodyContentString();LOG_INFO get url : url;LOG_INFO get content : content;if(strncmp(url.c_str(),/api/reg,8)0){// 调用注册函数_HandleRegisterRequest(url,content);}elseif(strncmp(url.c_str(),/api/login,9)0){// 调用登录函数_HandleLoginRequest(url,content);}else{//如果不能处理的 直接返回// 构造回发的http协议数据 让服务器返回char*resp_contentnewchar[256];string str_json{\code\:1};uint32_tlen_jsonstr_json.size();// 暂时先放这里#defineHTTP_RESPONSE_REQ\HTTP/1.1 404 OK\r\n\Connection:close\r\n\Content-Length:%d\r\n\Content-Type:application/json;charsetutf-8\r\n\r\n%ssnprintf(resp_content,256,HTTP_RESPONSE_REQ,len_json,str_json.c_str());tcp_conn_-send(resp_content);// 构造的时候会把tcpconn传递过来}}// echo --封装http的数据(直接echo不行)// conn-send(in_buf,buf-readableBytes());}同时根据解析出来的api请求可以再封装api相关的处理方法。if(strncmp(url.c_str(),/api/reg,8)0){// 调用注册函数_HandleRegisterRequest(url,content);}elseif(strncmp(url.c_str(),/api/login,9)0){// 调用登录函数_HandleLoginRequest(url,content);}else.....2.3 封装API此处封装的api完全就是业务层面的处理了针对每一个不同的数据包的解析可以在void CHttpConn::OnRead(Buffer *buf)方法里面增加不同的业务处理方法此处先列举一个用户注册的。// 用户登录 -- 收到的数据 发回客户端的数据intApiRegisterUser(std::stringpost_data,std::stringresp_json){intret0;string user_name;string nick_name;string pwd;string phone;string email;// 判断数据是否为空if(post_data.empty()){LOG_ERRORdecodeRegisterJson failed;//序列化 把结果返回给客户端// code 1encdoRegisterJson(1,resp_json);return-1;}// json反序列化.........// 注册账号.........// 先在数据库查询用户名 昵称 是否存在 如果不存在才去注册.......return0;}jsonapp的序列化和反序列化序列化#includejson/json.h//创建json对象Json::Value root;//设置json属性root[code]code;//json序列化对象Json::FastWriter writer;//执行序列化str_jsonwriter.write(root);return0;反序列化#includejson/json.h//json对象Json::Value root;//json反序列对象Json::Reader jsonReader;//执行反序列化resjsonReader.parse(str_json,root);registerApi#includeapi_register.h#includeiostreamusingnamespacestd;#includejson/json.h#includemuduo/base/Logging.h// Logger日志头文件//序列化intencdoeRegisterJson(intcode,stringresp_json){// 创建一个json对象Json::Value root;// 添加数据root[code]code;// 序列化Json::FastWriter writer;// 返回json字符串resp_jsonwriter.write(root);return0;}//反序列化intdecodeRegisterJson(conststd::stringstr_json,stringuser_name,stringnick_name,stringpwd,stringphone,stringemail){boolres;// 创建一个json对象Json::Value root;// 反序列化Json::Reader reader;resreader.parse(str_json,root);if(!res){LOG_ERRORparse reg json failed;return-1;}// 用户名if(root[userName].isNull()){LOG_ERRORuserName null;return-1;}user_nameroot[userName].asString();// 昵称if(root[nickName].isNull()){LOG_ERRORnickName null;return-1;}nick_nameroot[nickName].asString();//密码if(root[firstPwd].isNull()){LOG_ERRORfirstPwd null;return-1;}pwdroot[firstPwd].asString();//电话 非必须if(root[phone].isNull()){LOG_WARNphone null;}else{phoneroot[phone].asString();}//邮箱 非必须if(root[email].isNull()){LOG_WARNemail null;}else{emailroot[email].asString();}}intregisterUser(stringuser_name,stringnick_name,stringpwd,stringphone,stringemail){intret0;// 还没有处理先直接返回0returnret;}// 用户登录 -- 收到的数据 发回客户端的数据intApiRegisterUser(std::stringpost_data,std::stringresp_json){intret0;string user_name;string nick_name;string pwd;string phone;string email;// 判断数据是否为空if(post_data.empty()){LOG_ERRORdecodeRegisterJson failed;//序列化 把结果返回给客户端// code 1encdoeRegisterJson(1,resp_json);return-1;}// json反序列化retdecodeRegisterJson(post_data,user_name,nick_name,pwd,phone,email);if(ret0){encdoeRegisterJson(1,resp_json);return-1;}// 注册账号// 先在数据库查询用户名 昵称 是否存在 如果不存在才去注册retregisterUser(user_name,nick_name,pwd,phone,email);//先不操作数据库看看性能encdoeRegisterJson(ret,resp_json);return0;}loginApi代码#includeapi_login.h#includeiostream#includestring#includejson/json.h#includemuduo/base/Logging.h// Logger日志头文件usingnamespacestd;intdecodeLoginJson(conststringjson_str,stringuser_name,stringpwd){boolres;Json::Value root;Json::Reader reader;resreader.parse(json_str,root);if(!res){LOG_ERRORparse login json failed ;return-1;}// 用户名if(root[user].isNull()){LOG_ERRORuser null;return-1;}user_nameroot[user].asString();//密码if(root[pwd].isNull()){LOG_ERRORpwd null;return-1;}pwdroot[pwd].asString();return0;}// 登录成功返回jsonintencodeLoginJson(intcode,stringtoken,stringstr_json){Json::Value root;root[code]code;if(code0){root[token]token;// 正常返回的时候才写入token}Json::FastWriter writer;str_jsonwriter.write(root);return0;}intverifyUserPassword(stringuser_name,stringpwd){intret0;// 这里暂时不做处理因为这里还没有涉及数据库returnret;}intsetToken(stringuser_name,stringtoken){intret0;token1234;//更新到redisreturnret;}// 用户登录 -- 收到的数据 发回客户端的数据intApiUserLogin(std::stringpost_data,std::stringresp_json){string user_name;string pwd;string token;// 判断数据是否为空if(post_data.empty()){encodeLoginJson(1,token,resp_json);return-1;}// 解析jsonif(decodeLoginJson(post_data,user_name,pwd)0){LOG_ERRORdecodeRegisterJson failed;encodeLoginJson(1,token,resp_json);return-1;}// 验证账号和密码是否匹配if(verifyUserPassword(user_name,pwd)0){LOG_ERRORverifyUserPassword failed;encodeLoginJson(1,token,resp_json);return-1;}// 生成tokenif(setToken(user_name,token)0){LOG_ERRORsetToken failed;encodeLoginJson(1,token,resp_json);return-1;}// 封装登录结果encodeLoginJson(0,token,resp_json);return0;}总结https://github.com/0voice