Immutable 經常使用API簡介

本文主要整理了Immutable.js經常使用API的使用。

Immutable 是什麼？

關於Immutable的定義，官方文檔是這樣說的：

Immutable data encourages pure functions (data-in, data-out) and lends itself to much simpler application development and enabling techniques from functional programming such as lazy evaluation.

簡而言之，Immutable數據就是一旦建立，就不能更改的數據。每當對Immutable對象進行修改的時候，就會返回一個新的Immutable對象，以此來保證數據的不可變。對於Immutable的好處及介紹，你們能夠參考Immutable 詳解及 React 中實踐，這篇文章介紹的很清楚。

由於Immutable的官方文檔有點晦澀難懂，本文只是用來整理Immutable經常使用的API的使用，便於使用與查詢，想了解更詳細的內容，請戳這裏~

有不妥的地方歡迎你們指出~

Immutable 的幾種數據類型

1. List: 有序索引集，相似JavaScript中的Array。
2. Map: 無序索引集，相似JavaScript中的Object。
3. OrderedMap: 有序的Map，根據數據的set()進行排序。
4. Set: 沒有重複值的集合。
5. OrderedSet: 有序的Set，根據數據的add進行排序。
6. Stack: 有序集合，支持使用unshift（）和shift（）添加和刪除。
7. Range(): 返回一個Seq.Indexed類型的集合，這個方法有三個參數，start表示開始值，默認值爲0，end表示結束值，默認爲無窮大，step表明每次增大的數值，默認爲1.若是start = end,則返回空集合。
8. Repeat(): 返回一個vSeq.Indexe類型的集合，這個方法有兩個參數，value表明須要重複的值，times表明要重複的次數，默認爲無窮大。
9. Record: 一個用於生成Record實例的類。相似於JavaScript的Object，可是隻接收特定字符串爲key，具備默認值。
10. Seq: 序列，可是可能不能由具體的數據結構支持。
11. Collection: 是構建全部數據結構的基類，不能夠直接構建。

用的最多就是List和Map，因此在這裏主要介紹這兩種數據類型的API。

API的使用

1.fromJS()

做用：將一個js數據轉換爲Immutable類型的數據。

用法：fromJS(value, converter)

簡介：value是要轉變的數據，converter是要作的操做。第二個參數可不填，默認狀況會將數組準換爲List類型，將對象轉換爲Map類型，其他不作操做。

代碼實現：

const obj = Immutable.fromJS({a:'123',b:'234'},function (key, value, path) {
        console.log(key, value, path)
        return isIndexed(value) ? value.toList() : value.toOrderedMap())
    })

2.toJS()

做用：將一個Immutable數據轉換爲JS類型的數據。

用法：value.toJS()

3.is()

做用：對兩個對象進行比較。

用法：is(map1,map2)

簡介：和js中對象的比較不一樣，在js中比較兩個對象比較的是地址，可是在Immutable中比較的是這個對象hashCode和valueOf，只要兩個對象的hashCode相等，值就是相同的，避免了深度遍歷，提升了性能。

代碼實現：

import { Map, is } from 'immutable'
const map1 = Map({ a: 1, b: 1, c: 1 })
const map2 = Map({ a: 1, b: 1, c: 1 })
map1 === map2   //false
Object.is(map1, map2) // false
is(map1, map2) // true

4.List 和 Map

建立

List() 和 Map()

做用：用來建立一個新的List/Map對象

用法:

//List

List(): List<any>
List<T>(): List<T>

//Map

Map(): Map<any>
Map<T>(): Map<T>

List.of() 和 Map.of()

做用：建立一個新的包含value的List/Map對象

用法：

List.of<T>(...values: Array<T>): List<T>

Map.of<T>(...values: Object<T>): Map<T>

判斷

List.isList() 和 Map.isMap()

做用：判斷一個數據結構是否是List/Map類型

用法：

List.isList(maybeList: any): boolean

Map.isMap(maybeMap: any): boolean

長度

size

做用：獲取List/Map的長度

數據讀取

get() 、 getIn()

做用：獲取數據結構中的數據

has() 、 hasIn()

做用:判斷是否存在某一個key

用法：

Immutable.fromJS([1,2,3,{a:4,b:5}]).has('0'); //true
Immutable.fromJS([1,2,3,{a:4,b:5}]).has('0'); //true
Immutable.fromJS([1,2,3,{a:4,b:5}]).hasIn([3,'b']) //true

includes()

做用：判斷是否存在某一個value

用法：

Immutable.fromJS([1,2,3,{a:4,b:5}]).includes(2); //true
Immutable.fromJS([1,2,3,{a:4,b:5}]).includes('2'); //false 不包含字符2
Immutable.fromJS([1,2,3,{a:4,b:5}]).includes(5); //false 
Immutable.fromJS([1,2,3,{a:4,b:5}]).includes({a:4,b:5}) //false
Immutable.fromJS([1,2,3,{a:4,b:5}]).includes(Immutable.fromJS({a:4,b:5})) //true

first() 、 last()

做用：用來獲取第一個元素或者最後一個元素，若沒有則返回undefined

代碼：

Immutable.fromJS([1,2,3,{a:4,b:5}]).first()//1
Immutable.fromJS([1,2,3,{a:4,b:5}]).last()//{a:4,b:5}

Immutable.fromJS({a:1,b:2,c:{d:3,e:4}}).first() //1
Immutable.fromJS({a:1,b:2,c:{d:3,e:4}}).first() //{d:3,e:4}

數據修改

注：這裏對於數據的修改，是對原數據進行操做後的值賦值給一個新的數據，並不會對原數據進行修改，由於Immutable是不可變的數據類型。

設置 set()

做用：設置第一層key、index的值

用法：

set(index: number, value: T): List<T>
set(key: K, value: V): this

List在使用的時候，將index爲number值設置爲value。Map在使用的時候，將key的值設置爲value。

在List中使用時，若傳入的number爲負數，則將index爲size+index的值設置爲value，例，若傳入-1，則將size-1的值設爲value。若傳入的number的值超過了List的長度，則將List自動補全爲傳入的number的值，將number設置爲value，其他用undefined補全。注：跟js中不一樣，List中不存在空位，[,,,],List中若沒有值，則爲undefined。

代碼實現：

//////List
const originalList = List([ 0 ]);
// List [ 0 ]
originalList.set(1, 1);
// List [ 0, 1 ]
originalList.set(0, 'overwritten');
// List [ "overwritten" ]
originalList.set(2, 2);
// List [ 0, undefined, 2 ]

List().set(50000, 'value').size;
// 50001

//////Map
const { Map } = require('immutable')
const originalMap = Map()
const newerMap = originalMap.set('key', 'value')
const newestMap = newerMap.set('key', 'newer value')

originalMap
// Map {}
newerMap
// Map { "key": "value" }
newestMap
// Map { "key": "newer value" }

setIn()

做用：設置深層結構中某屬性的值

用法：

setIn(keyPath: Iterable<any>, value: any): this

用法與set()同樣，只是第一個參數是一個數組，表明要設置的屬性所在的位置

刪除 delete

做用：用來刪除第一層結構中的屬性

用法：

delete(index: number): List<T>  //List
delete(key: K): this  //Map

deleteIn()

用來刪除深層數據，用法參考setIn

deleteAll() (Map獨有，List沒有)

做用：用來刪除Map中的多個key

用法：deleteAll(keys: Iterable<K>): this

代碼示例：

const names = Map({ a: "Aaron", b: "Barry", c: "Connor" })
names.deleteAll([ 'a', 'c' ])
// Map { "b": "Barry" }

更新 update()

做用：對對象中的某個屬性進行更新，可對原數據進行相關操做

用法：

update(index: number, updater: (value: T) => T): this //List
update(key: K, updater: (value: V) => V): this  //Map

代碼示例：

////List
const list = List([ 'a', 'b', 'c' ])
const result = list.update(2, val => val.toUpperCase())

///Map
const aMap = Map({ key: 'value' })
const newMap = aMap.update('key', value => value + value)

updateIn()

用法參考setIn

清除 clear()

做用：清除全部數據

用法：clear(): this

代碼示例：

Map({ key: 'value' }).clear()  //Map
List([ 1, 2, 3, 4 ]).clear()   // List

List中的各類刪除與插入

List對應的數據結構是js中的數組，因此數組的一些方法在Immutable中也是通用的，好比push，pop,shift，unshift，insert。

1. push()：在List末尾插入一個元素
2. pop(): 在List末尾刪除一個元素
3. unshift: 在List首部插入一個元素
4. shift: 在List首部刪除一個元素
5. insert：在List的index處插入元素

代碼實現：

List([ 0, 1, 2, 3, 4 ]).insert(6, 5) 
//List [ 0, 1, 2, 3, 4, 5 ]
List([ 1, 2, 3, 4 ]).push(5)
// List [ 1, 2, 3, 4, 5 ]
List([ 1, 2, 3, 4 ]).pop()
// List[ 1, 2, 3 ]
List([ 2, 3, 4]).unshift(1);
// List [ 1, 2, 3, 4 ]
List([ 0, 1, 2, 3, 4 ]).shift();
// List [ 1, 2, 3, 4 ]

List中還有一個特有的方法用法設置List的長度，setSize()

List([]).setSize(2).toJS() //[undefined,undefined]

關於merge

merge

做用：淺合併，新數據與舊數據對比，舊數據中不存在的屬性直接添加，就數據中已存在的屬性用新數據中的覆蓋

mergrWith

做用：自定義淺合併，可自行設置某些屬性的值

mergeIn

做用：對深層數據進行淺合併

mergeDeep

做用：深合併，新舊數據中同時存在的的屬性爲新舊數據合併以後的數據

mergeDeepIn

做用：對深層數據進行深合併

mergrDeepWith

做用:自定義深合併，可自行設置某些屬性的值

這裏用一段示例完全搞懂merge，此示例爲Map結構，List與Map原理相同

const Map1 = Immutable.fromJS({a:111,b:222,c:{d:333,e:444}});
 const Map2 = Immutable.fromJS({a:111,b:222,c:{e:444,f:555}});

 const Map3 = Map1.merge(Map2);
  //Map {a:111,b:222,c:{e:444,f:555}}
 const Map4 = Map1.mergeDeep(Map2);
  //Map {a:111,b:222,c:{d:333,e:444,f:555}}
 const Map5 = Map1.mergeWith((oldData,newData,key)=>{
      if(key === 'a'){
        return 666;
      }else{
        return newData
      }
    },Map2);
  //Map {a:666,b:222,c:{e:444,f:555}}

序列算法

concat()

做用：對象的拼接，用法與js數組中的concat()相同，返回一個新的對象。

用法：const List = list1.concat(list2)

map()

做用：遍歷整個對象，對Map/List元素進行操做，返回一個新的對象。

用法：

Map({a:1,b:2}).map(val=>10*val)
//Map{a:10,b:20}

Map特有的mapKey()

做用：遍歷整個對象，對Map元素的key進行操做，返回一個新的對象。

用法：

Map({a:1,b:2}).mapKey(val=>val+'l')
//Map{al:10,bl:20}

Map特有的mapEntries()

做用：遍歷整個對象，對Map元素的key和value同時進行操做，返回一個新的對象。Map的map()也可實現此功能。

用法：

Map({a:1,b:2}).map((key,val)=>{
  return [key+'l',val*10]
})
//Map{al:10,bl:20}

過濾 filter

做用：返回一個新的對象，包括全部知足過濾條件的元素

用法：

Map({a:1,b:2}).filter((key,val)=>{
  return val == 2
})
//Map{b:2}

還有一個filterNot()方法，與此方法正好相反。

反轉 reverse

做用：將數據的結構進行反轉

代碼示例：

Immutable.fromJS([1, 2, 3, 4, 5]).reverse();
// List [5,4,3,2,1]
Immutable.fromJS({a:1,b:{c:2,d:3},e:4}).recerse();
//Map {e:4,b:{c:2,d:3},a:1}

排序 sort & sortBy

做用：對數據結構進行排序

代碼示例：

///List
Immutable.fromJS([4,3,5,2,6,1]).sort()
// List [1,2,3,4,5,6]
Immutable.fromJS([4,3,5,2,6,1]).sort((a,b)=>{
  if (a < b) { return -1; }
  if (a > b) { return 1; }
  if (a === b) { return 0; }
})
// List [1,2,3,4,5,6]
Immutable.fromJS([{a:3},{a:2},{a:4},{a:1}]).sortBy((val,index,obj)=>{
  return val.get('a')
},(a,b)=>{
  if (a < b) { return -1; }
  if (a > b) { return 1; }
  if (a === b) { return 0; }
})
//List  [ {a:3}, {a:2}, {a:4}, {a:1} ]

//Map

Immutable.fromJS( {b:1, a: 3, c: 2, d:5} ).sort()
//Map {b: 1, c: 2, a: 3, d: 5}
Immutable.fromJS( {b:1, a: 3, c: 2, d:5} ).sort((a,b)=>{
  if (a < b) { return -1; }
  if (a > b) { return 1; }
  if (a === b) { return 0; }
})
//Map {b: 1, c: 2, a: 3, d: 5}
Immutable.fromJS( {b:1, a: 3, c: 2, d:5} ).sortBy((value, key, obj)=> {
  return value
})
//Map {b: 1, c: 2, a: 3, d: 5}

分組 groupBy

做用：對數據進行分組

const listOfMaps = List([
  Map({ v: 0 }),
  Map({ v: 1 }),
  Map({ v: 1 }),
  Map({ v: 0 }),
  Map({ v: 2 })
])
const groupsOfMaps = listOfMaps.groupBy(x => x.get('v'))
// Map {
//   0: List [ Map{ "v": 0 }, Map { "v": 0 } ],
//   1: List [ Map{ "v": 1 }, Map { "v": 1 } ],
//   2: List [ Map{ "v": 2 } ],
// }

查找數據

indexOf() 、 lastIndexOf Map不存在此方法

做用：和js數組中的方法相同，查找第一個或者最後一個value的index值，找不到則返回-1

用法：

Immutable.fromJS([1,2,3,4]).indexof(3) //2
Immutable.fromJS([1,2,3,4]).lastIndexof(3) //2

findIndex() 、 findLastIndex() Map不存在此方法

做用：查找知足要求的元素的index值

用法：

Immutable.fromJS([1,2,3,4]).findIndex((value,index,array)=>{
  return value%2 === 0;
})   // 1
Immutable.fromJS([1,2,3,4]).findLastIndex((value,index,array)=>{
  return index%2 === 0;
})  // 3

find() 、 findLast()

做用：查找知足條件的元素的value值

用法：

Immutable.fromJS([1,2,3,4]).find((value,index,array)=>{
  return value%2 === 0;
})  // 2

Immutable.fromJS([1,2,3,4]).findLast((value,index,array)=>{
  return value%2 === 0;
})  // 4

findKey() 、 findLastKey()

做用：查找知足條件的元素的key值

用法：

Immutable.fromJS([1,2,3,4]).findKey((value,index,array)=>{
  return value%2 === 0;
})  // 1

Immutable.fromJS([1,2,3,4]).findLastKey((value,index,array)=>{
  return value%2 === 0;
})  // 3

findEntry() 、 findLastEntry()

做用：查找知足條件的元素的鍵值對 key:value

用法：

Immutable.fromJS([1,2,3,4]).findEntry((value,index,array)=>{
  return value%2 === 0;
})  // [1,2]

Immutable.fromJS([1,2,3,4]).findLastEntry((value,index,array)=>{
  return value%2 === 0;
})  // [3,4]

keyOf() lastKeyOf()

做用：查找某一個value對應的key值

用法：

Immutable.fromJS([1,2,3,4]).keyOf(2) //1
Immutable.fromJS([1,2,3,4]).lastKeyOf(2) //1

max() 、 maxBy()

做用：查找最大值

用法:

Immutable.fromJS([1, 2, 3, 4]).max() //4

Immutable.fromJS([{a;1},{a:2},{a: 3},{a:4}]).maxBy((value,index,array)=>{
  return value.get('a')
})  //{a:4}

min() 、 minBy()

做用：查找最小值

用法:

Immutable.fromJS([1, 2, 3, 4]).min() //1

Immutable.fromJS([{a;1},{a:2},{a: 3},{a:4}]).minBy((value,index,array)=>{
  return value.get('a')
})  //{a:1}

建立子集

slice()

做用： 和原生js中數組的slice數組同樣，包含兩個參數，start和end，start表明開始截取的位置，end表明結束的位置，不包括第end的元素。若不包括end，則返回整個對象，若end爲負數，則返回（start，length-end）對應的數據。若start只有一個而且爲負數，則返回最後的end個元素。

用法：

Immutable.fromJS([1, 2, 3, 4]).slice(0); //[1,2,3,4]
Immutable.fromJS([1, 2, 3, 4]).slice(0,2); //[1,2]
Immutable.fromJS([1, 2, 3, 4]).slice(-2); //[3,4]
Immutable.fromJS([1, 2, 3, 4]).slice(0,-2); //[1,2]

rest()

做用：返回除第一個元素以外的全部元素

用法:Immutable.fromJS([1, 2, 3, 4]).rest()//[2,3,4]

butLast()

做用：返回除最後一個元素以外的全部元素

用法:Immutable.fromJS([1, 2, 3, 4]).rest()//[1,2,3]

skip()

做用：有一個參數n, 返回截掉前n個元素以後剩下的全部元素

用法:Immutable.fromJS([1, 2, 3, 4]).skip(1)//[2,3,4]

skipLast()

做用：有一個參數n, 返回截掉最後n個元素以後剩下的全部元素

用法:Immutable.fromJS([1, 2, 3, 4]).skip(1)//[1,2,3]

skipWhile()

做用：返回從第一次返回false以後的全部元素

Immutable.fromJS([1, 2, 3, 4]).skipWhile(list.skipWhile((value,index,list)=>{
  return value > 2;
}))// [1,2,3,4]

skipUntil()

做用：返回從第一次返回true以後的全部元素

Immutable.fromJS([1, 2, 3, 4]).skipUntil(list.skipWhile((value,index,list)=>{
  return value > 2;
}))// [3,4]

take()

做用：有一個參數n, 返回前n個元素

用法:Immutable.fromJS([1, 2, 3, 4]).take(2)//[1,2]

takeLast()

做用：有一個參數n, 返回最後n個元素

用法:Immutable.fromJS([1, 2, 3, 4]).takeLast(2)//[3,4]

takeWhile()

做用：返回從第一次返回false以前的全部元素

Immutable.fromJS([1, 2, 3, 4]).skipWhile(list.takeWhile((value,index,list)=>{
  return value > 2;
}))// []

takeUntil()

做用：返回從第一次返回true以前的全部元素

Immutable.fromJS([1, 2, 3, 4]).skipUntil(list.takeUntil((value,index,list)=>{
  return value > 2;
}))// [1,2]

處理數據

reduce()

做用：和js中數組中的reduce相同,按索引升序的順序處理元素

用法：

Immutable.fromJS([1,2,3,4]).reduce((pre,next,index,arr)=>{
  console.log(pre+next)
  return pre+next; 
})
// 3 6 10

reduceRight()

做用：和js中數組中的reduce相同,按索引降序的順序處理元素

用法：

Immutable.fromJS([1,2,3,4]).reduceRight((pre,next,index,arr)=>{
  console.log(pre+next)
  return pre+next; 
})
// 7 9 10

every()

做用：判斷整個對象總中全部的元素是否是都知足某一個條件，都知足返回true，反之返回false。

代碼：

Immutable.fromJS([1,2,3,4]).every((value,index,arr)=>{
  return value > 2
}) // false

some()

做用：判斷整個對象總中全部的元素是否是存在知足某一個條件的元素，若存在返回true，反之返回false。

代碼：

Immutable.fromJS([1,2,3,4]).some((value,index,arr)=>{
  return value > 2
}) // true

join()

做用：同js中數組的join方法。把準換爲字符串

用法：Immutable.fromJS([1,2,3,4]).join(',') //1,2,3,4

isEmpty()

做用：判斷是否爲空

用法:

Immutable.fromJS([]).isEmpty(); // true
Immutable.fromJS({}).isEmpty(); // true

count()

做用：返回元素個數，可自定義條件，返回知足條件的個數

用法：

const list = Immutable.fromJS([1,2,3,4]);
const map = Immutable.fromJS({a:1,b:2,c:3,d:4});

list.count((value,index,list)=>{
  return value > 2;
})    //2

map.count((value,index,list)=>{
  return value > 2;
})    //2

countBy()

做用：與count不一樣的是，countBy返回一個對象

用法：

const list = Immutable.fromJS([1,2,3,4]);
const map = Immutable.fromJS({a:1,b:2,c:3,d:4});

list.countBy((value,index,list)=>{
  return value > 2;
} //{false: 2, true: 2}

map.countBy((value,index,list)=>{
  return value > 2;
} //{false: 2, true: 2}