Lua下基本的网络编程示例

Lua 这门语言天生就带着一股子机灵劲儿，它高度灵活，能在各种平台上跑，包括 Web 服务。说到 Lua 的 Web 生态，就不得不提 2004 年成立的 Kepler 社区，它贡献了整套开源的 Lua Web 组件。下面这张图就是 Lua 下基本的网络编程示例的直观展示：

当然，市面上也有其他基于 Lua 的 Web 框架，但 Kepler 社区提供的这套组件是绕不开的基石。咱们就把焦点放在它身上。

应用程序和框架

• Orbit：一个 Lua 的 MVC Web 框架，底层基于 WSAPI。
• WSAPI：它是从 Lua Web 应用抽象出的 Web 主机服务器接口，很多项目都依赖它。
• Xa vante：一个 Lua 写的 Web 服务器，提供了 WSAPI 接口。
• Sputnik：一个基于 WSAPI 的 wiki/CMS 项目，最初是 Kepler 团队为了好玩搞出来的。
• CGILua：曾经通过 WSAPI 提供 LuaPages 和 LuaScripts 的网页制作能力，但现在已停止维护。建议直接用 Orbit、Sputnik 或 WSAPI 代替。

接下来，我们会一步步带大家熟悉 Lua Web 开发的安装和使用流程。更多细节可以查阅 Kepler 官网。

Orbit

Orbit 是 Lua 世界里一个相当清爽的 MVC Web 框架。它彻底离开了 CGILua 的老路子。每个 Orbit 应用可以像一个“脚本”文件那样运行（类似 CGILua 模式），但如果想拆成多个文件，也完全支持。

所有的 Orbit 应用都遵循 WSAPI 协议，所以它们能跟 Xa vante、CGI 和 FastCGI 等后端无缝配合。它还自带一个启动器，可以快速拉起一个 Xa vante 实例用于开发调试。

安装 Orbit 最省事的办法是用 LuaRocks。一句命令就能搞定：

luarocks install orbit

当然，前提是先装好 LuaRocks 本身。如果还没装好所有依赖，可以在 Unix/Linux 环境下按照下面的步骤来。

安装 Apache

先连上服务器，装上 Apache2 以及需要的模块：

sudo apt-get install apache2 libapache2-mod-fcgid libfcgi-dev build-essential
sudo a2enmod rewrite
sudo a2enmod fcgid
sudo /etc/init.d/apache2 force-reload

安装 LuaRocks

sudo apt-get install luarocks

安装 WSAPI、FCGI、Orbit 和 Xa vante

sudo luarocks install orbit
sudo luarocks install wsapi-xa vante
sudo luarocks install wsapi-fcgi

配置 Apache2

编辑 Apache 的站点配置文件：

sudo raj /etc/apache2/sites-a vailable/default

在 这部分里添加下面的内容。如果原来有“AllowOverride None”，记得把它改成“AllowOverride All”，这样 .htaccess 文件才能覆盖配置。

    AddHandler fcgid-script .lua
    AddHandler fcgid-script .ws
    AddHandler fcgid-script .op
    FCGIWrapper "/usr/local/bin/wsapi.fcgi" .ws
    FCGIWrapper "/usr/local/bin/wsapi.fcgi" .lua
    FCGIWrapper "/usr/local/bin/op.fcgi" .op
    #FCGIServer "/usr/local/bin/wsapi.fcgi" -idle-timeout 60 -processes 1
    #IdleTimeout 60
    #ProcessLifeTime 60

改完后重启 Apache 让配置生效：

sudo /etc/init.d/apache2 force-reload

为了让 Orbit 应用能够被正常访问，还需要在应用根目录（这里假设是 /var/www）的 .htaccess 文件中加上 +ExecCGI：

Options +ExecCGI
DirectoryIndex index.ws

简单的例子 — Orbit

下面是一个最基本的 Orbit 应用（文件名 index.lua）：

#!/usr/bin/env index.lua
-- index.lua
require"orbit"

-- declaration
module("myorbit", package.seeall, orbit.new)

-- handler
function index(web)
  return my_home_page()
end

-- dispatch
myorbit:dispatch_get(index, "/", "/index")

-- Sample page
function my_home_page()
    return [[
    
    
    
First Page
    
    ]]
end

保存后，打开浏览器访问 http://localhost:8080/，就能看到“First Page”字样。

Orbit 还支持另一种玩法——直接在 Lua 代码里用函数生成 HTML：

#!/usr/bin/env index.lua
-- index.lua
require"orbit"

function generate()
    return html {
        head{title "HTML Example"},
        body{
            h2{"Here we go again!"}
        }
    }
end

orbit.htmllify(generate)

print(generate())

创建表单

一个简单表单的例子：

#!/usr/bin/env index.lua
require"orbit"

function wrap (inner)
    return html{ head(), body(inner) }
end

function test ()
    return wrap(form (H'table' {
        tr{td"First name",td( input{type='text', name='first'})},
        tr{td"Second name",td(input{type='text', name='second'})},
        tr{ td(input{type='submit', value='Submit!'}),
            td(input{type='submit',value='Cancel'})
        },
    }))
end

orbit.htmllify(wrap,test)

print(test())

更多细节可以翻翻 Orbit 的官方文档，那里有很长的教程。

WSAPI

前面提到过，WSAPI 是很多项目的底层支撑。它能跑在 Windows 和 Unix 系统上，支持 CGI、FastCGI 和 Xa vante 三种服务器/接口。

WSAPI 自带大量的 Lua 库，让网络编程省心不少。它支持以下功能：

• 请求处理（Request processing）
• 输出缓冲（Output buffering）
• 认证（Authentication）
• 文件上传（File uploads）
• 请求隔离（Request isolation）
• 多路复用（Multiplexing）

一个简单的 WSAPI 示例：

#!/usr/bin/env wsapi.cgi

module(..., package.seeall)
function run(wsapi_env)
  local headers = { ["Content-type"] = "text/html" }
  
  local function hello_text()
      coroutine.yield("")
      coroutine.yield("
Hello Wsapi!
")
      coroutine.yield("
PATH_INFO: " .. wsapi_env.PATH_INFO .. "
")
      coroutine.yield("
SCRIPT_NAME: " .. wsapi_env.SCRIPT_NAME .. "
")
      coroutine.yield("")
  end

  return 200, headers, coroutine.wrap(hello_text)
end

这里可以看到协程的用法——通过 coroutine.yield 逐段返回 HTML，最后返回状态码 200、响应头和一个协程包装的函数。

Xa vante

Xa vante 是一个基于 URI 模块化架构的 Lua HTTP Web 服务器（版本 1.1），通过映射处理器来处理请求。它目前提供了三种处理器：

• 文件处理器（File handler）
• 重定向处理器（Redirect handler）
• WSAPI 处理器（WSAPI handler）

文件处理器处理常规文件，重定向处理器负责 URI 重新映射，WSAPI 处理器则对接 WSAPI 应用。

一个简单的 Xa vante 配置示例：

require "xa vante.filehandler"
require "xa vante.cgiluahandler"
require "xa vante.redirecthandler"

-- Define here where Xa vante HTTP documents scripts are located
local webDir = XA VANTE_WEB

local simplerules = {

    { -- URI remapping example
      match = "^[^%./]*/$",
      with = xa vante.redirecthandler,
      params = {"index.lp"}
    },

    { -- cgiluahandler example
      match = {"%.lp$", "%.lp/.*$", "%.lua$", "%.lua/.*$" },
      with = xa vante.cgiluahandler.makeHandler (webDir)
    },
    
    { -- filehandler example
      match = ".",
      with = xa vante.filehandler,
      params = {baseDir = webDir}
    },
}

xa vante.HTTP{
    server = {host = "*", port = 8080},
    
    defaultHost = {
        rules = simplerules
    },
}

如果要用虚拟主机，可以这样写：

xa vante.HTTP{
    server = {host = "*", port = 8080},
    
    defaultHost = {},
    
    virtualhosts = {
        ["www.sitename.com"] = simplerules
    }
}

Lua Web 组件

除了上面介绍的几个核心组件，Kepler 社区还提供了一些实用的辅助库：

• Copas：基于协程的调度器，适合通过 TCP/IP 协议运行服务器。
• Cosmo：一个“安全模板”引擎，能防止模板里混入任意代码。
• Coxpcall：对 Lua 原生的 pcall 和 xpcall 的封装，让它们与协程兼容。
• LuaFileSystem：可移植的底层目录结构和文件属性访问库。
• Rings：允许在 Lua 内部创建新的 Lua 状态的库。

其他可选的 Lua Web 框架

Lua 的 Web 生态远不止这些。还有几个值得一提的框架：

• Moonstalk：专注于高效开发和托管动态 Web 项目，从简单页面到复杂应用都能搞定。
• Lapis：用 MoonScript（或 Lua）构建 Web 应用的框架，运行在 OpenResty（一个定制版的 Nginx）之上。
• Lua Server Pages：一个 Lua 脚本引擎插件，嵌入到其他 Web 开发方式中，能大幅简化传统 C 服务器页面的开发。

这些框架和组件共同构成了 Lua 在 Web 开发中的强大工具箱。根据项目需求灵活选型，就能发挥出 Lua 的独特优势。