手机自动化测试：Appium源码分析之跟踪代码分析八 1
手机自动化测试：Appium源码分析之跟踪代码分析八
lib/server/helpers.js模块， 研究之前，我们不防猜测一下这个模块的作用，然后在研究完成时在总结里面重新定义一下这个模块的作用。我猜测这个模块的作用就是提供了一些独立的方法，作为一些工具方法供其他模块使用
加载其他模块
var _ = require("underscore")
, gridRegister = require('./grid-register.js')
, logger = require('./logger.js').get('appium')
, status = require('./status.js')
, io = require('socket.io')
, mkdirp = require('mkdirp')
, bytes = require('bytes')
, domain = require('domain')
, format = require('util').format
, Args = require("vargs").Constructor;
模块 |
意义 |
gridRegister |
暂时不解释，等我学习到的时候再来解释 |
logger |
本地模块，这个模块已经说烂了，简单的来说提供日志输出的 |
status |
本地模块，请求返回码定义模块 |
socket.io |
是跨平台，多种连接方式自动切换，做即时通讯方面的开发很方便 |
mkdirp |
扩展模块， |
bytes |
公共模块，转化字符串的bytes值到数字型(比如1TB转换成1099511627776) |
domain |
捕捉异步回调中出现的异常 |
util |
核心模块，提供工具方法的模块 |
vargs |
参数模块 |
函数
allowCrossDomain
说这个函数之前，我们先来看看CORS协议
module.exports.allowCrossDomain = function (req, res, next) {
safely(req, function () {
//定义了资源能被所有域使用
res.header('Access-Control-Allow-Origin', '*');
//指示存取�Y源所允�S的方法，用�砘��先�д�求
res.header('Access-Control-Allow-Methods', 'GET,POST,PUT,OPTIONS,DELETE');
//指示那些HTTP header可以出�F在真���求，用於回��先�д�求
res.header('Access-Control-Allow-Headers', 'origin, content-type, accept');
});
// need to respond 200 to OPTIONS
//如果接受的方法是OPTIONS方法，会返回200状态码
if ('OPTIONS' === req.method) {
safely(req, function () {
res.sendStatus(200);
});
} else {
//然后调用传入的next函数
next();
}
};
winstonStream
module.exports.winstonStream = {
write: function (msg) {
msg = msg.replace(/$\s*$/m, "");
msg = msg.replace(/\[[^\]]+\] /, "");
logger.log('debug', msg);
}
};
这个是函数么？不太清楚，我只能暂时理解function(msg)内部的东西(这里其实是一个json字符串，只包含一个write元素，它对应了一个处理函数)
将msg经过2层过滤，去除一些特殊字符，然后打印出来
catchAllHandler
module.exports.catchAllHandler = function (e, req, res, next) {
safely(req, function () {
res.status(500).send({
status: status.codes.UnknownError.code
, value: "ERROR running Appium command: " + e.message
});
});
next(e);
};
这个方法其实就是简单的在函数调用前，添加一个函数。我们要执行的函数是next,而在next函数执行执行的函数是safely，这个safely我们在Appium源码分析(6)-responses模块 解释过。其实就是调用了传入的嵌套函数，将response的状态码设置为500，然后发送一个json字符串。
checkArgs
checkArgs的函数分几部分分析
//检查args的有效参数
module.exports.checkArgs = function (parser, args) {
//定义一个二维数组
var exclusives = [
['noReset', 'fullReset']
, ['ipa', 'safari']
, ['app', 'safari']
, ['forceIphone', 'forceIpad']
, ['deviceName', 'defaultDevice']
];
//遍历二维数组exclusives,遍历的元素的设置为exSet，为一维数组
_.each(exclusives, function (exSet) {
var numFoundInArgs = 0;
//遍历一维数组，遍历的元素设置为opt
_.each(exSet, function (opt) {
if (_.has(args, opt) && args[opt]) {
//如果args含有exclusives定义的参数，numFoundInArgs加1
numFoundInArgs++;
}
});
if (numFoundInArgs > 1) {
//如果超过一个参数，打印错误信息
console.error(("You can't pass in more than one argument from the set " +
JSON.stringify(exSet) + ", since they are mutually exclusive").red);
process.exit(1);
}
});
checkValidPort
checkArgs嵌套函数：
//检查端口的有效性
var checkValidPort = function (port) {
//限定端口号范围为(0,6536)
if (port > 0 && port < 65536) return true;
//超出范围，报错，返回false
console.error("Port must be greater than 0 and less than 65536");
return false;
};
validations字符串
checkArgs函数中定义的json字符串，定义了一些变量和对应的处理函数:
var validations = {
port: checkValidPort
, callbackPort: checkValidPort
, bootstrapPort: checkValidPort
, selendroidPort: checkValidPort
, chromedriverPort: checkValidPort
, robotPort: checkValidPort
, backendRetries: function (r) { return r >= 0; }
};
checkValidPort函数我们刚讲过，就不多说了。json字符串的最后一个元素，指定了一个匿名函数，就是判断传入的参数是否非负。
检查非默认参数的有效性
//解析出非默认参数的参数，是一个json字符串
var nonDefaultArgs = getNonDefaultArgs(parser, args);
//遍历validations字符串，元素定义为map的key值为args,value值为validator
_.each(validations, function (validator, arg) {
//是否为非默认的参数
if (_.has(nonDefaultArgs, arg)) {
//检查是否通过
if (!validator(args[arg])) {
//不通过检查的打印错误信息并退出
console.error("Invalid argument for param " + arg + ": " + args[arg]);
process.exit(1);
}
}
});
到此checkArgs函数解释完毕，看得出来这个函数的工作很多，但是总结下来就是：检查一些非默认参数的有效性。
getNonDefaultArgs
这个函数是找到非默认参数的，参照物就是parser.js模块中定义的一系列参数，我们来先看看parser.js模块：
var args = [
[['--shell'], {
required: false
, defaultValue: null
, help: 'Enter REPL mode'
, nargs: 0
}],
[['--localizable-strings-dir'], {
required: false
, dest: 'localizableStringsDir'
, defaultValue: 'en.lproj'
, help: 'IOS only: the relative path of the dir where Localizable.strings file resides '
, example: "en.lproj"
}],
[['--app'], {
看一下就知道了，一会我们会用到这个。
//得到非默认的参数
var getNonDefaultArgs = function (parser, args) {
var nonDefaults = {};
//遍历parser中定义的参数，遍历的元素设置为rawArg
_.each(parser.rawArgs, function (rawArg) {
//取每一个rawArg的第二个元素的值，取得dest属性值
var arg = rawArg[1].dest;
if (args[arg] !== rawArg[1].defaultValue) {
//如果args相同字段对应的值不是我们默认值，将该值添加到nonDefaults,以属性值为下标。
nonDefaults[arg] = args[arg];
}
});
return nonDefaults;
};
上面的解释用到parser.js中json字符串args，该args是由多个json字符串组成，所以rawArg[1]取的就是其中遍历到的json字符串的值，比如第二次便利的时候，rawArg的值为：
[['--localizable-strings-dir'], {
required: false
, dest: 'localizableStringsDir'
, defaultValue: 'en.lproj'
, help: 'IOS only: the relative path of the dir where Localizable.strings file resides '
, example: "en.lproj"
}]
那么rawArg[1]指的就是：
{
required: false
, dest: 'localizableStringsDir'
, defaultValue: 'en.lproj'
, help: 'IOS only: the relative path of the dir where Localizable.strings file resides '
, example: "en.lproj"
}
那么rawArg[1].defaultValue的值自然就是en.lproj