有学过 Java 的人应该会知道 StringBuilder 或是 StringBuffer 这两个在 java.lang 套件下的类别,常被用来处理需要一直被改变内容的字符串。由于 Java 编程语言一个字符串(String)有着不可变对象(Immutable Object)的特性,如果直接使用 String 类别来进行字符串的处理,在改变字符串的过程中,每次字符串内容的变化将会产生出新的 String 对象来表示,也导致其性能不是很好,需要使用内置的 StringBuilder 或是 StringBuffer 这两个类别来专门处理可变的字符串,处理完后再使用其 toString() 方法将最终结果创建为字符串对象。那么既然 Java 需要使用 StringBuilder 或是 StringBuffer 来处理字符串,基于 JavaScript 的 Node.js 也需要吗?

Node.js 使用 Chrome 的 V8 JavaScript 引擎来运行 JavaScript 程序,而实际上 V8 实作的字符串功能,性能也已经可以说是极好的了,所以官方也无内置 StringBuilder 或是 StringBuffer 之类的模块。也就是说,在 Node.js 中,可以不需要特别使用 StringBuilder 或是 StringBuffer 来提升字符串性能。

然而,StringBuilder 或是 StringBuffer 带来的价值仅仅只是字符串处理性能而已吗?不!Java 的 StringBuilder 和 StringBuffer 皆自带了常用的增、删、改、查之方法,可以大幅度地减少重复撰写的程序。

举例来说,若要将某一段字符串插入到某个字符串中,如果不使用 StringBuilder 或 StringBuffer,写出来的 Java 程序看起来会像这样:

String text = "This is apple.";
String insertString = "an ";
text = text.substring(0, 8) + insertString + text.substring(8);
System.out.println(text); // This is an apple.

利用字符串对象的 substring 方法将 text 字符串变量所表示的字符串切割成头、尾两个部份,再用 + 操作符将他们串接,并在两者中间插入新字符串。由这一系列的动作来完成我们所谓的「字符串插入」。

但如果使用 StringBuilder 或 StringBuffer,这个 Java 程序会变得十分简单,如下:

StringBuilder text = new StringBuilder("This is apple.");
String insertString = "an ";
text.insert(8, insertString);
System.out.println(text.toString());

直接使用 StringBuilder 对象的 insert 方法,将指定字符串插入至指定位置。程序看起来也更容易阅读。

当然,编程者也可以将使用 substring 方法来完成「字符串插入」的动作自己另外写成方法来调用,但这样做的话,之后字符串处理的过程中,如果遇到需要删除或是取代的时候不也要再实作一次吗?直接使用 StringBuilder 或 StringBuffer 会省事很多。

从刚刚就一直在说 StringBuilder 和 StringBuffer,这两者究竟差在哪里呢?其实,这两者的用法完全一样,只差在 StringBuilder 类别在多线程的条件下是不安全的,而 StringBuffer 类别则是拥有 thread-safe 的特性。若无多线程需求的话,使用 StringBuilder 类型会比较好,因为不用花费性能去处理同步问题。

Java 的内容讲了一堆,回到 Node.js 的主题上吧!Node.js 是单线程的结构,也就是说,同一时间不会有 CPU 同时运行某段程序的问题。若要在 Node.js 上实作如 Java 内置的 StringBuilder 或 StringBuffer,可以不必考虑 thread-safe 的问题,因此只需要有 StringBuilder 就好。

node-stringbuilder

node-stringbuilder 是一个使用 Node.js 8 之后才支持的 N-API 所开发的模块,使用 C 语言和 UTF-16 编码,在一段长度可变的内存内来处理字符串的相关操作,支持 string、Buffer、ReadStream、number、boolean 和其他对象的输入。同时它也内置字符串搜索的功能,使用「Boyer-Moore-MagicLen」算法。且每个对象皆能拷贝出新的独立对象来进行不一样的字符串处理。

npmjs.com

npm 安装指令

npm install node-stringbuilder

使用方法

初始化

使用 require 函数来引入 node-stringbuilder 模块。

const StringBuilder = require("node-stringbuilder");

接着使用 new 操作符,或是使用模块的 from 方法来创建 StringBuilder 对象。

const sb1 = new StringBuilder();
// or 
const sb2 = StringBuilder.from();

建构参数可以传入预设的文字内容和长度容量。

const sb = StringBuilder.from("First", 4096);

长度容量可以分成好几个区块,每个长度容量的区块是 128(个字符)。长度容量可以区块为单位进行扩充或是缩小。

// To expand
const newCapacity = 65536;
sb.expandCapacity(newCapacity);
// To shrink
sb.shrinkCapacity();

当有文字加入至 StringBuilder 对象中时,StringBuilder 会去检查它的长度容量是否足够容纳这新进来的文字。如果不行,它就会自动进行扩展,当然,扩展长度容量的时候会有一些延迟,如果频繁地运行扩展的动作,甚至会拖慢程序的运行速度。因此,如果编程者可以预测这个 StringBuilder 对象大概会存到多长的文字,建议在产生 StringBuilder 对象的阶段就先行设置。

串接(Append)

串接文字至原本的文字之后。

sb.append("string").append(123).append(false).append(fs.createReadStream(path));

串接文字至原本的文字之后,并进行换行。

sb.appendLine("string");

串接文字至原本的文字之后,并重复进行数次。

sb.appendRepeat("string", 3);

异步(async)的方式串接文件内容至原本的文字之后。

await sb.appendReadStream(fs.createReadStream(path));
插入(Insert)

插入文字至原本文字中的任意位置。

sb.insert("string"); // To the head.
sb.insert(5, "string");
取代(Replace)

取代原本文字中的指定位置范围的某段文字。

sb.replace(4, 15, "string");

取代部份原本文字中已存在的子字符串。

sb.replacePattern("old", "new");
sb.replacePattern(
    "old",
    "new",
    offset,
    limit
);

取代所有原本文字中已存在的子字符串。

sb.replaceAll("old", "new");
删除(Delete)

删除原本文字中的指定位置范围的某段文字。

sb.delete(4, 15);

删除原本文字中指定索引位置的字符。

sb.deleteCharAt(4);

清空 StringBuilder 对象,但保留现有的长度容量。

sb.clear();
子字符串(Substring)

仅保留原本文字中的指定位置范围的某段文字。

sb.substring(1, 5); // input the start and end index 
sb.substr(1, 5); // input the start index and length 
反转(Reverse)
sb.reverse();
大小写转换(Upper/Lower Case)

将文字转换成大写或是小写。

sb.upperCase();
sb.lowerCase();
修剪(Trim)

移除文字前后所有空白、换行相关的字符。

sb.trim();
重复(Repeat)

将目前的文字重复数次。

sb.repeat(1);
扩展长度容量

扩展 StringBuilder 对象的长度容量。

sb.expandCapacity(4096).append("string");

扩展 StringBuilder 对象的长度容量,并取得扩展之后的容量。

const capacity = sb.expandCapacity(4096, true);
缩小长度容量

根据目前的文字缩小 StringBuilder 对象的长度容量。

sb.shrinkCapacity().clone().append("string");

根据目前的文字缩小 StringBuilder 对象的长度容量,并取得缩小之后的容量。

const capacity = sb.shrinkCapacity(true);
取得目前文字长度
const length = sb.length();
取得长度容量
const capacity = sb.capacity();
计算字数
const words = sb.count();
创建字符串

将 StringBuilder 对象内指定位置范围的文字转成字符串。

const str = sb.toString(4, 10);

将 StringBuilder 对象内指定位置范围的文字转成 UTF-8 编码的 Buffer。

const buffer = sb.toBuffer(4, 10);

将 StringBuilder 对象内的文字都转成字符串。

const str = sb.toString();

将 StringBuilder 对象内的文字都转成 UTF-8 编码的 Buffer。

const buffer = sb.toBuffer();

取得 StringBuilder 对象内指定索引位置的文字字符。

const c = sb.charAt(4);
字符串搜索

从文字前端开始搜索子字符串。

const indexArray = sb.indexOf("string");
const indexArray2 = sb.indexOf("string", offset, limit);

从文字前端开始搜索符合正则表达式的子字符串。

const indexArray = sb.indexOf(/string/g);

从文后缀端开始搜索子字符串。

const indexArray = sb.lastIndexOf("string");
字符串比对

比对两文字是否完全相等。

const equal = sb.equals("string");

比对两文字是否在忽略大小写的条件下相等。

const equal = sb.equalsIgnoreCase("string");

比对文字是否以某字符串开头或结尾。

const start = sb.startsWith("string");
const end = sb.endsWith("string");
拷贝 StringBuilder 对象
const newSB = sb.clone();

性能的影响

由于使用 C 语言这样的底层程序实作模块的关系,node-stringbuilder 的性能大概只有在「串接(Append)」和「字符串比对(完全相等)」时会比 JS 程序还要来得差。虽说如此,这两者却也是平常开发产品时最常用的功能,因此如果不需要进行除了「串接(Append)」和「字符串比对(完全相等)」之外,其他的字符串操作的话,直接使用 JavaScript 程序原生的方式去产生字符串是比较好的。