利用 AEM Headless 的最佳化影像

影像是的重要方面 開發豐富、極具吸引力的AEM Headless體驗. AEM Headless支援影像資產的管理及其最佳化傳送。

AEM Headless內容模型中使用的內容片段，通常會參照要在Headless體驗中顯示的影像資產。 AEM GraphQL查詢可以寫入，以根據影像參考來源提供URL給影像。

此 ImageRef type有四個URL選項供內容參照使用：

• _path 是AEM中的參照路徑，不包含AEM來源（主機名稱）
• _dynamicUrl 是偏好的Web最佳化影像資產的完整URL。
  • 此 _dynamicUrl 不包含AEM來源，因此網域(AEM作者或AEM發佈服務)必須由使用者端應用程式提供。
• _authorUrl 是AEM作者上影像資產的完整URL
  • AEM作者 可用來提供headless應用程式的預覽體驗。
• _publishUrl 是AEM發佈上影像資產的完整URL
  • AEM發佈 通常是Headless應用程式生產部署顯示影像的位置。

此 _dynamicUrl 是用於影像資產的慣用URL且應取代的 _path， _authorUrl、和 _publishUrl 儘可能使用。

內容片段模型

確保包含影像參考的內容片段欄位為 內容參考 資料型別。

您可在下列欄位型別中進行檢閱： 內容片段模型，方法是選取欄位，並檢查 屬性 標籤在右側。

GraphQL持續查詢

在GraphQL查詢中，將欄位傳回為 ImageRef 型別並要求 _dynamicUrl 欄位。 例如，查詢 wknd網站專案 並將影像資產參考的影像URL加入其 primaryImage 欄位，可使用新的持續查詢完成 wknd-shared/adventure-image-by-path 定義為：

query($path: String!, $imageFormat: AssetTransformFormat=JPG, $imageSeoName: String, $imageWidth: Int, $imageQuality: Int) {
  adventureByPath(
    _path: $path
    _assetTransform: {
      format: $imageFormat
      width: $imageWidth
      quality: $imageQuality
      preferWebp: true
    }
  ) {
    item {
      _path
      title
      primaryImage {
        ... on ImageRef {
          _dynamicUrl
        }
      }
    }
  }
}

查詢變數

{
  "path": "/content/dam/wknd-shared/en/adventures/bali-surf-camp/bali-surf-camp",
  "imageFormat": "JPG",
  "imageWidth": 1000,
}

此 $path 變數用於 _path 篩選器需要內容片段的完整路徑(例如 /content/dam/wknd-shared/en/adventures/bali-surf-camp/bali-surf-camp)。

此 _assetTransform 定義 _dynamicUrl 旨在最佳化提供的影像轉譯。 您也可以變更URL的查詢引數，在使用者端上調整Web最佳化的影像URL。

GraphQL回應

產生的JSON回應包含要求的欄位，其中包含影像資產的網頁最佳化URL。

{
  "data": {
    "adventureByPath": {
      "item": {
        "_path": "/content/dam/wknd-shared/en/adventures/bali-surf-camp/bali-surf-camp",
        "title": "Bali Surf Camp",
        "primaryImage": {
          "_dynamicUrl": "/adobe/dynamicmedia/deliver/dm-aid--a38886f7-4537-4791-aa20-3f6ef0ac3fcd/adobestock_175749320.jpg?preferwebp=true&width=1000&quality=80"
        }
      }
    }
  }
}

若要載入應用程式中參照影像的網頁最佳化影像，請使用 _dynamicUrl 的 primaryImage 做為影像的來源URL。

在React中，從AEM Publish顯示網頁最佳化影像的外觀如下：

const AEM_HOST = "https://publish-p123-e456.adobeaemcloud.com";
...
let dynamicUrl = AEM_HOST + data.adventureByPath.item.primaryImage._dynamicUrl;
...
<img src={dynamicUrl} alt={data.adventureByPath.item.title}/>

請記住， _dynamicUrl 不包含AEM網域，因此您必須提供所要的原點以供影像URL解析。

回應式URL

上述範例顯示使用單一大小的影像，不過在網頁體驗中，通常需要回應式影像集。 回應式影像可透過以下方式實施： img srcsets 或 圖片元素. 下列程式碼片段會示範如何使用 _dynamicUrl 為基礎，並附加不同的寬度引數，以支援不同的回應式檢視。 不只可以 width 可使用查詢引數，但使用者端可以新增其他查詢引數，以根據其需求進一步最佳化影像資產。

const AEM_HOST = "https://publish-p123-e456.adobeaemcloud.com";
...
// Read the data from GraphQL response
let dynamicUrl = AEM_HOST + data.adventureByPath.item.primaryImage._dynamicUrl;
let alt = data.adventureByPath.item.title;
...
{/*-- Example img srcset --*/}
document.body.innerHTML=`<img>
    alt="${alt}"
    src="${dynamicUrl}&width=1000}"
    srcset="`
      ${dynamicUrl}&width=1000 1000w,
      ${dynamicUrl}&width=1600 1600w,
      ${dynamicUrl}&width=2000 2000w,
      `"
    sizes="calc(100vw - 10rem)"/>`;
...
{/*-- Example picture --*/}
document.body.innerHTML=`<picture>
      <source srcset="${dynamicUrl}&width=2600" media="(min-width: 2001px)"/>
      <source srcset="${dynamicUrl}&width=2000" media="(min-width: 1000px)"/>
      <img src="${dynamicUrl}&width=400" alt="${alt}"/>
    </picture>`;

React範例

讓我們建立簡單的React應用程式，在以下位置顯示網頁最佳化的影像 回應式影像模式. 回應式影像的主要模式有兩種：

• 具有srcset的Img元素 提升效能
• 圖片元素 設計控制項

具有srcset的Img元素

具有srcset的Img元素 搭配 sizes 屬性以為不同的熒幕大小提供不同的影像資產。 針對不同的熒幕大小提供不同的影像資產時，影像資料集相當實用。

圖片元素

圖片元素 用於多個 source 元素，為不同熒幕大小提供不同的影像資產。 為不同的熒幕大小提供不同的影像轉譯時，圖片元素相當實用。

範常式式碼

這個簡單的React應用程式會使用 AEM Headless SDK 查詢AEM Headless API以取得Adventure內容，並使用以下方法顯示網頁最佳化的影像： 具有srcset的img元素 和 圖片元素. 此 srcset 和 sources 使用自訂 setParams 此函式可將Web最佳化的傳遞查詢引數附加至 _dynamicUrl 因此，請根據網頁使用者端的需求變更傳送的影像轉譯。

在自訂React勾點中執行針對AEM的查詢 useAdventureByPath，使用AEM Headless SDK.

// src/App.js

import "./App.css";
import { useAdventureByPath } from './api/persistedQueries'

const AEM_HOST = process.env.AEM_HOST;

function App() {

  /**
   * Update the dynamic URL with client-specific query parameters
   * @param {*} imageUrl the image URL
   * @param {*} params the AEM web-optimized image query parameters
   * @returns the dynamic URL with the query parameters
   */
  function setOptimizedImageUrlParams(imageUrl, params) {
    let url = new URL(imageUrl);
    Object.keys(params).forEach(key => {
      url.searchParams.set(key, params[key]);
    });
    return url.toString();
  }

  // Get data from AEM using GraphQL persisted query as defined above
  // The details of defining a React useEffect hook are explored in How to > AEM Headless SDK
  // The 2nd parameter define the base GraphQL query parameters used to request the web-optimized image
  let { data, error } = useAdventureByPath(
        "/content/dam/wknd-shared/en/adventures/bali-surf-camp/bali-surf-camp",
        { imageFormat: "JPG" }
      );

  // Wait for AEM Headless APIs to provide data
  if (!data) { return <></> }

  const alt = data.adventureByPath.item.title;
  const imageUrl =  AEM_HOST + data.adventureByPath.item.primaryImage._dynamicUrl;

  return (
    <div className="app">

      <h1>Web-optimized images</h1>

      {/* Render the web-optimized image img with srcset for the Adventure Primary Image */}
      <h2>Img srcset</h2>

      <img
        alt={alt}
        src={setOptimizedImageUrlParams(imageUrl, { width: 1000 })}
        srcSet={
            `${setOptimizedImageUrlParams(imageUrl, { width: 1000 })} 1000w,
             ${setOptimizedImageUrlParams(imageUrl, { width: 1600 })} 1600w,
             ${setOptimizedImageUrlParams(imageUrl, { width: 2000 })} 2000w`
        }
        sizes="calc(100vw - 10rem)"/>

       {/* Render the web-optimized picture for the Adventure Primary Image */}
        <h2>Picture element</h2>

        <picture>
          {/* When viewport width is greater than 2001px */}
          <source srcSet={setOptimizedImageUrlParams(imageUrl, { width : 2600 })} media="(min-width: 2001px)"/>
          {/* When viewport width is between 1000px and 2000px */}
          <source srcSet={setOptimizedImageUrlParams(imageUrl, { width : 2000})} media="(min-width: 1000px)"/>
          {/* When viewport width is less than 799px */}
          <img src={setOptimizedImageUrlParams(imageUrl, { width : 400, crop: "550,300,400,400" })} alt={alt}/>
        </picture>
    </div>
  );
}

export default App;