具有默认值的选项的javascript设计模式？

Question

// opt_options is optional
function foo(a, b, opt_options) {
  // opt_c, opt_d, and opt_e are read from 'opt_options', only c and d have defaults
  var opt_c = 'default_for_c';
  var opt_d = 'default_for_d';
  var opt_e; // e has no default

  if (opt_options) {
    opt_c = opt_options.c || opt_c;
    opt_d = opt_options.d || opt_d;
    opt_e = opt_options.e;
  }
}

上面的内容看起来非常冗长。使用默认参数处理参数选项的更好方法是什么？

Answer 1

将 ES2018 spread syntax 用于对象属性：

const defaults = { a: 1, b: 2 };

const ƒ = (given = {}) => {
  const options = { ...defaults, ...given };
  console.log(options);
};

使用 ES6/ES2015 功能，有更多选项可用。

使用解构赋值：

const { a = 1, b = 2 } = options;

你也可以使用解构函数参数：

const ƒ = ({a = 1, b = 2, c = 3} = {}) => {
   console.log({ a, b, c });
};

使用Object.assign：

options = Object.assign({}, defaults, options);

没有依赖关系！

Answer 2

有一种新的 javascript 语法可以轻松设置默认值、逻辑赋值运算符：

// Super crazy this:
staticConfig.defaultPropsForFoo = 
  staticConfig.defaultPropsForFoo || {
    myDefault: 'props'
  }
// turns into:
staticConfig.defaultPropsForFoo ||= { myDefault: 'props' }

如果您更喜欢更严格的布尔语义，也可以使用 nullish 运算符：

staticConfig.defaultPropsForFoo ??= { myDefault: 'props' }

（可以说我们应该始终使用??= 版本，但它也很新）

另外，我一直使用默认参数，但是这种语法在任何解构赋值中都有效：

const {
  defaultPropsForFoo = { myDefault: 'props' },
  ...restConfig
} = staticConfig

Answer 3

使用 ES6 扩展运算符而不使用外部库

function Example(opts) {
   let defaults = { foo: 1, bar: 2 }
   opts = { ...defaults, ...(opts || {}) }
   console.log(opts);
}

Example({ bar: 3, baz: 4 })

// { foo: 1, bar: 3, baz: 4 }

Answer 4

这是一个简单而干净的方法，希望对某人有所帮助：

function example(url, {title = false, check = false, wait = false} = {}){
  console.log('url: ', URL);
  console.log('title: ', title);
  console.log('check: ', check);
  console.log('wait: ', wait);
}

example('https://example.com', {wait: 20})

这是上面代码的输出：

url:  https://example.com
title:  false
check:  false
wait:  20

Answer 5

这使用 jQuery.extend，但可以与您选择的库中的对象合并或 ES6 中的 Object.assign 互换。

function Module(options){
    var defaults = {
        color: 'red'
    };
    var actual = $.extend({}, defaults, options || {});
    console.info( actual.color );
}

var a = new Module();
// Red
var b = new Module( { color: 'blue' } );
// Blue

---

编辑：现在也在underscore 或lodash！

function Module(options){
    var actual = _.defaults(options || {}, {
         color: 'red'
    });
    console.info( actual.color );
}

var a = new Module();
// Red
var b = new Module( { color: 'blue' } );
// Blue

---

在 Javascript ES6 中你可以使用Object.assign:

function Module(options = {}){
    let defaults = {
        color: 'red'
    };
    let actual = Object.assign({}, defaults, options);
    console.info( actual.color );
}

Answer 6

      var mergeOptions = function mergeOptions(userOptions) {

        // Default options
        var options = {
            height: "100px",
            width: "100px" ,
            color: "blue"
        }

        if (userOptions) {
            Object.keys(userOptions).forEach(function (key) {
                options[key] = userOptions[key]
            })
        }

        return options;
    }

Answer 7

如果您有权访问ES6 with a stage 4 proposal（例如使用 Babel），您可以通过展开和解构赋值来完成此操作。

const defaultPrintOptions = {
  fontName: "times",
  fontStyle: "normal",
  fontSize: 10,
  align: "left"
};

// Setting the null default isn't necessary but
// makes it clear that the parameter is optional.
// Could use {} but would create a new object
// each time the function is called.
function print(text, options = null) {
  let {
    fontName,
    fontStyle,
    fontSize,
    align
  } = {
    ...defaultPrintOptions,
    ...options
  };

  console.log(text, fontName, fontStyle, fontSize, align);
}

print("All defaults:");
print("Override some:", {
  fontStyle: "italic",
  align: "center"
});
print("Override all:", {
  fontName: "courier",
  fontStyle: "italic",
  fontSize: 24,
  align: "right"
});

这也有效（但可能会创建更多对象）：

function myFunction({ 
  text = "", 
  line = 0, 
  truncate = 100 
} = {}) {
  console.log(text, line, truncate);
}

（来自David Walsh 的后一个示例-@wprl 的回答也提到了这一点）

Answer 8

虽然Object.assign 是将选项与默认值合并的直接方法，但它有一些缺点：

1. 如果您想使用三元运算符设置条件选项 - 即使undefined 值也会覆盖默认值：

   const options = {
     logging: isProduction ? 'none' : undefined
   };
   const defaults = {
     logging: 'verbose'
   }
   Object.assign({}, defaults, options); // {logging: undefined} !
   

2. 如果您提供不正确的选项名称 - 您不会收到警告：

   const options = {
     loging: 'none' // typo
   };
   const defaults = {
     logging: 'verbose'
   }
   Object.assign({}, defaults, options); // {logging: 'verbose', loging: 'none'} !
   

为了解决这些情况，我创建了微小的 flat-options 包。
它不会覆盖 undefined 值的默认值：

const options = {
  logging: isProduction ? 'none' : undefined
};
const defaults = {
  logging: 'verbose'
}
flatOptions(options, defaults); // {logging: 'verbose'}

并警告选项名称不正确：

const options = {
  loging: 'none' // typo
};
const defaults = {
  logging: 'verbose'
}
flatOptions(options, defaults); // throws "Unknown option: loging."

希望这会有所帮助！

Answer 9

如果您需要在许多连续的功能中执行此操作，那么标准化流程并加快流程的方法是：

function setOpts (standard, user) {
  if (typeof user === 'object' {
    for (var key in user) {
      standard[key] = user[key];
    }
  }
}

然后你可以像这样简单地定义你的函数：

var example = function (options) {
  var opts = {
    a: 1,
    b: 2,
    c:3
  };
  setOpts(opts, options);
}

这样你只在函数内部定义一个选项对象，它包含默认值。

如果要对avoid prototype inheritance进行额外检查，第一个函数可以是：

function setOpts (standard, user) {
  if (typeof user === 'object') {
    Object.keys(user).forEach(function (key) {
      standard[key] = user[key];
    });
  }
}

不支持后一种情况：IE

（可以查看兼容性表here）

---

最后，ECMAScript 6 将为我们带来最好的方法：default parameters。

这需要几个月的时间才能在浏览器中得到广泛支持。

Answer 10

还有更紧凑的 jQuery 版本：

function func(opts) {
    opts = $.extend({
        a: 1,
        b: 2
    }, opts);

    console.log(opts);
}

func();            // Object {a: 1, b: 2} 
func({b: 'new'});  // Object {a: 1, b: "new"} 

Answer 11

为了获得没有额外依赖的默认选项，我使用以下模式：

var my_function = function (arg1, arg2, options) {
    options = options || {};
    options.opt_a = options.hasOwnProperty('opt_a') ? options.opt_a : 'default_opt_a';
    options.opt_b = options.hasOwnProperty('opt_b') ? options.opt_b : 'default_opt_b';
    options.opt_c = options.hasOwnProperty('opt_c') ? options.opt_c : 'default_opt_b';


    // perform operation using options.opt_a, options.opt_b, etc.
};

虽然有点冗长，但我发现它易于阅读、添加/删除选项和添加默认值。当有很多选项时，稍微紧凑的版本是：

var my_function = function (arg1, arg2, options) {
    var default_options = {
        opt_a: 'default_opt_a',
        opt_b: 'default_opt_b',
        opt_c: 'default_opt_c'};

    options = options || {};
    for (var opt in default_options)
        if (default_options.hasOwnProperty(opt) && !options.hasOwnProperty(opt))
            options[opt] = default_options[opt];

    // perform operation using options.opt_a, options.opt_b, etc.
};

Answer 12

我认为您正在寻找这样的东西（抱歉回复晚了）：

function foo(a, b, options) { 
    this.defaults = {
        x: 48, 
        y: 72,
        z: 35
    };
    for (var i in this.defaults) {
        if (options[i] != "undefined") { this.defaults[i] = options[i]; }
    }
    // more code...
}

编辑：抱歉，这是从一些旧代码中获取的...您应该确保使用 hasOwnProperty() 方法来确保您不会遍历 function.prototype 上的所有内容

https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Object/hasOwnProperty

Answer 13

现在回想起来，我有点喜欢这样：

function foo(a, b, opt_options) {
  // Force opt_options to be an object
  opt_options = opt_options || {};

  // opt_c, opt_d, and opt_e are read from 'opt_options', only c and d have defaults
  var opt_c = 'default_for_c' || opt_options.c;
  var opt_d = 'default_for_d' || opt_options.d;
  var opt_e = opt_options.e; // e has no default
}