将配置传递给qooxdoo应用程序的最佳实践

时间:2015-02-24 19:27:38

标签: javascript qooxdoo

复杂的qooxdoo(桌面)应用程序可能需要在启动时获取特定于部署的配置,例如:

  • REST / WebSocket后端URL(可能与脚本/文档位置不同);
  • 品牌数据;
  • 启用/禁用功能;
  • 性能调整

等等。目前,我们采取以下措施:

<head>
    <script type="text/javascript">
        config = {
            key1: "foo",
            key2: "bar",
            key3: "<%= getParameter("myapp.key3") %>"
        };
    </script>
    <script type="text/javascript" src="script/myapp.js"></script>
</head>

正如您所注意到的,它是一个提供动态config.key3的JSP,以及静态config.key1config.key2。我有点不喜欢这种方法,因为1)config顶级对象在qooxdoo应用程序代码中无法识别,这会导致编译器警告,2)您可能会意外地弄乱另一个同名的顶级对象。谁能建议任何更好,更清洁的方法来做同样的事情?保持静态和动态配置的组合非常重要。例如,开发人员将其特定配置硬编码为某些VCS忽略的JSON文件;生产环境提供来自数据库的配置数据; staging / QA环境可以将两个源用于配置的不同部分。

问题当然不仅限于qooxdoo。我认为这可能是任何可能需要特定于部署的自定义的独立JavaScript应用程序的主题。

2 个答案:

答案 0 :(得分:2)

使用以下方法解决这两个问题(警告和顶级对象):

一个。在加载应用程序的JS:

之前的index.html中
window.qx = { $$environment: {
    "myapp.key1": "foo"
} };

湾稍后在您的Qooxdoo应用程序中

var key1 = qx.core.Environment.get("myapp.key1");

答案 1 :(得分:1)

对于预定义的环境,我建议使用正常的Qooxdoo配置,而不是提供的黑客@geonik。以下摘录自普通config.json

"config-warnings" : 
{
  "job-shadowing" : ["common", "source-script", "build-script"]
},

"jobs" :
{

  "common" :
  {
    "environment" :
    {
      "appname.version"     : "1.0.0",
      "appname.timeout"     : 30000,
      "appname.analyticsId" : "UA..."
    }
  },

  "source-script" :
  {
    "environment" :
    {
      "appname.serviceUrl"  : "http://127.0.0.1:8080/service",
      "appname.crossDomain" : true
    }
  },

  "build-script" :
  {
    "environment" :
    {
      "appname.serviceUrl"  : "/service",
      "appname.crossDomain" : false
    }
  }

}

通过上述内容,您可以在开发构建中进行一项设置,并在生成构建中进行其他设置。您可以添加更多环境,例如QA。与其他所需的设置。然后使用普通qx.core.Environment.get访问它们。

我不建议将运行时设置与本质上是静态的Qooxdoo配置混合使用。只需在应用程序启动时使用任何qx.io.*方式加载它们并在您的类中处理。