## 概述
Lua-resty-http 是一个基于 OpenResty 的 Lua 库，是 OpenResty 项目中一个非常有用的模块，用于从 Nginx 服务中发起 HTTP 请求。OpenResty 是一个基于 Nginx 与 LuaJIT 的全功能 Web 平台，它集成了大量精心设计的 Nginx 模块，以及大量的 Lua 库。
lua-resty-http 库允许你在 OpenResty 的 Lua 环境中轻松地发送 HTTP 请求，它提供了一个简单易用的 API 来处理 HTTP 请求和响应。这使得在 Nginx 配置文件中编写 Lua 脚本来处理 HTTP 请求和响应成为可能，从而可以构建高性能的 Web 应用和服务。如果你正在使用 OpenResty 并需要在 Nginx 配置中发起 HTTP 请求，lua-resty-http 是一个非常合适的选择。
>项目地址：https://github.com/ledgetech/lua-resty-http
## 特性
* 异步非阻塞：该库利用 nginx 的事件循环模型，让 HTTP 请求在后台执行，不会阻塞主线程，提高了整体性能。
* 连接池管理：它支持连接池的创建与管理，可以有效地复用 TCP 连接，减少握手延迟，提高服务响应速度。
* 丰富的 API 设计：Lua-Resty-HTTP 提供了一套完整的 API，包括设置超时、指定代理、添加请求头、处理重定向、自定义认证等，使得开发过程更为便捷。
* SSL/TLS 支持：内置 SSL/TLS 功能，支持 HTTPS 请求，且允许自定义证书和密钥。
* 错误处理：提供了详细的错误信息，便于调试和故障排除。
## 应用场景
* 数据获取：从 RESTful API 获取 JSON 或其他格式的数据。
* API 调用：在你的 OpenResty 应用中调用外部 Web 服务。
* 自动化测试：在 Lua 测试脚本中模拟 HTTP 请求，验证服务行为。
* 日志报告：向远程服务器发送日志或统计信息。
* 缓存刷新：根据 HTTP 响应自动更新本地缓存。
## 使用
#### 安装
这里通过OPM工具包安装，更多请查看 [ddd](ddd)
```
opm get ledgetech/lua-resty-http
```
#### 基础使用
使用 Lua-resty-http 发送 HTTP 请求的一个基本示例
```
local httpc = require("resty.http").new()
-- Single-shot requests use the `request_uri` interface.
local res, err = httpc:request_uri("http://example.com/helloworld", {
method = "POST",
body = "a=1&b=2",
headers = {
["Content-Type"] = "application/x-www-form-urlencoded",
},
})
if not res then
ngx.log(ngx.ERR, "request failed: ", err)
return
end
-- At this point, the entire request / response is complete and the connection
-- will be closed or back on the connection pool.
-- The `res` table contains the expeected `status`, `headers` and `body` fields.
local status = res.status
local length = res.headers["Content-Length"]
local body = res.body
```
### 进阶使用
`openresty.tinywan.com.conf`配置文件
```
server {
listen 80;
server_name openresty.tinywan.com;
location /lua_http_test {
default_type "text/html";
lua_code_cache off;
content_by_lua_file conf/lua/lua_http_test.lua;
}
}
```
`lua_http_test.lua` 脚本
```
local httpc = require("resty.http").new()
-- Single-shot requests use the `request_uri` interface.
local res, err = httpc:request_uri("https://www.workerman.net/u/Tinywan", {
method = "GET",
body = "name=Tinywan&age=24",
headers = {
["Content-Type"] = "application/x-www-form-urlencoded",
},
ssl_verify = false,
})
if not res then
ngx.log(ngx.ERR, "request failed: ", err)
return
end
local status = res.status
local length = res.headers["Content-Length"]
local body = res.body
ngx.say(res.body)
```
通过curl脚本测试请求打印结果
```html
$ curl -i http://openresty.tinywan.com/lua_http_test
HTTP/1.1 200 OK
Server: openresty/1.17.8.2
Date: Wed, 17 Jul 2024 09:42:10 GMT
Content-Type: text/html; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Vary: Accept-Encoding
<!doctype html>
<html lang="zh-cn">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<link rel="shortcut icon" href="/favicon.ico" />
<link href="https://cdn.workerman.net/css/bootstrap.min.css?v=20211126" rel="stylesheet">
<link href="https://cdn.workerman.net/css/main.css?v=20240705" rel="stylesheet">
<script src="https://cdn.workerman.net/js/jquery.min.js"></script>
<script src="https://cdn.workerman.net/js/bootstrap.min.js?v=20211126"></script>
<script src="https://cdn.workerman.net/js/functions.js?v=20220507"></script>
<script type="text/javascript" charset="UTF-8" src="https://cdn.wwads.cn/js/makemoney.js" async></script>
<title>Tinywan的主页-分享-workerman社区</title>
</head>
...
</body>
</html>
```
#### 项目应用
```
--[[--------------------------------------------------------
* | Copyright (C) Shaobo Wan (Tinywan)
* | Origin: 开源技术小栈
* |--------------------------------------------------------
--]]
local helper = require "vendor.helper"
local redis = require "resty.redis"
local resty_lock = require "resty.lock"
local http = require "resty.http"
local log = ngx.log
local ERR = ngx.ERR
local live_ngx_cache = ngx.shared.live_ngx_cache
-- 非error 日志开关 1:开启，0:关闭
local log_switch = 1
local redis_host = "127.0.0.1"
local redis_port = 6379
local redis_auth = "123456"
local redis_timeout = 1000
-- set ngx.cache
local function set_cache(key, value, exptime)
if not exptime then
exptime = 0
end
local succ, err, forcible = live_ngx_cache:set(key, value, exptime)
return succ
end
-- close redis
local function close_redis(red)
if not red then
return
end
--释放连接(连接池实现)
local pool_max_idle_time = 10000 --毫秒
local pool_size = 100 --连接池大小
local ok, err = red:set_keepalive(pool_max_idle_time, pool_size)
if not ok then
log(ERR, "set redis keepalive error : ", err)
end
end
-- read redis
local function read_redis(_host, _port, _auth, keys)
local red = redis:new()
red:set_timeout(redis_timeout)
local ok, err = red:connect(_host, _port)
if not ok then
log(ERR, "connect to redis error : ", err)
end
-- 请注意这里 auth 的调用过程
local count
count, err = red:get_reused_times()
if 0 == count then
ok, err = red:auth(_auth)
if not ok then
log(ERR, "failed to auth: ", err)
return close_redis(red)
end
elseif err then
log(ERR, "failed to get reused times: ", err)
return close_redis(red)
end
local resp = nil
if #keys == 1 then
resp, err = red:get(keys[1])
else
resp, err = red:mget(keys)
end
if not resp then
log(ERR, keys[1] .. " get redis content error : ", err)
return close_redis(red)
end
if resp == ngx.null then
resp = nil
end
close_redis(red)
if log_switch == 1 then
log(ERR, "[2] [read_redis] content from redis.cache id = " .. keys[1]) -- tag data origin
end
return resp
end
-- write redis
local function write_redis(_host, _port, _auth, keys, values)
local red = redis:new()
red:set_timeout(redis_timeout)
local ok, err = red:connect(_host, _port)
if not ok then
log(ERR, "connect to redis error : ", err)
end
local count
count, err = red:get_reused_times()
if 0 == count then
ok, err = red:auth(_auth)
if not ok then
log(ERR, "failed to auth: ", err)
return close_redis(red)
end
elseif err then
log(ERR, "failed to get reused times: ", err)
return close_redis(red)
end
-- set data
local resp = nil
if #keys == 1 then
resp, err = red:set(keys[1], values)
else
resp, err = red:mset(keys, values)
end
if not resp then
log(ERR, "set redis live error : ", err)
close_redis(red)
end
close_redis(red)
return resp
end
-- get ngx.cache
--[1]即使发生其他一些不相关的错误，您也需要尽快解除锁定。
--[2]在释放锁之前，您需要从后端获得的结果更新缓存，以便其他已经等待锁定的线程在获得锁定后才能获得缓存值。
--[3]当后端根本没有返回任何值时，我们应该通过将一些存根值插入缓存来仔细处理。
local function read_cache(key)
local ngx_resp = nil
-- 获取共享内存上key对应的值。如果key不存在，或者key已经过期，将会返回nil；如果出现错误，那么将会返回nil以及错误信息。
-- step 1
local val, err = live_ngx_cache:get(key)
if val then
if log_switch == 1 then
log(ERR, " [1] [read_ngx_cache] content from ngx.cache id = " .. key) -- tag data origin
end
return val
end
if err then
log(ERR, "failed to get key from shm: ", err)
end
-- cache miss!
-- step 2:
local lock, err = resty_lock:new("cache_lock") -- new resty.lock
if not lock then
log(ERR, "failed to create lock [cache_lock] : ", err)
return
end
local elapsed, err = lock:lock(key) -- 锁
if not elapsed then
log(ERR, "failed to acquire the lock", err)
return
end
-- lock successfully acquired!
-- step 3:
-- someone might have already put the value into the cache ,so we check it here again:
val, err = live_ngx_cache:get(key)
if val then
local ok, err = lock:unlock()
if not ok then
log(ERR, "failed to unlock [111] : ", err)
end
return val
end
--- step 4:
local val = read_redis(redis_host, redis_port, redis_auth, { key })
if not val then
local ok, err = lock:unlock()
if not ok then
log(ERR, "failed to unlock [222] : ", err)
end
-- FIXME: we should handle the backend miss more carefully
-- here, like inserting a stub value into the cache.
log(ERR, "[4] ngx.cache find redis cache no value found : ", err)
return ngx_resp
end
-- [lock] update the shm cache with the newly fetched value
local ok, err = live_ngx_cache:set(key, val, 1)
if not ok then
local ok, err = lock:unlock()
if not ok then
log(ERR, "failed to unlock [333] : ", err)
end
log(ERR, "failed to update live_ngx_cache: ", err)
end
local ok, err = lock:unlock()
if not ok then
log(ERR, "failed to unlock [444] : ", err)
end
return val
end
-------------- read_http 大并发采用 resty.http ，对于：ngx.location.capture 慎用
local function read_http(id)
local httpc = http.new()
local resp, err = httpc:request_uri("https://live.tinywan.com", {
method = "GET",
path = "/api/live/" .. id,
headers = {
["User-Agent"] = "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/40.0.2214.111 Safari/537.36"
}
})
if not resp then
log(ERR, "resty.http API request error :", err)
return
end
httpc:close()
-- 判断状态码
if resp.status ~= ngx.HTTP_OK then
log(ERR, "request error, status :", resp.status)
return
end
if resp.status == ngx.HTTP_FORBIDDEN then
log(ERR, "request error, status :", resp.status)
return
end
-- backend not data 判断api返回的状态码
local status_code = helper.cjson_decode(resp.body)['code']
if tonumber(status_code) == 200 then
-- 正常数据缓存到 Redis 数据缓存
local live_info_key = "LIVE_TABLE:" .. id
local live_value = helper.cjson_decode(resp.body)['data'] -- 解析的Lua自己的然后存储到Redis 数据库中去(这里最好使用lua的json格式去写入)
local live_live_str = write_redis(redis_host, redis_port, redis_auth, { live_info_key }, helper.cjson_encode(live_value))
if not live_live_str then
log(ERR, "redis set info error: ")
end
if log_switch == 1 then
log(ERR, "[3] [read_http] content from backend API id : " .. id) -- tag data origin
end
return helper.cjson_encode(live_value)
else
-- 后端没有数据直接返回 nil
log(ERR, " [read_http] backend API is not content return error_msg : " .. helper.cjson_decode(resp.body)['msg']) -- tag data origin
return
end
end
-- 业务逻辑处理
local function read_content(id)
local cache_content = nil
local live_key = "LIVE:" .. id
local content = read_cache(live_key)
if not content then
log(ERR, "[5] redis not found content, back to backend API , id : ", id)
content = read_http(id)
end
if not content then
log(ERR, "backend API not found content, id : ", id)
return cache_content
end
if tostring(content) == "false" then
log(ERR, "backend API content is false ", id)
return cache_content
end
return content
end
local _M = {
read_content = read_content
}
return _M
```
渲染请求效果
- 设计模式系列
- 工厂方法模式
- 序言
- Windows程序注册为服务的工具WinSW
- 基础
- 安装
- 开发规范
- 目录结构
- 配置
- 快速入门
- 架构
- 请求流程
- 架构总览
- URL访问
- 容器和依赖注入
- 中间件
- 事件
- 代码层结构
- 四个层次
- 路由
- 控制器
- 请求
- 响应
- 数据库
- MySQL实时同步数据到ES解决方案
- 阿里云DTS数据MySQL同步至Elasticsearch实战
- PHP中的MySQL连接池
- PHP异步非阻塞MySQL客户端连接池
- 模型
- 视图
- 注解
- @SpringBootApplication(exclude={DataSourceAutoConfiguration.calss})
- @EnableFeignClients(basePackages = "com.wotu.feign")
- @EnableAspectJAutoProxy
- @EnableDiscoveryClient
- 错误和日志
- 异常处理
- 日志处理
- 调试
- 验证
- 验证器
- 验证规则
- 扩展库
- 附录
- Spring框架知识体系详解
- Maven
- Maven和Composer
- 构建Maven项目
- 实操课程
- 01.初识SpringBoot
- 第1章 Java Web发展史与学习Java的方法
- 第2章 环境与常见问题踩坑
- 第3章 springboot的路由与控制器
- 02.Java编程思想深度理论知识
- 第1章 Java编程思想总体
- 第2章 英雄联盟的小案例理解Java中最为抽象的概念
- 第3章 彻底理解IOC、DI与DIP
- 03.Spring与SpringBoot理论篇
- 第1章 Spring与SpringBoot导学
- 第2章 Spring IOC的核心机制：实例化与注入
- 第3章 SpringBoot基本配置原理
- 04.SprinBoot的条件注解与配置
- 第1章 conditonal 条件注解
- 第2章 SpringBoot自动装配解析
- 05.Java异常深度剖析
- 第1章 Java异常分类剖析与自定义异常
- 第2章 自动配置Url前缀
- 06.参数校验机制与LomBok工具集的使用
- 第1章 LomBok工具集的使用
- 第2章 参数校验机制以及自定义校验
- 07.项目分层设计与JPA技术
- 第1章 项目分层原则与层与层的松耦合原则
- 第2章 数据库设计、实体关系与查询方案探讨
- 第3章 JPA的关联关系与规则查询
- 08.ORM的概念与思维
- 第1章 ORM的概念与思维
- 第2章 Banner等相关业务
- 第3章 再谈数据库设计技巧与VO层对象的技巧
- 09.JPA的多种查询规则
- 第1章 DozerBeanMapper的使用
- 第2章 详解SKU的规格设计
- 第3章 通用泛型Converter
- 10.令牌与权限
- 第1章 通用泛型类与java泛型的思考
- 常见问题
- 微服务
- demo
- PHP中Self、Static和parent的区别
- Swoole-Cli
- 为什么要使用现代化PHP框架？
- 公众号
- 一键部署微信公众号Markdown编辑器（支持适配和主题设计）
- Autodesigner 2.0发布
- Luya 一个现代化PHP开发框架
- PHPZip - 创建、读取和管理 ZIP 文件的简单库
- 吊打Golang的PHP界天花板webman压测对比
- 简洁而强大的 YAML 解析库
- 推荐一个革命性的PHP测试框架：Kahlan
- ServBay下一代Web开发环境
- 基于Websocket和Canvas实现多人协作实时共享白板
- Apipost预执行脚本如何调用外部PHP语言
- 认证和授权的安全令牌 Bearer Token
- Laradock PHP 的 Docker 完整本地开发环境
- 高效接口防抖策略，确保数据安全，避免重复提交的终极解决方案！
- TIOBE 6月榜单：PHP稳步前行，编程语言生态的微妙变化
- Aho-Corasick字符串匹配算法的实现
- Redis键空间通知 Keyspace Notification 事件订阅
- ServBay如何启用并运行Webman项目
- 使用mpdf实现导出pdf文件功能
- Medoo 轻量级PHP数据库框架
- 在PHP中编写和运行单元测试
- 9 PHP运行时基准性能测试
- QR码生成器在PHP中的源代码
- 使用Gogs极易搭建的自助Git服务
- Gitea
- webman如何记录SQL到日志？
- Sentry PHP: 实时监测并处理PHP应用程序中的错误
- Swoole v6 Alpha 版本已发布
- Proxypin
- Rust实现的Redis内存数据库发布
- PHP 8.4.0 Alpha 1 测试版本发布
- 121
- Golang + Vue 开发的开源轻量 Linux 服务器运维管理面板
- 内网穿透 FRP VS Tailscale
- 新一代开源代码托管平台Gitea
- 微服务系列
- Nacos云原生配置中心介绍与使用
- 轻量级的开源高性能事件库libevent
- 国密算法
- 国密算法（商用密码）
- GmSSL 支持国密SM2/SM3/SM4/SM9/SSL 密码工具箱
- GmSSL PHP 使用
- 数据库
- SQLite数据库的Web管理工具
- 阿里巴巴MySQL数据库强制规范
- PHP
- PHP安全测试秘密武器 PHPGGC
- 使用declare（strict_types=1）来获得更健壮的PHP代码
- PHP中的魔术常量
- OSS 直传阿里腾讯示例
- PHP源码编译安装APCu扩展实现数据缓存
- BI性能DuckDB数据管理系统
- 为什么别人可以是架构师！而我却不是？
- 密码还在用 MD5 加盐？不如试试 password_hash
- Elasticsearch 在电商领域的应用与实践
- Cron 定时任务入门
- 如何动态设置定时任务！而不是写死在Linux Crontab
- Elasticsearch的四种查询方式，你知道多少？
- Meilisearch vs Elasticsearch
- OpenSearch vs Elasticsearch
- Emlog 轻量级开源博客及建站系统
- 现代化PHP原生协程引擎 PRipple
- 使用Zephir编写C扩展将PHP源代码编译加密
- 如何将PHP源代码编译加密，同时保证代码能正常的运行
- 为什么选择Zephir给PHP编写动态扩展库？
- 使用 PHP + XlsWriter实现百万级数据导入导出
- Rust编写PHP扩展
- 阿里云盘开放平台对接进行文件同步
- 如何构建自己的PHP静态可执行文件
- IM后端架构
- RESTful设计方法和规范
- PHP编译器BPC 7.3 发布,成功编译ThinkPHP8
- 高性能的配置管理扩展 Yaconf
- PHP实现雪花算法库 Snowflake
- PHP官方现代化核心加密库Sodium
- pie
- 现代化、精简、非阻塞PHP标准库PSL
- PHP泛型和集合
- 手把手教你正确使用 Composer包管理
- JWT双令牌认证实现无感Token自动续期
- 最先进PHP大模型深度学习库TransformersPHP
- PHP如何启用 FFI 扩展
- PHP超集语言PXP
- 低延迟双向实时事件通信 Socket.IO
- PHP OOP中的继承和多态
- 强大的现代PHP高级调试工具Kint
- PHP基金会
- 基于webman+vue3高质量中后台框架SaiAdmin
- 开源免费的定时任务管理系统：Gocron
- 简单强大OCR工具EasyOCR在PHP中使用
- PHP代码抽象语法树工具PHP AST Viewer
- MySQL数据库管理工具PHPMyAdmin
- Rust编写的一款高性能多人代码编辑器Zed
- 超高性能PHP框架Workerman v5.0.0-beta.8 发布
- 高并发系列
- 入门介绍及安装
- Lua脚本开发 Hello World
- 执行流程与阶段详解
- Nginx Lua API 接口开发
- Lua模块开发
- OpenResty 高性能的正式原因
- 记一次查找 lua-resty-mysql 库 insert_id 的 bug
- 包管理工具OPM和LuaRocks使用
- 异步非阻塞HTTP客户端库 lua-resty-http
- Nginx 内置绑定变量
- Redis协程网络库 lua-resty-redis
- 动态HTML渲染库 lua-testy-template
- 单独的
- StackBlitz在线开发环境
- AI
- 基础概念
- 12312
- 基础镜像的坑
- 利用phpy实现 PHP 编写 Vision Transformer (ViT) 模型
- 语义化版本 2.0.0