Kong网关开发环境搭建与插件开发指南-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00424/article/details/148325335

Kong网关开发环境搭建与插件开发指南

kong Kong是一款高性能的开源API网关，支持多种协议和插件，能够实现API路由、认证、限流等功能，助力企业构建灵活、安全且可扩展的API架构。项目地址: https://gitcode.com/gh_mirrors/ko/kong

前言

Kong作为一款开源的API网关和微服务管理平台，其强大的可扩展性和丰富的插件生态吸引了众多开发者。本文将详细介绍如何搭建Kong的开发环境，包括从源码构建、测试环境配置到插件开发的完整流程，帮助开发者快速上手Kong的二次开发工作。

开发环境准备

基础环境要求

在开始Kong开发前，需要准备以下基础环境：

操作系统：推荐使用Linux系统（Ubuntu/Debian或Fedora/RHEL），macOS也可作为开发环境
硬件配置：建议至少8GB内存和多核CPU，特别是使用虚拟机时
基础工具链：Git、Make、GCC等编译工具

依赖安装

不同操作系统需要安装的依赖有所不同：

Ubuntu/Debian系统

sudo apt update && sudo apt install -y \
    automake build-essential curl file git \
    libyaml-dev libprotobuf-dev m4 perl \
    pkg-config procps unzip valgrind zlib1g-dev

Fedora/RHEL系统

dnf install automake gcc gcc-c++ git libyaml-devel \
    make patch perl perl-IPC-Cmd protobuf-devel \
    unzip valgrind valgrind-devel zlib-devel

macOS系统

# 安装Xcode（App Store）
# 安装Homebrew
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
# 安装依赖
brew install libyaml

源码构建与运行

获取源码

git clone https://github.com/Kong/kong
cd kong
git checkout master  # 切换到主分支

构建虚拟环境

Kong使用Bazel构建系统来管理开发环境：

make build-venv

构建完成后，激活虚拟环境：

# Bash/Zsh用户
. bazel-bin/build/kong-dev-venv.sh
# Fish Shell用户
. bazel-bin/build/kong-dev-venv.fish

启动依赖服务

Kong依赖PostgreSQL、Cassandra等数据库服务，可以使用预定义的docker-compose配置快速启动：

start_services  # 启动依赖服务

运行Kong

kong start  # 启动Kong
kong stop   # 停止Kong
deactivate  # 退出虚拟环境

插件开发指南

插件开发工具链

Kong提供了完善的插件开发工具链：

Pongo：专为插件开发设计的CLI工具，基于docker-compose创建包含所有依赖的本地测试环境
插件模板：官方提供的标准插件模板，包含最佳实践的文件结构、配置文件和CI设置

创建新插件

建议从官方插件模板开始开发，它提供了：

标准的Lua模块结构
必要的配置文件（.rockspec, .travis.yml等）
测试框架集成
文档模板

开发环境配置

在开发模式下，Kong会自动将当前目录添加到Lua文件搜索路径中。也可以通过修改以下Nginx指令来指定插件路径：

lua_package_path：指定Lua模块搜索路径
lua_package_cpath：指定Lua C模块搜索路径

测试与质量保证

测试框架

Kong使用Busted作为测试框架，测试分为三类：

单元测试：不依赖外部服务的基础测试
```
make test
```
集成测试：需要PostgreSQL和Cassandra服务
```
make test-integration
```
插件测试：需要PostgreSQL服务
```
make test-plugins
```

静态代码分析

使用Luacheck进行静态代码检查：

make lint

升级测试

Kong的升级机制需要特殊测试验证：

测试新旧版本并存时的兼容性
验证数据库迁移脚本的正确性
测试位于spec/05-migration/目录下

混合模式开发环境

Kong支持控制平面(CP)和数据平面(DP)分离的混合部署模式：

生成证书密钥对
创建CP和DP配置文件（如kong-cp.conf和kong-dp.conf）
分别配置并启动CP和DP节点
使用不同前缀区分服务目录

# 启动控制平面
kong start -c kong-cp.conf
# 启动数据平面
kong start -c kong-dp.conf

开发技巧与最佳实践

Makefile常用命令：
- make dev：安装开发依赖
- make install：全局安装Kong的Luarock
- make test-all：运行所有测试
调试建议：
- 使用Valgrind进行内存调试
- 利用Kong的详细日志模式
- 在测试环境中使用小规模数据集
性能优化：
- 关注插件性能热点
- 合理使用缓存机制
- 避免阻塞操作