扩展 Object.assign 实现深拷贝

扩展 Object.assign 实现深拷贝

本文参考: Object.assign 原理及其实现

需求场景

上一篇文章:手写实现深拷贝中,我们讲了浅拷贝和深拷贝,也实现了深拷贝方案。

但深拷贝,它是基于一个原对象,完完整整拷贝一份新对象出来,假如我们的需求是要将原对象上的属性完完整整拷贝到另外一个已存在的对象上,这时候深拷贝就有点无能为力了。

就有点类似于 Object.assign():

var a = {
    a: 1,
    b: 2,
    c: {
        a: 1
    }
}

var o = Object.assign(a, {a: 2, c: {b: 2}, d: 3});
o; // {a: 2, b: 2, c: {b: 2}, d: 3}

将一个原对象上的属性拷贝到另一个目标对象上,最终结果取两个对象的并集,如果有冲突的属性,则以原对象上属性为主,表现上就是直接覆盖过去,这是 Object.assign() 方法的用途。

但很可惜的是,Object.assign 只是浅拷贝,它只处理第一层属性,如果属性是基本类型,则值拷贝,如果是对象类型,则引用拷贝,如果有冲突,则整个覆盖过去。

这往往不符合我们的需求场景,讲个实际中常接触的场景:

在一些表单操作页面,页面初始化时可能会先前端本地创建一个对象来存储表单项,对象中可能会有一些初始值,然后访问了后台接口,读取当前页的表单数据,后台返回了 json 对象,这时候我们希望当前页的表单存储对象应该是后台返回的 json 对象和初始创建的对象的并集,有冲突以后台返回的为主,如:

var a = {
    a: {
        a: 1
    }
}

var o = {
    a: {
        b: 2
    }
}

// 我们希望得到的是:
{
    a: {
        a: 1, 
        b: 2
    }
}

Object.assign(a, b);  // {a: {b: 2}}

其实,说白了,这种需求就是希望可以进行深拷贝,而且是深拷贝到一个目标对象上。

上一篇的深拷贝方案虽然可以实现深度拷贝,但却不支持拷贝到一个目标对象上,而 Object.assign 虽然支持拷贝到目标对象上,但它只是浅拷贝,只处理第一层属性的拷贝。所以,两种方案都不适用于该场景。

但两种方案结合一下,其实也就是该需求的实现方案了,所以要么扩展深拷贝方案,增加与目标对象属性的交集处理和冲突处理;要么扩展 Object.assign,让它支持深拷贝。

实现方案

本篇就选择基于 Object.assign,扩展支持深拷贝:assignDeep。

这里同样会给出几个方案,因为深拷贝的实现可以用递归,也可以用循环,递归比较好写、易懂,但有栈溢出问题;循环比较难写,但没有栈溢出问题。

递归版

function assignDeep(target, ...sources) {
    // 1. 参数校验
    if (target == null) {
        throw new TypeError('Cannot convert undefined or null to object');
    }

    // 2. 如果是基本类型数据转为包装对象
    let result = Object(target);
    
    // 3. 缓存已拷贝过的对象,解决引用关系丢失问题
    if (!result['__hash__']) {
        result['__hash__'] = new WeakMap();
    }
    let hash  = result['__hash__'];

    sources.forEach(v => {
        // 4. 如果是基本类型数据转为对象类型
        let source = Object(v);
        // 5. 遍历原对象属性,基本类型则值拷贝,对象类型则递归遍历
        Reflect.ownKeys(source).forEach(key => {
            // 6. 跳过自有的不可枚举的属性
            if (!Object.getOwnPropertyDescriptor(source, key).enumerable) {
                return;
            }
            if (typeof source[key] === 'object' && source[key] !== null) {
                // 7. 属性的冲突处理和拷贝处理
                let isPropertyDone = false;
                if (!result[key] || !(typeof result[key] === 'object') 
                    || Array.isArray(result[key]) !== Array.isArray(source[key])) {
                    // 当 target 没有该属性,或者属性类型和 source 不一致时,直接整个覆盖
                    if (hash.get(source[key])) {
                        result[key] = hash.get(source[key]);
                        isPropertyDone = true;
                    } else {
                        result[key] = Array.isArray(source[key]) ? [] : {};
                        hash.set(source[key], result[key]);
                    }
                }
                if (!isPropertyDone) {
                    result[key]['__hash__'] = hash;
                    assignDeep(result[key], source[key]);
                }
            } else {
                Object.assign(result, {[key]: source[key]});
            }
        });
    });

    delete result['__hash__'];
    return result;
}

要注意的地方,其实也就是模拟实现 Object.assign 的一些细节处理,比如参数校验,参数处理,属性遍历,以及引用关系丢失问题。

循环版

function assignDeep(target, ...sources) {
    // 1. 参数校验
    if (target == null) {
        throw new TypeError('Cannot convert undefined or null to object');
    }

    // 2. 如果是基本类型,则转换包装对象
    let result = Object(target);
    // 3. 缓存已拷贝过的对象
    let hash = new WeakMap();
    
    // 4. 目标属性是否可直接覆盖赋值判断
    function canPropertyCover(node) {
        if (!node.target[node.key]) {
            return true;
        }
        if (node.target[node.key] == null) {
            return true;
        }
        if (!(typeof node.target[node.key] === 'object')) {
            return true;
        }
        if (Array.isArray(node.target[node.key]) !== Array.isArray(node.data)) {
            return true;
        }
        return false;
    }
    
    sources.forEach(v => {
        let source = Object(v);
        
        let stack = [{
            data: source,
            key: undefined,
            target: result
        }];

        while(stack.length > 0) {
            let node = stack.pop();
            if (typeof node.data === 'object' && node.data !== null) {
                let isPropertyDone = false;
                if (hash.get(node.data) && node.key !== undefined) {
                    if (canPropertyCover(node)) {
                        node.target[node.key] = hash.get(node.data);
                        isPropertyDone = true;
                    }
                }
                
                if(!isPropertyDone) {
                    let target;
                    if (node.key !== undefined) {
                        if (canPropertyCover(node)) {
                            target = Array.isArray(node.data) ? [] : {};
                            hash.set(node.data, target);
                            node.target[node.key] = target;
                        } else {
                            target = node.target[node.key];
                        }
                    } else {
                        target = node.target;
                    }
                    
                    Reflect.ownKeys(node.data).forEach(key => {
                        // 过滤不可枚举属性
                        if (!Object.getOwnPropertyDescriptor(node.data, key).enumerable) {
                            return;
                        }
                        stack.push({
                            data: node.data[key],
                            key: key,
                            target: target
                        });
                    });
                }
            } else {
                Object.assign(node.target, {[node.key]: node.data});
            }
        }

    });

    return result;
}

测试用例:

var a = {};
var o = {
    a: a,
    b: a,
    c: Symbol(),
    [Symbol()]: 1,
    d: function() {},
    e(){},
    f: () => {},
    get g(){},
    h: 1,
    i: 'sdff',
    j: null,
    k: undefined,
    o: /sdfdf/,
    p: new Date()
}

o.l = o;
var o1 = assignDeep({}, {m: {b: 2}, n: 1}, o, {n: {a: 1}});

上面的方案仍旧不是100%完美,仍旧存在一些不足:

  • 没有考虑 ES6 的 set,Map 等新的数据结构类型
  • get,set 存取器逻辑无法拷贝
  • 没有考虑属性值是内置对象的场景,比如 /sfds/ 正则,或 new Date() 日期这些类型的数据
  • 为了解决循环引用和引用关系丢失问题而加入的 hash 缓存无法识别一些属性冲突场景,导致同时存在冲突和循环引用时,拷贝的结果可能有误
  • 等等未发现的逻辑问题坑

虽然有一些小问题,但基本适用于大多数场景了,出问题时再想办法慢慢填坑,目前这样足够使用了,而且,当目标对象是空对象时,此时也可以当做深拷贝来使用。

当然,也欢迎指点一下。

TypeScript 业务版

根据实际项目中的业务需求,进行的相关处理,就没必要像上面的通用版考虑那么多细节,比如我项目中使用 ts 开发,业务需求是要解决实体类数据的初始化和服务端返回的实体类的交集合并场景。

另外,只有对象类型的属性需要进行交集处理,其余类型均直接覆盖即可:

/**
【需求场景】:
export class ADomain {
    name: string = 'dasu';
    wife: B[] = [];
    type: number;
}

export class B {
    count: number = 0;
}

xxxDomain: ADomain;
xxxService.getXXX().subscript(json => {
    this.xxxDomain = json;
    if (!this.xxxDomain.wife) { // 这个处理很繁琐
        this.xxxDomain.wife = [];
    }
});

假设变量 xxxDomain 为实体类 ADomain 实例,实体类内部对其各字段设置了一些初始值;
但由于 xxxService 从后端接口拿到数据后, json 对象可能并不包含 wife 字段,
这样当将 xxxDomain = json 赋值后,后续再使用到 xxxDomain.wife 时还得手动进行判空处理,
这种方式太过繁琐,一旦实体结构复杂一点,层次深一点,判空逻辑会特别长,特别乱,特别烦

(后端不负责初始化,而之所以某些字段需要初始化,是因为界面上需要该值进行呈现)

基于该需求场景,封装了这个工具类:
【使用示例】:
xxxService.getXXX().subscript(json => {
    DomainUtils.handleUndefined(json, ADomain);
    this.xxxDomain = json;
});
*/
export class DomainUtils {
    /**
    * 接收两个参数,第一个是服务端返回的 json 对象,第二个是该对象对应的 class 类,内部会自动根据 class 创建一个新的空对象,然后跟 json 对象的每个属性两两比较,如果在新对象中发现有某个字段有初始值,但 json 对象上没有,则复制过去。
    */
    static handleUndefined(domain: object, prop) {
        let o = new prop();
        if (Array.isArray(domain)) {
            domain.forEach(value => {
                DomainUtils._clone(domain, o);
            });
        } else {
            DomainUtils._clone(domain, o);
        }
        return domain;
    }
    
    private static _clone(target: object, source: object) {
        Object.keys(source).forEach(value => {
            if (!Array.isArray(source[value]) && typeof source[value] === 'object' && source[value] !== null) {
                if (target[value] == null) {
                    target[value] = source[value];
                } else {
                    DomainUtils._clone(target[value] as object, source[value] as object);
                }
            } else {
                if (target[value] == null) {
                    target[value] = source[value];
                }
            }
        });
    }
}

因为直接基于业务需求场景来进行的封装,所以我很明确参数的结构是什么,使用的场景是什么,很多细节就没处理了,比如参数的校验等。

而且,这个目的在于解决初始化问题,所以并不是一个深克隆,而是直接在原对象上进行操作,等效于将初始化的值都复制到原对象上,如果原对象同属性没有值的时候。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,029评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,395评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,570评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,535评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,650评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,850评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,006评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,747评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,207评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,536评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,683评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,342评论 4 330
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,964评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,772评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,004评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,401评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,566评论 2 349

推荐阅读更多精彩内容

  • Swift1> Swift和OC的区别1.1> Swift没有地址/指针的概念1.2> 泛型1.3> 类型严谨 对...
    cosWriter阅读 11,092评论 1 32
  • 手写实现深度拷贝 本文参考:面试题之如何实现一个深拷贝 基础理论 拷贝的基础是赋值,在 js 中,将一个变量赋值给...
    请叫我大苏阅读 970评论 0 1
  • 属性的简洁表示法 ES6允许直接写入变量和函数,作为对象的属性和方法。这样的书写更加简洁。 上面代码表明,ES6允...
    呼呼哥阅读 2,908评论 0 2
  • There was times when i doubted myself, I deeply appreciat...
    七月上的冥王星阅读 207评论 0 0
  • 1.JavaScript 是 web 上一种功能强大的编程语言 ,用于开发交互式 的 web 页面。它不需要进行 ...
    路人爱早茶阅读 228评论 0 0