ES6 - Object.assign()

ES6 - Object.assign()

語法與定義：

Object.assign方法用於對象的合併，將源對象（source）的所有可枚舉屬性，複製到目標對象（target）。
Object.assign方法的第一個參數是目標對象，後面的參數都是源對象。

const target = { a: 1 };

const source1 = { b: 2 };
const source2 = { c: 3 };

Object.assign(target, source1, source2);
target // {a:1, b:2, c:3}

注意，如果目標對象與源對象有同名屬性，或多個源對象有同名屬性，則後面的屬性會覆蓋前面的屬性。

const target = { a: 1, b: 1 };

const source1 = { b: 2, c: 2 };
const source2 = { c: 3 };

Object.assign(target, source1, source2);
target // {a:1, b:2, c:3}

如果只有一個參數，Object.assign會直接返回該參數。

const obj = {a: 1};
Object.assign(obj) === obj // true

如果該參數不是對象，則會先轉成對象，然後返回。

typeof Object.assign(2) // "object"

由於undefined和null無法轉成對象，所以如果它們作爲參數，就會報錯。

Object.assign(undefined) // 報錯
Object.assign(null) // 報錯

如果非對象參數出現在源對象的位置（即非首參數），那麼處理規則有所不同。首先，這些參數都會轉成對象，如果無法轉成對象，就會跳過。這意味着，如果undefined和null不在首參數，就不會報錯。

let obj = {a: 1};
Object.assign(obj, undefined) === obj // true
Object.assign(obj, null) === obj // true

其他類型的值（即數值、字符串和布爾值）不在首參數，也不會報錯。但是，除了字符串會以數組形式，拷貝入目標對象，其他值都不會產生效果。

const v1 = 'abc';
const v2 = true;
const v3 = 10;

const obj = Object.assign({}, v1, v2, v3);
console.log(obj); // { "0": "a", "1": "b", "2": "c" }

上面代碼中，v1、v2、v3分別是字符串、布爾值和數值，結果只有字符串合入目標對象（以字符數組的形式），數值和布爾值都會被忽略。這是因爲只有字符串的包裝對象，會產生可枚舉屬性。

Object(true) // {[[PrimitiveValue]]: true}
Object(10)  //  {[[PrimitiveValue]]: 10}
Object('abc') // {0: "a", 1: "b", 2: "c", length: 3, [[PrimitiveValue]]: "abc"}

上面代碼中，布爾值、數值、字符串分別轉成對應的包裝對象，可以看到它們的原始值都在包裝對象的內部屬性 [[PrimitiveValue]]上面，這個屬性是不會被Object.assign拷貝的。只有字符串的包裝對象，會產生可枚舉的實義屬性，那些屬性則會被拷貝。Object.assign拷貝的屬性是有限制的，只拷貝源對象的自身屬性（不拷貝繼承屬性），也不拷貝不可枚舉的屬性（enumerable: false）。

Object.assign({b: 'c'},
  Object.defineProperty({}, 'invisible', {
    enumerable: false,
    value: 'hello'
  })
)
// { b: 'c' }

上面代碼中，Object.assign要拷貝的對象只有一個不可枚舉屬性invisible，這個屬性並沒有被拷貝進去。屬性名爲 Symbol 值的屬性，也會被Object.assign拷貝。

Object.assign({ a: 'b' }, { [Symbol('c')]: 'd' })
// { a: 'b', Symbol(c): 'd' }

注意點

（1）淺拷貝

Object.assign方法實行的是淺拷貝，而不是深拷貝。也就是說，如果源對象某個屬性的值是對象，那麼目標對象拷貝得到的是這個對象的引用。

const obj1 = {a: {b: 1}};
const obj2 = Object.assign({}, obj1);

obj1.a.b = 2;
obj2.a.b // 2

上面代碼中，源對象obj1的a屬性的值是一個對象，Object.assign拷貝得到的是這個對象的引用。這個對象的任何變化，都會反映到目標對象上面。

（2）同名屬性的替換

對於這種嵌套的對象，一旦遇到同名屬性，Object.assign的處理方法是替換，而不是添加。

const target = { a: { b: 'c', d: 'e' } }
const source = { a: { b: 'hello' } }
Object.assign(target, source)
// { a: { b: 'hello' } }

上面代碼中，target對象的a屬性被source對象的a屬性整個替換掉了，而不會得到{ a: { b: 'hello', d: 'e' } }的結果。這通常不是開發者想要的，需要特別小心。

一些函數庫提供 Object.assign的定製版本（比如 Lodash 的_.defaultsDeep方法），可以得到深拷貝的合併。

（3）數組的處理

Object.assign可以用來處理數組，但是會把數組視爲對象。

Object.assign([1, 2, 3], [4, 5])
// [4, 5, 3]

上面代碼中，Object.assign把數組視爲屬性名爲 0、1、2 的對象，因此源數組的 0 號屬性4覆蓋了目標數組的 0 號屬性1。

（4）取值函數的處理

Object.assign只能進行值的複製，如果要複製的值是一個取值函數，那麼將求值後再複製。

const source = {
  get foo() { return 1 }
};
const target = {};

Object.assign(target, source)
// { foo: 1 }

上面代碼中， source對象的foo屬性是一個取值函數，Object.assign不會複製這個取值函數，只會拿到值以後，將這個值複製過去。

常見用途

（1）爲對象添加屬性

class Point {
  constructor(x, y) {
    Object.assign(this, {x, y});
  }
}

上面方法通過Object.assign方法，將x屬性和y屬性添加到Point類的對象實例。

（2）爲對象添加方法

Object.assign(SomeClass.prototype, {
  someMethod(arg1, arg2) {
    ···
  },
  anotherMethod() {
    ···
  }
});

// 等同於下面的寫法
SomeClass.prototype.someMethod = function (arg1, arg2) {
  ···
};
SomeClass.prototype.anotherMethod = function () {
  ···
};

上面代碼使用了對象屬性的簡潔表示法，直接將兩個函數放在大括號中，再使用assign方法添加到SomeClass.prototype之中。

（3）克隆對象

function clone(origin) {
  return Object.assign({}, origin);
}

上面代碼將原始對象拷貝到一個空對象，就得到了原始對象的克隆。
不過，採用這種方法克隆，只能克隆原始對象自身的值，不能克隆它繼承的值。如果想要保持繼承鏈，可以採用下面的代碼。

function clone(origin) {
  let originProto = Object.getPrototypeOf(origin);
  return Object.assign(Object.create(originProto), origin);
}

（4）合併多個對象

將多個對象合併到某個對象。

const merge = (target, ...sources) => Object.assign(target, ...sources);

如果希望合併後返回一個新對象，可以改寫上面函數，對一個空對象合併。

const merge = (...sources) => Object.assign({}, ...sources);

（5）爲屬性指定默認值

const DEFAULTS = {
  logLevel: 0,
  outputFormat: 'html'
};

function processContent(options) {
  options = Object.assign({}, DEFAULTS, options);
  console.log(options);
  // ...
}

上面代碼中，DEFAULTS對象是默認值，options對象是用戶提供的參數。Object.assign方法將DEFAULTS和options合併成一個新對象，如果兩者有同名屬性，則option的屬性值會覆蓋DEFAULTS的屬性值。

注意，由於存在淺拷貝的問題，DEFAULTS對象和options對象的所有屬性的值，最好都是簡單類型，不要指向另一個對象。否則，DEFAULTS對象的該屬性很可能不起作用。

const DEFAULTS = {
  url: {
    host: 'example.com',
    port: 7070
  },
};

processContent({ url: {port: 8000} })
// {
//   url: {port: 8000}
// }

上面代碼的原意是將 url.port改成 8000，url.host不變。實際結果卻是options.url覆蓋掉DEFAULTS.url，所以url.host就不存在了。