FreeSwitch的mod_translate模块详细,附带场景案例及代码示例
mod_translate 模块详细介绍
mod_translate
是 FreeSWITCH 中的一个拨号计划应用程序模块,用于对电话号码或字符串进行格式转换和翻译。它可以根据预定义的规则对输入的内容进行匹配和转换,常用于号码格式化、路由选择、号码屏蔽等场景。
主要功能
- 号码格式化:将输入的号码按照预定义的规则进行格式化。
- 号码翻译:根据规则将号码转换为另一种格式。
- 路由选择:根据号码前缀或其他规则选择不同的路由。
- 号码屏蔽:隐藏或替换号码中的部分数字。
使用场景
-
号码格式化:
- 将用户输入的号码统一格式化为国际标准格式(如
+1234567890
)。 - 去除号码中的特殊字符(如
-
、()
等)。
- 将用户输入的号码统一格式化为国际标准格式(如
-
号码翻译:
- 将短号码(如
1001
)翻译为完整的 E.164 格式号码(如+1234567890
)。 - 根据号码前缀选择不同的路由(如
1
开头的号码路由到美国,44
开头的号码路由到英国)。
- 将短号码(如
-
号码屏蔽:
- 隐藏号码中的部分数字(如将
+1234567890
转换为+123****890
)。
- 隐藏号码中的部分数字(如将
-
动态路由:
- 根据号码的特定规则动态选择网关或路由。
配置与使用
1. 配置 translate.conf.xml
mod_translate
的规则定义在 translate.conf.xml
文件中。以下是一个示例配置:
<configuration name="translate.conf" description="Number Translation Rules">
<profiles>
<profile name="example_profile">
<rule name="international_format">
<!-- 匹配任意号码 -->
<condition field="destination_number" expression="^(\d+)$">
<!-- 将号码格式化为国际标准格式 -->
<action application="set" data="translated_number=+1$1"/>
</condition>
</rule>
<rule name="shortcode_to_e164">
<!-- 匹配短号码 1001 -->
<condition field="destination_number" expression="^1001$">
<!-- 将短号码翻译为完整的 E.164 格式 -->
<action application="set" data="translated_number=+1234567890"/>
</condition>
</rule>
<rule name="mask_number">
<!-- 匹配任意号码 -->
<condition field="destination_number" expression="^(\d{3})(\d{3})(\d{4})$">
<!-- 屏蔽中间三位数字 -->
<action application="set" data="translated_number=$1***$3"/>
</condition>
</rule>
</profile>
</profiles>
</configuration>
2. 在拨号计划中使用 mod_translate
在拨号计划中,可以通过 translate
应用程序调用 mod_translate
对号码进行翻译。以下是一个示例拨号计划:
<extension name="Number Translation Example">
<condition field="destination_number" expression="^(\d+)$">
<!-- 调用 translate 应用程序,使用 example_profile 规则 -->
<action application="translate" data="example_profile"/>
<!-- 使用翻译后的号码进行呼叫 -->
<action application="bridge" data="sofia/gateway/my_gateway/${translated_number}"/>
</condition>
</extension>
代码示例
示例 1:号码格式化
- 输入号码:
1234567890
- 规则:将号码格式化为国际标准格式
+11234567890
。 - 拨号计划:
<extension name="Format Number"> <condition field="destination_number" expression="^(\d+)$"> <action application="translate" data="example_profile:international_format"/> <action application="log" data="INFO Translated Number: ${translated_number}"/> <action application="bridge" data="sofia/gateway/my_gateway/${translated_number}"/> </condition> </extension>
示例 2:短号码翻译
- 输入号码:
1001
- 规则:将短号码
1001
翻译为+1234567890
。 - 拨号计划:
<extension name="Shortcode Translation"> <condition field="destination_number" expression="^1001$"> <action application="translate" data="example_profile:shortcode_to_e164"/> <action application="log" data="INFO Translated Number: ${translated_number}"/> <action application="bridge" data="sofia/gateway/my_gateway/${translated_number}"/> </condition> </extension>
示例 3:号码屏蔽
- 输入号码:
1234567890
- 规则:将号码屏蔽为
123***7890
。 - 拨号计划:
<extension name="Mask Number"> <condition field="destination_number" expression="^(\d{3})(\d{3})(\d{4})$"> <action application="translate" data="example_profile:mask_number"/> <action application="log" data="INFO Masked Number: ${translated_number}"/> <action application="bridge" data="sofia/gateway/my_gateway/${translated_number}"/> </condition> </extension>
调试与日志
- 使用
sofia global siptrace on
开启 SIP 跟踪,查看号码翻译后的效果。 - 在拨号计划中使用
log
应用程序记录翻译后的号码:<action application="log" data="INFO Translated Number: ${translated_number}"/>
总结
mod_translate
是一个强大的号码翻译和格式化工具,适用于多种场景,如号码格式化、路由选择、号码屏蔽等。通过灵活的规则配置,可以轻松实现复杂的号码处理逻辑。结合拨号计划中的 translate
应用程序,能够显著提升 FreeSWITCH 的号码处理能力。
如果需要对 +86
开头的号码(中国区号)进行特殊处理,可以在 translate.conf.xml
中定义针对 +86
的规则,并在拨号计划中调用这些规则。以下是详细的配置和代码示例:
场景描述
假设我们需要对 +86
开头的号码进行以下处理:
- 格式化:将
+8613712345678
格式化为+86 137 1234 5678
。 - 路由选择:将
+86
开头的号码路由到特定的网关(如china_gateway
)。 - 号码屏蔽:将
+8613712345678
屏蔽为+86 137 **** 5678
。
配置 translate.conf.xml
在 translate.conf.xml
中定义针对 +86
的规则:
<configuration name="translate.conf" description="Number Translation Rules">
<profiles>
<profile name="china_profile">
<!-- 规则 1:格式化 +86 号码 -->
<rule name="format_china_number">
<condition field="destination_number" expression="^\+86(\d{3})(\d{4})(\d{4})$">
<action application="set" data="translated_number=+86 $1 $2 $3"/>
</condition>
</rule>
<!-- 规则 2:屏蔽 +86 号码 -->
<rule name="mask_china_number">
<condition field="destination_number" expression="^\+86(\d{3})(\d{4})(\d{4})$">
<action application="set" data="translated_number=+86 $1 **** $3"/>
</condition>
</rule>
</profile>
</profiles>
</configuration>
在拨号计划中使用 mod_translate
示例 1:格式化 +86
号码
- 输入号码:
+8613712345678
- 规则:将号码格式化为
+86 137 1234 5678
。 - 拨号计划:
<extension name="Format China Number"> <condition field="destination_number" expression="^\+86(\d{3})(\d{4})(\d{4})$"> <!-- 调用 translate 应用程序,使用 china_profile 规则 --> <action application="translate" data="china_profile:format_china_number"/> <!-- 记录翻译后的号码 --> <action application="log" data="INFO Formatted China Number: ${translated_number}"/> <!-- 使用翻译后的号码进行呼叫 --> <action application="bridge" data="sofia/gateway/china_gateway/${translated_number}"/> </condition> </extension>
示例 2:屏蔽 +86
号码
- 输入号码:
+8613712345678
- 规则:将号码屏蔽为
+86 137 **** 5678
。 - 拨号计划:
<extension name="Mask China Number"> <condition field="destination_number" expression="^\+86(\d{3})(\d{4})(\d{4})$"> <!-- 调用 translate 应用程序,使用 china_profile 规则 --> <action application="translate" data="china_profile:mask_china_number"/> <!-- 记录屏蔽后的号码 --> <action application="log" data="INFO Masked China Number: ${translated_number}"/> <!-- 使用屏蔽后的号码进行呼叫 --> <action application="bridge" data="sofia/gateway/china_gateway/${translated_number}"/> </condition> </extension>
示例 3:路由 +86
号码到特定网关
- 输入号码:
+8613712345678
- 规则:将
+86
开头的号码路由到china_gateway
。 - 拨号计划:
<extension name="Route China Number"> <condition field="destination_number" expression="^\+86\d+$"> <!-- 直接路由到 china_gateway --> <action application="bridge" data="sofia/gateway/china_gateway/${destination_number}"/> </condition> </extension>
调试与日志
- 使用
sofia global siptrace on
开启 SIP 跟踪,查看号码翻译后的效果。 - 在拨号计划中使用
log
应用程序记录翻译后的号码:<action application="log" data="INFO Translated Number: ${translated_number}"/>
总结
通过 mod_translate
,可以轻松实现对 +86
开头的号码进行格式化、屏蔽和路由选择。以下是关键点:
- 格式化:将
+8613712345678
格式化为+86 137 1234 5678
。 - 屏蔽:将
+8613712345678
屏蔽为+86 137 **** 5678
。 - 路由:将
+86
开头的号码路由到特定的网关(如china_gateway
)。
这种配置非常适合需要对中国号码进行特殊处理的场景,如国际呼叫、号码隐私保护等。
要实现号码归属地查询(如 13800138001
为中国北京,13303111232
为中国河北石家庄),可以通过以下步骤实现:
- 获取号码归属地数据:需要一个包含号码段和归属地信息的数据库或 API。
- 集成归属地查询功能:在 FreeSWITCH 中通过 Lua 脚本、HTTP 请求或数据库查询实现归属地查询。
- 返回归属地信息:将查询结果存储在变量中,并在拨号计划或日志中使用。
以下是具体的实现方案:
方案 1:使用 Lua 脚本查询本地数据库
步骤 1:准备归属地数据库
- 使用 SQLite、MySQL 或其他数据库存储号码段和归属地信息。
- 示例表结构:
CREATE TABLE number_location ( prefix VARCHAR(10) PRIMARY KEY, -- 号码前缀(如 138, 133) province VARCHAR(50), -- 省份(如 北京, 河北) city VARCHAR(50) -- 城市(如 北京, 石家庄) );
- 示例数据:
INSERT INTO number_location (prefix, province, city) VALUES ('138', '北京', '北京'), ('133', '河北', '石家庄'), ('139', '广东', '深圳');
步骤 2:编写 Lua 脚本
在 FreeSWITCH 中编写 Lua 脚本,查询数据库并返回归属地信息。
-- number_location.lua
local db = require "luasql.sqlite3"
local env = db.sqlite3()
local conn = env:connect("/path/to/number_location.db")
function query_location(number)
local prefix = string.sub(number, 1, 3) -- 提取号码前 3 位
local cursor, err = conn:execute(string.format("SELECT province, city FROM number_location WHERE prefix = '%s'", prefix))
if not cursor then
return nil, err
end
local row = cursor:fetch({}, "a")
if row then
return row.province, row.city
end
return nil, "No match found"
end
-- 示例:查询号码归属地
local number = session:getVariable("destination_number")
local province, city = query_location(number)
if province and city then
session:setVariable("number_location", string.format("中国 %s %s", province, city))
else
session:setVariable("number_location", "未知归属地")
end
步骤 3:在拨号计划中调用 Lua 脚本
在拨号计划中调用 Lua 脚本,并记录归属地信息。
<extension name="Number Location Query">
<condition field="destination_number" expression="^(\d+)$">
<!-- 调用 Lua 脚本查询归属地 -->
<action application="lua" data="number_location.lua"/>
<!-- 记录归属地信息 -->
<action application="log" data="INFO Number Location: ${number_location}"/>
<!-- 继续呼叫 -->
<action application="bridge" data="sofia/gateway/my_gateway/${destination_number}"/>
</condition>
</extension>
方案 2:使用 HTTP API 查询归属地
步骤 1:准备归属地 API
- 使用第三方归属地查询 API(如 聚合数据 或 阿里云)。
- 示例 API 请求:
GET https://api.example.com/location?number=13800138001
- 示例 API 响应:
{ "province": "北京", "city": "北京" }
步骤 2:编写 Lua 脚本调用 API
在 FreeSWITCH 中编写 Lua 脚本,调用 HTTP API 查询归属地。
-- http_location.lua
local http = require "socket.http"
local ltn12 = require "ltn12"
function query_location(number)
local url = string.format("https://api.example.com/location?number=%s", number)
local response = {}
local res, code = http.request{
url = url,
sink = ltn12.sink.table(response)
}
if code == 200 then
local json = table.concat(response)
local province, city = json:match('"province":"([^"]+)","city":"([^"]+)"')
if province and city then
return province, city
end
end
return nil, "API request failed"
end
-- 示例:查询号码归属地
local number = session:getVariable("destination_number")
local province, city = query_location(number)
if province and city then
session:setVariable("number_location", string.format("中国 %s %s", province, city))
else
session:setVariable("number_location", "未知归属地")
end
步骤 3:在拨号计划中调用 Lua 脚本
在拨号计划中调用 Lua 脚本,并记录归属地信息。
<extension name="Number Location Query">
<condition field="destination_number" expression="^(\d+)$">
<!-- 调用 Lua 脚本查询归属地 -->
<action application="lua" data="http_location.lua"/>
<!-- 记录归属地信息 -->
<action application="log" data="INFO Number Location: ${number_location}"/>
<!-- 继续呼叫 -->
<action application="bridge" data="sofia/gateway/my_gateway/${destination_number}"/>
</condition>
</extension>
方案 3:使用内置的 mod_curl
查询归属地
如果不想使用 Lua 脚本,可以通过 mod_curl
直接调用 HTTP API。
步骤 1:配置 mod_curl
在 curl.conf.xml
中配置 API 请求:
<configuration name="curl.conf" description="cURL Configuration">
<settings>
<param name="timeout" value="10"/>
</settings>
<profiles>
<profile name="location_api">
<param name="url" value="https://api.example.com/location?number=${destination_number}"/>
<param name="method" value="GET"/>
</profile>
</profiles>
</configuration>
步骤 2:在拨号计划中使用 mod_curl
在拨号计划中调用 mod_curl
,并解析 API 响应。
<extension name="Number Location Query">
<condition field="destination_number" expression="^(\d+)$">
<!-- 调用 HTTP API 查询归属地 -->
<action application="curl" data="location_api"/>
<!-- 解析 API 响应 -->
<action application="set" data="api_response=${curl_response_data}"/>
<action application="set" data="number_location=中国 ${api_response[province]} ${api_response[city]}"/>
<!-- 记录归属地信息 -->
<action application="log" data="INFO Number Location: ${number_location}"/>
<!-- 继续呼叫 -->
<action application="bridge" data="sofia/gateway/my_gateway/${destination_number}"/>
</condition>
</extension>
总结
实现号码归属地查询的三种方案:
- 本地数据库查询:适合数据量较小、查询频繁的场景。
- HTTP API 查询:适合使用第三方 API 的场景。
mod_curl
查询:适合不想编写 Lua 脚本的场景。
根据实际需求选择合适的方案,并结合 FreeSWITCH 的拨号计划和日志功能,实现号码归属地查询和记录。要实现号码归属地查询(如 13800138001
为中国北京,13303111232
为中国河北石家庄),可以通过以下步骤实现:
- 获取号码归属地数据:需要一个包含号码段和归属地信息的数据库或 API。
- 集成归属地查询功能:在 FreeSWITCH 中通过 Lua 脚本、HTTP 请求或数据库查询实现归属地查询。
- 返回归属地信息:将查询结果存储在变量中,并在拨号计划或日志中使用。
以下是具体的实现方案:
方案 1:使用 Lua 脚本查询本地数据库
步骤 1:准备归属地数据库
- 使用 SQLite、MySQL 或其他数据库存储号码段和归属地信息。
- 示例表结构:
CREATE TABLE number_location ( prefix VARCHAR(10) PRIMARY KEY, -- 号码前缀(如 138, 133) province VARCHAR(50), -- 省份(如 北京, 河北) city VARCHAR(50) -- 城市(如 北京, 石家庄) );
- 示例数据:
INSERT INTO number_location (prefix, province, city) VALUES ('138', '北京', '北京'), ('133', '河北', '石家庄'), ('139', '广东', '深圳');
步骤 2:编写 Lua 脚本
在 FreeSWITCH 中编写 Lua 脚本,查询数据库并返回归属地信息。
-- number_location.lua
local db = require "luasql.sqlite3"
local env = db.sqlite3()
local conn = env:connect("/path/to/number_location.db")
function query_location(number)
local prefix = string.sub(number, 1, 3) -- 提取号码前 3 位
local cursor, err = conn:execute(string.format("SELECT province, city FROM number_location WHERE prefix = '%s'", prefix))
if not cursor then
return nil, err
end
local row = cursor:fetch({}, "a")
if row then
return row.province, row.city
end
return nil, "No match found"
end
-- 示例:查询号码归属地
local number = session:getVariable("destination_number")
local province, city = query_location(number)
if province and city then
session:setVariable("number_location", string.format("中国 %s %s", province, city))
else
session:setVariable("number_location", "未知归属地")
end
步骤 3:在拨号计划中调用 Lua 脚本
在拨号计划中调用 Lua 脚本,并记录归属地信息。
<extension name="Number Location Query">
<condition field="destination_number" expression="^(\d+)$">
<!-- 调用 Lua 脚本查询归属地 -->
<action application="lua" data="number_location.lua"/>
<!-- 记录归属地信息 -->
<action application="log" data="INFO Number Location: ${number_location}"/>
<!-- 继续呼叫 -->
<action application="bridge" data="sofia/gateway/my_gateway/${destination_number}"/>
</condition>
</extension>
方案 2:使用 HTTP API 查询归属地
步骤 1:准备归属地 API
- 使用第三方归属地查询 API(如 聚合数据 或 阿里云)。
- 示例 API 请求:
GET https://api.example.com/location?number=13800138001
- 示例 API 响应:
{ "province": "北京", "city": "北京" }
步骤 2:编写 Lua 脚本调用 API
在 FreeSWITCH 中编写 Lua 脚本,调用 HTTP API 查询归属地。
-- http_location.lua
local http = require "socket.http"
local ltn12 = require "ltn12"
function query_location(number)
local url = string.format("https://api.example.com/location?number=%s", number)
local response = {}
local res, code = http.request{
url = url,
sink = ltn12.sink.table(response)
}
if code == 200 then
local json = table.concat(response)
local province, city = json:match('"province":"([^"]+)","city":"([^"]+)"')
if province and city then
return province, city
end
end
return nil, "API request failed"
end
-- 示例:查询号码归属地
local number = session:getVariable("destination_number")
local province, city = query_location(number)
if province and city then
session:setVariable("number_location", string.format("中国 %s %s", province, city))
else
session:setVariable("number_location", "未知归属地")
end
步骤 3:在拨号计划中调用 Lua 脚本
在拨号计划中调用 Lua 脚本,并记录归属地信息。
<extension name="Number Location Query">
<condition field="destination_number" expression="^(\d+)$">
<!-- 调用 Lua 脚本查询归属地 -->
<action application="lua" data="http_location.lua"/>
<!-- 记录归属地信息 -->
<action application="log" data="INFO Number Location: ${number_location}"/>
<!-- 继续呼叫 -->
<action application="bridge" data="sofia/gateway/my_gateway/${destination_number}"/>
</condition>
</extension>
方案 3:使用内置的 mod_curl
查询归属地
如果不想使用 Lua 脚本,可以通过 mod_curl
直接调用 HTTP API。
步骤 1:配置 mod_curl
在 curl.conf.xml
中配置 API 请求:
<configuration name="curl.conf" description="cURL Configuration">
<settings>
<param name="timeout" value="10"/>
</settings>
<profiles>
<profile name="location_api">
<param name="url" value="https://api.example.com/location?number=${destination_number}"/>
<param name="method" value="GET"/>
</profile>
</profiles>
</configuration>
步骤 2:在拨号计划中使用 mod_curl
在拨号计划中调用 mod_curl
,并解析 API 响应。
<extension name="Number Location Query">
<condition field="destination_number" expression="^(\d+)$">
<!-- 调用 HTTP API 查询归属地 -->
<action application="curl" data="location_api"/>
<!-- 解析 API 响应 -->
<action application="set" data="api_response=${curl_response_data}"/>
<action application="set" data="number_location=中国 ${api_response[province]} ${api_response[city]}"/>
<!-- 记录归属地信息 -->
<action application="log" data="INFO Number Location: ${number_location}"/>
<!-- 继续呼叫 -->
<action application="bridge" data="sofia/gateway/my_gateway/${destination_number}"/>
</condition>
</extension>
总结
实现号码归属地查询的三种方案:
- 本地数据库查询:适合数据量较小、查询频繁的场景。
- HTTP API 查询:适合使用第三方 API 的场景。
mod_curl
查询:适合不想编写 Lua 脚本的场景。
根据实际需求选择合适的方案,并结合 FreeSWITCH 的拨号计划和日志功能,实现号码归属地查询和记录。
如果接收到的号码为 FURX17733291111
,其中 FURX
是前缀,后面是实际的号码 17733291111
,并且有一个 MySQL 数据库表存储号码段和归属地信息,可以通过以下步骤实现归属地判断:
步骤 1:准备 MySQL 数据表
假设 MySQL 数据库中有一个表 number_location
,结构如下:
CREATE TABLE number_location (
prefix VARCHAR(10) PRIMARY KEY, -- 号码前缀(如 1773320)
province VARCHAR(50), -- 省份(如 河北省)
city VARCHAR(50), -- 城市(如 石家庄市)
carrier VARCHAR(50) -- 运营商(如 中国电信)
);
示例数据:
INSERT INTO number_location (prefix, province, city, carrier) VALUES
('1773320', '河北省', '石家庄市', '中国电信'),
('1773321', '河北省', '石家庄市', '中国移动'),
('1773322', '河北省', '石家庄市', '中国联通');
步骤 2:编写 Lua 脚本查询 MySQL 数据库
在 FreeSWITCH 中编写 Lua 脚本,连接 MySQL 数据库并查询号码归属地。
安装 Lua MySQL 驱动
确保 Lua 可以连接 MySQL 数据库。安装 luasql-mysql
驱动:
sudo apt install lua-sql-mysql
编写 Lua 脚本
创建 Lua 脚本 mysql_location.lua
:
-- mysql_location.lua
local mysql = require "luasql.mysql"
local env = mysql.mysql()
local conn = env:connect("database_name", "username", "password", "hostname", 3306)
function query_location(number)
-- 去除前缀 FURX
local clean_number = string.gsub(number, "^FURX", "")
-- 提取号码前 7 位(假设前缀长度为 7)
local prefix = string.sub(clean_number, 1, 7)
-- 查询数据库
local cursor, err = conn:execute(string.format("SELECT province, city, carrier FROM number_location WHERE prefix = '%s'", prefix))
if not cursor then
return nil, err
end
local row = cursor:fetch({}, "a")
if row then
return row.province, row.city, row.carrier
end
return nil, "No match found"
end
-- 示例:查询号码归属地
local number = session:getVariable("destination_number")
local province, city, carrier = query_location(number)
if province and city and carrier then
session:setVariable("number_location", string.format("中国 %s %s %s", province, city, carrier))
else
session:setVariable("number_location", "未知归属地")
end
步骤 3:在拨号计划中调用 Lua 脚本
在拨号计划中调用 Lua 脚本,并记录归属地信息。
<extension name="Number Location Query">
<condition field="destination_number" expression="^FURX(\d+)$">
<!-- 调用 Lua 脚本查询归属地 -->
<action application="lua" data="mysql_location.lua"/>
<!-- 记录归属地信息 -->
<action application="log" data="INFO Number Location: ${number_location}"/>
<!-- 继续呼叫 -->
<action application="bridge" data="sofia/gateway/my_gateway/${destination_number}"/>
</condition>
</extension>
运行结果
- 输入号码:
FURX17733291111
- 处理后的号码:
17733291111
- 查询的号码前缀:
1773320
- 查询结果:
- 省份:
河北省
- 城市:
石家庄市
- 运营商:
中国电信
- 省份:
- 日志输出:
INFO Number Location: 中国 河北省 石家庄市 中国电信
优化:支持动态前缀长度
如果号码前缀长度不固定(如 1773320
是 7 位,1380013
是 6 位),可以动态匹配最长前缀。
修改 Lua 脚本中的 query_location
函数:
function query_location(number)
-- 去除前缀 FURX
local clean_number = string.gsub(number, "^FURX", "")
-- 动态匹配最长前缀
for i = 7, 3, -1 do
local prefix = string.sub(clean_number, 1, i)
local cursor, err = conn:execute(string.format("SELECT province, city, carrier FROM number_location WHERE prefix = '%s'", prefix))
if not cursor then
return nil, err
end
local row = cursor:fetch({}, "a")
if row then
return row.province, row.city, row.carrier
end
end
return nil, "No match found"
end
总结
通过 Lua 脚本和 MySQL 数据库,可以实现对带有前缀的号码进行归属地判断。以下是关键点:
- 去除前缀:使用
string.gsub
去除前缀(如FURX
)。 - 查询数据库:根据号码前缀查询 MySQL 数据库,获取归属地信息。
- 动态前缀匹配:支持动态匹配最长前缀。
这种方案非常适合需要处理带有前缀的号码并查询归属地的场景。
如果号码前缀长度固定为 7 位,并且在数据库中匹配不到时,需要发起 HTTP 请求查询归属地,并将新号段的归属地信息存入数据库,可以通过以下步骤实现:
步骤 1:准备 MySQL 数据表
确保 MySQL 数据库中有一个表 number_location
,结构如下:
CREATE TABLE number_location (
prefix VARCHAR(10) PRIMARY KEY, -- 号码前缀(如 1773320)
province VARCHAR(50), -- 省份(如 河北省)
city VARCHAR(50), -- 城市(如 石家庄市)
carrier VARCHAR(50) -- 运营商(如 中国电信)
);
步骤 2:编写 Lua 脚本
在 FreeSWITCH 中编写 Lua 脚本,实现以下功能:
- 从号码中提取 7 位前缀。
- 查询 MySQL 数据库,如果匹配到则返回归属地信息。
- 如果未匹配到,则发起 HTTP 请求查询归属地。
- 将 HTTP 请求的结果存入 MySQL 数据库。
安装依赖
确保 Lua 可以连接 MySQL 和发起 HTTP 请求。安装以下依赖:
sudo apt install lua-sql-mysql lua-socket
编写 Lua 脚本
创建 Lua 脚本 dynamic_location.lua
:
-- dynamic_location.lua
local mysql = require "luasql.mysql"
local http = require "socket.http"
local ltn12 = require "ltn12"
local json = require "cjson" -- 如果需要解析 JSON 响应
-- 连接 MySQL 数据库
local env = mysql.mysql()
local conn = env:connect("database_name", "username", "password", "hostname", 3306)
-- 查询数据库
function query_database(prefix)
local cursor, err = conn:execute(string.format("SELECT province, city, carrier FROM number_location WHERE prefix = '%s'", prefix))
if not cursor then
return nil, err
end
local row = cursor:fetch({}, "a")
if row then
return row.province, row.city, row.carrier
end
return nil, "No match found"
end
-- 发起 HTTP 请求查询归属地
function query_http_api(prefix)
local url = string.format("https://api.example.com/location?number=%s", prefix)
local response = {}
local res, code = http.request{
url = url,
sink = ltn12.sink.table(response)
}
if code == 200 then
local json_response = table.concat(response)
local data = json.decode(json_response) -- 解析 JSON 响应
return data.province, data.city, data.carrier
end
return nil, "API request failed"
end
-- 将归属地信息存入数据库
function save_to_database(prefix, province, city, carrier)
local query = string.format("INSERT INTO number_location (prefix, province, city, carrier) VALUES ('%s', '%s', '%s', '%s')", prefix, province, city, carrier)
local res, err = conn:execute(query)
if not res then
return nil, err
end
return true
end
-- 主逻辑
local number = session:getVariable("destination_number")
local clean_number = string.gsub(number, "^FURX", "") -- 去除前缀 FURX
local prefix = string.sub(clean_number, 1, 7) -- 提取前 7 位
-- 查询数据库
local province, city, carrier = query_database(prefix)
if not province then
-- 如果数据库中没有匹配,发起 HTTP 请求
province, city, carrier = query_http_api(prefix)
if province then
-- 将新号段信息存入数据库
save_to_database(prefix, province, city, carrier)
else
province, city, carrier = "未知", "未知", "未知"
end
end
-- 设置归属地信息
session:setVariable("number_location", string.format("中国 %s %s %s", province, city, carrier))
步骤 3:在拨号计划中调用 Lua 脚本
在拨号计划中调用 Lua 脚本,并记录归属地信息。
<extension name="Dynamic Number Location Query">
<condition field="destination_number" expression="^FURX(\d+)$">
<!-- 调用 Lua 脚本查询归属地 -->
<action application="lua" data="dynamic_location.lua"/>
<!-- 记录归属地信息 -->
<action application="log" data="INFO Number Location: ${number_location}"/>
<!-- 继续呼叫 -->
<action application="bridge" data="sofia/gateway/my_gateway/${destination_number}"/>
</condition>
</extension>
运行结果
- 输入号码:
FURX17733291111
- 处理后的号码:
17733291111
- 查询的号码前缀:
1773320
- 数据库查询:
- 如果数据库中存在
1773320
,则直接返回归属地信息。 - 如果数据库中不存在
1773320
,则发起 HTTP 请求查询归属地,并将结果存入数据库。
- 如果数据库中存在
- 日志输出:
INFO Number Location: 中国 河北省 石家庄市 中国电信
HTTP API 响应示例
假设 HTTP API 的响应为 JSON 格式:
{
"province": "河北省",
"city": "石家庄市",
"carrier": "中国电信"
}
总结
通过 Lua 脚本,可以实现以下功能:
- 去除前缀:从号码中去除前缀(如
FURX
)。 - 数据库查询:根据 7 位前缀查询 MySQL 数据库。
- HTTP 请求:如果数据库中没有匹配,则发起 HTTP 请求查询归属地。
- 数据存储:将 HTTP 请求的结果存入 MySQL 数据库。
这种方案非常适合需要动态查询和存储号码归属地的场景。
在高并发场景下,频繁查询 MySQL 数据库确实可能造成 I/O 阻塞,影响系统性能。为了解决这个问题,可以采用缓存机制(如 Redis)来减少对 MySQL 的直接查询,同时优化查询逻辑和性能。以下是详细的优化方案和建议:
优化方案:Redis 缓存 + MySQL 持久化 + HTTP 请求
1. Redis 缓存
- 作用:将号码归属地信息缓存到 Redis 中,减少对 MySQL 的直接查询。
- 优点:
- Redis 是基于内存的键值存储,读写速度极快(微秒级)。
- 减少 MySQL 的 I/O 压力,提升系统性能。
- 实现:
- 在 Lua 脚本中优先查询 Redis。
- 如果 Redis 中不存在,则查询 MySQL 或发起 HTTP 请求,并将结果存入 Redis。
2. MySQL 持久化
- 作用:作为数据的持久化存储,存储所有号码归属地信息。
- 优点:
- 数据持久化,避免 Redis 重启或崩溃导致数据丢失。
- 支持复杂查询和数据统计分析。
3. HTTP 请求
- 作用:当 Redis 和 MySQL 中都没有匹配的号码归属地信息时,发起 HTTP 请求查询第三方 API。
- 优点:
- 动态获取最新的号码归属地信息。
- 将查询结果存入 Redis 和 MySQL,避免重复查询。
具体实现
1. Redis 缓存设计
- 键设计:
number_location:<前缀>
,例如number_location:1773320
。 - 值设计:存储 JSON 格式的归属地信息,例如
{"province":"河北省","city":"石家庄市","carrier":"中国电信"}
。
2. Lua 脚本逻辑
- 查询 Redis:
- 如果 Redis 中存在匹配的键,则直接返回归属地信息。
- 查询 MySQL:
- 如果 Redis 中不存在,则查询 MySQL。
- 如果 MySQL 中存在匹配的记录,则将结果存入 Redis 并返回。
- 发起 HTTP 请求:
- 如果 MySQL 中也不存在,则发起 HTTP 请求查询第三方 API。
- 将 HTTP 请求的结果存入 Redis 和 MySQL,并返回。
3. Lua 脚本代码
以下是优化后的 Lua 脚本示例:
-- dynamic_location_redis.lua
local redis = require "redis"
local mysql = require "luasql.mysql"
local http = require "socket.http"
local ltn12 = require "ltn12"
local json = require "cjson"
-- 连接 Redis
local redis_client = redis.connect("127.0.0.1", 6379)
-- 连接 MySQL
local mysql_env = mysql.mysql()
local mysql_conn = mysql_env:connect("database_name", "username", "password", "hostname", 3306)
-- 查询 Redis
function query_redis(prefix)
local key = "number_location:" .. prefix
local value = redis_client:get(key)
if value then
return json.decode(value)
end
return nil
end
-- 查询 MySQL
function query_mysql(prefix)
local cursor, err = mysql_conn:execute(string.format("SELECT province, city, carrier FROM number_location WHERE prefix = '%s'", prefix))
if not cursor then
return nil, err
end
local row = cursor:fetch({}, "a")
if row then
return row
end
return nil, "No match found"
end
-- 发起 HTTP 请求
function query_http_api(prefix)
local url = string.format("https://api.example.com/location?number=%s", prefix)
local response = {}
local res, code = http.request{
url = url,
sink = ltn12.sink.table(response)
}
if code == 200 then
return json.decode(table.concat(response))
end
return nil, "API request failed"
end
-- 将归属地信息存入 Redis 和 MySQL
function save_location(prefix, province, city, carrier)
-- 存入 Redis
local key = "number_location:" .. prefix
local value = json.encode({province = province, city = city, carrier = carrier})
redis_client:set(key, value)
-- 存入 MySQL
local query = string.format("INSERT INTO number_location (prefix, province, city, carrier) VALUES ('%s', '%s', '%s', '%s')", prefix, province, city, carrier)
mysql_conn:execute(query)
end
-- 主逻辑
local number = session:getVariable("destination_number")
local clean_number = string.gsub(number, "^FURX", "") -- 去除前缀 FURX
local prefix = string.sub(clean_number, 1, 7) -- 提取前 7 位
-- 查询 Redis
local location = query_redis(prefix)
if not location then
-- 查询 MySQL
location = query_mysql(prefix)
if not location then
-- 发起 HTTP 请求
location = query_http_api(prefix)
if location then
-- 将新号段信息存入 Redis 和 MySQL
save_location(prefix, location.province, location.city, location.carrier)
else
location = {province = "未知", city = "未知", carrier = "未知"}
end
else
-- 将 MySQL 查询结果存入 Redis
save_location(prefix, location.province, location.city, location.carrier)
end
end
-- 设置归属地信息
session:setVariable("number_location", string.format("中国 %s %s %s", location.province, location.city, location.carrier))
性能优化建议
1. 使用 LuaJIT
- 优点:
- LuaJIT 是 Lua 的即时编译版本,性能比标准 Lua 高 5-10 倍。
- 适合高并发场景,能够显著降低延迟。
- 实现:
- 在 FreeSWITCH 中启用 LuaJIT(需编译支持 LuaJIT 的 FreeSWITCH 版本)。
2. 使用 FreeSWITCH 原生代码
- 优点:
- 原生代码(C/C++)性能最优,延迟最低。
- 适合对性能要求极高的场景。
- 缺点:
- 开发复杂度高,维护成本大。
- 适合有丰富 C/C++ 开发经验的团队。
3. 异步非阻塞设计
- 优点:
- 使用异步非阻塞的方式查询 Redis、MySQL 和 HTTP API,避免阻塞主线程。
- 实现:
- 使用 FreeSWITCH 的异步任务模块(如
mod_event_socket
)或 Lua 协程。
- 使用 FreeSWITCH 的异步任务模块(如
总结
在高并发场景下,推荐以下方案:
- Redis 缓存:作为一级缓存,减少对 MySQL 的直接查询。
- MySQL 持久化:作为二级存储,保证数据持久化。
- HTTP 请求:作为动态数据源,获取最新归属地信息。
- LuaJIT:作为脚本引擎,提升性能。
如果对性能要求极高,可以考虑使用 FreeSWITCH 原生代码(C/C++)实现,但开发成本较高。对于大多数场景,LuaJIT + Redis + MySQL 的方案已经能够满足需求。
如果使用 LuaJIT,大部分 Lua 脚本代码可以直接运行,因为 LuaJIT 是 Lua 的兼容实现。不过,为了充分发挥 LuaJIT 的性能优势,可能需要对代码进行一些优化。此外,安装 LuaJIT 和相关的依赖项是必要的。
以下是详细的步骤和注意事项:
1. LuaJIT 的优势
- 性能:LuaJIT 的性能比标准 Lua 高 5-10 倍,特别适合高并发场景。
- 兼容性:LuaJIT 完全兼容 Lua 5.1,支持大部分 Lua 库和模块。
- FFI(外部函数接口):LuaJIT 提供了 FFI 功能,可以直接调用 C 函数,进一步提升性能。
2. Lua 脚本代码是否需要修改?
大部分 Lua 脚本代码可以直接在 LuaJIT 中运行,无需修改。但如果想充分发挥 LuaJIT 的性能优势,可以考虑以下优化:
优化建议
-
使用 FFI 调用 C 函数:
- 对于性能敏感的部分(如 Redis、MySQL 操作),可以使用 LuaJIT 的 FFI 直接调用 C 库,避免使用 Lua 的绑定库(如
luasql
、lua-redis
)。 - 示例:
local ffi = require "ffi" ffi.cdef[[ int printf(const char *fmt, ...); ]] ffi.C.printf("Hello, %s!\n", "world")
- 对于性能敏感的部分(如 Redis、MySQL 操作),可以使用 LuaJIT 的 FFI 直接调用 C 库,避免使用 Lua 的绑定库(如
-
避免全局变量:
- LuaJIT 对局部变量的访问速度更快,尽量减少全局变量的使用。
-
使用 LuaJIT 的 JIT 编译器:
- 确保 LuaJIT 的 JIT 编译器处于启用状态(默认启用),避免手动禁用。
-
优化字符串操作:
- LuaJIT 对字符串操作进行了优化,但仍需避免频繁的字符串拼接和操作。
3. 安装 LuaJIT 和依赖项
在 Ubuntu 22.04 上安装 LuaJIT
-
安装 LuaJIT:
sudo apt update sudo apt install luajit
-
验证安装:
luajit -v
输出示例:
LuaJIT 2.1.0-beta3 -- Copyright (C) 2005-2021 Mike Pall. http://luajit.org/
安装 LuaJIT 的 Redis 和 MySQL 驱动
-
Redis:
- 使用
lua-resty-redis
(基于 LuaJIT 的高性能 Redis 客户端)。luarocks install lua-resty-redis
- 使用
-
MySQL:
- 使用
luasql-mysql
(兼容 LuaJIT)。luarocks install luasql-mysql
- 使用
-
HTTP 请求:
- 使用
lua-resty-http
(基于 LuaJIT 的高性能 HTTP 客户端)。luarocks install lua-resty-http
- 使用
-
JSON 解析:
- 使用
cjson
(高性能 JSON 解析库)。luarocks install lua-cjson
- 使用
4. 修改 Lua 脚本以适配 LuaJIT
以下是一个适配 LuaJIT 的 Lua 脚本示例:
-- dynamic_location_luajit.lua
local redis = require "resty.redis"
local mysql = require "luasql.mysql"
local http = require "resty.http"
local cjson = require "cjson"
-- 连接 Redis
local redis_client = redis:new()
local ok, err = redis_client:connect("127.0.0.1", 6379)
if not ok then
freeswitch.consoleLog("ERR", "Failed to connect to Redis: " .. err)
return
end
-- 连接 MySQL
local mysql_env = mysql.mysql()
local mysql_conn = mysql_env:connect("database_name", "username", "password", "hostname", 3306)
-- 查询 Redis
function query_redis(prefix)
local key = "number_location:" .. prefix
local value, err = redis_client:get(key)
if value then
return cjson.decode(value)
end
return nil
end
-- 查询 MySQL
function query_mysql(prefix)
local cursor, err = mysql_conn:execute(string.format("SELECT province, city, carrier FROM number_location WHERE prefix = '%s'", prefix))
if not cursor then
return nil, err
end
local row = cursor:fetch({}, "a")
if row then
return row
end
return nil, "No match found"
end
-- 发起 HTTP 请求
function query_http_api(prefix)
local http_client = http.new()
local res, err = http_client:request_uri("https://api.example.com/location", {
method = "GET",
query = { number = prefix },
})
if res and res.status == 200 then
return cjson.decode(res.body)
end
return nil, "API request failed"
end
-- 将归属地信息存入 Redis 和 MySQL
function save_location(prefix, province, city, carrier)
-- 存入 Redis
local key = "number_location:" .. prefix
local value = cjson.encode({province = province, city = city, carrier = carrier})
redis_client:set(key, value)
-- 存入 MySQL
local query = string.format("INSERT INTO number_location (prefix, province, city, carrier) VALUES ('%s', '%s', '%s', '%s')", prefix, province, city, carrier)
mysql_conn:execute(query)
end
-- 主逻辑
local number = session:getVariable("destination_number")
local clean_number = string.gsub(number, "^FURX", "") -- 去除前缀 FURX
local prefix = string.sub(clean_number, 1, 7) -- 提取前 7 位
-- 查询 Redis
local location = query_redis(prefix)
if not location then
-- 查询 MySQL
location = query_mysql(prefix)
if not location then
-- 发起 HTTP 请求
location = query_http_api(prefix)
if location then
-- 将新号段信息存入 Redis 和 MySQL
save_location(prefix, location.province, location.city, location.carrier)
else
location = {province = "未知", city = "未知", carrier = "未知"}
end
else
-- 将 MySQL 查询结果存入 Redis
save_location(prefix, location.province, location.city, location.carrier)
end
end
-- 设置归属地信息
session:setVariable("number_location", string.format("中国 %s %s %s", location.province, location.city, location.carrier))
5. 在 FreeSWITCH 中启用 LuaJIT
-
确保 FreeSWITCH 编译时启用了 LuaJIT 支持:
- 在编译 FreeSWITCH 时,添加
--enable-luajit
选项。 - 示例:
./configure --enable-luajit make && make install
- 在编译 FreeSWITCH 时,添加
-
在 FreeSWITCH 中调用 LuaJIT 脚本:
- 使用
luajit
作为解释器:<action application="lua" data="dynamic_location_luajit.lua"/>
- 使用
总结
- 代码修改:大部分 Lua 脚本可以直接运行,但可以通过 FFI 和优化进一步提升性能。
- 依赖安装:需要安装 LuaJIT 和相关的高性能库(如
lua-resty-redis
、lua-resty-http
)。 - 性能优势:LuaJIT 在高并发场景下性能显著优于标准 Lua,适合对性能要求较高的场景。
通过以上步骤,可以在 Ubuntu 22.04 上顺利使用 LuaJIT 运行 Lua 脚本,并充分发挥其性能优势。