feat: 支持api路由指定虚拟前缀 feat: 同步补充文档 feat: 优化部分代码 feat: 调整官网样式

Author: iamtsm

balance/tl_ops_balance_core.lua

@@ -39,12 +39,12 @@ function _M:tl_ops_balance_core_filter(ctx)
     -- 服务节点配置列表
     local service_list_str, _ = cache_service:get(tl_ops_constant_service.cache_key.service_list);
     if not service_list_str then
-        tl_ops_err_content:err_content_rewrite_to_balance("", "empty", "", tl_ops_constant_balance.cache_key.service_empty)
+        tl_ops_err_content:err_content_rewrite_to_balance("", "empty", "", tl_ops_constant_balance.cache_key.service_empty, "")
         return
     end
     local service_list_table = cjson.decode(service_list_str);
     if not service_list_table and type(service_list_table) ~= 'table' then
-        tl_ops_err_content:err_content_rewrite_to_balance("", "empty", "", tl_ops_constant_balance.cache_key.service_empty)
+        tl_ops_err_content:err_content_rewrite_to_balance("", "empty", "", tl_ops_constant_balance.cache_key.service_empty, "")
         return
     end
 
@@ -75,7 +75,7 @@ function _M:tl_ops_balance_core_filter(ctx)
                     node, node_state, node_id, host, rule_match_mode = tl_ops_balance_core_body.tl_ops_balance_body_service_matcher(service_list_table)
                     if not node then
                         -- 无匹配
-                        tl_ops_err_content:err_content_rewrite_to_balance("", "empty", balance_mode, tl_ops_constant_balance.cache_key.mode_empty)
+                        tl_ops_err_content:err_content_rewrite_to_balance("", "empty", balance_mode, tl_ops_constant_balance.cache_key.mode_empty, "")
                         return
                     end
                 end
@@ -86,13 +86,13 @@ function _M:tl_ops_balance_core_filter(ctx)
     if rule_match_mode and rule_match_mode == api_match_mode.api then
         -- 域名负载
         if host == nil or host == '' then
-            tl_ops_err_content:err_content_rewrite_to_balance("", "nil", balance_mode, tl_ops_constant_balance.cache_key.host_empty)
+            tl_ops_err_content:err_content_rewrite_to_balance("", "nil", balance_mode, tl_ops_constant_balance.cache_key.host_empty, "")
             return
         end
 
         -- 域名匹配
         if host ~= "*" and host ~= ngx.var.host then
-            tl_ops_err_content:err_content_rewrite_to_balance("", "pass", balance_mode, tl_ops_constant_balance.cache_key.host_pass)
+            tl_ops_err_content:err_content_rewrite_to_balance("", "pass", balance_mode, tl_ops_constant_balance.cache_key.host_pass, "")
             return
         end
     end
@@ -106,7 +106,7 @@ function _M:tl_ops_balance_core_filter(ctx)
                 local token_result = tl_ops_limit_fuse_token_bucket.tl_ops_limit_token( node.service, node_id)  
                 if not token_result or token_result == false then
                     balance_count:tl_ops_balance_count_incr_fail(node.service, node_id)
-                    tl_ops_err_content:err_content_rewrite_to_balance("", "t-limit", balance_mode, tl_ops_constant_balance.cache_key.token_limit)
+                    tl_ops_err_content:err_content_rewrite_to_balance("", "t-limit", balance_mode, tl_ops_constant_balance.cache_key.token_limit, "")
                     return
                 end
             end
@@ -116,7 +116,7 @@ function _M:tl_ops_balance_core_filter(ctx)
                 local leak_result = tl_ops_limit_fuse_leak_bucket.tl_ops_limit_leak( node.service, node_id)
                 if not leak_result or leak_result == false then
                     balance_count:tl_ops_balance_count_incr_fail(node.service, node_id)
-                    tl_ops_err_content:err_content_rewrite_to_balance("", "l-limit", balance_mode, tl_ops_constant_balance.cache_key.leak_limit)
+                    tl_ops_err_content:err_content_rewrite_to_balance("", "l-limit", balance_mode, tl_ops_constant_balance.cache_key.leak_limit, "")
                     return
                 end
             end
@@ -137,7 +137,7 @@ function _M:tl_ops_balance_core_filter(ctx)
         end
         shared:incr(limit_req_fail_count_key, 1)
 
-        tl_ops_err_content:err_content_rewrite_to_balance(node.service .. ":" .. node.name, "offline", balance_mode, tl_ops_constant_balance.cache_key.offline)
+        tl_ops_err_content:err_content_rewrite_to_balance(node.service .. ":" .. node.name, "offline", balance_mode, tl_ops_constant_balance.cache_key.offline, "")
         return
     end
 
@@ -155,6 +155,7 @@ function _M:tl_ops_balance_core_balance(ctx)
     local tlops_ups_mode = ctx.tlops_ups_mode
     local tlops_ups_node = ctx.tlops_ups_node
     local tlops_ups_node_id = ctx.tlops_ups_node_id
+    local tlops_ups_api_prefix = ngx.var.tlops_ups_api_prefix;
 
     if not tlops_ups_mode or not tlops_ups_node or not tlops_ups_node_id then
         return
@@ -173,7 +174,8 @@ function _M:tl_ops_balance_core_balance(ctx)
     ngx.header[tl_ops_constant_balance.proxy_server] = tlops_ups_node.service .. ":" .. tlops_ups_node.name;
     ngx.header[tl_ops_constant_balance.proxy_state] = "online"
     ngx.header[tl_ops_constant_balance.proxy_mode] = tlops_ups_mode
-
+    ngx.header[tl_ops_constant_balance.proxy_prefix] = tlops_ups_api_prefix
+    
     local ok, err = ngx_balancer.set_current_peer(tlops_ups_node.ip, tlops_ups_node.port)
     if ok then
         ngx_balancer.set_timeouts(3, 60, 60)

balance/tl_ops_balance_core_api.lua

@@ -13,6 +13,7 @@ local tl_ops_constant_health        = require("constant.tl_ops_constant_health")
 local shared                        = ngx.shared.tlopsbalance
 local find                          = ngx.re.find
 
+
 -- 处理匹配逻辑
 local tl_ops_balance_api_matcher_mode = function (matcher, request_uri, obj)
     local match_mode = obj.match_mode
@@ -21,13 +22,14 @@ local tl_ops_balance_api_matcher_mode = function (matcher, request_uri, obj)
     end
     -- 正则匹配模式
     if match_mode == tl_ops_match_mode.reg or match_mode == tl_ops_match_mode.regi or match_mode == tl_ops_match_mode.regid then
-        local from, to , _ = find(request_uri , obj.url , match_mode);
+        local from, to , _ = find(request_uri , (obj.fake_prefix .. obj.url) , match_mode);
         if from and to then
             local sub = string.sub(request_uri, from, to)
             if sub then
                 if not matcher or not matcher.url then
                     matcher = obj
                 end
+                -- 规则最长匹配优先
                 if matcher.url and #sub > #matcher.url then
                     matcher = obj
                 end
@@ -36,7 +38,7 @@ local tl_ops_balance_api_matcher_mode = function (matcher, request_uri, obj)
     end
     -- 全文匹配
     if match_mode == tl_ops_match_mode.all then
-        if request_uri == obj.url then
+        if request_uri == (obj.fake_prefix .. obj.url) then
             matcher = obj;
         end
     end
@@ -45,23 +47,19 @@ local tl_ops_balance_api_matcher_mode = function (matcher, request_uri, obj)
 end
 
 -- 获取命中的api路由项
-local tl_ops_balance_api_get_matcher_rule = function(api_list_table, rule, rule_match_mode)
+local tl_ops_balance_api_get_matcher_rule = function(api_list_table, rule, rule_match_mode, request_uri)
     local matcher = nil;
     local matcher_list = api_list_table[rule]
 
     if not matcher_list then
         return nil
     end 
 
-    -- 获取当前url
-    local request_uri = tl_ops_utils_func:get_req_uri();
-
     -- 获取当前host
     local cur_host = ngx.var.host;
 
     for i, obj in pairs(matcher_list) do
         repeat
-
             if rule_match_mode == tl_ops_constant_balance_api.mode.host then
                 -- 如果是优先host规则匹配，先剔除不属于当前host的规则
                 if obj.host == nil or obj.host == '' then
@@ -109,15 +107,18 @@ local tl_ops_balance_api_service_matcher = function(service_list_table)
     if not api_list_table then
         return nil, nil, nil, nil, rule_match_mode
     end
+
+    -- 获取当前url
+    local request_uri = tl_ops_utils_func:get_req_uri();
 
     -- 根据路由当前策略进行路由, 返回正则命中的api
     if api_rule == tl_ops_constant_balance_api.rule.point then
         matcher = tl_ops_balance_api_get_matcher_rule(
-            api_list_table, tl_ops_constant_balance_api.rule.point, rule_match_mode
+            api_list_table, tl_ops_constant_balance_api.rule.point, rule_match_mode, request_uri
         );
     elseif api_rule == tl_ops_constant_balance_api.rule.random then
         matcher = tl_ops_balance_api_get_matcher_rule(
-            api_list_table, tl_ops_constant_balance_api.rule.random, rule_match_mode
+            api_list_table, tl_ops_constant_balance_api.rule.random, rule_match_mode, request_uri
         );
     end
 
@@ -142,7 +143,6 @@ local tl_ops_balance_api_service_matcher = function(service_list_table)
         end
     -- 服务内随机
     elseif api_rule == tl_ops_constant_balance_api.rule.random then
-        local request_uri = tl_ops_utils_func:get_req_uri();
         math.randomseed(#request_uri)
         node_id = tonumber(math.random(0,1) % #service_list_table[matcher.service]) + 1
         node = service_list[node_id]
@@ -158,6 +158,16 @@ local tl_ops_balance_api_service_matcher = function(service_list_table)
     if rewrite_url and rewrite_url ~= '' then
         ngx.req.set_uri(rewrite_url, false)
     end
+
+    -- 需要转发到服务具体路径
+    local fake_prefix = matcher.fake_prefix
+    if fake_prefix and matcher.fake_prefix ~= '' then
+        -- 通过虚拟前缀截取后缀
+        local fake_sub = string.sub(request_uri, #fake_prefix + 1, #request_uri)
+        if fake_sub then
+            ngx.var.tlops_ups_api_prefix = fake_sub
+        end
+    end
 
     return node, node_state, node_id, host, rule_match_mode
 end

bin/install_centeros.sh

@@ -6,7 +6,7 @@ TL_OPS_PATH="/usr/local/tl-ops-manage/"
 TL_OPS_CONF_PATH="/usr/local/tl-ops-manage/conf/tl_ops_manage.conf"
 TL_OPS_LUA_PATH="/usr/local/openresty/lualib/?.lua;;/usr/local/tl-ops-manage/?.lua;;"
 TL_OPS_LUAC_PATH="/usr/local/openresty/lualib/?.so;;"
-TL_OPS_VER="v3.1.0"
+TL_OPS_VER="v3.2.0"
 
 echo_msg(){
     cur_time=$(date "+%Y-%m-%d %H:%M:%S")

bin/install_ubuntu.sh

@@ -6,7 +6,7 @@ TL_OPS_PATH="/usr/local/tl-ops-manage/"
 TL_OPS_CONF_PATH="/usr/local/tl-ops-manage/conf/tl_ops_manage.conf"
 TL_OPS_LUA_PATH="/usr/local/openresty/lualib/?.lua;;/usr/local/tl-ops-manage/?.lua;;"
 TL_OPS_LUAC_PATH="/usr/local/openresty/lualib/?.so;;"
-TL_OPS_VER="v3.1.0"
+TL_OPS_VER="v3.2.0"
 
 echo_msg(){
     cur_time=$(date "+%Y-%m-%d %H:%M:%S")

conf/tl_ops_manage.conf

@@ -27,7 +27,10 @@ server {
 
 	charset utf8;
 
-	location / { 
+    # lua_code_cache off;
+
+	location / {
+		set $tlops_ups_api_prefix "";
 		proxy_set_header X-Real-IP $remote_addr;
         proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
         proxy_set_header Host $http_host;
@@ -36,7 +39,7 @@ server {
 		proxy_set_header X-CLIENT-VERIFY $ssl_client_verify;
 		add_header Access-Control-Allow-Headers *;
 		add_header Access-Control-Allow-Methods *;
-		proxy_pass http://tlopsmanage;
+		proxy_pass http://tlopsmanage$tlops_ups_api_prefix;
 
 		rewrite_by_lua_block {
 			tlops:tl_ops_process_init_rewrite();

constant/tl_ops_constant_balance.lua

@@ -25,6 +25,7 @@ local tl_ops_constant_balance = {
     proxy_server = "Tl-Proxy-Server",   -- 请求头标记
     proxy_state = "Tl-Proxy-State",
     proxy_mode = "Tl-Proxy-Mode",
+    proxy_prefix = "Tl-Proxy-Prefix",
     api = {
         list = {
             point = tl_ops_constant_balance_api.point,

constant/tl_ops_constant_balance_api.lua

@@ -22,6 +22,7 @@ local tl_ops_constant_balance_api = {
             node = 0,                               -- 当前url路由到的service下的node的索引
             host = "tlops1.com",                    -- 当前url处理的域名范围
             rewrite_url = "",                       -- 当前url重写后的url
+            fake_prefix = "",                       -- 当前uri规则的虚拟前缀
         },
         random = {
             id = 1,
@@ -30,6 +31,7 @@ local tl_ops_constant_balance_api = {
             service = "tlops-demo",                 -- 当前url路由到的service
             host = "tlops1.com",                    -- 当前url处理的域名范围
             rewrite_url = "",                       -- 当前url重写后的url
+            fake_prefix = "",                       -- 当前uri规则的虚拟前缀
         }
     },
     rule = {-- api rule 策略

err/tl_ops_err_content.lua

@@ -17,13 +17,14 @@ end
 
 -- uri重写，实现错误内容自定义
 -- 重写到balance err内容处理
-function _M:err_content_rewrite_to_balance(server, state, mode, err)
+function _M:err_content_rewrite_to_balance(server, state, mode, err, prefix)
     ngx.req.set_uri_args({ 
         type = "balance",
         cache_key = err, 
         mode = mode, 
         state = state, 
-        server = server
+        server = server,
+        prefix = prefix
     })
     ngx.req.set_uri("/balanceerr/", true)
 end

err/tl_ops_err_content_core.lua

@@ -28,6 +28,7 @@ local tl_ops_err_content_balance_handler = function(args)
     ngx.header[constant_balance.proxy_server] = args.server
     ngx.header[constant_balance.proxy_state] = args.state
     ngx.header[constant_balance.proxy_mode] = args.mode
+    ngx.header[constant_balance.proxy_prefix] = args.prefix
 
     local str = cache_balance:get(args.cache_key)
     if not str then

gitbook/README_API.md

@@ -8,4 +8,4 @@
 
 ## 插件模块接口
 
-除了默认模块的配置外，项目还支持插件自行提供对外API管理接口，典型的例子就是， `SSL插件` 提供的 `get_ssl.lua` 和 `set_ssl.lua`
+除了默认模块的配置外，项目还支持插件自行提供对外API管理接口