WEB服务

主要是用的web和lua的开发框架可以灵活的处理业务利用lua的热更新和加载的原理

用法说明

没启动一个web服务器必须要定义他的router逻辑和handle的逻辑可以直接定义也可以从外部文件导入

内置方法

web(cfg) 获取web服务
web.vhost 生成主机名配置
web.context,web.ctx 请求变量
web.handle,web.h 请求处理函数
web.router,web.r 添加路由

web服务

http = web(cfg)
配置:配置文件返回:http任务对象

配置信息:

name
bind tcp://127.0.0.1:9090
keepalive
reuseport
output 日志输出

内置函数:

http.vhost(hostname , router) 绑定主机名router
http.format(codec , string) 日志输出格式
http.addr(string)} 设置全局IP地址获取字段默认:remote_addr
http.to(lua.write) output数据输出
[http.default(string , handle)](#) 设置默认的处理逻辑
http.start()

内置router:

http.r 默认的router

    local http = web{
        -- proc 服务名称 
        name = "demo_web", 
        -- 监听端口
        bind = "tcp://0.0.0.0:9090?read_timeout=100&idle_timeout=100", --监听的端口
        keepalive = "on"
    }

    local r = http.vhost("x.vela.com" , {})
    r.GET("/aa" , web.handle"xxxxxxx")
    r.GET("/cc" , function() end)

    http.start()

router

r = web.router(cfg) 或者 r = web.r(cfg)
利用的web的router路由逻辑，完成默认路由的注入，利用web的快速匹配模式完成路由查找
下面是www.a.com的主机的配置,文件路径:www.a.com.lua

内置方法:

router.GET
router.HEAD
router.POST
router.PUT
router.PATCH
router.DELETE
router.CONNECT
router.OPTIONS
router.TRACE
router.POST
router.ANY 忽略发方法名注意: router.ANY("*" , web.handle...)
router.default 没有命中HTTP请求后转发的路径
router.not_found 等同default

语法: r.METHOD(path string , web.handle ... )
参数 path：代表路径的完全兼容 web.router的路径语法如:/api/{name}/{val:*}
参数 handle: 就是用web.handle构造的对象

    local r = web.router{
    -- 日志格式 , 关闭：off 
    access_format = "time,server_addr,server_port,remote_addr,host,path,query,ua,referer,status,content-lenght,region_info,http_risk",

    -- 日志的格式 
    access_encode = "json",

    -- 记录IP的位置信息
    access_region = "x-real-ip",
    
    --
    output = vela.file{},
    
    interceptor = function()
        if ctx.status == 500 then
            ctx.say([[{"code": 500 , "message":"invalid request"}]])    
        end
    end
}

完整的例子

local ctx = web.context-- 用户请求周期变量
local json = vela.json
local function auth() 
    local u = json.decode(ctx.body_raw)
    if u.name == "admin" and u.pass == "123654" then
        ctx.say(json.encode({code=200 , body = u.name .. "login success"}))
        ctx.exit(200) 
        return
    end
    ctx.say(json.encode({code=200 , body = "login fail"}))
    ctx.exit(200)
end

r.POST("/login" , auth) --注册路由

r.GET("/info" , 
    web.handle{
        code = 200,
        filter = { "host = www.a.com,www.c.com" , "uri = /info" },
        header = web.header{
            ['server'] = "vela-web-test-v1.0", 
        },
        
        body = "helo",
        hook = function()
            ctx.say("helo by hook")
        end,
        eof = true 
    },
    "defaut_handle" --这个是查找公共库下的handle处理逻辑 ,一般为default_handle.lua
)

context

web服务context的http请求逻辑

ctx.say
ctx.json
ctx.file(filepath)
ctx.raw(string...)
ctx.redirect(url , code) 跳转状态默认302
ctx.append(string) 追加返回内容
ctx.req_header, ctx.rqh 设置请求头
ctx.resp_header, ctx.rph 设置返回头
ctx.try(v...) 检测值是否为空
ctx.bind(codec) 自动解码请求格式支持:json和file
ctx.clone() 克隆远程地址
web.context.json 自动encode obj 对象并且发送JSON对象 , obj 需要满足是userdata anydata 且满足ToJson 接口

    local ctx = web.context
    ctx.json(obj)

web.context.bind 自动绑定请求参数如果异常会自动退出请求

    local ctx = web.context
    local v = ctx.bind()
    ctx.say(v.int("id"))
    ctx.say(v.str("name"))
    ctx.say(v.bool("enable"))

web.context.say(string...)

    local ctx = web.context
    local r = web.router()

    r.GET("/" , function()
        ctx.say("helo")
    end)

web.context.append(string...)

    local ctx = web.context
    local r = web.router()
    r.GET("/" , function()
        ctx.say("helo")
        ctx.append(" vela-go")
    end)

web.context.exit(int)

    local ctx = web.context
    local r = web.router()
    r.GET("/" , function()
        ctx.say("helo")
        ctx.append(" vela-go")
        ctx.exit(200)
    end)

web.context.resp_header(name1 , value1 , name2, value2,name3 , value3)
web.context.rph(name1 , value1 , name2 , value2)

  local ctx = web.context
  local r = web.router()
  r.GET("/" , function()
      ctx.set_healder("content-length",1 , "uuid","x-x")
      ctx.say("helo")
  end)

web.context.eof()

    local ctx = web.context
    local r = web.router()

    r.GET("/" , function()
        ctx.say("helo")
        ctx.eof() --关闭继续运行
    end)

web.context.arg_*
作用: 读取用户请求参数的值
语法： web.context.arg_name , web.context.arg_a

    -- http://www.a.com/a?name=edx&a=123
    local ctx = web.context
    local name = ctx.arg_name or "" --name=edx
    local a = ctx.arg_a or "" -- a=123

web.context.post_*
作用：读取用户POST参数
语法： web.context.post_value

    -- POST /api HTTP/1.1
    -- Host: www.a.com
    -- Rule: sqli-deny
    --
    -- name=edunx&value=123
    
    local ctx = web.context
    local say = http.response.say

    say(ctx.post_name , " " , ctx.post_value)

web.context.param_*
作用：读取路由中的param
语法： web.context.param_name , web.context.param_val

 -- http://www.a.com/api/admin/123456
 -- 路由 r.GET("/api/{name}/{val:*}

    local ctx = web.context

    local name = ctx.param_name 
    local val = ctx.param_val

    ctx.say(name , " " , val)

web.context.http_*
作用：获取请求header头里面的参数
语法： web.context.http_rule , web.context.http_user_agent

    -- GET / HTTP/1.1
    -- Host: www.a.com
    -- Rule: sqli-deny

    local ctx = web.context
    local rule = ctx.http_rule

web.context.cookie_*
作用：获取cookie里的某个具体字段
语法： web.context.cookie_session

    -- GET / HTTP/1.1
    -- Host: www.a.com
    -- cookie:session=123x

    local ctx = web.context
    local v = ctx.cookie_session
    ctx.say(v)

web.context.remote_addr
作用: 获取connection的四层IP地址
语法: web.context.remote_addr

    local addr = web.context.remote_addr

web.context.remote_port
作用: 获取connection的四层端口
语法: web.context.remote_port

    local port = web.context.remote_port

web.context.server_addr
作用: 获取本地服务器的IP地址
语法: web.context.server_addr

    local addr = web.context.server_addr

web.context.server_port
作用: 获取本地服务器的端口
语法: web.context.server_addr

    local port = web.context.server_port

web.context.host
作用: 获取用户请求的主机名
语法: web.context.host

    local host = web.context.host

web.context.uri
作用: 获取获用户请求的URI
语法: web.context.uri

    -- http://www.a.com/api/info
    local uri = web.context.uri -- /api/info

web.context.args
作用: 获取用户请求的args字符串
语法: web.context.args

    -- http://www.a.com/api/info?name=admin&val=123
    local args = web.context.args -- name=admin&val=123

web.context.request_uri
作用: 获取完整的请求URI
语法: web.context.request_uri

    -- http://www.a.com/api/info?name=admin&val=123
    local request = web.context.request_uri -- /api/info?name=admin&val=123

web.context.http_time
作用: 获取请求时间
语法: web.context.http_time

    local ht = web.context.http_time --2020-01-01 01:02:03.00

web.context.cookie_raw
作用: 获取cooie的子完整自字符串
语法: web.context.cookie_raw

    local cookie = web.context.cookie_raw

web.context.header_raw
作用: 获取完整的header字符串
语法: web.context.header_raw

    local raw = web.context.header_raw

web.context.content_length
作用: 获取获取用户请求的包大小
语法: web.context.content_length

    local len = web.context.content_length

web.context.content_type
作用: 获取获取用户请求的content_type
语法: web.context.content_type

    local ct = web.context.content_type

web.context.body
作用: 获取用户的请求的body请求体
语法: web.context.body

    local body = web.context.body

web.context.region_cityid
作用: 获取用户所在城市的ID
语法: web.context.region_cityid

    local id = web.context.region_cityid

web.context.region_info
作用: 获取获IP地址位置信息
语法: web.context.region_info

    local info = web.context.region_info

web.context.ua
作用: 获取user_agent
语法: web.context.ua

    local ua = web.context.ua

web.context.referer
作用: 获取referer
语法: web.context.referer

    local ref = web.context.referer

web.context.status
作用: 获取返回状态码
语法: web.context.status

    local status = web.context.status

web.context.sent
作用: 获取发送数据包的大小
语法: web.context.sent

    local sent = web.context.sent

web.context.clone
作用： clone线上服务器的内容

  local ctx = web.ctx
  r.GET("/baidu" , ctx.clone("https://www.baidu.com"))

handle

主要的业务处理逻辑绑定之前注册路由可以是下面的三种模式
template: 直接采用模板渲染的方式: ${host} 变量满足context的接口 function: 函数处理模式利用内置的context 和 ctx 逻辑 handler: 模式,采用提前处理定义好的数据和返回模式 clone: clone线上服务器的链接信息 web.clone("https://wwww.baidu.com") redirect: 重定向服务器web.redirect("https://www.baidu.com" , 302)

    local ctx = web.context
    local h = web.handle
    r.GET("/template" , h'${host} allow by ${uri}')

    r.GET("/function" , function() 
      ctx.say(vela.format("%s allow by %s" , ctx.host , ctx.uri)) 
      ctx.exit(200)
    end)

    r.GET("/handle" , h{
      code = 200,
      body = "${host} allow by handle",
      eof  = false, --继续往下匹配
    }, h{
      code = 200,
      body = "${host} allow by handle",
      eof  = true,
    })

handle 下面调用方式:

    -- 注册路由的时候直接创建
    r.GET("/123" , web.handle{ })
    
    -- 注册路由时候 告诉名称， 自动从公共库中加载
    r.GET("/get/info" , "sqli" , "xss" , "not_found")
    
    --直接注入匿名函数
    r.GET("/get/useinfo" , function() end)

    r.GET("/get/useinfo" , web.handle'${app}')

    --文件路径
    r.FILE("/static/{filepath:*}" , "share/www/html")

    --文件重定向
    r.FILE("/static/{filepath:*}" , "share/www/html" , function()
        return "/index.html" 
    end)

定义库文件
handle库的定义，一般是文件名调用中的handler
如下中handle

    return web.handle{ --记得一定要return 不然无法获取
        code = 200,
        header = web.header{},
        body = "aaaa${uri}"
    }

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

web服务.md

web服务.md

WEB服务

用法说明

内置方法

web服务

router

context

handle

Files

web服务.md

Latest commit

History

web服务.md

File metadata and controls

WEB服务

用法说明

内置方法

web服务

router

context

handle