大家好,我是杨成功。
经过上一篇的学习,数据结构的集合部分已经完结了。那么下面我们又要认识一个新的数据结构,它的名字相信你绝不陌生,它就是字典。
这个字典可不是查汉字时用的那个字典。字典在数据结构中也是用来存储唯一的不重复的值,这一点倒和集合类似。不过两者的存储形式不同。
集合更关注元素本身,以元素本身的值作为唯一标识。而字典的存储形式是 键值对
,这个我们太熟了。以 key
为标识,value
为对应的值,这不就是我们的 Json 嘛。
下面我们从最基础开始,系统的学习一下字典。
什么是字典
上面说了,集合中是通过元素的值来决定元素的唯一性。然而在字典中,存储的方式是键值对,也就是 key->value
的形式,字典只要求 key 必须唯一,value 则没有限制。
这里 key 的作用是唯一标识,用来查询对应的 value 值。也就是说可以通过唯一的 key 映射到对应的 value。所以字典也称作映射,符号表或关联数组。
在计算机世界中,字典经常用来标识对象的引用地址。比如在 JavaScript 当中的引用类型
数据,变量名会指向数据的引用,这是一对映射关系。变量名不能重复,但是不同的变量名可以指向同一块引用。
与 Set 类似,JavaScript ES6 中同样包含了一个 Map
类,即我们所说的字典。
创建字典类
下面我们参照 ES6 Map 类的实现,自己动手实现一个 Dictionary
类。
class Dictionary {
constructor() {
this.table = {}
}
}
与前面的其他数据结构实现类似,我们在一个对象 table
中存储所有字典的元素。我们的保存形式为:table[key] = {key, value}
。
在字典中,通常是用字符串作为键名(key),数据值可以是任意类型。但是 JavaScript 并不是强类型的语言,无法保证传入的键名一定是字符串。所以我们需要将键名做一次字符串的转化。
写一个默认的转换字符串函数:
代码语言:javascript复制function keyToString(item) {
if(item === null) {
return 'NULL'
}
if(item === undefined) {
return 'UNDEFINED'
}
if(item instanceof String) {
return `${item}`
}
return item.toString()
}
除此之外,我们还有必要将键值对的数据格式封装成一个单独的类。因为我们的 key 是不固定的,然而在后面的方法中要频繁使用 key,此时你不知道键名具体是什么。所以封装一个 ValuePair
类会让后续的使用更方便:
class ValuePair {
constructor(key, value) {
this.key = key;
this.value = value;
}
}
接下来在类中声明一些必要的方法如下:
set
:向字典中添加新元素remove
:以键名为参数,移除字典中对应的键值hasKey
:检测某个键名是否存在于字典中,存在则返回 trueget
:用键名查找对应的键值并返回clear
:清空字典size
:返回字典所包含键的数量isEmpty
:在 size 等于零时返回 truekeys
:返回字典中所有键名组成的数组values
:返回字典中所有键值组成的数组keyValues
:返回所有键值对forEach
:迭代所有的键值对
hasKey 方法
该方法的作用是检测一个键是否在字典中。因为这个方法会在添加和删除元素时使用,所以先实现:
代码语言:javascript复制hasKey(key) {
return this.table[keyToString(key)] != null
}
首先对传入的键进行字符串转换,然后判断键值是不是 null
或者 undefined
。
set 方法
set 方法用来在字典中添加键值对:
代码语言:javascript复制set(key, value) {
if(key != null && value != null) {
let table_key = keyToString(key)
this.table[table_key] = new ValuePair(key, value)
return true
}
return false
}
remove 方法
remove 方法用来在字典中删除一个键值对:
代码语言:javascript复制remove(key) {
if(this.hasKey(key)) {
delete this.table[keyToString(key)]
return true
}
return false
}
get 方法
get 方法用来获取键名对应的键值:
代码语言:javascript复制get(key) {
if(this.hasKey(key)) {
let table_key = keyToString(key)
return this.table[table_key].value
}
return undefined
}
keys, values, keyValues 方法
这三个是比较简单的辅助函数,一起介绍:
代码语言:javascript复制keyValues() {
return Object.values(this.table)
}
keys() {
return this.keyValues().map(valuePair=> valuePair.key)
}
values() {
return this.keyValues().map(valuePair=> valuePair.value)
}
首先 keyValues
方法会以数组的形式返回字典的所有键值,返回结果是一个 ValuePair 实例的数组。然后在这个函数的基础上,再分别获取对应的 key 数组和 value 数组。
forEach 方法
forEach 方法与数组的 forEach 方法功能一致,就是迭代所有元素,我们看一下迭代字典的所有值怎么实现:
代码语言:javascript复制forEach(callFn) {
let valuePairs = this.keyValues()
for(let i = 0; i < valuePairs.length; i ) {
let result = callFn(valuePairs[i].key, valuePairs[i].value)
if(result === false) break;
}
}
首先传一个回调函数作为参数,然后遍历字典的长度,并在循环里调用这个回调函数。这里我们的一个设计是,如果在回调函数内返回 false
,则会中断循环。
clear, size, isEmpty 方法
这个三个方法也比较基础:
代码语言:javascript复制size() {
return Object.keys(this.table).length;
}
isEmpty() {
return this.size() === 0
}
clear() {
this.table = {}
}
使用字典
前面我们写了不少方法实现了一个字典类,现在来使用一下:
代码语言:javascript复制var dict = new Dictionary();
dict.set("name", "赛罗");
dict.set("color", "红蓝");
dict.set("skill", "头标");
添加了三个键值对,我们看一下基本方法的返回结果:
代码语言:javascript复制console.log(dict.keys()); // ['name', 'color', 'skill']
console.log(dict.values()); // ['赛罗', '红蓝', '头标']
console.log(dict.size()); // 3
console.log(dict.hasKey("color")); // true
console.log(dict.get("color")); // 红蓝
console.log(dict.hasKey("like")); // false
console.log(dict.get("like")); // undefined
看结果都没问题,再来一波遍历:
代码语言:javascript复制dict.forEach((key, value) => {
console.log(key, value);
if (key === "color") return false;
});
// 打印结果:
// name 赛罗
// color 红蓝
可见循环遍历是没有问题的,而且当函数执行返回 false 时,则会终止遍历,因此第三个键值对没有打印出来,结果达标。
最后再看一下删除:
代码语言:javascript复制// 删除键值对
console.log(dict.remove("color")); // true
console.log(dict.remove("like")); // false
console.log(dict.remove("skill")); // true
console.log(dict.keyValues()); // [ValuePair]
console.log(dict.hasKey("color")); false
console.log(dict.size()); 1
// 清空字典
dict.clear();
console.log(dict.keyValues()); // []
console.log(dict.isEmpty()); // true
也没问题,结果完美!
总结
本篇从头到尾介绍了字典的相关知识,你学会了吗?虽然 ES6 提供了原生支持,但是对于我们学习者来说,手动实现一次更有助于了解原理。
下一篇,我们介绍另一个数据结构 —— 散列表。
本文来源公众号:程序员成功。这是学习 JavaScript 数据结构与算法的第 16 篇,本系列会连续更新一个月。