string.replaceAll()中的特殊字符（$ \）与matcher.appendReplacement

string.replaceAll中的特殊字符

string.replaceAll(String regex, String replacement)中的replacement参数即替换内容中含有特殊字符 $ \ 时，需转义。

 

/*
 * 字符串"$ \"中的$与\字符互换位置
 */
public class SpecialCharReplace {
	public static void main(String[] args) {
		String str = "$ \\";
		/*
		 * string.replaceAll()中的特殊字符 $ 与 \ 
		 * 
		 * 由于 $ 字符在作为替换内容时，是一个特殊字符，指反向引用前面的分组内容，所以把
		 * 某字符替换成 $ 字符时，因该在前面加上转义字符 \。
		 * \ 字符就不用说了，本身就是转义字符，但为什么在作为替换内容时要使用四个 \ 字符
		 * ，这里又不是用在正则表达式里？这就是因为 \ 字符在作为替换内容里也是一个特殊字
		 * 符，它用来将前面讲的 $ 字符进行转换的，所以也为特殊字符。以下是replaceAll的
		 * 源码片断，从源码就可以看出 \$ 是两个特殊字符
		 * 
		 * if (nextChar == '\\') {
		 *      cursor++;
		 *      nextChar = replacement.charAt(cursor);
		 *      result.append(nextChar);
		 *      cursor++;
		 * } else if (nextChar == '$') {
		 *      // Skip past $
		 *      cursor++;
		 *      ...
		 * }else {
		 *      result.append(nextChar);
		 *      cursor++;
		 * }
		 */
		System.out.println(str.replaceAll("\\$(\\W)\\\\", "\\\\$1\\$"));// \ $
	}

} 

Matcher对象的appendReplacement典型应用与特殊字符&\的进一步分析

问题的提出

字符串模板：
    String template="尊敬的客户${customerName}你好！本次消费金额${amount}，您帐户${accountNumber}上的余额为${balance}，欢迎下次光临！";
其中以 ${ 开始 } 结尾的为待替换的变量域。
数据存放于Map中，key为域名，value为域值。如：
Map--
    customerName = 刘明
    accountNumber = 888888888
    balance = $1000000.00
    amount = $1000.00
请编写函数：
    public static String composeMessage(String template, Map data) throw Exception
实现将任意模板字符串中的变量域，按域名替换为data中的域值。
例如，上例替换结果为：
    "尊敬的客户刘明你好！本次消费金额$1000.00，您帐户888888888上的余额为$1000000.00，欢迎下次光临！"
注：如果Map中找不到域值，以空字符串""替换。

问题的解决

public class RegexExam {
    public static void main(String args[]) {
        HashMap data = new HashMap();
        String template = "尊敬的客户${customerName}你好！本次消费金额${amount}，"
                + "您帐户${accountNumber}上的余额为${balance}，欢迎下次光临！";
        data.put("customerName", "刘明");
        data.put("accountNumber", "888888888");
        data.put("balance", "$1000000.00");
        data.put("amount", "$1000.00");
        try {
            System.out.println(composeMessage(template, data));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    public static String composeMessage(String template, Map data)
            throws Exception {
        String regex = "\\$\\{(.+?)\\}";
        Pattern pattern = Pattern.compile(regex);
        Matcher matcher = pattern.matcher(template);
        /*
         * sb用来存储替换过的内容，它会把多次处理过的字符串按源字符串序
         * 存储起来。
         */
        StringBuffer sb = new StringBuffer();
        while (matcher.find()) {
            String name = matcher.group(1);//键名
            String value = (String) data.get(name);//键值
            if (value == null) {
                value = "";
            } else {
                /*
                 * 由于$出现在replacement中时，表示对捕获组的反向引用，所以要对上面替换内容
                 * 中的 $ 进行替换，让它们变成 "\$1000.00" 或 "\$1000000000.00" ，这样
                 * 在下面使用 matcher.appendReplacement(sb, value) 进行替换时就不会把
                 * $1 看成是对组的反向引用了，否则会使用子匹配项值amount 或 balance替换 $1
                 * ，最后会得到错误结果：
                 *
                 * 尊敬的客户刘明你好！本次消费金额amount000.00，您帐户888888888上的余额
                 * 为balance000000.00，欢迎下次光临！
                 *
                 * 要把 $ 替换成 \$ ，则要使用 \\\\\\& 来替换，因为一个 \ 要使用 \\\ 来进
                 * 行替换，而一个 $ 要使用 \\$ 来进行替换，因 \ 与  $ 在作为替换内容时都属于
                 * 特殊字符：$ 字符表示反向引用组，而 \ 字符又是用来转义 $ 字符的。
                 */
                value = value.replaceAll("\\$", "\\\\\\$");
                //System.out.println("value=" + value);
            }
            /*
             * 经过上面的替换操作，现在的 value 中含有 $ 特殊字符的内容被换成了"\$1000.00"
             * 或 "\$1000000000.00" 了，最后得到下正确的结果：
             *
             * 尊敬的客户刘明你好！本次消费金额$1000.00，您帐户888888888上的
             * 余额为$1000000.00，欢迎下次光临！
             *
             * 另外，我们在这里使用Matcher对象的appendReplacement()方法来进行替换操作，而
             * 不是使用String对象的replaceAll()或replaceFirst()方法来进行替换操作，因为
             * 它们都能只能进行一次性简单的替换操作，而且只能替换成一样的内容，而这里则是要求每
             * 一个匹配式的替换值都不同，所以就只能在循环里使用appendReplacement方式来进行逐
             * 个替换了。
             */
            matcher.appendReplacement(sb, value);
            System.out.println("sb = " + sb.toString());
        }
        //最后还得要把尾串接到已替换的内容后面去，这里尾串为“，欢迎下次光临！”
        matcher.appendTail(sb);
        return sb.toString();
    }
}