业务脚本执行与退出码控制


更多信息请参阅 getExitCode


如何使用

简介:

本案例演示了一个完整的业务脚本执行流程,包括业务步骤执行、条件判定以及通过 exit(code) 返回明确的业务退出码。
脚本以“登录 → 校验 → 返回业务码”为示例,展示了如何在不同业务阶段根据执行结果退出脚本,并为外部任务或终端提供可判断的执行状态。

运行前:

  1. 下载并安装 Total Control 11.0(Update 20)及以上版本(立即下载
  2. 将示例代码保存为一个 .js 文件(如 TestGetExitCode.js),并放置到 Total Control 默认脚本目录
  3. 打开脚本终端(主面板 → 脚本 → 脚本终端),执行:
    >> sigmaLoad("TestGetExitCode.js");
    


源代码

/**
 * business_login_demo.js
 * 目标:演示在业务脚本中如何设置 exit(code)
 */

// 业务退出码(示例)
var EXIT_OK = 0;
var EXIT_BAD_ARGS = 10;
var EXIT_ENV_NOT_READY = 20;
var EXIT_VALIDATE_FAIL = 30;
var EXIT_DEP_FAILED = 40;
var EXIT_UNKNOWN = 50;

function fail(code, msg) {
	print("[FAIL] code=" + code + " msg=" + msg);
	exit(code);
}

function main() {
	// 1) 参数检查(示例)
	var user = "demo_user"; // 真实业务里通常来自参数/配置
	if (!user) return fail(EXIT_BAD_ARGS, "missing user");

	// 2) 环境检查(示例:网络/设备/前置条件)
	var envOk = true; // 真实业务里请替换为实际判断
	if (!envOk) return fail(EXIT_ENV_NOT_READY, "env not ready");

	// 3) 业务步骤(示例:登录)
	print("[STEP] login start...");
	var loginOk = true; // 替换为真实登录结果
	if (!loginOk) return fail(EXIT_DEP_FAILED, "login api failed");

	// 4) 业务校验(示例:检查登录态)
	print("[STEP] validate session...");
	var validateOk = true; // 替换为真实校验
	if (!validateOk) return fail(EXIT_VALIDATE_FAIL, "session invalid");

	// 5) 成功
	print("[OK] business done");
	exit(EXIT_OK);
}

try {
	main();
} catch (e) {
	print("[EXCEPTION] " + e);
	exit(EXIT_UNKNOWN);
}

运行结果

[STEP] login start...
[STEP] validate session...
[OK] business done

继续在脚本终端执行以下代码

>> getExitCode()

运行结果

0

TCHelp