Nginx配置location进行接口转发

需求描述

story

微服务架构
项目上使用的是Spring Cloud微服务框架开发,熟悉微服务的同学应该知道，微服务将对功能模块进行了切分，模块与模块之间可以通过注册中心进行服务调用，也可以直接发起RESTFUL风格的HTTP请求进行API调用。
跨语言的服务之间进行交互
微服务还有一个比较关键的特点是，对于每个模块，是不限定语言开发的，举个例子:一个商城系统，后台管理服务可以使用php进行开发，库存系统可以使用java进行开发。这个时候，你可以通过负载或者网关进行转发
技术选型:http OR Nginx
在注册中心获取不到另一个服务的注册信息的时候，我们可以通过后端进行HTTP请求转发来访问另一个服务的接口,但是这会带来一个问题，就是前端先访问了后端，后端去访问了另一个服务，这就可能存在性能问题，尤其是请求较多的接口，这样频繁地转发接口显然是不好的。
Nginx支持对请求路径进行匹配与映射，并将这部分的接口请求分发到相应的端口进行响应。一次请求即可，相比http请求，少了一次请求转发。

使用Nginx配置location进行接口转发

生产环境中，用户首先访问网站的域名，然后由Nginx监听80端口对请求进行转发。

例如用户发起以下请求查询汇率数据:
http://[WEB_DOMAIN]/api/v1/runtime/exchange
经过Nginx处理后到达服务端的请求则是这样的:
http://[host:port]/v1/runtime/exchange
这个请求再经过微服务的网关，找到runtime服务，就会访问路由为/exchange的接口。
了解了这个后，我们来处理需求。

约定

跟coupons服务接口侧商定，所有关于coupons服务的接口均采用applcationCode和coupons参数进行路由映射.
举个例子:该服务部署在192.168.31.2下的8085端口，提供了一个查询接口，那么应该是这种规则:

http://192.168.31.2:8085/runtime/coupons/data

此时，前端依然保持系统原有风格进行api调用:

http://www.baidu.com/api/v1/runtime/coupons/data

那么如何实现访问http://www.baidu.com/api/v1/runtime/coupons/data跳转到http://192.168.31.2:8085/runtime/coupons/data呢?

Nginx配置:

proxy_params

index  index.html index.htm;
proxy_connect_timeout 3000s;
proxy_send_timeout 3000s;
proxy_read_timeout 3000s;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
proxy_http_version 1.1;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header Host $host;
client_max_body_size    100m;

*.conf

server
{
    ## 监听80端口
    listen 80;
    ## 访问域名 WEB_DOMAIN为具体的域名，如:www.baidu.com
    server_name WEB_DOMAIN;
    index index.html index.htm;
    ## 匹配 路径中包含 /api/v1 的请求，并且/api/v1/后存在runtime或者workbench，将这些请求转发到具体的proxy_pass中
    location ~ ^/api/v1/(runtime|workbench)/coupons/ {
        ## 引入proxy_params文件的配置信息
        include    proxy_params;
        ## 代理转发地址,具体的 host 和 post 自己指定
        proxy_pass http://host:port;
        ## 重写,转发前，将url中的某些参数进行过滤
        rewrite ^/api/v1/(.*)$ /$1 break;
    }
    ## 日志
    access_log logs/*.log;
}

重置Nginx配置
找到nginx的安装目录的sbin

shell> cd sbin
shell> ./nginx -s reload

这样，就可以使用nginx对coupons服务接口进行转发了

最后编辑于：2020.12.20 23:18:56