新秀网关Apache-APISIX 插件 proxy-rewrite

一、概述

proxy-rewrite 官方的定义是上游代理信息重写插件（请求方是下游，服务方是上游）。

举个例子就是你的应用服务（用于认证的）接口各式各样的REST API，我现在就可以通过proxy-rewrite 插件给他们统一加一个前缀auth来方便管理和使用而你应用代码不需要任何改变。以前访问你应用使用/sso/check api，现在就是/auth/sso/check api了，而这个转换过程就是proxy-rewrite的功能了。

这里是官方的介绍：https://github.com/apache/incubator-apisix/blob/master/doc/zh-cn/plugins/proxy-rewrite.md

官方主要以REST接口形式来说明的，这里主要说下页面配置。

二、使用

参数概念

这个插件有如下四个参数：

• scheme 就是选择下访问你上游服务的协议是HTTP还是HTTPS
• uri 表示转发到哪个REST API 上
• regex_uri 有两个参数，第一个使用正则匹配你请求的API，第二个参数 是在匹配成功时转发到哪个REST API上
• host 转发到上游的新 host 地址，例如：iresty.com
• headers 转发请求的时候可以设置下header内容。如果想要删除某个 header 的话，把对应的值设置为空字符串即可。

示例

1、创建Upstream

这个就是你上游服务配置,它根据配置规则在给定的一组服务节点上执行负载平衡

2、创建Service

创建个Service,为上游服务提供了抽象，都是在router使用的，里面配置了服务的upstream。

3、创建个Route

可以看到，这里我们使用了service。注意，如果你在router同时配置了upstream 和service,会使用upstream的配置。

4、编写测试类

@RestController
@RequestMapping("/check")
@CrossOrigin
public class CheckController {

    /**
     * 获取基础信息 /check/getIp 
     * @param request
     * @return
     */
    @RequestMapping("/getIp")
    public String getIp(HttpServletRequest request) {
        Map<String, Object> datas = new HashMap<>(16);
        datas.put("OsName", OSUtil.getOsName());
        datas.put("ProcessNo", OSUtil.getProcessNo());
        datas.put("RealIp", OSUtil.getRealIp(request));
        datas.put("HostName", OSUtil.getHostName());
        datas.put("x-forwarded-for", request.getHeader("x-forwarded-for") == null ? "No x-forwarded-for" : request.getHeader("x-forwarded-for")
        );

        return JSON.toJSONString(datas);
    }

    /**
     * 默认返回 /check/def
     * @return
     */
    @RequestMapping("/def")
    public String def() {

        return "this is def msg";
    }

    /**
     * 转发请求 /check/rewrite/getIp
     * @return
     */
    @RequestMapping("/rewrite/getIp")
    public String rewrite() {

        return "我被转发到这里了 /rewrite/getIp， cat:"+request.getHeader("cat");
    }
}

这时候我调用接口 check/getIp 返回如下信息：

{"ProcessNo":89159,"OsName":"Mac OS X","x-forwarded-for":"172.21.13.65, 172.21.13.68","HostName":"luqiangdeMacBook-Pro.local","RealIp":"172.21.13.65"}

这时候我添加插件

5、添加插件 proxy-rewrite

点击添加插件，选择proxy-rewrite，填写请求转发

这时候在调用 check/getIp ,返回如下信息：

我被转发到这里了 /rewrite/getIp， cat:123

这时其实就是将/check/getIp 的请求转发到了 /check/rewrite/getIp 上。

当然我们还可以使用另一种方式，入配置了uri参数，会优先使用uri的配置

这时候在调用 check/getIp ,返回如下信息：
this is def msg

6、给请求添加统一的前缀

上面的例子就是给某一个接口进行转发，但如果要像开始说的给我的应用增加一个公共的前缀路径

这时我访问/matrix/check/getIp 接口，就会返回如下数据：

{"ProcessNo":89332,"OsName":"Mac OS X","x-forwarded-for":"172.21.13.65, 172.21.13.68","HostName":"luqiangdeMacBook-Pro.local","RealIp":"172.21.13.65"}

完美的对我们的请求进行了转发。

三、总结

• 1、proxy-rewrite 插件可以针对我们的请求进行各种策略的转发。
• 2、要记住 regex_uri 和 uri是互斥的，一起配置后regex_uri 是无效的。
• 3、可以从regex_uri 第一个参数中提取数据用于第二个参数
• 4、proxy rewrite 插件也支持REST API的形式
• 5、可以通过proxy rewrite 插件 增加公共的header