写好一个函数的建议

前言

JS 中,除了变量,用的最多的应该就是函数了,函数是 Javascript 的第一公民。

要写好一个函数,个人认为可以从以下几点来编写:

  1. 命名准确
  2. 函数注释
  3. 函数参数
  4. 函数的返回

本文对以上几点做了梳理和总结,希望能对大家有所帮助。

正文

1. 命名准确

  1. 函数名称

这应该是最基本的要求了,函数的命名需要明确,语义清晰,简单概括函数的功能。我们不要想着代码简短而缩短函数名称,这并不会提高什么性能或效率,相反,一个函数名称若不够清晰,往往其他人无法理解。

除了一些都所有人知道的名次(我们这边的 SKU )缩写外,一些相对来讲比较少人知道的专业名次就尽量不要使用缩写。

尽量使用动词,比如:getXxxxxsetXxxxx,动词在前面,语义就能更加清晰。

  1. 参数命名

参数的命名同样重要,我们都强调语义化,参数命名让调用者更清晰的知道该传入什么,对应什么参数。当然,像一些通用命名还是可接受的,像 callbackfn,即使不看注释,往往我也知道这里的参数要做什么,传什么。

2. 函数注释

当我们的命名准确后,我们也不可能让每一个看代码的人都通过名称就知道这个函数在做什么,这个参数代表什么。因此,函数一定要写注释,具体的交互代码不写,但函数的功能,参数至少是不可避免的。

/**
 * 时间格式化工具函数
 * 
 * @param { (Date | number) } date - 时间
 * @param { string } unit - 转换格式
 */
export const timeFormat = (date: Date | number | string, unit: string) => {
  if (!date) {
    return ''
  }
  if (typeof date === 'string') return date;
  if (typeof date === 'number') {
    date = new Date(date);
  }
  const year = date.getFullYear();
  const month = date.getMonth() + 1;
  const day = date.getDate();
  const hour = date.getHours();
  const minute = date.getMinutes();
  const second = date.getSeconds();
  if (unit === 'year') return `${year}`;
  if (unit === 'month') return `${year}-${month}`;
  if (unit === 'day') return `${year}-${month}-${day}`;
  if (unit === 'hour') return `${year}-${month}-${day} ${hour}`;
  if (unit === 'minute') return `${year}-${month}-${day} ${hour}:${minute}`;
  if (unit === 'second') return `${year}-${month}-${day} ${hour}:${minute}:${second}`;
}
复制代码
  1. 参数注释

像上面这个例子,参数前面都加了一个 @param,表明这个是参数的注释。

一般的格式为 @param { type } 参数 - 参数解释

type 表明的是参数的类型,比如 stringnumber,当有多个参数类型的时候,可以这么来标示 { (string|string[]) },表示这个参数可以是字符串或者字符串数组。

还有其他的参数注释可以这么来写

  • 对象属性:需要解释对象的每一个属性
/**
 * Assign the project to an employee.
 * @param {Object} employee - The employee who is responsible for the project.
 * @param {string} employee.name - The name of the employee.
 * @param {string} employee.department - The employee's department.
 */
 Project.prototype.assign = function(employee) {
   // ...
 };
复制代码
  • 可选参数:

有两种语法 JSDocGoogle Closure Compiler

JSDoc 语法

/**
 * 时间格式化工具函数
 * 
 * @param { (Date | number) } date - 时间
 * @param { string } [unit] - 转换格式
 */
export const timeFormat = (date: Date | number | string, unit: string) => {
  // ...
}
复制代码

Google Closure Compiler 语法

/**
 * 时间格式化工具函数
 * 
 * @param { (Date | number) } date - 时间
 * @param { string= } unit - 转换格式
 */
export const timeFormat = (date: Date | number | string, unit: string) => {
  // ...
}
复制代码
  • 默认值:
/**
 * 时间格式化工具函数
 * 
 * @param { (Date | number) } date - 时间
 * @param { string } [unit = 'second'] - 转换格式
 */
export const timeFormat = (date: Date | number | string, unit: string) => {
  // ...
}
复制代码
  1. 函数注释

函数的功能点需要表明,一个函数一个功能,这就是我们说的 单一功能,一个函数就做一件事,因此注释也只会说明函数做了哪一件事。

  1. 其他注释

除了 @param 之外,还有其他的类型

3. 函数参数

  1. 参数默认值

有时候,当一个函数的参数不那么必要,或者某一个值相对应用较多,就应该考虑加上一个默认值,比如上面的时间转换工具,参数就应该这么写。

export const timeFormat = (date: Date, unit = 'second') => {
  // ...
}
复制代码

当我们的业务中需要 YYYY-MM-DD hh:mm:ss 这样的格式较多的时候,unit 默认就是 second, 这样,当我们调用函数的时候,可以只传一个 date 参数,而不需要在每一处调用的代码都写上 timeFormat(new Date(), 'second')

  1. 对象参数

在一段打印代码中,参数多达十几个。像下面这个 打印函数

async function printer_proxy_print(
  html_str: string,
  file_path: string,
  device: string | undefined,
  orientation: number,
  printer_mode: string,
  width: number,
  height: number,
  scale: number,
  from: number,
  to: number,
  left_offset: number,
  top_offset: number,
  pdf_tools: string | undefined,
  begin_page = 1,
  end_page = 1,
  repeat_times = 1,
  print_type: string
) {
    // ...
}
复制代码

这个时候,我们可以给参数默认值,这样可以只传前面几个必要的参数,像这样调用。

async function printer_proxy_print(
  html_str: string,
  file_path: string,
  device = 'pc',
  orientation = 'xxx',
  printer_mode = 'xxx',
  width = 123,
  height = 123,
  scale = 123,
  from = 123,
  to = 123,
  left_offset = 123,
  top_offset = 123,
  pdf_tools = 123,
  begin_page = 1,
  end_page = 1,
  repeat_times = 1,
  print_type = 'base64'
) {
    // ...
}

await printer_proxy_print(html_str, file_path);
复制代码

上面的方法看似可行,实际上,当我中间某个参数不一样的时候,我就需要把这个参数前面的参数都传一遍。这样显然不可行。所以当参数多的时候,我们需要用对象解构的方式传参。

async function printer_proxy_print({
  html_str,
  file_path,
  device = 'pc',
  orientation = 'xxx',
  printer_mode = 'xxx',
  width = 123,
  height = 123,
  scale = 123,
  from = 123,
  to = 123,
  left_offset = 123,
  top_offset = 123,
  pdf_tools = 123,
  begin_page = 1,
  end_page = 1,
  repeat_times = 1,
  print_type = 'base64'
}) {
    // ...
}

await printer_proxy_print({html_str, file_path});
复制代码

解构的好处便是我可以随便传我想要的某几个参数,而不用在意顺序问题。不过像这么多参数的函数往往存在问题(具体问题具体分析)。也就是下面提到的参数数量问题。

  1. 参数数量

一个函数的参数越少越好,最多不应该超过3个,参数多往往以为着关系多,逻辑交叉相对也就多了起来。在进行测试的时候,往往也就很难覆盖到所有条件,出问题概率也就加大了。

参数多的时候,有时候也意味着功能多,就违背了 单一功能 的原则。

  1. 参数类型防御

TS 开发前,我们不知道用户会传什么东西进来,这时候往往容易产生类型错误,又或者,我们想实现兼容,像前面的 timeFormat 函数,我们希望用户调用的时候,可以是想对 时间对象 格式化,也可以是对 时间戳 格式化,那我们就需要做一个防御处理。

  if (!date) {
    return ''
  }
  if (typeof date === 'string') return date;
  if (typeof date === 'number') {
    date = new Date(date);
  }
复制代码

不过值得注意的是,即使我们用上了 TS,在大多数情况下,我们确实可以避免参数类型问题,但是这并不绝对,因为我们有时候会直接接受 接口 返回的数据。

我们常说,永远不要相信用户的输入,同样,接口返回的数据我也不信,我们不能保证,后端不会出错,约定好的参数是数组类型,怎么空的时候,你给我个 null 呢?

当然这些情况有时候需要去试错,有时候我们能想到的可能,不要偷懒,给写上类型判断吧。

4. 函数的返回

  1. 幂等

什么叫幂等,简单来说,输入什么输出什么是固定的,入参决定了出参,不管调用多少次,只要输入一样,结果应该保持一样。

简单的例子:

  function sum(a: number, b: number) {
    return a + b;
  }
复制代码

幂等函数具有可维护性,相对容易进行单元测试。

  1. 纯函数

纯函数在幂等的条件下,还要求没有副作用。

举个例子:

  const dog = {
    name: 'puppy',
    age: 2,
    weight: 30,
  }

  if (!dog.color) {
    console.log('has no color');
  }

  function addColor(dog) {
    dog.color = 'white';
  }

  addColor(dog);
  console.log(dog); // {name: "puppy", age: 2, weight: 30, color: "white"}
复制代码

可以看到,addColor 函数修改了 dog 对象的属性,也就是产生了副作用,我们应该怎么做修改会合理点呢?可以像下面这样:

  function addColor(dog) {
    let copyDog = Object.assign({}, dog);
    copyDog.color = 'white';
    return copyDog;
  }
复制代码

这样一来,dog 对象的属性就不会修改,addColor 函数是纯函数。

  1. return null

null 在进行处理的时候相对麻烦,需要进行判断,导致了额外的代码,应当返回空对象,或者是空数组,或者抛出异常。

总结

良好的代码,自带注释。

希望大家都能养成好的习惯。

谢谢。

作者:皮小蛋
链接:https://juejin.cn/post/6965382280839692302
来源:掘金

版权声明:小马大哥哥 发表于 2021-05-27 23:25:58。
转载请注明:写好一个函数的建议 | 马哥导航

暂无评论

暂无评论...