此页面由 Cloud Translation API 翻译。

Looker 扩展程序框架

Looker 扩展框架是一个开发框架，可大幅降低构建自定义 JavaScript 数据应用和工具（例如以下各项）的难度和复杂性：

面向贵公司的内部平台应用
面向客户的外部平台，例如使用 Looker 中的数据构建的嵌入式分析应用的客户门户网站
有针对性的内部工具
用于嵌入到外部应用中的应用

Looker Marketplace 上提供的 Looker 扩展程序的当前示例包括 Looker Data Dictionary 和 LookML Diagram。

为何要使用扩展框架？

Web 应用开发的部分环节轻松有趣，而其他环节则明显更耗时，而且并不那么有趣。扩展程序框架可帮助您简化许多不太有趣的任务。

扩展框架会处理构建 Web 应用的一些比较繁琐的方面，以便您可以立即开始开发。通过扩展框架创建的自定义应用和工具可从 Looker 中访问，从而使 Looker 能够处理以下类型的函数，例如：

身份验证 - 可让您使用 Looker 现有的身份验证选项进行登录（例如密码登录、LDAP、SAML 和 OpenID Connect）。
访问权限控制和权限管理。
API 访问权限 - 允许您在 Looker 中使用其他常见的开发者资源，例如第三方 API 端点。

扩展框架功能

Looker 扩展框架包含以下功能：

Looker 扩展程序 SDK，可提供用于访问 Looker 公共 API 和在 Looker 环境中进行交互的函数。
Looker 组件：一个预构建的 React 界面组件库，可在扩展程序中使用。
Embed SDK：一个可用于在扩展程序中嵌入信息中心、Look 和 Explore 的库。如需查看示例代码，请参阅 kitchen sink 扩展程序。您还可以使用 Embed SDK 将扩展程序嵌入到第三方应用中。将探索、Look 或信息中心嵌入到扩展程序中时，必须在浏览器中启用 Cookie。
create-looker-extension 实用程序，用于创建包含所有必要的扩展文件和依赖项的基本扩展程序，您可以将其用作构建扩展程序的起点。
我们的 Looker 扩展框架示例代码库，其中包含模板和示例扩展程序，可帮助您快速入门。
能够访问第三方 API 端点并将第三方数据添加到扩展程序中。
能够在 Looker 中创建全屏扩展程序。全屏扩展程序可用于内部或外部平台应用。

在全屏扩展程序中，您可以将一组用户添加到“仅限扩展程序”用户群组，从而阻止这些用户通过您的扩展程序导航到 Looker 的其他部分。您还可以通过将扩展程序网址中的 /extensions 替换为 /spartan 来移除 Looker 导航栏。
能够为扩展程序配置访问密钥，以便用户必须输入密钥才能运行扩展程序。如果您想为扩展程序收费，这会很有用，但您应该使用标准的 Looker 权限来限制那些不应能够访问扩展程序的用户。
从 Looker 24.0 开始，可以开发在信息中心内的板块中运行的扩展程序。支持作为平铺或可视化图表运行的扩展程序可以在信息中心处于编辑模式时添加，也可以从探索中作为可视化图表保存到信息中心。扩展程序还可以配置为 LookML 信息中心中的平铺。

扩展框架要求

如需使用 Looker 扩展程序框架进行开发，请执行以下操作：

您需要拥有 LookML 开发者权限才能访问您的实例。
您的 Looker 管理员必须启用 Extension Framework 功能。
建议您熟悉 JavaScript 或 TypeScript。
我们建议使用 React 进行开发，不过也有适用于原始 JavaScript 的扩展 SDK。

为了在 Looker 中运行，每个扩展程序（无论其功能如何）都必须在 Looker 中包含以下元素：

满足以下要求的 LookML 项目：
- 包含模型文件
- 包含项目清单文件
- 已连接到 Git 代码库
LookML 模型文件需要一个指向实例上有效数据库连接的 connection 参数。
项目清单文件需要 application 参数。application 参数用于为扩展程序提供标签、告知 Looker 在何处查找扩展程序 JavaScript，并提供扩展程序的授权列表。授权定义了扩展程序可以访问的 Looker 资源。除非 Looker 资源列在授权中，否则扩展程序将无法访问该资源。

注意：从 Looker 24.0 开始，application 参数包含 mount_points 子参数，该子参数用于确定扩展程序在 Looker 界面中的列出位置以及向用户提供的可用性，并确定扩展程序是否会提供自己的数据。旨在在信息中心图块中运行的扩展程序需要在 application 参数中指定 mount_points。

以下是包含 application 参数的项目清单文件示例：
```
  project_name: "super_duper_extension"
  application: super_duper_extension {
    label: "Super Duper Extension"
    url: "http://localhost:8080/dist/bundle.js"
    mount_points: {
      standalone: no
    }
    entitlements: {
      local_storage: no
      navigation: no
      new_window: no
      new_window_external_urls: []
      use_form_submit: yes
      use_embeds: no
      use_downloads: no
      core_api_methods: []
      external_api_urls: []
      oauth2_urls: []
      scoped_user_attributes: []
      global_user_attributes: []
    }
  }
```
如需了解详情，请参阅 application 参数文档页面。

Looker 扩展框架开发入门

最简单的入门方式是先从模板生成新的初始扩展程序，然后自定义该初始扩展程序并向其中添加功能。这样可确保所有配置和封装都正确无误，而手动操作很难做到这一点。如需了解如何为扩展程序创建新的 Looker 项目并生成初始扩展程序，请参阅构建 Looker 扩展程序文档页面。

如需更自定义或更高级的模板，您可以浏览 Looker 扩展框架示例代码库。该代码库中的任何扩展程序都可以克隆并重新用作项目的起点。

创建基本扩展程序并验证一切正常后，您可以开始添加其他功能和自定义设置：

您可以在 Looker 扩展框架代码示例文档页面上查看包含示例代码的常见用例列表。
如需使用我们的组件库快速开发界面和布局，请参阅 Looker 界面组件网站。
Looker 扩展程序 Kitchensink 模板是一个扩展程序，其中提供了各种扩展程序功能的示例。您可以将此模板用作百科全书或参考指南，但不能将其用作起点或实际模板。我们建议您使用扩展程序生成器或克隆一个更基本的示例来开始。
我们还提供了可作为信息中心卡片使用的扩展程序示例。平铺可视化图表扩展服务展示了如何使用扩展服务框架构建自定义可视化图表。功能块 SDK 扩展程序显示了特定于功能块扩展程序的可用 API 方法。