写点什么

OpenResty 入门

用户头像
捉虫大师
关注
发布于: 2021 年 05 月 31 日

本文已收录 https://github.com/lkxiaolou/lkxiaolou 欢迎 star。

OpenResty 介绍

OpenResty 通过汇聚各种设计精良的 Nginx 模块(主要由 OpenResty 团队自主开发),从而将 Nginx 有效地变成一个强大的通用 Web 应用平台。这样,Web 开发人员和系统工程师可以使用 Lua 脚本语言调动 Nginx 支持的各种 C 以及 Lua 模块,快速构造出足以胜任 10K 乃至 1000K 以上单机并发连接的高性能 Web 应用系统。OpenResty 的目标是让你的 Web 服务直接跑在 Nginx 服务内部,充分利用 Nginx 的非阻塞 I/O 模型,不仅仅对 HTTP 客户端请求,甚至于对远程后端诸如 MySQL、PostgreSQL、Memcached 以及 Redis 等都进行一致的高性能响应。

OpenResty 安装

可参考 http://openresty.org/en/linux-packages.html


以 centos 为例:


  • wget https://openresty.org/package/centos/openresty.repo

  • mv openresty.repo /etc/yum.repos.d/

  • yum check-update

  • yum install openresty

hello world 程序

  • mkdir -p /home/roshi/opensty/conf /home/roshi/opensty/logs

  • 写个输出”hello world“的配置


worker_processes  1;error_log logs/error.log;events {    worker_connections 1024;}
http { server { listen 6699; location / { default_type text/html;

content_by_lua_block { ngx.say("HelloWorld") } } }}
复制代码


  • 运行用上述的安装方式,nginx 会安装在/usr/local/openresty目录,执行


/usr/local/openresty/nginx/sbin/nginx -p /home/roshi/openresty -c /home/roshi/openresty/conf/nginx.conf
复制代码


  • 测试


curl http://127.0.0.1:6699
复制代码


处理流程

OpenResty 处理一个请求,它的处理流程参考如下图


实战

nginx 最常用的是反向代理功能,例如通过 URL 上的特征将同一个域名下的请求按照规则分发给不同的后端集群,举个例子:


http://example.com/user/1http://example.com/product/1


是同个域名下的两个请求,他们分别对应用户与商品,后端提供服务的集群很可能是拆分的,这种情况使用 nginx 就可以很容易地分流;


但如果这个分流的特征不在 header 或者 URL 上,比如在 post 请求的 body 体中,nginx 原生就没法支持,此时可以借助 OpenResty 的 lua 脚本来实现。


我就遇到过这样一个需求,同样的请求需要路由到不同的集群处理,但特征无法通过 header 或者 URL 来区分,因为在前期的设计中,不需要区分;这个请求可以处理单个的请求,也可以处理批量的情况,现在批量的请求性能不如人意,需要一个新集群来处理,抽象为以下请求


curl -X "POST" -d '{"uids":[1,2]}' -H "Content-Type:application/json" 'http://127.0.0.1:6699/post'
复制代码


期望分离当 body 体中 uids 是多个和单个的请求,当 uids 只有 1 个 uid 时请求路由到后端 A,uids 中 uid 数量大于 1 时路由到后端 B


在之前的 nginx.conf 基础上修改


worker_processes  1;error_log logs/error.log info;events {    worker_connections 1024;}
http { upstream single.uid { server host.docker.internal:8888; } upstream multiple.uids { server host.docker.internal:9999; }
server { listen 6699; location / { default_type application/json; # default upstream set $upstream_name 'multiple.uids';
rewrite_by_lua_block {
cjson = require 'cjson.safe' ngx.req.read_body() local body = ngx.req.get_body_data() if body then ngx.log(ngx.INFO, "body=" .. body) local data = cjson.decode(body)
if data and type(data) == "table" then local count = 0 for k,v in pairs(data["uids"]) do count = count + 1 end
ngx.log(ngx.INFO, "count = " .. count)
if count == 1 then ngx.var.upstream_name = "single.uid" end end end } proxy_pass http://$upstream_name; } }}
复制代码


  • 第二行将日志级别调整为 info,方便调试观察

  • 定义两个 upstream,对应不同的后端,由于我的 openresty 在 docker 容器中,后端服务在物理机中,所有这里使用了 host.docker.internal 代替后端 ip

  • 使用 rewrite_by_lua_block(可以对照上文中的处理流程图)

  • 使用 cjson 来解析 body,判断 uids 中的数量,这段都是 lua 代码,注意 lua 代码和 nginx 配置的语法是不一样的,lua 中获取 nginx 的变量使用 ngx.var.upstream_name


后端代码这里也贴一下,使用 golang 编写,用到了 echo 框架


package main
import ( "github.com/labstack/echo/v4" "github.com/labstack/echo/v4/middleware" "os" "strconv")
type Response struct { Success bool `json:"success"` Message string `json:"message"` Port int `json:"port"` Uids []int `json:"uids"`}
type Request struct { Uids []int `json:"uids"`}
var port = 8888
func main() {
e := echo.New() e.Use(middleware.Logger()) e.Use(middleware.Recover())
e.POST("/post", post)
if len(os.Args) >= 2 { p, err := strconv.Atoi(os.Args[1]) if err == nil { port = p } } e.Logger.Fatal(e.Start(":"+strconv.Itoa(port)))}
func post(c echo.Context) error { req := Request{} err := c.Bind(&req) if err != nil { c.JSON(500, Response{ Success: false, Port: port, Message: "bind body error", }) return err } response := Response{ Success: true, Port: port, } for _, uid := range req.Uids { response.Uids = append(response.Uids, uid + 100) } c.JSON(200, response) return nil}
复制代码


分别监听在 8888 和 9999 端口,运行后,请求 6699 端口(nginx 监听)观察



同时,在日志/home/roshi/openresty/logs/error.log中也能看到


最后

本文从安装,基本原理上简单介绍了 OpenResty,并从一个实际的例子展示了 OpenResty 的能力,希望看完的你也能入门 OpenResty。




搜索关注微信公众号"捉虫大师",后端技术分享,架构设计、性能优化、源码阅读、问题排查、踩坑实践。



发布于: 2021 年 05 月 31 日阅读数: 22
用户头像

捉虫大师

关注

还未添加个人签名 2018.09.19 加入

欢迎关注我的公众号“捉虫大师”

评论

发布
暂无评论
OpenResty入门