背景
团队中做一个项目，使用Django开发多个应用，如app1、app2等，均采用docker镜像部署到k8s环境中，整体架构为：
用户client => nginx反向代理路由分发 => app1/app2/app3/...
常规处理方案：
- 使用3个域名，如a.com.cn表示访问app1，b.com.cn表示访问app2，c.com.cn表示app3，且这3个域名都指向同一IP地址IP_ABC。
- 当nginx接收到这3个域名请求后，会根据nginx配置中server_name进行匹配，然后直接代理proxy_pass到app1或app2或app3的地址上。
- nginx 的app1简单示例如下：
server {
listen 80 ;
server_name a.com.cn;
location / {
proxy_pass http://app1_addr:app1_port/;
}
}
此种方案简单清晰，对于api接口及静态页面（如django中的admin管理台页面）不会产生任何问题，因为一个app对应一个域名，从逻辑上看是一对一的访问，app之间互相隔离。
问题源起及解决思路
- 当app逐渐增多时，域名数量随之增多，虽然都部署在同一个k8s集群命名空间中。域名管理起来费事。
- 当app经常会变化时，除了修改nginx代理配置外，还得与调用端（可能是其它外部系统）一同修改，调用端配置起来也麻烦。
有了这些问题，那么我们就尝试用url前缀去识别路由分发，实现通过url前缀进行反向代理，而不是通过域名去反向代理。
比如/A/xxx这种url就路由到app1，/B/xxx这种url就路由到app2，依次类推。
刚开始配置还是很简单的，nginx配置如下：
server {
listen 80 ;
server_name abc.com.cn; //统一的一个域名
location ^~ /A/ {
proxy_pass http://app1_addr:app1_port/;
}
** app2和app3的照着上面/A/的配置修改下。**
}
此配置大概意思是当匹配到带/A/这种前缀的url时，就将请求路由到app1_addr:app1_port/中。具体location指令请参考nginx手册。
问题一：admin登录无法跳转
api接口访问正常，但在请求http://abc.com.cn:8080/A/admin/，使用django自带的管理台时，无法进行302的跳转。在新的url页面无法访问。
经分析，过程是这样的：
- 浏览器请求http://abc.com.cn:8080/A/admin/；
- nginx进行代理，去掉了前缀/A/，请求django应用app1时，url为http://app1_ip:app1_port/admin/；
- app1（django）接收到请求，重定向到/admin/login/?xxxxx，此时返回给浏览器端的response header中location为/admin/login/?xxx；
- 浏览器当遇到301或302时，直接根据location值，进行新请求，此时新的url为http://abc.com.cn:8080/admin/login/?xxx；
- 新请求失败了，因为新的url确实不存在。
此问题出现在第4步，需要nginx在遇到301或302时，重新修改response header中location值，这样浏览器就能按添加前缀/A/后的url进行请求了。
修改配置后如下：
server {
listen 80 ;
server_name abc.com.cn; //统一的一个域名
location ^~ /A/ {
proxy_pass http://app1_addr:app1_port/;
proxy_redirect ~^/(.*)$ http://abc.com.cn:8080/A/$1;
}
** app2和app3的照着上面/A/的配置修改下。**
}
新增加一行proxy_redirect指令，具体指令说明请参见nginx手册，大概意思是告诉nginx，当遇到301或302服务器端重定向时，按^/(.*)$进行正则匹配，即匹配/xxxx这种url。当匹配成功后，将响应header中location值修改成http://abc.com.cn:8080/A/$1，再将响应继续返回给浏览器。其中$1表示正则匹配中(...)中的元组序号。
当然，根据实际需求，还可以再添加多个proxy_rediect指令，原理一样：
proxy_redirect ~^http://.*/(.*)$ http://abc.com.cn:8080/A/$1;
proxy_redirect ~^http://.*:\d+/(.*)$ http://abc.com.cn:8080/A/$1;
问题二：静态页无法访问
现在api、admin管理台能访问了，但发现管理台的js/css/html/jpg这些静态资源都访问失败。
分析如下，当django返回html到浏览器后，浏览器会解析html中静态资源url并请求，此时静态资源的url为/static/admin/xx/x.js或/admin/xxx/xxx这种格式。浏览器去请求这些url当然不存在，nginx便会直接报不存在资源。
此时，可以有两种方案：
- 修改django工程，将admin中返回的html或js文件中的请求统一添加前缀；
- 在nginx代理中统一处理响应内容，将响应内容中url进行替换，再返回给浏览器使用。
第一种方法找了找，发现不好修改，毕竟admin是django集成在安装包中的，工程里并不会去直接继承或二次封装admin模块，因此放弃了。
第二种方法找到了nginx中sub_filter指令，再次修改如下：
server {
listen 80 ;
server_name abc.com.cn; //统一的一个域名
location ^~ /A/ {
proxy_pass http://app1_addr:app1_port/;
proxy_redirect ~^/(.*)$ http://abc.com.cn:8080/A/$1;
sub_filter /admin/ /A/admin/;
sub_filter /static/ /A/static/;
sub_filter_once off;
}
** app2和app3的照着上面/A/的配置修改下。**
}
新增加sub_filter*三行指令，具体指令用法请参见手册，大概意思是nginx根据sub_filter_types（本文没写，默认是text/html），去检查每次的响应内容，若内容为text/html，则进行替换操作，将响应内容中的【/admin/】字符串替换成【/A/admin/】字符串，即增加前缀操作，static同理。最后再添加sub_filter_once off;表明上面的替换是替换响应内容的所有地方，如果不加这句指令，则只会替换一次。
若工程中还存在其它子应用的静态工程，也可照此来进行替换操作。
这种替换后，原工程不用修改，不影响本地开发调试，感觉还是不错的。
结果
现在api接口、admin管理台都能正常访问了。完成了通过url前缀方式来反向代理功能。
实现了浏览器或外部系统只需要通过
http://abc.com.cn:8080/A/xxxx
http://abc.com.cn:8080/B/xxxx
http://abc.com.cn:8080/C/xxxx
这种格式的URL访问即可，只需一个域名，仅通过/A/这种前缀来区分不同的子应用。
一般我们会使用前后端分离去开发项目，若有必要，也可以使用sub_filter去替换相应的请求内容。
网友评论