概念

mokia 主要围绕以下几个概念进行工作：

• 生成器（producer）
• 装饰器（decorator）
• 模拟数据结构（schema）

生成器（producer）

生成器就是用于生成各种数据类型的函数，它们执行后会立即返回结果，如：

import mokia from 'mokia';

mokia.producer.boolean(); // 生成随机布尔值
mokia.producer.integer(); // 生成随机整型
mokia.producer.fullName(); // 生成随机英文名
mokia.producer.date(); // 生成随机日期字符串
// ...

通常为了生成满足特定范围或条件的值，这些生成器函数可能会有多个重载，如integer()、integer(max)、integer(min, max)。

所有内置的生成器由独立的包@mokia/producer (opens new window)提供，可以单独安装使用，你可以在 API 文档中查看。

装饰器（decorator）

装饰器也是函数，每个内置的生成器都对应着一个装饰器函数，执行装饰器函数并不会立即返回生成器的结果，而是得到一个返回生成器结果的无参函数：

import mokia from 'mokia';

const int = mokia.integer(max); // 返回一个函数：() => number
// 等价于
const int = () => mokia.producer.integer(max);

装饰器函数与对应的生成器函数一样，拥有多个重载，接收的参数将会被缓存起来，每次结果函数被执行时，都会将这些参数作为生成器的参数来执行。

依赖于这一特性，装饰器函数通常用于定义模拟数据结构（schema），以便生成结构复杂的模拟数据。

除此之外，其返回值也可以当作 TypeScript 的属性装饰器使用：

import mokia from 'mokia';

class User {
  @mokia.fullName()
  name: string;
}

const user = new User();
console.log(user.name); // 随机的英文名

所有内置的装饰器由独立的包@mokia/decorator (opens new window)提供，可以单独安装使用。

模拟数据结构（schema）

对于实际的业务场景，单纯使用生成器来产生模拟数据是远远不够的，真实的接口数据往往由不同的数据嵌套、组合形成，这时我们可以定义模拟数据结构来生成更加复杂的数据。

模拟数据结构本质就是普通的 JS 对象，传入到generate生成器，就可以根据对象结构来生成模拟数据：

基本类型、对象

Run

producer.generate({
  num: 1,
  bool: true,
  str: 'string',
  obj: {
    null: null,
    undefined: undefined,
  },
});

函数

Run

producer.generate({
  foo: () => Math.random(),
  nested: {
    nested: {
      value: () => Math.random(),
    },
  },
});

数组

Run

producer.generate({
  arr: [
    1,
    () => Math.random(),
    {
      foo: () => Math.random(),
    },
    [() => Math.random()],
  ],
});

当传入对象的属性值为不同类型时，有不同的生成逻辑：

• 当值为基本类型时，返回当前值
• 当值为函数时，返回函数执行结果
• 当值为对象时，执行generate(obj)，并返回结果
• 当值类数组时，遍历每一项执行generate(item)，并返回结果

正因为 decorator 也是函数，所以可以参与模拟数据结构的定义：

装饰器

Run

producer.generate({
  name: mokia.fullName(),
  birthday: mokia.birthday(),
  email: mokia.email(),
  homepage: mokia.url(),
});

等价引用

上面提到的几个概念，虽然技术实现分离到不同的包中， 但在实际使用中，我们通常只需引用一个依赖——mokia：

- import * as decorator from '@mokia/decorator';
- import * as producer from '@mokia/producer';
+ import mokia from 'mokia';

// 调用decorator
- decorator.boolean();
+ mokia.boolean();

// 调用producer
- producer.boolean();
+ mokia.producer.boolean();

// 作为函数调用
- producer.generate({ foo: decorator.boolean() });
+ mokia({ foo: mokia.boolean() });