javaScript中String.replace()的第二个参数为函数时的用法介绍

Cooking Regex微信公众号
正则表达式学习

 

一、定义和用法

replace() 方法用于在字符串中用一些字符替换另一些字符，或替换一个与正则表达式匹配的子串。

语法：stringObject.replace(regexp/substr,replacement)

返回值
一个新的字符串，是用 replacement 替换了 regexp 的第一次匹配或所有匹配之后得到的。
说明
字符串 stringObject 的 replace() 方法执行的是查找并替换的操作。它将在 stringObject 中查找与 regexp 相匹配的子字符串，然后用 replacement 来替换这些子串。如果 regexp 具有全局标志 g，那么 replace() 方法将替换所有匹配的子串。否则，它只替换第一个匹配子串。
replacement 可以是字符串，也可以是函数。如果它是字符串，那么每个匹配都将由字符串替换。但是 replacement 中的 $ 字符具有特定的含义。如下表所示，它说明从模式匹配得到的字符串将用于替换。

注意：ECMAScript v3 规定，replace() 方法的参数 replacement 可以是函数而不是字符串。在这种情况下，每个匹配都调用该函数，它返回的字符串将作为替换文本使用。该函数的第一个参数是匹配模式的字符串。接下来的参数是与模式中的子表达式匹配的字符串，可以有 0 个或多个这样的参数。接下来的参数是一个整数，声明了匹配在 stringObject 中出现的位置。最后一个参数是 stringObject 本身。

二、用法详解

1、replace(regexp/substr,文本)

说明：这个用法这边不讨论，可参考这篇

2、replace(regexp/substr,函数)

当replace方法的第二个参数传入一个function，这个function会在每次匹配后，替换之前调用。

参数说明：这个方法的参数是没有固定个数的，但有一定的规则，参数的个数需要根据捕获组的个数来定。

function(matchStr,groups,index,sourceStr){

}

参数matchStr是每次正则匹配到的字符串，这是固定的；
参数groups是正则表达式捕获组匹配到的内容。若正则表达式没有捕获组则没有该参数，groups加个s的意思是这边可能有多个分组，也就是说groups这个位置代表的是group1,group2,group3......等等参数。参数个数根据捕获组的个数来定。
参数index是匹配项在字符串中的开始下标
参数sourceStr则是原字符串

举例1：没有分组的情况

"123".replace(/\d/g,function(matchStr,index,sourceStr){

 return 返回值;
}); 

举例2：有一个分组的情况

"123".replace(/(\d)/g,function(matchStr,group1,index,sourceStr){

return 返回值;
}); 

举例3：有两个分组的情况

"123".replace(/(\d)(\d)/g,function(matchStr,group1,group2,index,sourceStr){

 return 返回值;
}); 

总结：也就是说replace(正则对象,函数)第一个参数的正则表达式有几个捕获组，对应的函数function()的参数就会跟着变化。

但有个规律：function的第一个参数一定是此次正则匹配到的字符串，若没有捕获组的情况下，第二个参数就是匹配的字符串的开始位置index，第三个参数保存的是被正则匹配原字符串；若有捕获组的话，情况就变了，从第二个参数开始保存的是捕获组匹配到的字符，分组匹配参数个数后，若有剩余的参数才是index，接下去才是保存被正则匹配原字符串。

 

返回值说明（如下代码）：这边一定要有一个返回值result且这个返回值替换的是此次匹配到的matcherStr，要不然会返回一个undefined。

str.replace(/\d/g,function(matchStr,index,sourceStr){

return result;
}); 

三、运用例子

例子1：把字符串中的每个数字+1后替换原数字

 

(function(){
	var str='aa12bb0cc789';
	console.info("原字符串："+str+"<br/>");
	var newStr=str.replace(/\d/g,function(matchStr,index,sourceStr){
	var result=parseInt(matchStr)+1;
    return result;
}); 
console.info("替换后的字符串："+newStr+"<br/>");
})();

结果：

 

例子2：一个字符串由a-z的字母组成，把连续出现多次的字符串进行压缩。如输入:aaabbbbcccccd  输出:3a4b5cd

 

function compressRepeatedStr(input){
	var result=input.replace(/([a-z])\1+/g,function(matchStr,group1){
		return matchStr.length+group1;
	});	
	return result;
}

结果：