文档帮助

术语、图标和标签

许多类在使用配置对象创建(实例化)时使用快捷名称。快捷名称称为别名(如果类扩展了 Ext.Component,则称为xtype)。别名/xtype 列在适用类的类名旁边,以便快速参考。

访问级别

框架类或其成员可以指定为privateprotected。否则,该类/成员为publicPublicprotectedprivate是访问描述符,用于传达类或类成员的使用方式和时间。

成员类型

成员语法

以下是一个示例类成员,我们可以对其进行分解以显示类成员的语法(在本例中,从 Ext.button.Button 类中查看的 lookupComponent 方法)。

lookupComponent ( item ) : Ext.Component
protected

在初始化items配置期间或添加新项目时,将原始配置对象添加到此容器时调用added), or {@link #insert inserted.

此方法将传递的对象转换为实例化的子组件。

当需要对子项创建应用特殊处理时,可以在子类中覆盖此方法。

参数

item :  Object

要添加的配置对象。

返回值
Ext.Component

要添加的组件。

让我们看看成员行的每个部分

成员标志

API 文档使用许多标志来进一步传达类成员的功能和意图。标签可以用文本标签、缩写或图标表示。

类图标

- 表示框架类

- 单例框架类。*有关更多信息,请参阅单例标志

- 组件类型框架类(Ext JS 框架中任何扩展 Ext.Component 的类)

- 表示该类、成员或指南在当前查看的版本中是新的

成员图标

- 表示类型为 config 的类成员

- 表示类型为 property 的类成员

- 表示类型为 method 的类成员

- 表示类型为 event 的类成员

- 表示类型为 theme variable 的类成员

- 表示类型为 theme mixin 的类成员

- 表示该类、成员或指南在当前查看的版本中是新的

类成员快速导航菜单

在 API 文档页面上的类名称下方,有一排按钮,对应于当前类拥有的成员类型。每个按钮都显示了按类型划分的成员数量(此数量会随着过滤器的应用而更新)。单击按钮将导航到该成员部分。将鼠标悬停在成员类型按钮上将显示一个弹出菜单,其中包含该类型的所有成员,以便快速导航。

Getter 和 Setter 方法

与类配置选项相关的 getter 和 setter 方法将在方法部分以及 API 文档和成员类型菜单的配置部分中显示,位于它们所使用的配置下方。getter 和 setter 方法文档将在配置行中找到,以便于参考。

历史记录栏

您的页面历史记录保存在本地存储中,并显示在顶部标题栏下方(使用可用的空间)。默认情况下,仅显示与您当前查看的产品/版本匹配的页面搜索结果。您可以通过单击历史记录栏右侧的 按钮并选择“全部”单选按钮来扩展显示的内容。这将显示所有产品/版本的历史记录栏中的所有最近页面。

在历史记录配置菜单中,您还会看到最近页面访问的列表。结果按“当前产品/版本”和“全部”单选按钮过滤。单击 按钮将清除历史记录栏以及本地存储中保存的历史记录。

如果在历史记录配置菜单中选择了“全部”,则“在历史记录栏中显示产品详细信息”的复选框选项将被启用。选中后,每个历史页面的产品/版本将与历史记录栏中的页面名称一起显示。将光标悬停在历史记录栏中的页面名称上也会显示产品/版本作为工具提示。

搜索和过滤器

可以使用页面顶部的搜索字段搜索 API 文档和指南。

在 API 文档页面上,还有一个过滤器输入字段,使用过滤器字符串过滤成员行。除了按字符串过滤外,还可以按访问级别、继承和只读过滤类成员。这是使用页面顶部的复选框完成的。

API 类导航树底部的复选框过滤类列表,以包含或排除私有类。

单击空的搜索字段将显示您最近的 10 次搜索,以便快速导航。

API 文档类元数据

每个 API 文档页面(除了 Javascript 原语页面)都有一个与该类相关的元数据的菜单视图。此元数据视图将包含以下一项或多项

展开和折叠示例和类成员

可运行示例(Fiddles)默认情况下在页面上展开。您可以使用代码块左上角的箭头分别折叠和展开示例代码块。您还可以使用页面右上角的切换按钮切换所有示例的折叠状态。切换所有状态将在页面加载之间记住。

类成员默认情况下在页面上折叠。您可以使用成员行左侧的箭头图标或使用右上角的全部展开/折叠切换按钮全局展开和折叠成员。

桌面 -vs- 移动视图

在较窄的屏幕或浏览器上查看文档将导致针对较小外形尺寸优化的视图。桌面视图和“移动”视图之间的主要区别在于

查看类源代码

可以通过单击 API 文档页面顶部的类名来查看类源代码。可以通过单击成员行右侧的“查看源代码”链接来查看类成员的源代码。

Sencha Test 2.4.0


顶部

项目、场景和套件

Sencha Studio 使您能够编写测试脚本,以结构化和可预测的方式重复测试您的应用程序。这种级别的测试有助于确保应用程序在增长和成熟时保持稳定。在创建单个测试之前,您首先需要设置您的工作区并初始化一个测试项目

在每个工作区/项目中,您将在以下分组下有一个测试节点

  • 工作区根目录本身
  • 工作区中的每个应用程序
  • 工作区中的每个包

Sencha Studio Workspace View

测试项目是 Sencha Studio 中测试套件层次结构的一部分。它们允许您通过工作区来管理测试范围。根工作区测试项目中的测试可以应用于工作区中任何应用程序或包共享的代码。应用程序或包的测试项目中的测试将针对其各自父级中的代码运行。

测试项目

初始化测试项目

进入工作区、应用程序或包后,您将在父文件夹下看到一个“测试”节点。首次选择“测试”节点时,Sencha Studio 将显示测试项目创建屏幕。单击“初始化测试项目”以创建测试项目文件(默认情况下为test/project.json,但您也可以在必要时指定工作区内的其他目录)。Sencha Studio 将创建测试项目并显示测试项目详细信息视图。

Sencha Studio Init Test Project

位置(URL)

位于工作区根级别或包内的测试项目将要求您在项目设置“位置(URL)”字段中输入“index.html”目标文件。此目标文件是在运行测试时启动的文件。位于应用程序内的项目将使用应用程序生成的“index.html”文件(除非明确覆盖)。提供的 URL 应以有效的协议(http 或 https)开头。

Sencha Studio Project URL

测试框架

Sencha Studio 默认包含最新版本的 Jasmine。查看优秀的Jasmine 文档以获取有关编写和编辑 Jasmine 测试的更多信息。

Sencha Studio Project Test Framework

使用其他测试框架编写适配器的文档将在未来指南中详细介绍。

附加库

通过在测试项目的“附加库”部分指定每个文件的路径,可以在测试项目中包含其他 JavaScript 文件以供测试运行。这些文件通常是外部库,例如映射客户端、数据模拟实用程序和其他支持脚本,这些脚本可以在运行测试时使用。每个文件的路径将附加到工作区目录;例如,设置“shared/UserData.js”的文件路径将在测试时导致测试运行程序加载“[workspaceDirectory]/shared/UserData.js”。所有附加库文件将在运行测试规范之前加载。

Sencha Studio Project Additional Libraries

测试项目和场景

测试项目必须至少包含一个“场景”才能发挥作用。测试项目包含一个或多个场景,用于在测试项目中组织单元测试分组。测试项目包含所有场景将继承的通用配置项。场景包含定义完整测试集合所需的信息,包括测试脚本的位置、测试主题的 URL 等。

添加场景

您可以通过单击项目工具栏上的“新建场景”按钮来添加场景。为场景命名一个描述测试将管理的内容的名称,并选择场景类型。如果您选择了测试工程师角色,则默认情况下所有添加的场景都将是 WebDriver 场景。开发人员可以选择 In-Browser 和 WebDriver。

Sencha Studio Project Add Scenario

除非您要避免目录冲突,否则应将场景目录保留为其默认值,在这种情况下,您可以指向测试项目配置目录内的另一个目录。

保存后,场景将出现在工作区导航树中,位于其父测试项目下。

场景位置(URL)

场景详细信息中的“位置(URL)”字段允许您

  1. 通过提供 URL(以“http”或“https”开头)来覆盖父测试项目详细信息中设置的 URL
  2. 将哈希或查询附加到测试项目的 URL(通过包含以“#”、“?”或某些组合开头的字符串)

场景附加库

除了在测试项目中设置的库之外,场景可能还具有指定的支持 JavaScript 文件。场景继承在测试项目中指定的附加 JavaScript 库,这些库在场景定义的任何附加库之前加载。

创建 Jasmine 测试套件

您可以在 Sencha Studio 或您喜欢的 IDE/文本编辑器中直接创建和编辑测试。测试将位于“场景”详细信息视图中“目录”字段指示的子文件夹中。您可以通过单击“测试”选项卡中的“场景”来导航到该视图。

要在 Sencha Studio 中创建新的测试,请使用工作区导航树中目标“场景”的上下文菜单,或单击顶部工具栏上的“新建测试套件”按钮。

Sencha Studio Add Test Suite

然后可以通过展开父“场景”节点并选择测试套件节点来打开测试套件进行编辑。

Sencha Studio Select Test Suite

可以在 Sencha Studio 的编辑器中直接修改套件。用户编写的测试可以针对应用程序中的内部逻辑运行,也可以通过模拟应用程序 UI 上的事件来运行。您还可以使用事件记录器功能直接编写用户交互,这使您可以记录浏览器中的实时交互。然后可以在测试运行时重复这些记录的事件。

套件遵循以下约定

describe("A suite", function() {

});

describe 中的第一个参数应该是对套件旨在测试的内容的简洁的英文解释。我们的实际测试将放在 describe 函数内部。

创建 Jasmine 测试规范

添加套件后,可以创建实际的测试并将其添加到套件的 describe 函数中。在 Jasmine 术语中,单个测试被称为规范。规范是一个 JavaScript 函数,它解释了程序的一部分应该完成什么。规范应该用简洁的语言解释测试的目标。然后,它应该提供执行测试以满足该期望的 JavaScript 代码。

it("contains spec with an expectation", function() {
    expect(true).toBe(true);
});

因此,套件和规范一起显示如下

describe("A suite", function() {

    it("contains spec with an expectation", function() {
        expect(true).toBe(true);
    });

});

然后,您可以根据需要向套件添加任意数量的规范。最好根据测试目标来组织套件。通常,这种组织将遵循应用程序的组织方式。

有关 Jasmine 测试框架的更多信息,请务必查看他们的 套件文档

结论

现在您已经建立了测试环境,您需要开始针对代码编写测试。有关完整示例,请参阅 使用 Sencha Studio 测试您的应用程序 演练指南。

如果您有任何其他问题、疑虑或错误报告,请访问 Sencha Test 论坛

Sencha Test 2.4.0