

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# 使用 Amazon DCV Web UI SDK
<a name="render-ui"></a>

 下列教學課程說明如何向 Amazon DCV 伺服器進行身分驗證、連接至該伺服器，以及從 Amazon DCV Web UI SDK 轉譯 `DCVViewer` React 元件。

**Topics**
+ [先決條件](#prerequisites)
+ [步驟 1：準備您的 HTML 頁面](#prep-html-ui)
+ [步驟 2：驗證、連接和轉譯 `DCVViewer` React 元件。](#auth-conn-render)
+ [從 AWS-UI 更新至 Cloudscape 設計系統](#updateawsuitocloudscape)

## 先決條件
<a name="prerequisites"></a>

 您需要安裝 `React` 、、 `ReactDOM` `Cloudscape Design Components React` `Cloudscape Design Global Styles`和 `Cloudscape Design Design Tokens` 。

```
$ npm i react react-dom @cloudscape-design/components @cloudscape-design/global-styles @cloudscape-design/design-tokens
```

 您也需要下載 `Amazon DCV Web Client SDK` 。請參閱 [Amazon DCV Web 用戶端 SDK 入門](getting-started.md)以閱讀如何執行此操作的step-by-step指南。

您必須建立用於匯入`dcv`模組的別名，因為它是 Amazon DCV Web UI SDK 的外部相依性。例如，如果您使用 webpack 綁定 Web 應用程式，您可以使用 [ resolve.alias](https://webpack.js.org/configuration/resolve/#resolvealias) 選項，如下所示：

```
const path = require('path');

module.exports = {
  //...
  resolve: {
    alias: {
      dcv: path.resolve('path', 'to', 'dcv.js'),
    },
  },
};
```

如果您使用彙總進行綁定，您可以安裝 [ @rollup/plugin-alias](https://www.npmjs.com/package/@rollup/plugin-alias)，並像這樣使用：

```
import alias from '@rollup/plugin-alias';
const path = require('path');

module.exports = {
  //...
  plugins: [
    alias({
      entries: [
        { find: 'dcv', replacement: path.resolve('path', 'to', 'dcv.js') },
      ]
    })
  ]
};
```

## 步驟 1：準備您的 HTML 頁面
<a name="prep-html-ui"></a>

 在您的網頁中，您必須載入必要的 JavaScript 模組，而且應該有一個 `<div>` HTML 元素，其中包含一個有效的 `id` HTML 元素，其中會轉譯您應用程式的進入元件。

例如：

```
<!DOCTYPE html>
<html lang="en" style="height: 100%;">
  <head>
    <title>DCV first connection</title>
  </head>
  <body style="height: 100%;">
    <div id="root" style="height: 100%;"></div>
    <script type="module" src="index.js"></script>
  </body>
</html>
```

## 步驟 2：驗證、連接和轉譯 `DCVViewer` React 元件。
<a name="auth-conn-render"></a>

 本節說明如何完成使用者身分驗證程序、如何連接 Amazon DCV 伺服器，以及如何轉譯 `DCVViewer` React 元件。

 首先，從 `index.js` 檔案匯入 `React` `ReactDOM`和您的頂層`App`元件。

```
import React from "react";
import ReactDOM from 'react-dom';
import App from './App';
```

轉譯應用程式的頂層容器節點。

```
ReactDOM.render(
  <React.StrictMode>
    <App />
  </React.StrictMode>,
  document.getElementById("root")
);
```

 在 `App.js` 檔案中，匯入 Amazon DCV Web 用戶端 SDK 做為 ESM 模組、Amazon DCV Web UI SDK 的 `DCVViewer` React 元件，`React`以及 `Cloudscape Design Global Styles`套件。

```
import React from "react";
import dcv from "dcv";
import "@cloudscape-design/global-styles/index.css";
import {DCVViewer} from "./dcv-ui/dcv-ui.js";
```

 以下範例示範如何在身分驗證成功的情況下，對 Amazon DCV 伺服器進行身分驗證，並從 Amazon DCV Web UI SDK 轉譯 `DCVViewer` React 元件。

```
const LOG_LEVEL = dcv.LogLevel.INFO;
const SERVER_URL = "https://your-dcv-server-url:port/";
const BASE_URL = "/static/js/dcvjs";

let auth;

function App() {
  const [authenticated, setAuthenticated] = React.useState(false);
  const [sessionId, setSessionId] = React.useState('');
  const [authToken, setAuthToken] = React.useState('');
  const [credentials, setCredentials] = React.useState({});

  const onSuccess = (_, result) => {
    var { sessionId, authToken } = { ...result[0] };

    console.log("Authentication successful.");

    setSessionId(sessionId);
    setAuthToken(authToken);
    setAuthenticated(true);
    setCredentials({});
  }

  const onPromptCredentials = (_, credentialsChallenge) => {
    let requestedCredentials = {};

    credentialsChallenge.requiredCredentials.forEach(challenge => requestedCredentials[challenge.name] = "");
    setCredentials(requestedCredentials);
  }

  const authenticate = () => {
    dcv.setLogLevel(LOG_LEVEL);

    auth = dcv.authenticate(
      SERVER_URL,
      {
        promptCredentials: onPromptCredentials,
        error: onError,
        success: onSuccess
      }
    );
  }

  const updateCredentials = (e) => {
    const { name, value } = e.target;
    setCredentials({
      ...credentials,
      [name]: value
    });
  }

  const submitCredentials = (e) => {
    auth.sendCredentials(credentials);
    e.preventDefault();
  }

  React.useEffect(() => {
    if (!authenticated) {
      authenticate();
    }
  }, [authenticated]);

  const handleDisconnect = (reason) => {
    console.log("Disconnected: " + reason.message + " (code: " + reason.code + ")");
    auth.retry();
    setAuthenticated(false);
  }

  return (
    authenticated ?
    <DCVViewer
      dcv={{
        sessionId: sessionId,
        authToken: authToken,
        serverUrl: SERVER_URL,
        baseUrl: BASE_URL,
        onDisconnect: handleDisconnect,
        logLevel: LOG_LEVEL
      }}
      uiConfig={{
        toolbar: {
          visible: true,
          fullscreenButton: true,
          multimonitorButton: true,
        },
      }}
    />
    :
    <div
      style={{
        height: window.innerHeight,
        backgroundColor: "#373737",
        display: 'flex',
        alignItems: 'center',
        justifyContent: 'center',
      }}
    >
      <form>
        <fieldset>
          {Object.keys(credentials).map((cred) => (
            <input
              key={cred}
              name={cred}
              placeholder={cred}
              type={cred === "password" ? "password" : "text"}
              onChange={updateCredentials}
              value={credentials[cred]}
            />
          ))}
        </fieldset>
        <button
          type="submit"
          onClick={submitCredentials}
        >
          Login
        </button>
      </form>
    </div>
  );
}

const onError = (_, error) => {
  console.log("Error during the authentication: " + error.message);
}

export default App;
```

 、 `error` 和 `promptCredentials` `success`函數是必須在身分驗證程序中定義的強制性回呼函數。

 如果 Amazon DCV 伺服器提示登入資料，回`promptCredentials`呼函數會從 Amazon DCV 伺服器收到請求的登入資料挑戰。如果 Amazon DCV 伺服器設定為使用系統身分驗證，則必須以使用者名稱和密碼的形式提供憑證。

 如果身分驗證失敗，回`error`呼函數會從 Amazon DCV 伺服器接收錯誤物件。

 如果身分驗證成功，回`success`呼函數會接收包含工作階段 ID () `sessionId` 和授權字符 (`authToken`) 的耦合陣列，以供使用者在 Amazon DCV 伺服器上連線到每個工作階段。上述程式碼範例會更新 React 狀態，以在身分驗證成功時轉譯`DCVViewer`元件。

 若要進一步了解此元件接受的屬性，請參閱 [ Amazon DCV Web UI SDK 參考](https://docs.aws.amazon.com/dcv/latest/websdkguide/dcv-viewer.html#DCVViewer)。

 若要進一步了解自我簽署憑證，請參閱[自我簽署憑證的重新導向說明](https://docs.aws.amazon.com/dcv/latest/adminguide/redirection-clarifications-with-self-signed-certs.html)。

## 從 AWS-UI 更新至 Cloudscape 設計系統
<a name="updateawsuitocloudscape"></a>

 從 SDK 1.3.0 版開始，我們將`DCVViewer`元件從 AWS-UI 更新至其演變：[Cloudscape Design](https://cloudscape.design/)。

 Cloudscape 使用與 AWS-UI 不同的視覺化佈景主題，但基礎程式碼基礎保持不變。因此，根據 遷移應用程式`DCVViewer`應該很簡單。若要遷移，請將您安裝的 AWS-UI 相關 NPM 套件取代為相關聯的 Cloudscape 套件：


| AWS-UI 套件名稱 | Cloudscape 套件名稱 | 
| --- | --- | 
| @awsui/components-react | @cloudscape-design/元件 | 
| @awsui/全域樣式 | @cloudscape-design/全域樣式 | 
| @awsui/collection-hooks | @cloudscape-design/collection-hooks | 
| @awsui/design-tokens | @cloudscape-design/design-tokens | 

 如需遷移的詳細資訊，請參閱 [AWS-UI GitHub 文件頁面](https://github.com/aws/awsui-documentation)。