用过Mongodb 的同学都知道,它会默认为每个 文档(document) 生成一个ObjectId类型的_id字段。而且很多时候,在构建rest api的时候,都会用该字段来标识资源。比如:访问具体一篇博文的内容,URL就可能是:/posts/:postId,这里:postId就是直接用_id字段的字符串形式来表示。它通常会是这样一串值:** 538f0231d74805ed36fc30db**。
那么当我们在对rest api服务做测试的时候,就需要来模拟这样的id,而且它必须有效的。什么意思呢?我来举个例子:假设我们要对查看博文这个api做测试,那么其中就可能会有这样两条用例:
当postId不合法时,服务器应该返回处理错误
当postId合法但不存在时,服务器应该返回处理成功并返回0条记录
其中,第1条用例我们在测试的时候,可以很简单地模拟一个无效的postId,比如:12345 这样的就可以了。但是对于第2条,我们则必须要模拟一个有效的id,它是可以通过mongodb合法性校验的,但是呢mongodb利用这个id去数据库中寻找时又是找不到对应记录的。
为了达到这样一个目的,我们必须得要知道id到底是如何生成出来的,这样我们就可以模拟出符合要求的id了。
好,开干吧!既然说id是个ObjectId类型的,那么我们先去搞清楚ObjectId这种类型到底是什么东西,通过Mongodb官方文档 了解到ObjectId其实就是12个字节长的BSON 。其中12个字节具体内容为:
如上图所示,12个字节被拆成4个部分,每个部分都很好理解,无需多做解释。这里唯一要提的一点是其具体的实现是根据mongodb驱动器(driver)的。下面是node版本驱动器 中对于objectid生成部分的实现代码(具体实现见js-bson 中的generate方法):
ObjectID.prototype.generate = function(time) {
if ('number' != typeof time) {
time = parseInt(Date.now()/1000,10);
}
var time4Bytes = BinaryParser.encodeInt(time, 32, true, true);
/* for time-based ObjectID the bytes following the time will be zeroed */
var machine3Bytes = BinaryParser.encodeInt(MACHINE_ID, 24, false);
var pid2Bytes = BinaryParser.fromShort(typeof process === 'undefined' ? Math.floor(Math.random() * 100000) : process.pid);
var index3Bytes = BinaryParser.encodeInt(this.get_inc(), 24, false, true);
return time4Bytes + machine3Bytes + pid2Bytes + index3Bytes;
};
这里的MACHINE_ID就直接采用了随机数,而其他的驱动器则采用了md5值。接下来,我们再来看看encodeInt方法:
BinaryParser.encodeInt = function encodeInt (data, bits, signed, forceBigEndian) {
var max = maxBits[bits];
if (data >= max || data < -(max / 2)) {
this.warn("encodeInt::overflow");
data = 0;
}
if (data < 0) {
data += max;
}
for (var r = []; data; r[r.length] = String.fromCharCode(data % 256), data = Math.floor(data / 256));
for (bits = -(-bits >> 3) - r.length; bits--; r[r.length] = "\0");
return ((this.bigEndian || forceBigEndian) ? r.reverse() : r).join("");
};
该方法其实最终就会返回bits位字符串。那么此前的generate方法就是会返回一个包含12个字符的字符串。所以这其实就是ObjectId内部的表现形式。我们接着继续看mongodb的文档 发现ObjectId的对外字符串表现形式其实是一个16进制的字符串,那么字符串长度是多少呢?这里简单做换算就可以了:1个字节需要2位16进制来表示,那么12个字节就是24位。所以这个长度一定是24。
好了,那么归根结底,一个合法的id字符串表现形式其实就是:一个由16进制数字组成的长度为24的字符串。
了解了这个原理,那要mock一个id就轻而易举了。这里推荐一个名为chancejs的随机数据生成工具,利用chance.hash({ length: 24 });就可以了!