abler-api 0.1.16 → 0.1.19

package/README.md

@@ -5,7 +5,7 @@ API服务相关工具
 安装
 
 ```
-npm i abler-api-util@latest -s
+npm i abler-api@latest -s
 ```
 
 
@@ -13,8 +13,13 @@ npm i abler-api-util@latest -s
 引用
 
 ```
-const {apiUtil} = require("abler-api");
+const {apiUtil, preconditions} = require("abler-api");
 apiUtil.config(conf,errCfg,dbSql);
 ...
 ```
 
+
+
+### preconditions
+
+API服务启动时前置条件检查，使用

package/dist/cjs/pp-util.js

@@ -3,20 +3,27 @@
 var require$$0 = require('crypto');
 var require$$1 = require('abler-util');
 var require$$2 = require('abler-db');
+var require$$3 = require('abler-net');
+var require$$0$1 = require('fs');
+var require$$1$1 = require('path');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
 var require$$0__default = /*#__PURE__*/_interopDefaultLegacy(require$$0);
 var require$$1__default = /*#__PURE__*/_interopDefaultLegacy(require$$1);
 var require$$2__default = /*#__PURE__*/_interopDefaultLegacy(require$$2);
+var require$$3__default = /*#__PURE__*/_interopDefaultLegacy(require$$3);
+var require$$0__default$1 = /*#__PURE__*/_interopDefaultLegacy(require$$0$1);
+var require$$1__default$1 = /*#__PURE__*/_interopDefaultLegacy(require$$1$1);
 
 const crypto = require$$0__default["default"];
-const ppUtil$1 = require$$1__default["default"].ppUtil;
+const ppUtil$2 = require$$1__default["default"].ppUtil;
 const {
   dbUtil,
   kvStorage
 } = require$$2__default["default"];
-let conf, appSetting, err, dbSql;
+const netUtil = require$$3__default["default"];
+let conf$1, appSetting, err$1, dbSql;
 const pnToken = "access_token",
       hnToken = pnToken,
       pnApiKey = "apiKey",
@@ -24,20 +31,20 @@ const pnToken = "access_token",
       // 我们接收到的 headers 中的字段名总是全小写的
 pnApiSecret = "apiSecret",
       hnApiSecret = pnApiSecret.toLowerCase();
-const MD5 = ppUtil$1.MD5,
-      moveProperty = ppUtil$1.moveProperty;
+const MD5 = ppUtil$2.MD5,
+      moveProperty = ppUtil$2.moveProperty;
 
 class apiUtil$1 {
-  static debugFlag = ppUtil$1.newGuid(); //应用必须设置，否则谁也不知道是啥
+  static debugFlag = ppUtil$2.newGuid(); //应用必须设置，否则谁也不知道是啥
 
-  static testFlag = ppUtil$1.newGuid();
+  static testFlag = ppUtil$2.newGuid();
   static envId_dev = "?"; // static apiCallRecSaver;
 
   static config(appConfig, appErrCfg, appDbSql) {
-    ppUtil$1.config(appConfig, appErrCfg);
-    conf = appConfig;
-    appSetting = conf?.appSetting;
-    err = appErrCfg, dbSql = appDbSql;
+    ppUtil$2.config(appConfig, appErrCfg);
+    conf$1 = appConfig;
+    appSetting = conf$1?.appSetting;
+    err$1 = appErrCfg, dbSql = appDbSql;
     apiUtil$1.debugFlag = appSetting?.debugFlag || apiUtil$1.debugFlag;
     apiUtil$1.testFlag = appSetting?.testFlag || apiUtil$1.testFlag; // apiUtil.apiCallRecSaver = apiCallRecSaver;
   } //#region ===== 需要应用系统重写的方法
@@ -50,7 +57,7 @@ class apiUtil$1 {
 
 
   static _getApiSecret(companyId) {
-    return ppUtil$1.newGuid();
+    return ppUtil$2.newGuid();
   }
   /**
    * 保存 API 调用记录,应用系统必须重写此方法
@@ -74,26 +81,6 @@ class apiUtil$1 {
   } //#endregion
   //#region ===== API服务相关工具
 
-  /**
-   * 获取客户端IP地址
-   * @param req
-   * @returns {*|string|string}
-   */
-
-
-  static getClientIp(req) {
-    let ip = req.headers["x-real-ip"] || req.headers["x-true-ip"] || req.headers['x-forwarded-for'] || req.headers['x-forward-for'] || req.connection.remoteAddress || req.socket.remoteAddress || req.headers['host'] || ""; // console.log("Request IP:", ip, "req: ", req);
-
-    if (ip.indexOf(",") >= 0) {
-      ip = ip.split(',')[0];
-    }
-
-    if (ip.indexOf(":") >= 0) {
-      ip = ip.substring(ip.lastIndexOf(':') + 1);
-    }
-
-    return ip;
-  }
   /**
    * 从请求中解出数据，包括路径参数、查询参数和Body
    * @param req
@@ -173,18 +160,18 @@ class apiUtil$1 {
 
 
   static setParamsFunctions(params) {
-    ppUtil$1.defUnenumProp(params, "asNumber", function (name, minValue, maxValue, defaultValue) {
+    ppUtil$2.defUnenumProp(params, "asNumber", function (name, minValue, maxValue, defaultValue) {
       // if (!this.hasOwnProperty(name)) // {} 定义的对象没有 hasOwnProperty 函数
       if (this[name] === undefined) return defaultValue;
       let result = +this[name];
 
       if (typeof result !== "number" || result < minValue || result > maxValue) {
-        throw [err.INVALID_PARAM, `参数 ${name} 必须是 ${minValue} ~ ${maxValue} 之间的数字`];
+        throw [err$1.INVALID_PARAM, `参数 ${name} 必须是 ${minValue} ~ ${maxValue} 之间的数字`];
       }
 
       return result;
     });
-    ppUtil$1.defUnenumProp(params, "asBool", function (name, defaultValue) {
+    ppUtil$2.defUnenumProp(params, "asBool", function (name, defaultValue) {
       if (this[name] === undefined) return defaultValue;
       let result = JSON.parse(this[name]);
       return !!result;
@@ -249,7 +236,7 @@ class apiUtil$1 {
 
   static apiFail(error, req) {
     configNeeded();
-    let response = err.ERROR(error, err.errorLangParamFlag + ppUtil$1.getMsgLang(req));
+    let response = err$1.ERROR(error, err$1.errorLangParamFlag + ppUtil$2.getMsgLang(req));
     response.datetime = new Date();
 
     if (req && req.headers) {
@@ -470,12 +457,12 @@ class apiUtil$1 {
           delete params.token;
         } else {
           // 如果没有token，则返回错误
-          console.log(err.TOKEN_NEEDED);
+          console.log(err$1.TOKEN_NEEDED);
 
           if (res) {
-            res.send(err.ERROR(err.TOKEN_NEEDED));
+            res.send(err$1.ERROR(err$1.TOKEN_NEEDED));
           } else if (!noErr) {
-            throw err.TOKEN_NEEDED;
+            throw err$1.TOKEN_NEEDED;
           }
         }
       }
@@ -497,7 +484,7 @@ class apiUtil$1 {
     const params = apiUtil$1.extractParams(req);
     req.accessToken = req.accessToken || apiUtil$1.extractToken(req);
 
-    if (req.accessToken === MD5(ppUtil$1.idNumDisturbing)) {
+    if (req.accessToken === MD5(ppUtil$2.idNumDisturbing)) {
       //todo: 检查IP
       params.__internal__ = true;
       req.ignoreToken = true; // if (params.idNum || params.personId) {
@@ -518,7 +505,7 @@ class apiUtil$1 {
       return true;
     } else {
       // console.log('token error.', req.accessToken);
-      throw err.TOKEN_INVALID;
+      throw err$1.TOKEN_INVALID;
     }
   }
   /**
@@ -554,7 +541,7 @@ class apiUtil$1 {
 
       if (dbgToken) {
         let envId = process.env.ECS_DEPLOY_ID;
-        req.__debug__ = dbgToken && dbgToken === MD5(req.headers.timestamp, ppUtil$1.commonHashDisturbing) && (envId === "florist_longdan" || envId === "shuzi");
+        req.__debug__ = dbgToken && dbgToken === MD5(req.headers.timestamp, ppUtil$2.commonHashDisturbing) && (envId === "florist_longdan" || envId === "shuzi");
       } else {
         req.__debug__ = false;
       } // console.log("__debug__:", req.__debug__, "dbgToken:", dbgToken);
@@ -734,7 +721,7 @@ class apiUtil$1 {
         };
 
         if (rec.secret !== "") {
-          rec.secret = ppUtil$1.getEncAse192(rec.secret);
+          rec.secret = ppUtil$2.getEncAse192(rec.secret);
         }
 
         req.apiCallRec = rec;
@@ -801,7 +788,7 @@ class apiUtil$1 {
       return certInfo;
     }).catch(e => {
       console.log('获取企业证书失败:\n', e);
-      throw [err.ACCESS_REFUSED, `获取企业证书失败：${err.ERROR(e).message}`];
+      throw [err$1.ACCESS_REFUSED, `获取企业证书失败：${err$1.ERROR(e).message}`];
     });
   }
   /**
@@ -815,7 +802,7 @@ class apiUtil$1 {
   static async verifyApiSignature(tokenData, req) {
     try {
       if (!req.headers.timestamp) {
-        throw [err.ACCESS_REFUSED, `必须在请求头中设置时戳`];
+        throw [err$1.ACCESS_REFUSED, `必须在请求头中设置时戳`];
       }
 
       let timestamp = parseInt(req.headers.timestamp);
@@ -823,13 +810,13 @@ class apiUtil$1 {
       let maxTimeDiff = apiUtil$1.isDebugMode(req) ? 7 * 24 * 3600 : apiUtil$1.isTestMode(req) ? 4 * 3600 : 100; // 100
 
       if (timestamp.toString() == "NaN" || currentTime < timestamp - 5000 || currentTime - timestamp > maxTimeDiff * 1000) {
-        throw [err.ACCESS_REFUSED, `时戳(${timestamp})无效，当前时戳：${currentTime},时差 ${(currentTime - timestamp) / 1000}秒`];
+        throw [err$1.ACCESS_REFUSED, `时戳(${timestamp})无效，当前时戳：${currentTime},时差 ${(currentTime - timestamp) / 1000}秒`];
       }
 
       let signature = req.headers.signature;
 
       if (!signature) {
-        throw [err.ACCESS_REFUSED, `必须在请求头中提供签名`];
+        throw [err$1.ACCESS_REFUSED, `必须在请求头中提供签名`];
       }
 
       let signData = apiUtil$1.extractToken(req, null, true) || tokenData.apiKey;
@@ -884,7 +871,7 @@ class apiUtil$1 {
 
         if (!tokenData.certPublicKeySpare) {
           throw {
-            eo: err.ACCESS_REFUSED,
+            eo: err$1.ACCESS_REFUSED,
             msgArgv: "签名验证异常",
             data: e
           };
@@ -933,7 +920,7 @@ class apiUtil$1 {
         } catch (e) {
           console.log("SPO服务签名验证异常(备用证书), ", e);
           throw {
-            eo: err.ACCESS_REFUSED,
+            eo: err$1.ACCESS_REFUSED,
             msgArgv: "签名验证异常(spare)",
             data: e
           };
@@ -942,7 +929,7 @@ class apiUtil$1 {
 
       if (!verifyOK) {
         console.log("SPO服务签名验证失败, tokenData: ", tokenData);
-        throw [err.ACCESS_REFUSED, "签名验证未通过"];
+        throw [err$1.ACCESS_REFUSED, "签名验证未通过"];
       }
 
       return verifyOK;
@@ -960,7 +947,7 @@ class apiUtil$1 {
     if (!tokenData.companyInfo) {
       tokenData.companyInfo = await apiUtil$1.queryCompanyInfo(tokenData.apiKey, true).catch(e => {
         console.log("执行企业信息查询发生异常", e);
-        throw [err.API_KEY_INVALID, "执行企业信息查询发生异常：" + e.message || ""];
+        throw [err$1.API_KEY_INVALID, "执行企业信息查询发生异常：" + e.message || ""];
       });
     }
 
@@ -969,7 +956,7 @@ class apiUtil$1 {
     if (companyInfo != null) {
       let secret = apiUtil$1._getApiSecret(tokenData.apiKey);
 
-      if (secret !== tokenData.apiSecret) throw err.API_SCREPT_INVALID; // 不再检查 IP 白名单，改为验证证书签名
+      if (secret !== tokenData.apiSecret) throw err$1.API_SCREPT_INVALID; // 不再检查 IP 白名单，改为验证证书签名
       // console.log("fromIp:", tokenData.clientIp, "ipWhiteList:", companyInfo.ipWhiteList);
       // let whiteList = companyInfo.ipWhiteList || "";
       // // 没有设置ip白名单的就不检查了
@@ -983,7 +970,7 @@ class apiUtil$1 {
       });
     }
 
-    throw [err.API_KEY_INVALID, tokenData.apiKey];
+    throw [err$1.API_KEY_INVALID, tokenData.apiKey];
   }
   /**
    * 检查令牌数据是否存在
@@ -1034,10 +1021,152 @@ class apiUtil$1 {
         paramExists = typeof params[paramName] != 'undefined' || typeof params[paramName + paramSufix] != 'undefined';
       }
 
-      if (!paramExists) return ppUtil$1.errorPormise(err.ERROR(err.PARAMETER_NEEDED, paramName));
+      if (!paramExists) return ppUtil$2.errorPormise(err$1.ERROR(err$1.PARAMETER_NEEDED, paramName));
     }
 
     return Promise.resolve(paramSufix);
+  }
+  /**
+   * 获取客户端IP地址
+   * @param req
+   * @returns {*|string|string}
+   */
+
+
+  static getClientIp(req) {
+    let ip = req.headers["x-real-ip"] || req.headers["x-true-ip"] || req.headers['x-forwarded-for'] || req.headers['x-forward-for'] || req.connection.remoteAddress || req.socket.remoteAddress || req.headers['host'] || ""; // console.log("Request IP:", ip, "req: ", req);
+
+    if (ip.indexOf(",") >= 0) {
+      ip = ip.split(',')[0];
+    }
+
+    if (ip.indexOf(":") >= 0) {
+      ip = ip.substring(ip.lastIndexOf(':') + 1);
+    }
+
+    return ip;
+  }
+  /**
+   * 获取与本机一起提供服务的所有主机
+   * @param params
+   * @returns {{port: (number|number), hosts: [string]}}
+   */
+
+
+  static getEnvHosts(params) {
+    configNeeded();
+    let envType = ppUtil$2.getEnvType();
+    let x = conf$1.envHosts[envType] || {
+      hosts: ["localhost"]
+    };
+    let port = +params.port || 8443;
+    return {
+      hosts: x.hosts,
+      port: x.port || port
+    };
+  }
+  /**
+   * 检查指定的host和发送请求的ip是不是自己的ip
+   * @param host
+   * @param req
+   * @returns {Promise<*>}
+   */
+
+
+  static async hostIsMySelf(host, req) {
+    let clientIp = apiUtil$1.getClientIp(req);
+    return getMyIp({
+      hosts: [host, clientIp]
+    });
+  }
+  /**
+   * 检查是否应该把请求转发到其它服务器，若是则转发
+   * @param options
+   * @returns {Promise<boolean>}
+   */
+
+
+  static async checkForwardsHost(options) {
+    configNeeded();
+    const params = options.replacements;
+    const myEnvHosts = apiUtil$1.getEnvHosts(params);
+    const myIp = ppUtil$2.getMyIp();
+    const host = params.host || myIp;
+    if (!myEnvHosts.hosts.contains(host)) throw [err$1.ACCESS_REFUSED, `环境${conf$1.envId}貌似无此主机：${params.host}`];
+
+    if (!apiUtil$1.hostIsMySelf(host, options._res.req)) {
+      let result = await apiUtil$1.forwardsTo(host, myEnvHosts.port, params, options._res.req, myIp);
+
+      options._res.send(result);
+
+      return true;
+    }
+
+    return false;
+  }
+  /**
+   * 将收到的请求转发到另一台主机
+   * @param anotherIp
+   * @param port
+   * @param params
+   * @param req
+   * @param lanClient
+   * @returns {Promise<*>}
+   */
+
+
+  static async forwardsTo(anotherIp, port, params, req, lanClient) {
+    let url = anotherIp.indexOf("://") > 0 ? anotherIp : `${req.headers.scheme}://${anotherIp}:${port}${req.originalUrl}`;
+
+    if (url.indexOf("?") > 0) {
+      url = url.substring(0, url.indexOf("?"));
+    }
+
+    let reqOptions = {
+      method: req.method,
+      url: url,
+      data: params
+    };
+    let result = await netUtil.apiRequest(reqOptions);
+
+    if (result.status !== 200) {
+      console.log(`访问 ${reqOptions.url} 出错`, result.status, result.res.statusMessage);
+      throw [err$1.EXCEPTION, `[${result.status}] - ${result.res.statusMessage}`];
+    }
+
+    return result.data;
+  }
+  /**
+   * 解析配置项路径
+   * @param keyPath
+   * @returns {{parent: null, parentKey: string, value, key: string}}
+   */
+
+
+  static parseCfgPath(keyPath) {
+    let keys = Array.isArray(keyPath) ? keyPath : keyPath.split(".");
+    let parentKey = "";
+    let key = "config";
+    let value = conf$1;
+    let parent = null;
+
+    for (let i = 0; i < keys.length; i++) {
+      parent = value;
+      parentKey += (parentKey ? "." : "") + key;
+      key = keys[i];
+      value = parent[key];
+
+      if (value === undefined) {
+        throw [err$1.INVALID_PARAM, `无此配置项: ${key}`];
+      }
+    }
+
+    return {
+      parent,
+      parentKey,
+      key,
+      value
+    };
   } //#endregion
   //region ====中间件
 
@@ -1051,7 +1180,7 @@ class apiUtil$1 {
       await apiUtil$1.checkRequestToken(req);
       await next();
     } catch (e) {
-      res.send(err.ERROR(e));
+      res.send(err$1.ERROR(e));
     }
 
     return false;
@@ -1099,7 +1228,7 @@ class apiUtil$1 {
 
       return true;
     } catch (e) {
-      res.send(err.ERROR(e));
+      res.send(err$1.ERROR(e));
       return false;
     }
   }
@@ -1149,11 +1278,11 @@ class apiUtil$1 {
     let errResponse = null;
 
     if (!tokenData.clientIp) {
-      errResponse = apiUtil$1.spoApiFail(err.GET_CLIENTIP_FAIL, req);
+      errResponse = apiUtil$1.spoApiFail(err$1.GET_CLIENTIP_FAIL, req);
     } else if (!tokenData.apiKey) {
-      errResponse = apiUtil$1.spoApiFail([err.PARAMETER_NEEDED, "apiKey"], req);
+      errResponse = apiUtil$1.spoApiFail([err$1.PARAMETER_NEEDED, "apiKey"], req);
     } else if (!tokenData.apiSecret) {
-      errResponse = apiUtil$1.spoApiFail([err.PARAMETER_NEEDED, "apiSecret"], req);
+      errResponse = apiUtil$1.spoApiFail([err$1.PARAMETER_NEEDED, "apiSecret"], req);
     }
 
     if (errResponse != null) {
@@ -1189,7 +1318,7 @@ class apiUtil$1 {
     let accessToken = apiUtil$1.extractToken(req);
 
     if (!accessToken) {
-      res.send(apiUtil$1.spoApiFail(err.TOKEN_NEEDED, req)); // apiUtil.sendOrRedirect(req, res, spoApiFail(err.TOKEN_NEEDED, req));
+      res.send(apiUtil$1.spoApiFail(err$1.TOKEN_NEEDED, req)); // apiUtil.sendOrRedirect(req, res, spoApiFail(err.TOKEN_NEEDED, req));
 
       return;
     }
@@ -1210,7 +1339,7 @@ class apiUtil$1 {
       req.tokenData = p;
       return apiUtil$1.$checkApiKeyOld(req, res, next);
     }).catch(e => {
-      apiUtil$1.sendOrRedirect(req, res, apiUtil$1.spoApiFail(err.TOKEN_INVALID, req));
+      apiUtil$1.sendOrRedirect(req, res, apiUtil$1.spoApiFail(err$1.TOKEN_INVALID, req));
     });
   }
   /**
@@ -1245,24 +1374,247 @@ class apiUtil$1 {
       });
     }
   } //#endregion
+  //region ====一些通用服务功能
+
+  /**
+   * 获取配置数据
+   * @param options
+   * @returns {Promise<boolean|*>}
+   */
+  // api/config/appSetting.ossEnabled
+
+
+  static async getConfigValue(options) {
+    configNeeded();
+    const params = options.replacements;
+    let item = params.item;
+    delete params.item;
+    if (await apiUtil$1.checkForwardsHost(options)) return true;
+    let c = apiUtil$1.parseCfgPath(item);
+    delete c.parent;
+    c.host = ppUtil$2.getMyIp();
+    return c;
+  }
+  /**
+   * 设置配置数据
+   * @param options
+   * @returns {Promise<*>}
+   */
+
+
+  static async setConfigValue(options) {
+    configNeeded();
+    const params = options.replacements;
+    let item = params.item;
+    delete params.item; // if (await checkForwardsHost(options))
+    //     return true;
+
+    await apiUtil$1.parametersOK(params, "value");
+    let c = apiUtil$1.parseCfgPath(item);
+
+    if (typeof c.value === "object") {
+      throw [err$1.ACCESS_REFUSED, `暂不支持修改复杂配置`];
+    } // c.oldValue = c.value;
+
+
+    c.newValue = params.value;
+    c.parent[c.key] = c.newValue;
+    delete c.parent;
+    c.host = ppUtil$2.getMyIp();
+    return c; // 应用层自行处理多机同步
+  } //#endregion
 
 
 }
 
 function configNeeded() {
-  if (!conf || !err) {
+  if (!conf$1 || !err$1) {
+    ppUtil$2.configNeeded();
+    conf$1 = ppUtil$2.appConfig;
+    appSetting = conf$1.appSetting;
+    err$1 = ppUtil$2.appErrCfg;
+  }
+}
+
+var ppUtilApi = apiUtil$1;
+
+function commonjsRequire(path) {
+	throw new Error('Could not dynamically require "' + path + '". Please configure the dynamicRequireTargets or/and ignoreDynamicRequires option of @rollup/plugin-commonjs appropriately for this require call to work.');
+}
+
+const fs = require$$0__default$1["default"];
+const path = require$$1__default$1["default"];
+const ppUtil$1 = require$$1__default["default"].ppUtil;
+const redisUtil = require$$2__default["default"].redisUtil;
+let conf, err; // const dbCheck = require('../dbupdate/dd-version');
+
+/**
+ * API服务启动时前置条件检查
+ * ok = await preconditions
+ *     .setAppName(conf.thisApp)
+ *     .addCheckPromise(preconditions.checkExEnvSetting())
+ *     .addCheckPromise(preconditions.checkRedis())
+ *     .addCheckPromise(checkDatabase())
+ *     .addChecker(myChecker, args)
+ *     .checkAll()
+ */
+
+class preconditions$1 {
+  static appName;
+  static checkFunctions = [];
+  static checkPromises = [];
+
+  static setAppName(aName) {
     ppUtil$1.configNeeded();
     conf = ppUtil$1.appConfig;
-    appSetting = conf.appSetting;
     err = ppUtil$1.appErrCfg;
+    preconditions$1.appName = aName || conf.thisApp;
+    return preconditions$1;
+  }
+
+  static addCheckPromise(p) {
+    preconditions$1.checkPromises.push(p);
+    return preconditions$1;
+  }
+
+  static addChecker(checkFunc, args) {
+    preconditions$1.checkFunctions.push({
+      check: checkFunc,
+      args: args
+    });
+    return preconditions$1;
+  }
+
+  static async checkAll() {
+    for (let i = 0; i < preconditions$1.checkFunctions.length; i++) {
+      const f = preconditions$1.checkFunctions[i];
+      preconditions$1.addCheckPromise(f.check(f.args));
+    }
+
+    for (let i = 0; i < preconditions$1.checkPromises.length; i++) {
+      let msg = await preconditions$1.checkPromises[i];
+
+      if (msg) {
+        if (!preconditions$1.messages) {
+          preconditions$1.messages = [];
+        }
+
+        preconditions$1.messages.push(`${preconditions$1.messages.length + 1}. ${msg}`);
+      }
+    }
+
+    let text = "";
+
+    if (preconditions$1.messages) {
+      text = `*** 由于以下原因，${preconditions$1.appName} 尚不能正常提供服务：\n\n` + preconditions$1.messages.join("\n\n") + "\n\n*** 请检查以上各项条件，修复后重新启动服务";
+      console.log("\n" + text); // for (let i = 0; i < preconditions.messages.length; i++) {
+      //     console.log(preconditions.messages[i]);
+      // }
+    }
+
+    if (!(await fs.async_exists("../log"))) {
+      await fs.async_mkdir("../log");
+    }
+
+    await fs.async_writeFile(`../log/preconditions`, text);
+    return !text;
+  } // 检查器
+
+  /**
+   * 检查本机外部配置文件版本
+   */
+
+
+  static async checkExEnvSetting() {
+    return await checkExEnvSetting();
   }
+  /**
+   * redis 可用性检查
+   */
+
+
+  static async checkRedis() {
+    return await checkRedis();
+  } // /**
+  //  * 数据库可用性及业务数据版本版本检查
+  //  */
+  // static async checkDatabase() {
+  //     return await checkDatabase();
+  // }
+
+
 }
 
-var ppUtilApi = apiUtil$1;
+async function createEnvSettingFile(fileName) {
+  try {
+    const cfgText = await ppUtil$1.doCreateEnvSettingFile(fileName);
+
+    if (cfgText.indexOf(`cfgVersion: "${conf._envSetting.cfgVersion}"`) > 0) {
+      console.log(`\n*** 已創建新的本機環境配置文件\n${fileName}\n请檢查各項內容是否正确(此项更新服务可正常运行)\n\n`);
+      return "";
+    }
+
+    return `已創建新的本機環境配置文件\n${fileName}\n请檢查並正確設置各項內容，然後將配置版本號修改為${conf._envSettings.default.cfgVersion}`;
+  } catch (e) {
+    return `創建本機環境配置文件失敗\n《${fileName}》\n${err.ERROR(e).message}`;
+  }
+}
+
+async function checkExEnvSetting() {
+  if (!conf._envSetting.localSettingImported) {
+    let fileName = conf.getEnvSettingFileName();
+
+    if (!fs.existsSync(fileName)) {
+      return await createEnvSettingFile(fileName);
+    }
+
+    let envSettingEx = commonjsRequire(fileName);
+
+    if (envSettingEx.cfgVersion !== conf._envSettings.default.cfgVersion) {
+      if (envSettingEx.cfgVersion !== "0.0") {
+        let fp = path.parse(fileName);
+        let newFileName = path.join(fp.dir, fp.name + envSettingEx.cfgVersion + fp.ext);
+
+        if (!fs.existsSync(newFileName)) {
+          fs.renameSync(fileName, newFileName);
+        }
+      }
+
+      return await createEnvSettingFile(fileName);
+    }
+  }
+} // async function checkDatabase() {
+//     return dbCheck.check().then(info => info.updateMessage);
+// }
+
+
+async function checkRedis() {
+  if (!conf.redis.enabled) return "";
+  const redis = redisUtil.newClient("io"); // console.log(`checkRedis begin：`);
+
+  await ppUtil$1.wait(15 * 1000, param => {
+    if (redis.ready && redis.connected || redis.error) {
+      return true;
+    }
+  }).catch(e => {
+    redis.error = e;
+  });
+
+  if (redis.error) {
+    console.log(`未能成功連接 redis： ${redis.error}，請檢查相關設置`);
+    return `未能成功連接 redis： ${redis.error}，請檢查相關設置`;
+  } // console.log(`checkRedis done：`);
+  // console.log(redis);
+
+}
+
+var ppPrecond = preconditions$1;
 
 const apiUtil = ppUtilApi;
+const preconditions = ppPrecond;
 var ppUtil = {
-  apiUtil
+  apiUtil,
+  preconditions
 };
 
 module.exports = ppUtil;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "abler-api",
-  "version": "0.1.16",
+  "version": "0.1.19",
   "description": "API服务相关工具",
   "main": "./dist/cjs/pp-util.js",
   "-module": "./dist/es/pp-util.js",
@@ -16,7 +16,8 @@
   "dependencies": {
     "q": "^1.5.1",
     "abler-util": ">=0.1.1",
-    "abler-db": ">=0.1.1"
+    "abler-db": ">=0.1.1",
+    "abler-net": ">=0.1.1"
   },
   "devDependencies": {
     "@babel/core": "^7.18.5",