core_framework —— 基于libev的轻量级lua网络开发框架-白红宇

core_framework —— 基于libev的轻量级lua网络开发框架

阅读量：5902 次

发布时间：2019-06-19

本文共 4978 字，大约阅读时间需要 16 分钟。

大道至简, 返璞归真.

前言

在发表这篇博文的前夕, 还有一些小伙伴在提问一些以下相关的问题:

性能怎么样？

是否容易上手?

开发目标在哪?

如何反馈问题?

对比行业内的lua开源项目有何优势?

等等, 以上问题会在本文中一一介绍.

CF的起因

首先来聊聊情怀这个东西! 相信每一个行业内的从业者都或多或少有过一个梦, 这个梦叫做: "我到时候要开发一个XXX"！其实作者当初也是一样.

每当半夜(凌晨)在加班、看文档、调试的时候, 总会搜索到一些几年前或十几年前的框架或入门demo。例如: , 链接的源码是一些同学fork的镜像站。

每次看到这些内容或多或少都会激起心中那一丝丝快熄灭的热情, 也许这就是最后对技术的渴望？

就是在动手创建项目之前还反复问过自己是否要做? 能坚持下去么？也许被喷都是一种奢望？

在心里一一回答了这些问题后, 在2018年末创建了.

说句实话! 一个网络开发框架最难的不是实现某个功能, 而是从零开始一步一步添砖加瓦的造轮子!

作为一个网络开发框架, 最重要的两个功能肯定是需要的！定时器库、事件驱动库. 如何抉择？选项有2个: libev / libuv .

libev 成熟稳定、轻量级、unix like支持、容易嵌入;libuv 比libev更加优秀，增加了许多功能(线程池、信号、同步、锁等等)，封装更加完善, 并且增加了windows支持;

从cf框架开发之初选型来看, libuv绝对是目前最优解. 但是作者偏偏选择了libev. 也从此开始, 艰辛的底层开发之路就此展开.

首先, 作者不让使用者C/C++进行实际业务开发! 这样做会让使用者有较高的开发成本与学习成本, 而选择一门较好的脚本语言就显得尤为重要.

作者对还算是稍微熟悉一点, 所以就选了Lua作为业务脚本语言。至于Lua语言的优势这里就不说了, 网上大把文章夸它的.

现在既然脚本语言已经选定, 那么就开始写代码吧！Let's Lua.

CF的编写之路

1. 网络层

首先, 我们来看一段C封装给Lua调用的API代码:

LUAMOD_API intluaopen_tcp(lua_State *L){    luaL_checkversion(L);    /* 添加SSL支持 */    SSL_library_init();    SSL_load_error_strings();    // CRYPTO_set_mem_functions(xmalloc, xrealloc, xfree);    // OpenSSL_add_ssl_algorithms();    /* 添加SSL支持 */    luaL_newmetatable(L, "__TCP__");    lua_pushstring (L, "__index");    lua_pushvalue(L, -2);    lua_rawset(L, -3);    lua_pushliteral(L, "__mode");    lua_pushliteral(L, "kv");    lua_rawset(L, -3);    luaL_Reg tcp_libs[] = {        {"read", tcp_read},        {"write", tcp_write},        {"ssl_read", tcp_sslread},        {"ssl_write", tcp_sslwrite},        {"stop", tcp_stop},        {"start", tcp_start},        {"close", tcp_close},        {"listen", tcp_listen},        {"connect", tcp_connect},        {"ssl_connect", tcp_sslconnect},        {"new", tcp_new},        {"new_ssl", ssl_new},        {"free_ssl", ssl_free},        {"new_server_fd", new_server_fd},        {"new_client_fd", new_client_fd},        {NULL, NULL}    };    luaL_setfuncs(L, tcp_libs, 0);    luaL_newlib(L, tcp_libs);    return 1;}

以上是TCP实现的C代码的片段, 有兴趣阅读源码的小伙伴请点击;

众所周知Lua没有原生的Socket. 那么就需要框架编写者自己抽象底层逻辑重新实现一套API.

简单的封装Lua C库谁都会, 而且也算不上是什么难事. 但是我们的目的是将底层同步阻塞Socket hook为非阻塞, 这时候难点就来了！

大家都知道libev是基于react模型的事件驱动网络库, 所有注册事件后的业务逻辑都是以回调的形式触发. 那不就变成node-lua代码了吗？(笑)

这时候, 作者想了个点子来解决这个问题! 执行流程如下:

每次需要做一些同步操作的时候, 就调用C API注册回调事件.

为当前注册的所有事件创建一个Lua协程保存上下文并让出当前协程执行权.

等到注册事件被触发后, 调用C API恢复协程继续执行.

简单来说就是将C层次的异步回调逻辑封装为Lua层的同步非阻塞, 保证不因为IO问题阻塞线程.

下面提供一段socket同步非阻塞的伪代码, 经供参考:

function TCP:recv(bytes)    local current_co = co_self()    self.read_co = read_ev(function()    -- do action    -- stop timer_ev    -- wakeup(current_co) 恢复执行权    end)   self.timer_co =  self.timer_ev(function()    -- do action    -- stop read_ev    -- wakeup(current_co) 恢复执行权    end)    tcp_start(io, EV_READ, self.read_co)    timer_start(timer, 3秒超时, self.timer_co)    return co_yield() -- 让出执行权end

一个Lua版的Socket EV_READ伪代码大致的处理流程如上, 想看实际处理逻辑请看。

同理, Socket write/connect/listen等等API直接照抄就行(UDP也大同小异). (其实这里有个小插曲就是SSL SOCKET的坑, 但是由于篇幅问题就不说了.)

细心的小伙伴可能发现代码同时注册了Socket与Timer事件, Socket非阻塞操作不能解决read与connect超时的问题. 所以cf框架干脆就封装彻底一点.

至此, Socket算是已经算是基本hook与封装完成了. 接下来就可以开始写应用层协议了.