前言#

一个string家族的重磅函数将和大家见面了，函数查找子串并替换，这个函数的用法多样，但是配合所给的例子都非常好理解，只有一个地方说的有点隐晦，稍后我会和大家讲解清楚，为了说明这个函数的用法，官方也给了不少的例子，今天我们就结合这些例子来一起看一下这个函数。

内容#

string.gsub()##

原型：string.gsub (s, pattern, repl [,m])
解释：这个函数会返回一个替换后的副本，原串中所有的符合参数pattern的子串都将被参数repl所指定的字符串所替换，如果指定了参数m，那么只替换查找过程的前m个匹配的子串，参数repl可以是一个字符串、表、或者是函数，并且函数可以将匹配的次数作为函数的第二个参数返回，接下来看看参数repl的含义：
如果参数repl是一个常规字符串，成功匹配的子串会被repl直接替换，如果参数repl中包含转移字符%，那么可以采用%n的形式替换，当%n中的n取值1-9时，表示一次匹配中的第n个子串，当其中的n为0时，表示这次匹配的整个子串，%%表示一个单独的%。
如果参数repl是一个表，那么每次匹配中的第一个子串将会作为整个表的键，取table[匹配子串]来替换所匹配出来的子串，当匹配不成功时，函数会使用整个字符串来作为table的键值。
如果参数repl是一个函数，那么每一次匹配的子串都将作为整个函数的参数，取function(匹配子串)来替换所匹配出来的子串，当匹配不成功时，函数会使用整个字符串来作为函数的参数。如果函数的返回值是一个数字或者是字符串，那么会直接拿来替换，如果它返回false或者nil，替换动作将不会发生，如果返回其他的值将会报错。

Usage##

首先新建一个文件将文件命名为gsubtest.lua然后编写如下代码：

-- 常规替换
x = string.gsub("hello world", "(%w+)", "lua")
print("\n",x)

-- 都用匹配的第一个串*2来替换
x = string.gsub("hello world", "(%w+)", "%1 %1")
print("\n",x)

-- 用匹配出的完成串*2来替换第一次匹配的结果
x = string.gsub("hello world", "%w+", "%0 %0", 1)
print("\n",x)

-- 使用一个完整匹配和一个匹配的第二个串来替换
x = string.gsub("hello world from c to lua", "(%w+) (%a+)", "%0 %2")
print("\n",x)

-- 调用系统函数来替换
x = string.gsub("os = $OS, pathext = $PATHEXT", "%$(%w+)", os.getenv)
print("\n",x)

-- 调用自定义函数
x = string.gsub("4 + 5 = $return 4+5$", "%$(.-)%$", function (s)
      return loadstring(s)()
    end)
print("\n",x)

-- 调用表来替换
local t = {name="lua", version="5.1"}
x = string.gsub("$name-$version.tar.gz", "%$(%w+)", t)
print("\n",x)

运行结果

string_gsub.png

总结#

透过例子来看这个函数是不是已经很清楚了，其中大部分的例子都可以看懂，我只说明一下我的解释中出现的一些词，比如“一次匹配中的第二个子串”表示的是函数的匹配参数pattern中至少包含两个括号，第二个括号所匹配出来的就是第二个子串，明白了这一点是不是就可以看懂第四组的输出了。
有一点需要注意的是，使用函数作为替换结果时，函数只能返回数字、字符串、false和nil。
这里还想说一下第五组测试结果，官方文档中给出的是取系统变量HOME和USER，我在这个版本的lua并且是Windows7系统时无法正确输出，所以选了其他的变量来代替。