构建 Looker 扩展程序简介

本页面介绍了如何生成和配置基本 Looker 扩展程序模板,然后您可以添加模板。

如需创建新的 Looker 扩展程序,您需要执行以下任务:

以下过程说明了如何构建上述元素。

为扩展程序配置 Looker

Looker 扩展程序都需要一个包含模型文件和清单文件的 LookML 项目。

  1. 为扩展程序创建一个空白项目

  2. 在新项目中,使用 Looker IDE 中文件浏览器顶部的 + 创建模型文件

  3. 使用 connection 参数和 include 参数生成新模型文件:

    connection 参数中的 connection_name 替换为实例上有效数据库连接的名称。该扩展程序需要有效的模型文件,因为 Looker 权限数据是通过 LookML 模型访问的。如需管理对扩展程序的访问权限,您必须将扩展程序与有效的 LookML 模型相关联,并授予用户访问该模型的权限。修改完模型文件后,请点击保存更改

    由于您的扩展程序不需要视图文件,因此请删除 include: "/views/*.view.lkml" 参数或在行开头添加 # 字符以让行成为注释。将 include: "/views/*.view.lkml" 参数保持原样会导致 LookML 验证程序生成错误。

  4. 在 Looker IDE 的文件浏览器顶部使用 + 创建项目清单文件

    项目清单文件最初是空的,但在此过程中,您会将生成的内容复制到项目清单文件中,其中包含 application 参数。application 参数会为扩展程序添加标签,告知 Looker 在何处查找扩展程序 JavaScript,并提供扩展程序的权利列表。授权定义了扩展程序可以访问的 Looker 资源。扩展程序将无法访问 Looker 资源,除非这项权限列在权益中。

    不过,您可以暂时保留清单文件,因为在此过程的后面,您需要将文件的其余部分复制到该文件中。

  5. 为新项目配置 Git 连接

    您可以通过以下方式访问 Configure Git(配置 Git)页面:点击 Looker IDE 右上角的 Configure Git(配置 Git)按钮,或使用项目配置页面(如设置和测试 Git 连接文档页面中所述)。

为扩展程序设置项目并将其关联到 Git 后,您就可以生成扩展程序模板文件了。

生成扩展程序模板文件

您可以通过以下两种方式生成扩展程序模板代码文件:

这两个进程都需要 Yarn,因此请确保您已安装 Yarn。

使用 create-looker-extension 创建扩展程序模板

create-looker-extension 实用程序会创建一个基本的 Looker 扩展程序,其中包含所有必要的扩展程序文件和依赖项。然后,您可以以此为基础,添加其他代码和功能以完成扩展程序。

要生成扩展程序模板,请执行以下操作:

  1. 运行 create-looker-extension 实用程序,并将 <extension_name> 替换为您的扩展程序的名称:

    yarn create looker-extension <extension_name>
    
  2. 确认扩展程序名称或提供其他名称,然后选择构建扩展程序所用的语言和框架:

    然后,create-looker-extension 实用程序将使用您指定的框架填充基本模板,并将所有生成的文件放入使用扩展程序名称的新目录中:

  3. 转到为扩展程序创建的目录:

    cd <extension_name>
    
  4. 安装扩展程序依赖项:

    yarn install
    
  5. 启动开发服务器:

    yarn develop
    

    该扩展程序现在正在 http://localhost:8080/bundle.js 本地运行并提供 JavaScript。

  6. 您的扩展程序目录中是文件 manifest.lkml。复制此文件的内容。

  7. 在 LookML 项目中,将 manifest.lkml 的内容粘贴到项目清单文件中:

    点击保存更改,保存您的项目清单文件。

  8. 在 LookML IDE 中,点击 Validate LookML,然后依次点击 Commit Changes & PushDeploy to Production

  9. 使用浏览器的重新加载函数重新加载 Looker。

    在 Looker 的浏览菜单中,您会看到新附加信息的名称:

  10. 浏览菜单中选择您的扩展程序,以查看该扩展程序的输出内容。

如果您的管理员启用了增强的导航实验室功能,则扩展程序会列在新的增强型左侧导航面板应用部分。

克隆 Git 代码库以创建扩展程序模板

Looker 维护着一个 Git 代码库,该代码库位于 https://github.com/looker-open-source/extension-examples 中,且有多个扩展程序模板。如果您要使用其中的某个示例,请导航到该示例的代码库,然后按照以下说明操作。

此过程需要使用 Yarn,因此请确保您已安装 Yarn。

  1. 在本地命令行上,使用以下命令克隆 Git 代码库:

    git clone git@github.com:looker-open-source/extension-examples.git
    
  2. 转到包含您要在系统上安装的模板的目录。在此示例中,我们将使用 React 和 JavaScript 的“Hello World”扩展程序:

    cd extension-examples/react/javascript/helloworld-js
    
  3. 安装扩展程序依赖项:

    yarn install
    

    您可能需要更新 Node 版本,或使用 Node Version Manager 更改 Node 版本。

  4. 您的扩展程序目录中是文件 manifest.lkml。复制此文件的内容。

  5. 在 LookML 项目中,将 manifest.lkml 的内容粘贴到项目清单文件中:

    点击保存更改,保存您的项目清单文件。

  6. 在 LookML IDE 的右上角,点击 Validate LookML,然后依次点击 Commit Changes & PushDeploy to Production

  7. 在终端中,启动开发服务器:

    yarn develop
    

    该扩展程序现在正在清单文件 url 参数中指定的本地开发服务器上运行并提供 JavaScript:http://localhost:8080/bundle.js

  8. 使用浏览器的重新加载函数重新加载 Looker。

    在 Looker 的浏览菜单中,您会看到新扩展程序的名称,该名称由项目清单文件中的 label 参数决定:

  9. 浏览菜单中选择您的扩展程序,以查看该扩展程序的输出内容。

如果您的管理员启用了增强的导航实验室功能,则扩展程序会列在新的增强型左侧导航面板应用部分。

修改扩展程序

创建基本扩展程序后,您可以通过修改相应的 JavaScript 或 TypeScript 文件来修改代码或向其中添加代码。

扩展程序目录下的 src 目录包含可添加代码的源文件。在上面的示例中,对于 React 和 JavaScript“Hello World”模板,文件名为 HelloWorld.js。修改该文件或向该文件添加代码,将会修改或向扩展程序添加内容。

下面是 React 和 JavaScript HelloWorld.js 文件的输出:

import React, { useEffect, useState, useContext } from 'react'
import { Space, ComponentsProvider, Text } from '@looker/components'
import { ExtensionContext } from '@looker/extension-sdk-react'

export const HelloWorld = () => {
  const { core40SDK } = useContext(ExtensionContext)
  const [message, setMessage] = useState()

  useEffect(() => {
    const initialize = async () => {
      try {
        const value = await core40SDK.ok(core40SDK.me())
        setMessage(`Hello, ${value.display_name}`)
      } catch (error) {
        setMessage('Error occured getting information about me!')
        console.error(error)
      }
    }
    initialize()
  }, [])

  return (
    &#60;>
      &#60;ComponentsProvider>
        &#60;Space p="xxxxxlarge" width="100%" height="50vh" around>
          &#60;Text p="xxxxxlarge" fontSize="xxxxxlarge">
            {message}
          &#60;/Text>
        &#60;/Space>
      &#60;/ComponentsProvider>
    &#60;/>
  )
}

在上面的示例中,您可以通过更改 setMessage('Hello, ${me.display_name}') 行中的文本来更改扩展程序的文本输出。

请注意,在添加功能时,您可能需要在项目清单文件的 application 参数中修改已向扩展程序授予的权限。