在 Javascript 中正确获取对象 属性
Proper getting of an object property in Javascript
我目前正在一个大型 Javascript 代码库中工作,代码库中充斥着求助于异常的流控制代码
function getChecklistUrl() {
try {
return dataLayerObject.config.checklist;
} catch (e) {
try {
console.error('dataLayer', e);
} catch (ignore) {}
}
}
我可能更喜欢条件逻辑,例如同一函数的这个实现
function getChecklistUrl() {
if(typeof dataLayerObject == 'object' &&
'config' in dataLayerObject &&
typeof dataLayerObject.config == 'object' &&
'checklist' in dataLayerObject.config &&
typeof dataLayerObject.config.checklist == 'object') {
return dataLayerObject.config.checklist;
}
return null;
}
虽然后者感觉冗长,但当然可以编写辅助函数来减少此类检查的样板文件。
前者是 Javascript 的惯用语吗?后者是否脆弱(跨浏览器/场景)并且最好留给 try
/ catch
呢?或者前者只是懒惰的证据?
编辑
这些对象被假定为'plain'对象,例如var obj = {}
所以我不相信我关心这里的原型链。
在 javascript 中检查对象属性的正确方法是 Object.hasOwnProperty() 方法。
示例:
var Person = {
first_name: 'Fred',
last_name: 'Flintstone'
};
if ( 'object' === typeof Person && Person.hasOwnProperty('first_name' ) {
window.alert('the property exists!');
}
编辑
为了检查嵌套对象的属性,您可以尝试这样的操作:
function checkNested(obj /*, level1, level2, ... levelN*/) {
var args = Array.prototype.slice.call(arguments, 1);
for (var i = 0; i < args.length; i++) {
if (!obj || !obj.hasOwnProperty(args[i])) {
return false;
}
obj = obj[args[i]];
}
return true;
}
var test = {level1:{level2:{level3:'level3'}} };
checkNested(test, 'level1', 'level2', 'level3'); // true
checkNested(test, 'level1', 'level2', 'foo'); // false
如果你希望它简短,你可以这样做,但它不会检查 dataLayer 是否是一个对象,所以如果它是一个带有配置和清单的函数,它也会 return 它。但由于它是自定义对象,因此可能不是问题。如果需要,您可以添加 'in' 或 'hasOwnProperty' 检查,或者如果您愿意,可以使用三元检查。
var getChecklistUrl = function getChecklistUrl() {
return dataLayerObject && dataLayerObject.config && dataLayerObject.config.checklist || null;
}
你总是可以利用转换来缩短它:
if ( typeof dataLayerObject == 'object' &&
dataLayerObject.config &&
dataLayerObject.config.checklist &&
typeof dataLayerObject.config.checklist == 'object') {
// do something
}
如果你真的不需要检查checklist是否真的是一个对象,你可以去掉最后的typeof
。第一个 typeof
是必需的,因为您的变量看起来可能是全局变量。
首先,你不需要同时检查 property in object
&& typeof obj[property] == 'object'
,你可以只使用typeof
照顾这两项检查。原因是,如果 obj.property
不存在,typeof
将 return undefined
。
因此,您可以通过编写一个检查某物是否为对象的小型实用函数来模块化您的方法:
function isObject(o) {
return typeof o == 'object' && o !== null; // take care of the corner case that typeof null == 'object'
}
然后只需在必要的对象链上使用它,通过检查它所有拥有的对象是否存在来查找 属性:
function getChecklistUrl() {
if(isObject(dataLayerObject) &&
isObject(dataLayerObject.config) &&
isObject(dataLayerObject.config.checklist)) {
return dataLayerObject.config.checklist;
}
return null;
}
var dataLayerObject = {
config: {
checklist: ['array of stuff']
}
}
function isObject(o) {
return typeof o == 'object' && o !== null;
}
function getChecklistUrl() {
if (isObject(dataLayerObject) &&
isObject(dataLayerObject.config) &&
isObject(dataLayerObject.config.checklist)) {
return dataLayerObject.config.checklist;
}
return null;
}
console.log(getChecklistUrl()[0]);
恕我直言,这使代码更有条理且更易于阅读。
您还可以为采用点分隔字符串的对象执行类似 getter 的操作,如果 属性 没有,则 return 为 属性 或 null '不存在:
function getObjProperty(obj, propString) {
if(!isObject(obj) || !propString || typeof propString != 'string') {
return null; // make sure obj is an object and propString is a non-empty string
}
var props = propString.split('.');
for (var i = 0, l = props.length; i < l; i++) {
var p = props[i];
if(!isObject(obj[p])) { return null; } // if current property isn't an object, return null
obj = obj[p]; // otherwise update the object to the next one down the property chain
}
return obj;
}
您可以像这样使用它:getObjProperty(dataLayerObject, 'config.checklist');
var dataLayerObject = {
config: {
checklist: ['array of stuff']
}
};
function isObject(o) {
return typeof o == 'object' && o !== null;
}
function getObjProperty(obj, propString) {
if (!isObject(obj) || !propString || typeof propString != 'string') {
return null;
}
var props = propString.split('.');
for (var i = 0, l = props.length; i < l; i++) {
var p = props[i];
if (!isObject(obj[p])) { //
return null;
} // if current property isn't an object, return null
obj = obj[p]; // otherwise update the object to the next one down the property chain
}
return obj;
}
console.log(getObjProperty(dataLayerObject, 'config.checklist'));
或者您可以使用
注意:
上面的例子也检查了原型链。如果你不想要这个,你应该在检查 属性 是否是一个对象时使用 hasOwnProperty
来检查 属性 是否存在于测试对象上。
显示了这种方法的一种变体。
我目前正在一个大型 Javascript 代码库中工作,代码库中充斥着求助于异常的流控制代码
function getChecklistUrl() {
try {
return dataLayerObject.config.checklist;
} catch (e) {
try {
console.error('dataLayer', e);
} catch (ignore) {}
}
}
我可能更喜欢条件逻辑,例如同一函数的这个实现
function getChecklistUrl() {
if(typeof dataLayerObject == 'object' &&
'config' in dataLayerObject &&
typeof dataLayerObject.config == 'object' &&
'checklist' in dataLayerObject.config &&
typeof dataLayerObject.config.checklist == 'object') {
return dataLayerObject.config.checklist;
}
return null;
}
虽然后者感觉冗长,但当然可以编写辅助函数来减少此类检查的样板文件。
前者是 Javascript 的惯用语吗?后者是否脆弱(跨浏览器/场景)并且最好留给 try
/ catch
呢?或者前者只是懒惰的证据?
编辑
这些对象被假定为'plain'对象,例如var obj = {}
所以我不相信我关心这里的原型链。
在 javascript 中检查对象属性的正确方法是 Object.hasOwnProperty() 方法。
示例:
var Person = {
first_name: 'Fred',
last_name: 'Flintstone'
};
if ( 'object' === typeof Person && Person.hasOwnProperty('first_name' ) {
window.alert('the property exists!');
}
编辑
为了检查嵌套对象的属性,您可以尝试这样的操作:
function checkNested(obj /*, level1, level2, ... levelN*/) {
var args = Array.prototype.slice.call(arguments, 1);
for (var i = 0; i < args.length; i++) {
if (!obj || !obj.hasOwnProperty(args[i])) {
return false;
}
obj = obj[args[i]];
}
return true;
}
var test = {level1:{level2:{level3:'level3'}} };
checkNested(test, 'level1', 'level2', 'level3'); // true
checkNested(test, 'level1', 'level2', 'foo'); // false
如果你希望它简短,你可以这样做,但它不会检查 dataLayer 是否是一个对象,所以如果它是一个带有配置和清单的函数,它也会 return 它。但由于它是自定义对象,因此可能不是问题。如果需要,您可以添加 'in' 或 'hasOwnProperty' 检查,或者如果您愿意,可以使用三元检查。
var getChecklistUrl = function getChecklistUrl() {
return dataLayerObject && dataLayerObject.config && dataLayerObject.config.checklist || null;
}
你总是可以利用转换来缩短它:
if ( typeof dataLayerObject == 'object' &&
dataLayerObject.config &&
dataLayerObject.config.checklist &&
typeof dataLayerObject.config.checklist == 'object') {
// do something
}
如果你真的不需要检查checklist是否真的是一个对象,你可以去掉最后的typeof
。第一个 typeof
是必需的,因为您的变量看起来可能是全局变量。
首先,你不需要同时检查 property in object
&& typeof obj[property] == 'object'
,你可以只使用typeof
照顾这两项检查。原因是,如果 obj.property
不存在,typeof
将 return undefined
。
因此,您可以通过编写一个检查某物是否为对象的小型实用函数来模块化您的方法:
function isObject(o) {
return typeof o == 'object' && o !== null; // take care of the corner case that typeof null == 'object'
}
然后只需在必要的对象链上使用它,通过检查它所有拥有的对象是否存在来查找 属性:
function getChecklistUrl() {
if(isObject(dataLayerObject) &&
isObject(dataLayerObject.config) &&
isObject(dataLayerObject.config.checklist)) {
return dataLayerObject.config.checklist;
}
return null;
}
var dataLayerObject = {
config: {
checklist: ['array of stuff']
}
}
function isObject(o) {
return typeof o == 'object' && o !== null;
}
function getChecklistUrl() {
if (isObject(dataLayerObject) &&
isObject(dataLayerObject.config) &&
isObject(dataLayerObject.config.checklist)) {
return dataLayerObject.config.checklist;
}
return null;
}
console.log(getChecklistUrl()[0]);
恕我直言,这使代码更有条理且更易于阅读。
您还可以为采用点分隔字符串的对象执行类似 getter 的操作,如果 属性 没有,则 return 为 属性 或 null '不存在:
function getObjProperty(obj, propString) {
if(!isObject(obj) || !propString || typeof propString != 'string') {
return null; // make sure obj is an object and propString is a non-empty string
}
var props = propString.split('.');
for (var i = 0, l = props.length; i < l; i++) {
var p = props[i];
if(!isObject(obj[p])) { return null; } // if current property isn't an object, return null
obj = obj[p]; // otherwise update the object to the next one down the property chain
}
return obj;
}
您可以像这样使用它:getObjProperty(dataLayerObject, 'config.checklist');
var dataLayerObject = {
config: {
checklist: ['array of stuff']
}
};
function isObject(o) {
return typeof o == 'object' && o !== null;
}
function getObjProperty(obj, propString) {
if (!isObject(obj) || !propString || typeof propString != 'string') {
return null;
}
var props = propString.split('.');
for (var i = 0, l = props.length; i < l; i++) {
var p = props[i];
if (!isObject(obj[p])) { //
return null;
} // if current property isn't an object, return null
obj = obj[p]; // otherwise update the object to the next one down the property chain
}
return obj;
}
console.log(getObjProperty(dataLayerObject, 'config.checklist'));
或者您可以使用
注意:
上面的例子也检查了原型链。如果你不想要这个,你应该在检查 属性 是否是一个对象时使用 hasOwnProperty
来检查 属性 是否存在于测试对象上。