README_zh.md

wlua

中文 English

wlua 是什么

wlua 是一个运行在 skynet 上的使用 Lua 编写的 Web 框架。 它兼顾开发效率和运行时性能， 可用于快速开发 API Server。

特性

• 路由采用 gin 风格，结构清晰，易于编码和维护
• 支持 middleware 机制，可在任意路由上挂载中间件
• 支持多种路由，路由可分组
• 可作为HTTP API Server，也可用于构建 VUE 类应用

最简示例

local wlua = require "wlua"
local app = wlua:default()

app:get("/", function (c)
    c:send("Hello wlua!")
end)

app:run()

安装

依赖

编译 skynet 需要 gcc 4.9+ 版本.

然后用下面的命令编译 wlua:

git clone https://github.com/hanxi/wlua
cd wlua
sudo make install

WLUA_HOME 和 WLUA_BIN 可以在 Makefile 设置, 所以可以用下面的命令自定义安装目录(默认的 WLUA_HOME 为 /usr/local/wlua , WLUA_BIN 为 /usr/local/bin/wlua ):

make install WLUA_HOME=/usr/local/wlua WLUA_BIN=/usr/local/bin/wlua

所以需要 /usr/local/bin 目录在 $PATH 路径里。

快速开始

开始使用 wlua 的一种快速方法是利用可执行的 cli 工具 wlua 来生成脚手架应用程序。

wlua 命令 与 wlua 框架一起安装。运行查看帮助：

$ wlua help
wlua 0.0.2, a web framework for Lua that is as simple as it is powerful.

Usage: wlua COMMAND [OPTIONS]

Commands:
 new <name>    Create a new application
 start         Start the server
 stop          Stop the server
 reload        Reload the server
 version       Show version of wlua
 help          Show help tips

以 wlua_demo 为名字新创建一个工程:

$ wlua new wlua_demo

开启服务:

$ cd wlua_demo
$ wlua start

使用浏览器进入 http://localhost:8081 查看效果. 或者使用 curl 命令查看效果:

$ curl -i http://localhost:8081

路由语法

路由已改用 lua-rax 库实现，具体规则参考 lua-rax 。 匹配规则和之前的 lua-r3 有所区别，主要原因是 lua-r3 编译需要太多的依赖。

API 示例

More examples in wlua-examples

Using GET, POST, PUT, PATCH, DELETE and OPTIONS

local wlua = require "wlua"

-- Creates a wlua router with default logger middleware.
local app = wlua:default()

app:get("/someget", function (c)
    c:send("someget")
end)

app:post("/somepost", function (c)
    c:send("somepost")
end)

app:put("/someput", function (c)
    c:send("someput")
end)

app:delete("/somedelete", function (c)
    c:send("somedelete")
end)

app:patch("/somepatch", function (c)
    c:send("somepatch")
end)

app:head("/somehead", function (c)
    c:send("somehead")
end)

app:options("/someoptions", function (c)
    c:send("someoptions")
end)

-- By default it serves on :8081
app:run()

Parameters in path

Querystring parameters

Urlencoded Form

Another example: query + post form

Post JSON

Upload files

Grouping routes

Blank Wlua without middleware by default

Using middleware

JSON rendering

Serving static files

Serving data from file

Custom Middleware

Graceful shutdown or reload

Set and get a cookie

origin skynet service

use skynet service_provider create uniqservice

timer task

示例项目

• wlua-demo wlua 示例项目，配合 vue-admin-template 制作的后台模板
• skynet-admin skynet 管理后台，深度集成 skynet cluster 集群管理

参考

• skynet
• gin
• wlua-demo
• vue-admin-template
• skynet-admin
• lua-rax