安科网

lua web快速开发指南(7) - 高效的接口调用 - httpc库

小烨

小烨

2019-11-17

关注 关注

httpc库基于cf框架都内部实现的socket编写的http client库.

httpc库内置SSL支持, 在不使用代理的情况下就可以请求第三方接口.

httpc支持header、args、body、timeout请求设置, 完美支持各种httpc调用方式.

API介绍

httpc库使用前需要手动导入httpc库: local httpc = require "httpc".

httpc.get(domain, HEADER, ARGS, TIMEOUT)

调用get方法将会对domain发起一次HTTP GET请求.

domain是一个符合URL定义规范的字符串;

HEADER是一个key-value数组, 一般用于添加自定义头部;

ARGS为请求参数的key-value数组, 对于GET方法将会自动格式化为:args[n][1]=args[n][2]&args[n+1][1]=args[n+1][2];

TIMEOUT为httpc请求的最大超时时间;

httpc.post(domain, HEADER, BODY, TIMEOUT)

调用post方法将会对domain发起一次HTTP POST请求, 此方法的content-type会被设置为:application/x-www-form-urlencoded.

domain是一个符合URL定义规范的字符串;

HEADER是一个key-value数组, 一般用于添加自定义头部; 不支持Content-Type与Content-Length设置;

BODY是一个key-value数组, 对于POST方法将会自动格式化为:body[n][1]=body[n][2]&body[n+1][1]=body[n+1][2];

TIMEOUT为httpc请求的最大超时时间;

httpc.json(domain, HEADER, JSON, TIMEOUT)

json方法将会对domain发起一次http POST请求. 此方法的content-type会被设置为:application/json.

HEADER是一个key-value数组, 一般用于添加自定义头部; 不支持Content-Type与Content-Length设置;

JSON必须是一个字符串类型;

TIMEOUT为httpc请求的最大超时时间;

httpc.file(domain, HEADER, FILES, TIMEOUT)

file方法将会对domain发起一次http POST请求.

HEADER是一个key-value数组, 一般用于添加自定义头部; 不支持Content-Type与Content-Length设置;

FILES是一个key-value数组, 每个item包含: name(名称), filename(文件名), file(文件内容), type(文件类型)等属性. 文件类型可选.

TIMEOUT为httpc请求的最大超时时间;

httpc 返回值

所有httpc请求接口均会有2个返回值: code, response. code为http协议状态码, response为回应body(字符串类型).

参数不正确, 连接被断开等其它错误, code将会为nil, response为错误信息.

"一次性HTTP请求"

什么是一次性httpc请求呢?

每次我们使用httpc库在请求第三方http接口的时候, 都会在接口返回后关闭连接. 这在日常使用中一边也没什么问题.

但是当我们需要多次请求同一个接口的时候, 每次请求完毕就关闭连接显然不是那么高效, 现在我们尝试使用一个http class对象来解决这个问题.

注意: httpc class对象不能对不同域名的接口使用同一个连接, 这会返回一个错误调用给使用者.

httpc库的class对象使用介绍

要使用httpc的class需要导入httpc的class库, 导入方式为: local httpc = require "httpc.class".

当需要使用httpc发起请求之前, 需要先创建一个httpc的对象, 如: local hc = httpc:new {}. httpc对象创建与初始化完毕后, 使用方式同上述API所示.

hc与httpc拥有相同的API, 但是需要使用不同的调用方式. 如: hc:get、hc:post、hc:json、hc:file.

一旦hc使用完毕时, 需要显示的调用hc:close()方法来关闭创建的httpc对象并销毁httpc的连接.

开始实践

现在, 让我们将上面学到的API使用方式运用到实践中.

1. 启动一个httpd库的web server

在main.lua中启动一个httpd的server.

local httpd = require "httpd"
local json = require "json"

local app = httpd:new("httpd")


app:listen("", 8080)

app:run()

1. 增加一个API路由用于ip地址归属地查询

我们先利用httpd库启动一个server服务, 并且对外提供IP归属地查询接口

app:api('/ip', function(content)
    local httpc = require "httpc"
    local args = content.args
    if not args or not args['ip'] then
        return json.encode({
            code = 400,
            msg = "错误的接口调用方式",
            data = json.null,
            })
    end
    local code, response = httpc.get("http://freeapi.ipip.net/"..args["ip"])
    if code ~= 200 then
        return json.encode({
            code = 401,
            msg = "获取数据失败",
            data = json.null,
            })
    end
    return response
end)

现在代码已经完成! 让我们打开浏览器输入:http://localhost:8090/ip?ip=8.8.8.8查看返回数据.

2. 查询多个IP地址的归属地

一个请求对应一次回是HTTP协议的本质! 但是我们经常会遇到批量请求的业务场景, 我们就以此来设计一个批量请求/返回的例子.

让我们假设客户端将会发送一次POST请求, body为json类型并且里面包含一个IP数组: ip_list = {1.1.1.1, 8.8.8.8, 114.114.114.114}.

服务端在接受到这个数组之后, 需要将这ip的归属地信息一次性返回给客户端.

app:api('/ips', function(content)
    local httpc = require "httpc.class"
    if not content.json then
        return json.encode({
            code = 400,
            msg  = "错误的调用参数",
            data = json.null,
        })
    end
    local args = json.decode(content.body)
    if type(args) ~= 'table' or type(args['ip_list']) ~= 'table' then
        return json.encode({
            code = 400,
            msg  = "错误的参数类型",
            data = json.null,
        })
    end
    local hc = httpc:new {}
    local ret = { code = 200 , data = {}}
    for _, ip in ipairs(args['ip_list']) do
        local code, response = hc:get("http://freeapi.ipip.net/"..ip)
        ret['data'][#ret['data']+1] = json.decode(response)
    end
    hc:close()
    return json.encode(ret)
end)

由于普通浏览器POST无法发送json, 让我们使用curl命令行工具进行测试:

curl -H "Content-Type: application/json" -X POST -d '{"ip_list":["1.1.1.1","8.8.8.8","114.114.114.114"]}' http://localhost:8090/ip

返回数据如下:

{"code":200,"data":[["CLOUDFLARE.COM","CLOUDFLARE.COM","","",""],["GOOGLE.COM","GOOGLE.COM","","","level3.com"],["114DNS.COM","114DNS.COM","","",""]]}

3. 持续优化.

上述例子似乎已经非常完美! 我们利用连接保持的方式进行了3次请求, 这样已经缩短了请求50%的连接消耗(TCP握手).

但是对于非常需要性能的我们来说: 每次请求需要等到上一个请求处理完毕后才能继续发起新的请求, 这样的方式显然还不足以满足我们.

这样的情况下, httpc库提供了一个叫multi_request的方法. 具体使用方法在这里.

这个方法可以让我们同时发送几十上百个请求来解决单个连接阻塞的问题.

4. 并发请求

现在, 让我使用httpc库的multi_request方法来并发请求多个接口, 减少连接阻塞带来的问题.

app:api('/ips_multi', function (content)
    local httpc = require "httpc"
    if not content.json then
        return json.encode({
            code = 400,
            msg  = "错误的调用参数",
            data = json.null,
        })
    end
    local args = json.decode(content.body)
    if type(args) ~= 'table' or type(args['ip_list']) ~= 'table' then
        return json.encode({
            code = 400,
            msg  = "错误的参数类型",
            data = json.null,
        })
    end
    local requests = {}
    local responses = { code = 200, data = {}}
    for _, ip in ipairs(args["ip_list"]) do
        requests[#requests+1] = {
            domain = "http://freeapi.ipip.net/"..ip,
            method = "get",
        }
    end
    local ok, ret = httpc.multi_request(requests)
    for _, res in ipairs(ret) do
        responses['data'][#responses['data'] + 1] = res
    end
    return json.encode(responses)
end)

好的, 现在让我们再次使用curl工具进行测试:

curl -H "Content-Type: application/json" -X POST -d '{"ip_list":["1.1.1.1","8.8.8.8","114.114.114.114"]}' http://localhost:8090/ips_multi

我们可以从cf的请求回应时间看到, 响应时间消耗再次降低了50%.

[candy@MacBookPro:~/Documents/core_framework] $ ./cfadmin
[2019/06/16 17:45:21] [INFO] httpd正在监听: 0.0.0.0:8090
[2019/06/16 17:45:21] [INFO] httpd正在运行Web Server服务...
[2019/06/16 17:45:23] - ::1 - ::1 - /ips_multi - POST - 200 - req_time: 0.140253/Sec
[2019/06/16 17:45:38] - ::1 - ::1 - /ips - POST - 200 - req_time: 0.288286/Sec

完整的代码

local httpd = require "httpd"
local json = require "json"

local app = httpd:new("httpd")

app:api('/ip', function(content)
    local httpc = require "httpc"
    local args = content.args
    if not args or not args['ip'] then
        return json.encode({
            code = 400,
            msg = "错误的接口调用方式",
            data = json.null,
            })
    end
    local code, response = httpc.get("http://freeapi.ipip.net/"..args["ip"])
    if code ~= 200 then
        return json.encode({
            code = 401,
            msg = "获取数据失败",
            data = json.null,
            })
    end
    return response
end)

app:api('/ips', function(content)
    local httpc = require "httpc.class"
    if not content.json then
        return json.encode({
            code = 400,
            msg  = "错误的调用参数",
            data = json.null,
        })
    end
    local args = json.decode(content.body)
    if type(args) ~= 'table' or type(args['ip_list']) ~= 'table' then
        return json.encode({
            code = 400,
            msg  = "错误的参数类型",
            data = json.null,
        })
    end
    local hc = httpc:new {}
    local ret = { code = 200 , data = {}}
    for _, ip in ipairs(args['ip_list']) do
        local code, response = hc:get("http://freeapi.ipip.net/"..ip)
        ret['data'][#ret['data']+1] = json.decode(response)
    end
    hc:close()
    return json.encode(ret)
end)

app:api('/ips_multi', function (content)
    local httpc = require "httpc"
    if not content.json then
        return json.encode({
            code = 400,
            msg  = "错误的调用参数",
            data = json.null,
        })
    end
    local args = json.decode(content.body)
    if type(args) ~= 'table' or type(args['ip_list']) ~= 'table' then
        return json.encode({
            code = 400,
            msg  = "错误的参数类型",
            data = json.null,
        })
    end
    local requests = {}
    local responses = { code = 200, data = {}}
    for _, ip in ipairs(args["ip_list"]) do
        requests[#requests+1] = {
            domain = "http://freeapi.ipip.net/"..ip,
            method = "get",
        }
    end
    local ok, ret = httpc.multi_request(requests)
    for _, res in ipairs(ret) do
        responses['data'][#responses['data'] + 1] = res
    end
    return json.encode(responses)
end)

app:listen("", 8090)

app:run()

继续学习

下一章节我们将学习如何使用httpd库编写Websocket.

domain 接口

小烨

小烨

0 关注 0 粉丝 0 动态

关注 关注

相关推荐

python-spider 第七关

:return: a dict the contains cookies from the domain.

书虫媛 2020-08-18

what is conversion exit defined in ABAP domain

我们之前用了这个data element。UI framework的getter 会自动检测data type的domain上是否维护conversion exit，如果有，就自动调用，我们没有写任何代码。还是这个routine只控制ui field?Co

liuttorrie 2020-07-04

【asp.net core 系列】6 实战之 一个项目的完整结构

在《asp.net core 系列》之前的几篇文章中，我们简单了解了路由、控制器以及视图的关系以及静态资源的引入，让我们对于asp.net core mvc项目有了基本的认识。不过，这些并不是 asp.net core mvc项目的全部内容，剩下的内容我将

Yakamoz 2020-06-17

Requests 设置cookies方式

cookies_value = {‘name1‘: ‘value1‘,　　path表示cookie所在的目录，asp.net默认为/，就是根目录。这是因为cookie能让其path路径下的页面访问。　　浏览器会将domain和path都相同的cookie保

Lophole 2020-06-13

域账户提升本地管理员权限

1，新建的域用户默认属于 “user” 下的 ”domain user” 组成员。3 , 所以要想域账户拥有管理员权限，可以在域控制器里将域账号添加到domian admin是组里，当然你也可以在pc端手动将此域账户加入到administrator组里。4

liaoxuewu 2020-06-11

java JDBC DAO ORM Domain

JDBC是用于在Java语言编程中与数据库连接的API.JDBC是一个规范，它提供了一整套接口，允许以一种可移植的访问底层数据库API。使用JDBC驱动程序来访问数据库，并用于存储数据到数据库中.java应用程序通过JDBC API首先连接到JDBC Dr

技术之博大精深 2020-06-10

WebLogic11g-创建域(Domain)及基本配置

6、选择创建域的类型这里我们选择”生成一个自动配置的域以支持下列产品”，输入1回车。输入3 然后next回车 确认密码；

Lophole 2020-05-25

如何重构一些可怕的代码

好消息是，您可以应用几种简单的技术来简化嵌套的if-else语句。如今，我们大多数人都在Gousto中实践TDD，但是代码库的这一特定部分是几年前的，它的重要性和状态阻碍了我和其他人在过去对其进行重构。现在我们有了测试，有了更多的信心，我们可以开始拆分代码

gtsjx 2020-05-19

Node.js Domain 模块实例详解

Node.jsDomain(域) 简化异步代码的异常处理，可以捕捉处理try catch无法捕捉的异常。

apidnr 2020-03-18

[译文] 应用领域驱动设计, 第五章 - 领域服务

原文: Applied Domain-Driven Design , Part 5 - Domain Service. Domain Service is not be confused with Application Service or Web Se

Lophole 2020-05-09

ZABBIX结合自动发现机制实现站点/hs页面健康监控

域名列表可以拿到后配置检测健康状态的脚本。配置完毕后将模板套用到准备了webhs.sh和domain.list文件的客户端机器上即可，两分钟后会发现已经自动发现并监控了

SIMONDOMAIN 2020-05-09

Unix域套接字-Unix Domain Socket（转）

add by zhj: Unix Domain Socket是网络socket的优化，适用于服务端与客户端在同一台机器上的情况。相比网络socket，它可以提高通信效率。最近在搭建Nginx+Gunicorn的时候，返现这两个进程可以通过一个后缀为.soc

书虫媛 2020-05-03

一个奇怪的网页bug 竟然是局域网DNS搞的鬼

更新了网站服务器后，明明测试的时候用另一个IP可以正常浏览网站的slide show ，而且外网也可以正常浏览，偏偏用回旧IP的时候内网就是有不显示的问题。以为是wordpress 的问题，于是打开F12调试又查不到代码哪一行出错。删了那条记录就正常了[骷

Lophole 2020-04-29

Cisco ASA - Permit/Deny Traffic Domain name FQDN

no access-list 200 extended permit ip object-group Reception-Desktop-with-liminatioin object-group Mallcoo-Server log. no access

luvhl 2020-04-10

git 在pull/push指定密钥文件

# 编辑当前用户的ssh config 文件。#每一组由 Host 开始。Host gitlab.com # 这里的ip/domain 是你的主机名，写ip或者域名

书虫媛 2020-03-07

what is conversion exit defined in ABAP domain

我们之前用了这个data element。UI framework的getter 会自动检测data type的domain上是否维护conversion exit，如果有，就自动调用，我们没有写任何代码。还是这个routine只控制ui field?Co

Lophole 2020-03-03

php+nginx改为socket

—— 维基百科Unix domain socket 或者 IPC socket是一种终端，可以使同一台操作系统上的两个或多个进程进行数据通信。与管道相比，Unix domain sockets 既可以使用字节流和数据队列，而管道通信则只能通过字节流。Uni

SIMONDOMAIN 2020-02-25

Fully Qualified Domain Name [FQDN]

A fully qualified domain name is the complete domain name for a specific computer, or host on the internet. The FQDN consists o

SIMONDOMAIN 2020-02-19

通过提高PageRank / Domain权限，简化7种SEO流程

　　上涨的浪潮抬高了所有船只，这与增加站点权限类似。改善PageRank或域权限时，哪些因素受到影响?在今天的Whiteboard星期五中，Cyrus详细介绍了七个SEO流程，这些投资可以通过在链接构建和增强权威方面的大量投资而变得更加容易。　　单击上方的

zhuakuang0 2020-02-17

Azure（Office 365）：添加和验证Domain 相关的考量点

以及添加和验证Domain具体有哪些考量点呢？域名是一个唯一的名字，可以出现在电子邮件@符号之后的后缀，通常采用组织名称或者标准互联网后缀形式，比如contoso.com或者contoso.edu。你可以在Office 365 中购买一个域名，也可以从Do

书虫媛 2020-02-11
小烨

小烨

W3CSchool教程
HTML 教程
CSS 教程
Bootstrap 教程
Javascript 教程
jQuery 教程
后端教程
C 教程
Java 教程
PHP 教程
Python 教程
Go 教程
移动开发
Android 教程
Swift 教程
Kotlin 教程
jQuery Mobile 教程
ionic 教程
关于我们
新闻动态
联系方式
招聘英才
安科实验室
帮助与反馈

安科网(Ancii)，中国第一极客网

Copyright © 2013 - 2019 Ancii.com

京ICP备18063983号 京公网安备11010802014868号