TS类型体操入门 —— 实现DeepKeyOf

581次阅读  |  发布于2年以前

背景

我们知道，在ts中提供了keyof关键字让我们能够获取一个interface的全部的key

interface Stu {
    name: string;
    age: number;
}

type keys = keyof Stu; // type keys = 'name' | 'age'

但并没有提供下面这样的递归地获取一个interface的key的能力

interface Stu {
    name: string;
    age: number;
    nest: {
        a: {
            b: number;
        }
    }
}

// expected
type deepKeys = deepkeyof Stu; // type deepKeys = 'name' | 'age' | 'nest' | 'nest.a' | 'nest.a.b'

可实际上这种能力非常有用，比如在类似于lodash.get的这种场景下，如果能够有类似于deepkeyof这样的能力，我们就可以直接将path的可能参数都提前限定下来，而不只是简单的设置为string。

let obj = {
    a: {
        b: {
            c: '2333'
        }
    }
}

_.get(obj, 'a.b.c'); // '2333'

实现思路

1. 什么是类型体操

类型体操(type gymnastics)一词最早出现于Haskell的文档[1]中，我认为可以简单理解为类型编程，和我们平时使用JavaScript、C++等语言处理各种值的编程其实没有本质区别，只不过在类型编程中，处理的值是类型。

在JS中，我们在处理的值就是JS这门语言为我们提供的值（包括各种基础数据类型及复杂类型），JS同时给我们提供了一系列的操作符，例如下面的 + 、* ，以及像 split 这样的内置的API。

let a = 1;
let b = a + 2;
let c = b * 5;

let s = 'typescript';
let t = s.split('s');

在TypeScript的类型编程中，我们所处理的值变成了类型这一事物，查看以下代码

type Temp = {
    name: string;
    age: number;
}

type keys = keyof Temp; // type keys = 'name' | 'age'

这里出现的值有 Temp ，操作符 有 keyof 。这里使用了 keyof 来提取Temp中的key。

可能看到这里，你对类型编程还是没有一个具体的概念，我们做以下对比来感受一下类型编程和我们平时通常意义认为的编程的区别。

在类型编程中，我们定义的“变量”是不可变的，我们只能去生成新的变量，而不能去修改已有的变量，这一点和函数式编程语言类似。

// in JavaScript
let a = 1;
const b = 10;
// in type gymnastics
type a = 1;

a = 2;
type b = 2;

类型编程中只有表达式，没有“语句”这一概念，也就没有所谓的条件语句，不过有extends ? :表达式可以帮助我们达到类似的目的。

// in JavaScript
let max;
let a = 10, b = 20;
if (a > b) {
    max = a;
} else {
    max = b;
}
// in type gymnastics
type temp = 10;

type isNumber<T> = T extends number ? true : false;

type res = isNumber<temp>; // type res = true;

类型编程中没有循环，不过可以用递归来模拟。

// in JavaScript
let index = 1;

let n = 10;

while(n--) {
    index *= 10;
}
// in type gymnastics
type path = 'a.b.c';

type Split<T extends string> = T extends `${infer A}.${infer B}` ? A | Split<B> : T;

type test = Split<path>; // type test =  a  |  b  |  c

ts的类型编程中，泛型相当于是函数，只不过泛型本身没法当做参数被传递给泛型

function temp(arg: string) {
    return arg + '123';
}
type Temp<T extends string> = `${T}123`;

2. TS提供的部分类型操作

interface Stu {
    name: string;
    age: number;
    nest: {
        a: {
            b: number;
        }
    }
}

type temp = Stu['nest'];  // type temp = { a: { b: number; }; }

type temp1 = Stu['next' | 'name'] // type temp1 = string | { a: { b: number; }; }
type key1 = 'nest';
type key2 = 'a';
type key3 = `${key1}.${key2}`; // type key3 =  nest.a 

type key4 = 'name' | 'nest'; // union用于模板字符串也会得到一个union
type key5 = `get${key4}`; // type key5 = 'getname' | 'getnest'

// 如果模板字符串的输入中出现了never，会导致整个字符串变成never
type key6 = `get${never}`; // type key6 = never
type UnpackPromise<T extends Promise<any>> = T extends Promise<infer A> ? A : never;

type test = UnpackPromise<Promise<number>> // type test = number
type path = 'a.b.c';

type Split<T extends string> = T extends `${infer A}.${infer B}` ? A | Split<B> : T;

type test = Split<path>; // type test =  a  |  b  |  c 
interface Temp {
    name: string;
    age: number;
}

type ToFunc = {
    [k in keyof Temp]: (arg: Temp[k]) => void;
}

// type ToFunc = {
//     name: (arg: string) => void;
//     age: (arg: number) => void;
// }

// 甚至能把原interface中的key也改了
type ToGetFunc = {
    [k in keyof Temp as `get${k}`]: (arg: Temp[k]) => void;
}

// type ToGetFunc = {
//     getname: (arg: string) => void;
//     getage: (arg: number) => void;
// }

3. 顺序执行方案

回到我们最初的问题，实现DeepKeyOf，我们可以先尝试使用顺序执行的方式实现

1 . 使用keyof拿到第一层的key

interface Stu {
    name: string;
    age: number;
    nest: {
        a: {
            b: number;
        }
    }
}

type keys1 = keyof Stu; // type keys1 = 'name' | 'age' | 'nest';

2 . 拿到第一层的key以后，用来获取第二层的类型

type types2 = Stu[keys1]; // type types2 = string | number | { a: { b: number; } }

3 . 将第二层中仍然有多层结构的type过滤出来

type OnlyObject<T extends any> = T extends Record<string, any> ? T : never;
type types2_needed = OnlyObject<types2>; // type types2_needed = { a: { b: number; } }

4 . 把第二层的key拿出来

type keys2 = keyof types2_needed; // type keys2 =  a

5 . 使用步骤4拿到的key重复步骤2

6 . 最终，我们可以拿到每一层的key

type keys1 = 'name' | 'age' | 'nest';
type keys2 = 'a';
type keys3 = 'b';

7 . 尝试一番后发现使用这样顺序执行的方式似乎是没法做到把不同层之间的key正确连接起来的，比如keys2中的'a'并不知道自己是由keys1中哪个key对应的type中获取的。

4. 递归方案

  1. 虽然顺序执行的方式不能解决问题，但是可以为我们的递归的解决方案提供思路。我们的输入是一个任意的interface，输出是它的各级的key连接以后的一个union。
// input
interface Stu {
  name: string;
  nest: {
    a: {
      b: number;
    };
    tt: {
      c: boolean;
    };
  };
  info: {
    score: number;
    grade: string;
  };
}

// output
'name' | 'nest' | 'nest.a' | 'nest.a.b' | 'nest.tt' | 'nest.tt.c' | 'info' |'info.score' | 'info.grade'

在顺序执行步骤的第五步中，我们需要重复第二步，可以猜测我们现在需要解决的这个问题是可以分解为同类的子问题的。

仔细观察，可以发现我们的问题可以这样来表示

1 . 假设我们有一个泛型DeepKeyOf可以获取我们需要的key

type DeepKeyOf<T> = xxx;
type test = DeepKeyOf<Stu> // type test = 'name' | 'nest' | 'nest.a' | 'nest.a.b' | 'nest.tt' | 'nest.tt.c' | 'info' |'info.score' | 'info.grade'

2 . 其内部实现大概会是下面这样

type DeepKeyOf<T> = {
    [k in keyof T]: k;
}[keyof T];

type DeepKeyOf<T> = {
    [k in keyof T]: k |  `  ${k}  .  ${DeepKeyOf<T[k]>}  `  ; 
}[keyof T]

这一步可能比较跳，我们简单解释一下。

3 . 我们再将 Stu 类型传入，手动把这个泛型展开

interface Stu {
  name: string;
  nest: {
    a: {
      b: number;
    };
    tt: {
      c: boolean;
    };
  };
  info: {
    score: number;
    grade: string;
  };
}

type res = DeepKeyOf<Stu>;
type res = {
    name: 'name' | `${'name'}.${DeepKeyOf<string>}`;
    nest: 'nest' | `${'nest'}.${DeppKeyOf<{a: {b: number;} tt: {c: boolean;}}>}`;
    info: 'info' | `${'info'}.${DeepKeyOf<{score: number; grade: string;}>}`;
}['name' | 'nest' | 'info'];
type res = 'name' | `${'name'}.${DeepKeyOf<string>}` | 'nest' | `${'nest'}.${DeppKeyOf<{a: {b: number;} tt: {c: boolean;}}>}` | 'info' | `${'info'}.${DeepKeyOf<{score: number; grade: string;}>}`;

如果我们的DeepKeyOf实现正确的话，DeepKeyOf<string> 应当返回never，DeppKeyOf<{a: {b: number;} tt: {c: boolean;}}>应当返回 'a' | 'a.b' ，DeepKeyOf<{score: number; grade: string;}> 应当返回 'score' | 'grade'

never是union “|” 这一运算中的幺元[4]，任何type与never做union运算均为其本身

如：'name' | 'nest' | never === 'name' | 'nest'

4 . 补充细节


type DeepKeyOf<T> = T extends Record<string, any> ? {
    [k in keyof T]: k | ` ${k} . ${DeepKeyOf<T[k]>} ` ;
}[keyof T] : never;

这是因为keyof T在没有对T做类型限制的情况下拿到的类型会是string | number | symbol，而模板字符串可以接收的类型是 string | number | bigint | boolean | null | undefined，这两个type之间是不兼容的，我们需要对k的类型做进一步的限制

type DeepKeyOf<T> = T extends Record<string, any> ? {
    [k in keyof T]: k extends string ? k | ` ${k} . ${DeepKeyOf<T[k]>} `  : never ;
}[keyof T] : never;

5.最终我们就得到了我们需要的DeepKeyOf泛型

type DeepKeyOf<T> = T extends Record<string, any> ? {
    [k in keyof T]: k extends string ? k | `${k}.${DeepKeyOf<T[k]>}` : never;
}[keyof T] : never;

interface Stu {
  name: string;
  nest: {
    a: {
      b: number;
    };
    tt: {
      c: boolean;
    };
  };
  info: {
    score: number;
    grade: string;
  };
}

type res = DeepKeyOf<Stu>; // "name" | "nest" | "info" | "nest.a" | "nest.tt" | "nest.a.b" | "nest.tt.c" | "info.score" | "info.grade"

总结

以上，我们通过实现一个简单的DeepKeyOf了解了类型编程这一概念，它和我们通常意义认为的编程其实没有本质区别，只是编程中操作的值不同，使用的运算符不同。在实际业务开发过程中，利用类型编程的知识，可以把一些类型收窄到我们实际需要的范围，比如需要一个整数形式的字符串，我们完全可以使用${bigint}，而不是简单的使用一个string。收窄到实际需要的范围不仅可以提高开发体验（类型收窄后，IDE可以相应地提供智能提示，也可以避免大量类型模板代码），也能提高代码的可读性（比如一个函数的输入输出可以更加明确）。

ps：如果你对类型编程感兴趣，可以尝试一下这个体操库[5]，这个repo里有比较多有用的体操题，并且提供了难度分级，同时可以查看其他人的solution，帮助我们快速上手类型体操。

参考资料

[1]Haskell的文档: https://wiki.haskell.org/index.php?title=OOP_vs_type_classes&oldid=5437#Type_classes_is_a_sort_of_templates.2C_not_classes

[2]索引类型: https://www.typescriptlang.org/docs/handbook/2/indexed-access-types.html

[3]模板字符串: https://www.typescriptlang.org/docs/handbook/2/template-literal-types.html

[4]幺元: https://zh.wikipedia.org/zh-cn/%E5%96%AE%E4%BD%8D%E5%85%83

[5]这个体操库: https://github.com/type-challenges/type-challenges/blob/master/README.md

Copyright© 2013-2020

All Rights Reserved 京ICP备2023019179号-8