前言：统一网关apisix自带插件不符合现有业务逻辑时，自定义开发插件可能会选择lua开发。而apisix是基于OpenResty构建的，即开发/Debug时需要OpenResty环境。

OpenResty简介

OpenResty（也称为ngx_openresty）是一个基于Nginx的全功能Web应用服务器，它通过集成了许多第三方模块和库，为Nginx提供了更多功能和扩展性。OpenResty使得开发人员能够使用Lua编程语言来扩展Nginx服务器的功能，从而更灵活地构建高性能的Web应用程序和服务。

以下是OpenResty的一些主要特点和组成部分：

• Nginx核心： OpenResty使用Nginx作为底层服务器，继承了Nginx的高性能和可扩展性。Nginx是一个轻量级、高性能的Web服务器和反向代理服务器，广泛用于构建高流量的网站和应用。

• Lua支持： OpenResty集成了Lua编程语言，允许开发人员通过Lua脚本扩展和定制Nginx的功能。Lua是一种轻量级、高效的脚本语言，它可以用于处理请求、响应、路由、访问控制等各种服务器端任务。

• 第三方模块和库： OpenResty提供了丰富的第三方模块和库，用于扩展Nginx的功能。这些模块可以处理缓存、认证、请求处理、流量控制、WebSockets等多种任务。

• 高性能代理： OpenResty支持高性能的反向代理，能够有效地负载均衡和处理大量的并发请求。

• Lua脚本控制： 使用Lua脚本，可以动态地配置Nginx，使得开发人员能够在请求处理阶段执行自定义逻辑。这可以用于构建复杂的应用逻辑和路由规则。

• 缓存和加速： OpenResty具有强大的缓存和加速功能，可以缓存静态内容，减轻后端服务器的负担，提高响应速度。

• WebSockets支持： OpenResty支持处理WebSockets协议，使得构建实时通信的应用变得更加简单。

• 动态模块加载： OpenResty支持动态地加载和卸载模块，不需要重新编译或重启服务器。

• 总之，OpenResty是一个强大的服务器平台，它将Nginx和Lua集成在一起，提供了高性能、灵活性和扩展性，适用于构建高性能的Web应用程序和服务。

OpenResty环境搭建：

###1.环境准备

• openresty下载：https://github.com/openresty/openresty/releasesDownload zip包 解压到windows使用目录即可

• 目录结构如下：
  
  

•  

• openresty框架中，支持直接在location中运行lua代码块/在location中定位.lua文件，两种方式的使用方法参考：openresty快速入门

2.运行方式

• 访问ip+port+path
  eg：localhost:9099/discovery

IDEA环境搭建：

1.环境准备:

• idea 插件安装: EmmyLua,Nginx Support
• 大致思路:配置nginx_server(即openresty路径下nginx) 在idea上编写lua脚本，通过ant将代码及配置文件复制到openresty路径下

2.环境配置

1.创建maven工程:
2.配置nginx为openresty的nginx的启动文件

3.配置ant:
注:此处主要复制lua脚本到openresty路径下。

build.xml文件如下

<?xml version="1.0" encoding="UTF-8"?>
<!-- 项目路径 -->
<project name="openResty" default="copy" basedir="E:\work\openresty-1.21.4.2-win64">
    <description>
        run nginx-server
    </description>
    <!-- set global properties for this build -->
    <property name="openresty-home" location="E:\work\openresty-demo\src"/>
    <property name="resource-path" location="${openresty-home}/${ant.project.name}"/>
    <property name="target-src" location="${basedir}/lua"/>

    <target name="clean" depends="">
        <echo>清理openresty目录 ${dist}下的conf,logs,janus,januslib</echo>
        <delete file="${target-src}\discovery.lua"/>
        <delete file="${target-src}\nacos.lua"/>
        <delete file="${target-src}\test.lua"/>
    </target>
	
    <target name="copy"  description="generate the distribution" >
        <echo>复制安装文件</echo>
        <copy todir="${target-src}">
            <fileset dir="${openresty-home}"></fileset>
        </copy>
    </target>

</project>

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16
• 17
• 18
• 19
• 20
• 21
• 22
• 23
• 24
• 25
• 26

4.ant配置build.xml

5.将ant插件与nginx插件关联起来:

6.配置nginx 日志路径，以便在idea控制台查看

3.运行方式

1.手动执行ant命令，查看效果，正常情况下可以看到idea src目录下代码被copy到lua路径下

2.访问ip+port+path
eg：localhost:9099/discovery

3.在本地开发时，只需重启nginx服务，再重新访问步骤2的地址即可。

idea+openresty+lua开发环境搭建_idea openresty-CSDN博客

vscode lua插件_OpenResty(lua) 调试-CSDN博客

luaIde 调试openresty

调试视频 提取码:o3rk

1.创建一个项目 如果已存在项目忽略

 

2.项目中创建src目录

1.  
   (src目录可是任意名字 示例中将src放入根目录中,您也可以放到其他目录,src目录为lua脚本根目录)
2.  
   如果已存在项目忽略

 

3.配置项目

 

前三步可以忽略根据自己的项目来定即可.

4.用vscode 打开项目文件夹 示例中的项目文件夹为openresty_test

5.打开一个lua文件以启动luaide插件(演示中没有lua文件,所以创建一个文件 test.lua)

6.根据提示将调试文件拷贝到src目录中

1.  
   选择LuaDebugOpenrestyJit 后缀选择.lua
2.  
   由于luaide支持多种lua框架的调试所以会有很多不同的后缀名,openresty 选择.lua即可
3.  
   这一步操作后 LuaDebugOpenrestyJit.lua 拷贝到src 下

 

 

 

 

 

 

7.点击vscode左侧luaide按钮选择[打开luaide最新调试文件所在文件夹]

 

 

1.  
   linux 找到socketLibOpenRestylinux目录下的 socket.so 拷贝到openresty_test(项目根目录)
2.  
   mac 找到socketLibOpenRestymac目录下的 socket.so 拷贝到openresty_test(项目根目录)
3.  
   windows 找到socketLibOpenRestywindows目录下的 socket.so 拷贝到openresty_testlualib(项目根目录lualib)

8.在luaide配置中设置脚本根目录 选择settings(中文为设置)

1.  
   搜索luaide.scriptRoots 并进行设置 然后重启vscode
2.  
   这里注意vscode 的设置配置分为
3.  
   1.用户设置
4.  
   2.工作空间设置 示例中添加到了 工作空间设置 设置后重启vscode f1 reloadwindow
5.  
   3.文件夹设置
6.  
   修改配置后重启vscode f1 reload window

 

9.添加调试代码以启动调试

 

10.添加调试配置

 

 

 

 

11.启动调试 nginx -p pwd/ -c conf/nginx.conf (启动调试根据自己项目情况自行启动.这里只是演示)

12.访问页面

 

调试演示结束!

 

worker_processes  1;
events {
    worker_connections  1024;
}
http {
    lua_package_path '<ZBS>/lualibs/?/?.lua;<ZBS>/lualibs/?.lua;;';
    lua_package_cpath '<ZBS>/bin/clibs/?.dll;;';
    server {
        location /hellolua {
           default_type 'text/plain';
           content_by_lua_file 'lua/content.lua';
        }
    }
}

require('mobdebug').start('192.168.1.22')
local name = ngx.var.arg_name or "Anonymous"
ngx.say("Hello, ", name, "!")
ngx.say("Done debugging.")
require('mobdebug').done()

./
content.lua
mobdebug.lua
socket.lua

必须将源码的根目录设置为 Sources 目录。

具体做法是打开菜单 File -> Project Structure 打开 Project Structure 设置面板，点击右侧的 Add Content Root 来添加你的源码根目录，然后点击 Mark as Sources 标记。

require("lualib.mobdebug").start("127.0.0.1", 8172)

./bin/apisix start

{
    "id": "1",
    "update_time": 1611044949,
    "uri": "/foo/*",
    "status": 1,
    "priority": 0,
    "plugins": {},
    "upstream": {
        "nodes": {
            "127.0.0.1:1980": 2,
            "127.0.0.1:1981": 1
        },
        "type": "roundrobin"
    },
    "create_time": 1611044129
}

curl 127.0.0.1:9080/foo/1

local ok, err = balancer.set_current_peer(server.host, server.port)