💡 Kong侦听四个端口的请求,默认情况是

8000:此端口是Kong用来监听来自客户端的HTTP请求的,并将此请求转发到您的上游服务。这也是本教程中最主要用到的端口。

8443:此端口是Kong监听HTTP的请求的端口。该端口具有与8000端口类似的行为,但是它只监听HTTPS的请求,并不会产生转发行为。可以通过配置文件来禁用此端口。

8001:用于管理员对KONG进行配置的端口。

8444:用于管理员监听HTTPS请求的端口。

在本文中,我们将介绍Kong的路由功能,并详细说明8000端口上的客户端请求如何根据请求头、URI或HTTP被代理到配置中的上游服务。

入门示例

先做一个最简单的转发。当访问8000端口时,自动转发到http://api01.bitspaceman.com:8000/news/qihoo

1、先创建两个Service

  1. curl -i -X POST \
  2. --url http://localhost:8001/services/ \
  3. --data 'name=example-service' \
  4. --data 'url=http://api01.bitspaceman.com:8000/news/qihoo'
  5. curl -i -X POST \
  6. --url http://localhost:8001/services/ \
  7. --data 'name=163-service' \
  8. --data 'url=http://3g.163.com/touch/jsonp/sy/recommend'

2、然后,添加两个Route

  1. curl -i -X POST \
  2. --url http://localhost:8001/services/example-service/routes \
  3. --data 'hosts[]=news.com'
  4. curl -i -X POST \
  5. --url http://localhost:8001/services/163-service/routes \
  6. --data 'paths[]=/news' \
  7. --data 'hosts[]=news.com'

3、最后,访问一下:
代理详解 - 图1

根据hosts=news.com做转发
代理详解 - 图2

根据hosts=news.com和paths=/news做转发
原理,等同于Nginx的location。后面介绍下详细的用法。


hosts属性

可以设置多个host,像下面这样:

  1. $ curl -i -X POST http://localhost:8001/routes/ \
  2. -H 'Content-Type: application/json' \
  3. -d '{"hosts":["example.com", "foo-service.com"]}'
  4. $ curl -i -X POST http://localhost:8001/routes/ \
  5. -d 'hosts[]=example.com' \
  6. -d 'hosts[]=foo-service.com'

也可以使用通配符:

  1. {
  2. "hosts": ["*.example.com", "service.com"]
  3. }

paths属性

可以设置多个path:

  1. {
  2. "paths": ["/service", "/hello/world"]
  3. }

还可以使用正则表达式:

  1. {
  2. "paths": ["/users/\d+/profile", "/following"]
  3. }

给正则设置优先级:

  1. [
  2. {
  3. "paths": ["/status/\d+"],
  4. "regex_priority": 0
  5. },
  6. {
  7. "paths": ["/version/\d+/status/\d+"],
  8. "regex_priority": 6
  9. },
  10. {
  11. "paths": ["/version"],
  12. "regex_priority": 3
  13. },
  14. ]

优先级别如下:

1、/version
2、/version/\d+/status/\d+
3、/status/\d+

如何捕获正则分组?

如下面一个path:

  1. /version/(?<version>\d+)/users/(?<user>\S+)

支持这样一个请求:

  1. /version/1/users/john

还可以被插件使用:

  1. local router_matches = ngx.ctx.router_matches
  2. -- router_matches.uri_captures is:
  3. -- { "1", "john", version = "1", user = "john" }

Path添加字符的方式 ?

  1. $ curl -i -X POST http://localhost:8001/routes \
  2. --data-urlencode 'uris[]=/status/\d+'

preserve_host属性

当使用代理的时候,Kong的默认(false)是将上游请求的Host头设置为API的upstream_url属性的主机名。

  1. {
  2. "name": "my-api",
  3. "upstream_url": "http://my-api.com",
  4. "hosts": ["service.com"],
  5. }

客户端请kong的请求头:

  1. GET / HTTP/1.1
  2. Host: service.com

设置为falsekong将从upstream_url中提取主机名作为HOST的值去请求上游服务。

  1. GET / HTTP/1.1
  2. Host: my-api.com

设置为true,客户端请求的HOST通过kong透传到上游服务,而不是从upstream_url提取。

  1. GET / HTTP/1.1
  2. Host: service.com

strip_uri属性

指定uri前缀去匹配一个API,但是不包含在上游的请求中。这个参数接收一个boolean的值。

uris strip_uri 客户端请求 上游请求
/mockbin false /some_path not proxied
/mockbin false /mockbin /mockbin
/mockbin false /mockbin/some_path /mockbin/some_path
/mockbin true /some_path not proxied
/mockbin true /mockbin /
/mockbin true /mockbin/some_path /some_path

method属性

就是GET、POST、PUT、DELETE等等,不多说了。