修订记录
版本 | 修订人 | 修订内容 | 修订日期 |
---|---|---|---|
V1.0 | 王旭 | 创建文档 | 2023-08-29 |
前言:统一网关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>
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的地址即可。