更便利、更清晰——API网关接管你的Nginx服务

原创

克莱尔小熊

发布于 2021-12-26 21:47:58

2.4K0

发布于 2021-12-26 21:47:58

文章被收录于专栏：API网关

API网关作为腾讯云中间件的接入层，路由转发是API网关的核心能力。使用API网关接管Nginx服务，能够降低Nginx配置管理的难度，简化路由定义方式，同时能拥有API网关众多的插件能力。本文介绍API网关对Nginx配置的支持，以及相应的迁移方案。

一、API网关——路由转发的核心产品

API 网关是用于实现完整 API 托管的服务，用于协助开发者轻松完成 API 的创建、维护、发布、监控等整个生命周期的管理。通过 API 网关，可以封装后端各种服务，以 API 的形式，提供给各方使用。同时，API 网关协助您完成 API 文档管理、API 测试和 SDK 生成等。

路由转发是API网关的核心能力，目前在 API 网关中可创建五种后端类型的 API，其中后端对接公网 URL/IP、VPC、SCF、Mock 的 API 统称为通用 API，后端对接 TSF 的 API 称为微服务API。通过定义API的前后端配置，能够将访问API的请求转发到对应的后端服务上。同时，API网关支持多种类型的插件，通过绑定插件，能够在API转发过程中对请求和响应进行修改，实现更多元的业务需要。

二、Nginx服务，如何迁移到API网关？

Nginx是lgor Sysoev为俄罗斯访问量第二的rambler.ru站点设计开发的。从2004年发布至今，凭借开源的力量，已经接近成熟与完善。

Nginx功能丰富，可作为HTTP服务器，也可作为反向代理服务器，邮件服务器。支持FastCGI、SSL、Virtual Host、URL Rewrite、Gzip等功能。并且支持很多第三方的模块扩展。

Nginx的稳定性、功能集、示例配置文件和低系统资源的消耗让他后来居上，在全球活跃的网站中有12.18%的使用比率，大约为2220万个网站。

但是，Nginx配置较为繁琐，在路由较为复杂的场景下，Nginx配置的管理，会变成一件更加困难的事情，大大提升了运维成本。另外，对于一些通用的能力，需要对每条Nginx配置都进行更改才能将其应用在路由上，在使用上较为繁琐。因此，使用API网关替代Nginx实现路由转发，是一个很好的选择。

2.1 Nginx常用功能

Nginx常用功能有：反向代理，负载均衡、Web缓存等。

1）反向代理

作为web服务器最常用的功能之一，Nginx具有强大的反向代理能力。

Nginx在做反向代理时，提供性能稳定，并且能够提供配置灵活的转发功能。Nginx可以根据不同的正则匹配，采取不同的转发策略，比如图片文件结尾的走文件服务器，动态页面走web服务器，只要你正则写的没问题，又有相对应的服务器解决方案，你就可以随心所欲的玩。并且Nginx对返回结果进行错误页跳转，异常判断等。如果被分发的服务器存在异常，他可以将请求重新转发给另外一台服务器，然后自动去除异常服务器。

2）负载均衡

Nginx提供的负载均衡策略有2种：内置策略和扩展策略。内置策略为轮询，加权轮询，Ip hash。

3）web缓存

Nginx可以对不同的文件做不同的缓存处理，配置灵活，并且支持FastCGI_Cache，主要用于对FastCGI的动态程序进行缓存。配合着第三方的ngx_cache_purge，对制定的URL缓存内容可以的进行增删管理。

2.2 Nginx主要配置

Nginx的配置主要分为几大类：

1、全局块：配置影响nginx全局的指令。一般有运行nginx服务器的用户组，nginx进程pid存放路径，日志存放路径，配置文件引入，允许生成worker process数等。

2、events块：配置影响nginx服务器或与用户的网络连接。有每个进程的最大连接数，选取哪种事件驱动模型处理连接请求，是否允许同时接受多个网路连接，开启多个网络连接序列化等。

3、http块：可以嵌套多个server，配置代理，缓存，日志定义等绝大多数功能和第三方模块的配置。如文件引入，mime-type定义，日志自定义，是否使用sendfile传输文件，连接超时时间，单连接请求数等。

4、server块 ：配置虚拟主机的相关参数，一个http中可以有多个server。

5、location块：配置请求的路由，以及各种页面的处理情况。

2.3 API网关对Nginx HTTP模块的支持

由于Nginx的main模块和events模块主要为Nginx系统配置，用户配置主要在http模块。

API网关支持大多数Nginx用户配置，总体来说，映射关系如下：

upstream：可通过网关后端通道实现。
server：可通过API网关Service实现。
location：可通过API网关API实现。

1 http模块

Nginx的http模块，主要负责HTTP服务器相关属性的配置，包含server和upstream子模块。

具体说明如下：

http {     
    include mime.types; # 用来设定文件的mime类型,类型在配置文件目录下的mime.type文件定义，来告诉nginx来识别文件类型。     
    default_type application/octet-stream;      
     access_log /usr/local/var/log/nginx/access.log  main;
     sendfile on; # 用于开启高效文件传输模式。     
     tcp_nopush on; # 用于防止网络阻塞。     
     tcp_nodelay on; # 用于防止网络阻塞。     
     keepalive_timeout 10; # 设置客户端连接保持活动的超时时间，在超过这个时间之后，服务器会关闭该连接。     
     gzip on; # gzip 压缩，用来对静态资源进行压缩，需要客户端同时支持才有效。     
     gzip_disable "MSIE [1-6]\.(?!.*SV1)"; # IE6的某些版本对gzip的压缩支持很不好,故关闭。     
     gzip_http_version 1.0; # HTTP1.0以上的版本都启动gzip    
     gzip_types text/plain application/javascript application/x-javascript text/javascript text/css application/xml; # 指定哪些类型的相应才启用gzip压缩，多个用空格分隔     
     gzip_comp_level 5; # 压缩等级，可选1-9，值越大压缩时间越长压缩率越高，通常选2-5     
     upstream myproject {         .....     }     
     server {         ....     } }

网关替代方案：网关目前默认支持gzip压缩，固定压缩类型和压缩等级，后续专享实例支持部分参数自定义配置。

2 upstream模块

含义：Nginx upstream为后端服务提供简单的负载均衡。

upstream backend_name {
     server 192.168.12.1:80 weight=5;     
     server 192.168.12.2:80 down;     
     server 192.168.12.3:8080  max_fails=3  fail_timeout=20s;     
     server 192.168.12.4:8080; 
 }  
 
 server {
    location / {     
        proxy_pass  http://backend_name/;   
    }
 }

网关替代方案：后端通道（包括VPC通道和TKE通道）

Nginx配置	APIGW (VPC通道)
调度算法（默认轮询）	负载均衡算法（支持加权轮询）
server指令：指定后端服务器IP地址和端口	节点列表：定义后端的节点地址和端口
max_fails：允许请求失败的次数	重试次数：API网关请求节点失败的重试次数
fail_timeout：经历失败后暂停服务的时间	异常恢复时间

可以在控制台创建后端通道，具体配置可参考：

https://cloud.tencent.com/document/product/628/60271

https://cloud.tencent.com/document/product/628/64688

3 server模块

定义：Nginx server模块是http的子模块，用来定义一个虚拟主机，包含一些全局定义。

server {     
    listen      80; # 用于指定虚拟主机的服务端口。     
    server_name localhost www.example.com; # 用来指定IP地址或者域名，多个域名之间用空格分开。     
    root        /www/wwwroot/www.example.com; # 全局定义，表示在该server下web的根目录，注意要和locate {}下面定义的区分开来。     
    index       index.php index.html index.htm; # 全局定义访问的默认首页地址。     
    charset     utf-8; # 设置网页的默认编码格式。     
    access_log  logs/host.access.log  main; # 用来指定此虚拟主机的访问日志存放路径，输出格式为main。     
    error_log   logs/host.error.log  
    error; # 错误日志存放路径，输出格式为error。     
    error_page  404  /404.html; # 状态码为404时的时候的网页地址,还可定义500,502之类的     
    .... 
}

网关替代方案：service。网关的服务是一组API的集合，包含一个独立的域名，可用作虚拟主机。

Nginx配置	API网关
listen虚拟主机服务端口	网关默认域名，开80/443端口
server_name指定域名	网关服务自定义域名，一个服务可绑定5个自定义域名
index全局定义访问的默认首页地址	可通过配置/，指定默认访问地址

可以在控制台创建后端通道，具体配置可参考：

https://cloud.tencent.com/document/product/628/11787

location

定义： Server中的location用来定位URL和解析URL。

location /api {
     proxy_pass  http://192.168.0.1; #请求转向地址192.168.0.1     #不修改被代理服务器返回的响应头中的location头       
     proxy_set_header Host $host;     
     proxy_set_header X-Real-IP $remote_addr;     
     proxy_set_header X-Forwarded-For 
     $proxy_add_x_forwarded_for; 
 }

网关替代方案：api。网关的API包含前端配置和后端配置。

Nginx 配置	APIGW
/uri	API前端配置（路径）,路径支持正则表达式方式匹配。
proxy_pass	API后端URL
proxy_set_header	API参数配置（支持Header, Query, Path位置的参数，可设置默认值）
rewrite实现URL重写（替换正则匹配的内容）