AEM GraphQL API를 사용하는 React 앱 빌드

마지막 업데이트: 2024-01-25
  • 작성 대상:
  • Beginner
    Developer

이 장에서는 AEM GraphQL API가 외부 애플리케이션에서 경험을 유도하는 방법을 살펴봅니다.

간단한 React 앱을 사용하여 쿼리하고 표시합니다 개인 AEM GraphQL API에 의해 노출된 콘텐츠. React의 사용은 대부분 중요하지 않으며 소비하는 외부 애플리케이션은 모든 플랫폼의 프레임워크에 작성될 수 있습니다.

사전 요구 사항

이 다중 파트 자습서의 이전 부분에 설명된 단계가 완료되었다고 가정됩니다. 또는 basic-tutorial-solution.content.zip 는 AEM Author 및 Publish as a Cloud Service 서비스에 설치됩니다.

이 장의 IDE 스크린샷은 Visual Studio 코드

다음 소프트웨어를 설치해야 합니다.

목표

방법 알아보기:

  • 예제 React 앱을 다운로드하여 시작합니다.
  • 다음을 사용하여 AEM GraphQL 끝점 쿼리 AEM Headless JS SDK
  • 팀 및 참조된 멤버 목록을 AEM에 쿼리
  • 팀 구성원의 세부 사항에 대해 AEM 쿼리

샘플 React 앱 가져오기

이 장에서는 AEM GraphQL API와 상호 작용하고 팀원 및 팀원으로부터 얻은 개인 데이터를 표시하는 데 필요한 코드로 스터브아웃 샘플 React 앱을 구현합니다.

샘플 React 앱 소스 코드는 Github.com에서 사용할 수 있습니다. https://github.com/adobe/aem-guides-wknd-graphql/tree/main/basic-tutorial

React 앱을 다운로드하려면:

  1. 에서 샘플 WKND GraphQL React 앱 복제 Github.com.

    $ cd ~/Code
    $ git clone git@github.com:adobe/aem-guides-wknd-graphql.git
    
  2. 다음으로 이동 basic-tutorial 폴더를 만들고 IDE에서 엽니다.

    $ cd ~/Code/aem-guides-wknd-graphql/basic-tutorial
    $ code .
    

    VSCode의 React 앱

  3. 업데이트 .env.development AEM as a Cloud Service 게시 서비스에 연결합니다.

    • 설정 REACT_APP_HOST_URI의 값은 AEM as a Cloud Service의 게시 URL이 됩니다(예: REACT_APP_HOST_URI=https://publish-p123-e456.adobeaemcloud.com) 및 REACT_APP_AUTH_METHOD의 값: 까지 none
    노트

    프로젝트 구성, 콘텐츠 조각 모델, 작성된 콘텐츠 조각, GraphQL 끝점 및 이전 단계의 지속 쿼리를 게시했는지 확인합니다.

    로컬 AEM Author SDK에서 위의 단계를 수행한 경우 다음을 지정할 수 있습니다. http://localhost:4502REACT_APP_AUTH_METHOD의 값: 까지 basic.

  4. 명령줄에서 aem-guides-wknd-graphql/basic-tutorial 폴더

  5. React 앱 시작

    $ cd ~/Code/aem-guides-wknd-graphql/basic-tutorial
    $ npm install
    $ npm start
    
  6. React 앱이 의 개발 모드에서 시작됩니다. http://localhost:3000/. 자습서 전체에서 React 앱에 대한 변경 사항이 즉시 반영됩니다.

부분적으로 구현된 React 앱

중요

이 React 앱은 부분적으로 구현됩니다. 이 자습서의 단계에 따라 구현을 완료합니다. 구현 작업이 필요한 JavaScript 파일에는 다음 주석이 있습니다. 이 자습서에 지정된 코드를 사용하여 해당 파일의 코드를 추가/업데이트해야 합니다.

//​**​**​**​**​**​**​**​**​**​**​**​**​**​***

// TODO AEM Headless 자습서의 단계에 따라 이를 구현합니다.

//​**​**​**​**​**​**​**​**​**​**​**​**​**​***

React 앱 구조

샘플 React 앱에는 다음 세 가지 주요 부분이 있습니다.

  1. 다음 src/api 폴더에는 AEM에 GraphQL 쿼리를 만드는 데 사용되는 파일이 포함되어 있습니다.

    • src/api/aemHeadlessClient.js AEM과의 통신에 사용되는 AEM Headless 클라이언트를 초기화하고 내보냅니다.
    • src/api/usePersistedQueries.js 구현 사용자 정의 React 후크 AEM GraphQL의 데이터를 Teams.jsPerson.js 구성 요소를 봅니다.
  2. 다음 src/components/Teams.js 파일은 목록 쿼리를 사용하여 팀 및 팀원의 목록을 표시합니다.

  3. 다음 src/components/Person.js 파일에는 매개 변수가 있는 단일 결과 쿼리를 사용하여 한 사람의 세부 정보가 표시됩니다.

AEMHeadless 개체 검토

리뷰 aemHeadlessClient.js 파일을 만드는 방법 AEMHeadless AEM과 통신하는 데 사용되는 개체입니다.

  1. 열기 src/api/aemHeadlessClient.js.

  2. 1-40행을 검토합니다.

    • 가져오기 AEMHeadless 에서 선언 JavaScript용 AEM Headless 클라이언트, 11행

    • 에 정의된 변수를 기반으로 한 권한 부여 구성 .env.development, 14-22행 및 화살표 함수 표현식 setAuthorization, 31-40행

    • 다음 serviceUrl 포함된 항목에 대한 설정 개발 프록시 27행입니다

  3. 줄 42-49는 를 인스턴스화할 때 가장 중요합니다. AEMHeadless React 앱 전체에서 사용하도록 클라이언트 및 내보냅니다.

// Initialize the AEM Headless Client and export it for other files to use
const aemHeadlessClient = new AEMHeadless({
  serviceURL: serviceURL,
  endpoint: REACT_APP_GRAPHQL_ENDPOINT,
  auth: setAuthorization(),
});

export default aemHeadlessClient;

AEM GraphQL 지속 쿼리를 실행하도록 구현

원본을 구현하려면 fetchPersistedQuery(..) AEM GraphQL 지속 쿼리를 실행하는 함수에서 usePersistedQueries.js 파일. 다음 fetchPersistedQuery(..) 함수에서 aemHeadlessClient 개체 runPersistedQuery() 함수를 사용하여 쿼리를 비동기적으로 실행할 수 있습니다.

나중에 사용자 지정 React useEffect 후크는 AEM에서 특정 데이터를 검색하기 위해 이 함수를 호출합니다.

  1. 위치 src/api/usePersistedQueries.js 업데이트 fetchPersistedQuery(..)로 시작하는 두 번째 행인 35행 아래에 코드가 표시됩니다.
/**
 * Private, shared function that invokes the AEM Headless client.
 *
 * @param {String} persistedQueryName the fully qualified name of the persisted query
 * @param {*} queryParameters an optional JavaScript object containing query parameters
 * @returns the GraphQL data or an error message
 */
async function fetchPersistedQuery(persistedQueryName, queryParameters) {
  let data;
  let err;

  try {
    // AEM GraphQL queries are asynchronous, either await their return or use Promise-based syntax
    const response = await aemHeadlessClient.runPersistedQuery(
      persistedQueryName,
      queryParameters
    );
    // The GraphQL data is stored on the response's data field
    data = response?.data;
  } catch (e) {
    // An error occurred, return the error messages
    err = e
      .toJSON()
      ?.map((error) => error.message)
      ?.join(", ");
    console.error(e.toJSON());
  }

  // Return the GraphQL and any errors
  return { data, err };
}

팀 기능 구현

그런 다음 React 앱의 기본 보기에서 팀과 팀원을 표시하는 기능을 빌드합니다. 이 기능을 사용하려면 다음 조건을 충족해야 합니다.

  • 새 항목 사용자 지정 React useEffect 후크 위치: src/api/usePersistedQueries.js 를 호출하는 경우 my-project/all-teams 지속 쿼리, AEM에서 팀 콘텐츠 조각 목록을 반환합니다.
  • 의 React 구성 요소 src/components/Teams.js 새로운 사용자 지정 React를 호출합니다. useEffect 를 후크하여 팀 데이터를 렌더링합니다.

완료되면 앱의 기본 보기가 AEM의 팀 데이터로 채워집니다.

팀 보기

단계

  1. 열기 src/api/usePersistedQueries.js.

  2. 함수 찾기 useAllTeams()

  3. 을(를) 만들려면 useEffect 지속 쿼리를 호출하는 후크 my-project/all-teams 경유 fetchPersistedQuery(..), 다음 코드를 추가합니다. 또한 후크는 의 AEM GraphQL 응답에서 관련 데이터만 반환합니다. data?.teamList?.items를 활성화하면 React 보기 구성 요소가 상위 JSON 구조를 인식하지 못합니다.

    /**
     * Custom hook that calls the 'my-project/all-teams' persisted query.
     *
     * @returns an array of Team JSON objects, and array of errors
     */
    export function useAllTeams() {
      const [teams, setTeams] = useState(null);
      const [error, setError] = useState(null);
    
      // Use React useEffect to manage state changes
      useEffect(() => {
        async function fetchData() {
          // Call the AEM GraphQL persisted query named "my-project/all-teams"
          const { data, err } = await fetchPersistedQuery(
            "my-project/all-teams"
          );
          // Sets the teams variable to the list of team JSON objects
          setTeams(data?.teamList?.items);
          // Set any errors
          setError(err);
        }
        // Call the internal fetchData() as per React best practices
        fetchData();
      }, []);
    
      // Returns the teams and errors
      return { teams, error };
    }
    
  4. 열기 src/components/Teams.js

  5. 다음에서 Teams React 구성 요소를 사용하여 AEM에서 팀 목록을 가져옵니다. useAllTeams() 후크.

    import { useAllTeams } from "../api/usePersistedQueries";
    ...
    function Teams() {
      // Get the Teams data from AEM using the useAllTeams
      const { teams, error } = useAllTeams();
      ...
    }
    
  6. 반환된 데이터를 기반으로 오류 메시지를 표시하거나 표시기를 로드하는 보기 기반 데이터 유효성 검사를 수행합니다.

    function Teams() {
      const { teams, error } = useAllTeams();
    
      // Handle error and loading conditions
      if (error) {
        // If an error ocurred while executing the GraphQL query, display an error message
        return <Error errorMessage={error} />;
      } else if (!teams) {
        // While the GraphQL request is executing, show the Loading indicator
        return <Loading />;
      }
      ...
    }
    
  7. 마지막으로 팀 데이터를 렌더링합니다. GraphQL 쿼리에서 반환된 각 팀은 제공된 를 사용하여 렌더링됩니다 Team React 하위 구성 요소입니다.

    import React from "react";
    import { Link } from "react-router-dom";
    import { useAllTeams } from "../api/usePersistedQueries";
    import Error from "./Error";
    import Loading from "./Loading";
    import "./Teams.scss";
    
    function Teams() {
      const { teams, error } = useAllTeams();
    
      // Handle error and loading conditions
      if (error) {
        return <Error errorMessage={error} />;
      } else if (!teams) {
        return <Loading />;
      }
    
      // Teams have been populated by AEM GraphQL query. Display the teams.
      return (
        <div className="teams">
          {teams.map((team, index) => {
            return <Team key={index} {...team} />;
          })}
        </div>
      );
    }
    
    // Render single Team
    function Team({ title, shortName, description, teamMembers }) {
      // Must have title, shortName and at least 1 team member
      if (!title || !shortName || !teamMembers) {
        return null;
      }
    
      return (
        <div className="team">
          <h2 className="team__title">{title}</h2>
          <p className="team__description">{description.plaintext}</p>
          <div>
            <h4 className="team__members-title">Members</h4>
            <ul className="team__members">
              {/* Render the referenced Person models associated with the team */}
              {teamMembers.map((teamMember, index) => {
                return (
                  <li key={index} className="team__member">
                    <Link to={`/person/${teamMember.fullName}`}>
                      {teamMember.fullName}
                    </Link>
                  </li>
                );
              })}
            </ul>
          </div>
        </div>
      );
    }
    
    export default Teams;
    

사용자 기능 구현

포함 팀 기능 완료하면 팀원 또는 개인의 세부 정보에 대한 표시를 처리하는 기능을 구현해 보겠습니다.

이 기능을 사용하려면 다음 조건을 충족해야 합니다.

  • 새 항목 사용자 지정 React useEffect 후크 위치: src/api/usePersistedQueries.js 매개 변수가 있는 my-project/person-by-name 지속 쿼리이며 1인 레코드를 반환합니다.

  • 의 React 구성 요소 src/components/Person.js 개인의 전체 이름을 쿼리 매개 변수로 사용하고, 새로운 사용자 지정 React를 호출합니다. useEffect 후크하여 개인 데이터를 렌더링합니다.

완료되면 팀 보기에서 사용자 이름을 선택하면 사용자 보기가 렌더링됩니다.

개인

  1. 열기 src/api/usePersistedQueries.js.

  2. 함수 찾기 usePersonByName(fullName)

  3. 을(를) 만들려면 useEffect 지속 쿼리를 호출하는 후크 my-project/all-teams 경유 fetchPersistedQuery(..), 다음 코드를 추가합니다. 또한 후크는 의 AEM GraphQL 응답에서 관련 데이터만 반환합니다. data?.teamList?.items를 활성화하면 React 보기 구성 요소가 상위 JSON 구조를 인식하지 못합니다.

    /**
     * Calls the 'my-project/person-by-name' and provided the {fullName} as the persisted query's `name` parameter.
     *
     * @param {String!} fullName the full
     * @returns a JSON object representing the person
     */
    export function usePersonByName(fullName) {
      const [person, setPerson] = useState(null);
      const [errors, setErrors] = useState(null);
    
      useEffect(() => {
        async function fetchData() {
          // The key is the variable name as defined in the persisted query, and may not match the model's field name
          const queryParameters = { name: fullName };
    
          // Invoke the persisted query, and pass in the queryParameters object as the 2nd parameter
          const { data, err } = await fetchPersistedQuery(
            "my-project/person-by-name",
            queryParameters
          );
    
          if (err) {
            // Capture errors from the HTTP request
            setErrors(err);
          } else if (data?.personList?.items?.length === 1) {
            // Set the person data after data validation
            setPerson(data.personList.items[0]);
          } else {
            // Set an error if no person could be found
            setErrors(`Cannot find person with name: ${fullName}`);
          }
        }
        fetchData();
      }, [fullName]);
    
      return { person, errors };
    }
    
  4. 열기 src/components/Person.js

  5. 다음에서 Person React 구성 요소, 구문 분석 fullName 경로 매개 변수를 사용하고 AEM에서 개인 데이터를 가져옵니다. usePersonByName(fullName) 후크.

    import { useParams } from "react-router-dom";
    import { usePersonByName } from "../api/usePersistedQueries";
    ...
    function Person() {
      // Read the person's `fullName` which is the parameter used to query for the person's details
      const { fullName } = useParams();
    
      // Query AEM for the Person's details, using the `fullName` as the filtering parameter
      const { person, error } = usePersonByName(fullName);
      ...
    }
    
  6. 반환된 데이터를 기반으로 오류 메시지를 표시하거나 표시기를 로드하는 보기 기반 데이터 유효성 검사를 수행합니다.

    function Person() {
      // Read the person's `fullName` which is the parameter used to query for the person's details
      const { fullName } = useParams();
    
      // Query AEM for the Person's details, using the `fullName` as the filtering parameter
      const { person, error } = usePersonByName(fullName);
    
      // Handle error and loading conditions
      if (error) {
        return <Error errorMessage={error} />;
      } else if (!person) {
        return <Loading />;
      }
      ...
    }
    
  7. 마지막으로 개인 데이터를 렌더링합니다.

    import React from "react";
    import { useParams } from "react-router-dom";
    import { usePersonByName } from "../api/usePersistedQueries";
    import { mapJsonRichText } from "../utils/renderRichText";
    import Error from "./Error";
    import Loading from "./Loading";
    import "./Person.scss";
    
    function Person() {
      // Read the person's `fullName` which is the parameter used to query for the person's details
      const { fullName } = useParams();
    
      // Query AEM for the Person's details, using the `fullName` as the filtering parameter
      const { person, error } = usePersonByName(fullName);
    
      // Handle error and loading conditions
      if (error) {
        return <Error errorMessage={error} />;
      } else if (!person) {
        return <Loading />;
      }
    
      // Render the person data
      return (
        <div className="person">
          <img
            className="person__image"
            src={process.env.REACT_APP_HOST_URI+person.profilePicture._path}
            alt={person.fullName}
          />
          <div className="person__occupations">
            {person.occupation.map((occupation, index) => {
              return (
                <span key={index} className="person__occupation">
                  {occupation}
                </span>
              );
            })}
          </div>
          <div className="person__content">
            <h1 className="person__full-name">{person.fullName}</h1>
            <div className="person__biography">
              {/* Use this utility to transform multi-line text JSON into HTML */}
              {mapJsonRichText(person.biographyText.json)}
            </div>
          </div>
        </div>
      );
    }
    
    export default Person;
    

앱 사용

앱 검토 http://localhost:3000/ 및 클릭 구성원 링크. 또한 AEM에서 컨텐츠 조각을 추가하여 팀 Alpha에 더 많은 팀 및/또는 구성원을 추가할 수 있습니다.

중요

구현 변경 사항을 확인하거나 위의 변경 사항 후에 앱이 작동하도록 할 수 없는 경우 기본 자습서 솔루션 분기.

언더더 후드

브라우저 열기 개발자 도구 > 네트워크필터 대상 all-teams 요청. GraphQL API 요청 알림 /graphql/execute.json/my-project/all-teams 다음에 대해 만들어짐: http://localhost:3000아님 의 값에 대하여 REACT_APP_HOST_URI, 예 <https://publish-pxxx-exxx.adobeaemcloud.com. 다음과 같은 이유로 React 앱의 도메인에 대해 요청이 수행됩니다. 프록시 설정 은(는) 을 사용하여 활성화되었습니다. http-proxy-middleware 모듈.

프록시를 통한 GraphQL API 요청

메인 리뷰 ../setupProxy.js 파일 및 다음 범위 내 ../proxy/setupProxy.auth.**.js 파일이 방법을 나타냄 /content/graphql 경로가 프록시화되고 정적 자산이 아님을 나타냅니다.

module.exports = function(app) {
  app.use(
    ['/content', '/graphql'],
  ...

로컬 프록시 사용은 프로덕션 배포에 적합한 옵션이 아니며 자세한 내용은 다음에서 확인할 수 있습니다. 프로덕션 배포 섹션.

축하합니다!

축하합니다! 기본 자습서의 일부로 AEM GraphQL API의 데이터를 사용하고 표시할 React 앱을 만들었습니다!

이 페이지에서는