AEM as a Cloud Service에서 클라이언트측 라이브러리 사용 using-client-side-libraries

디지털 경험은 복잡한 JavaScript 및 CSS 코드로 구동되는 클라이언트측 처리에 크게 의존합니다. AEM 클라이언트 측 라이브러리(clientlibs)를 사용하면 이러한 클라이언트 측 라이브러리를 구성하고 저장소 내에 중앙에서 저장할 수 있습니다. AEM Project Archetype의 프론트엔드 빌드 프로세스와 함께하면 AEM 프로젝트에 대한 프론트엔드 코드를 간편하게 관리할 수 있습니다.

AEM에서 clientlib을 사용할 때의 장점은 다음과 같습니다.

Clientlib은 AEM에서 CSS 및 JavaScript을 제공하는 기본 제공 솔루션입니다.

클라이언트측 라이브러리란 무엇입니까? what-are-clientlibs

사이트에서는 클라이언트측에서 처리할 JavaScript 및 CSS와 아이콘 및 웹 글꼴과 같은 정적 리소스가 필요합니다. clientlib은 AEM에서 참조하고(필요한 경우 카테고리별로) 이러한 리소스를 제공하는 메커니즘입니다.

AEM은 사이트의 CSS와 JavaScript을 중앙 위치에 있는 단일 파일로 수집하여 HTML 출력에 모든 리소스의 복사본을 하나만 포함하도록 합니다. 이를 통해 게재 효율성을 극대화하고 프록시를 통해 이러한 리소스를 저장소 중앙에서 유지 관리할 수 있어 액세스 보안을 유지할 수 있습니다.

AEM as a Cloud Service용 프론트엔드 개발 fed-for-aemaacs

모든 JavaScript, CSS 및 기타 프론트엔드 자산은 AEM Project Archetype의 ui.frontend 모듈에서 유지 관리되어야 합니다. Archetype의 유연성을 통해 원하는 최신 웹 도구를 사용하여 이러한 리소스를 만들고 관리할 수 있습니다.

그런 다음 Archetype은 리소스를 단일 CSS 및 JS 파일로 컴파일하여 리포지토리의 cq:clientLibraryFolder에 자동으로 포함할 수 있습니다.

클라이언트측 라이브러리 폴더 구조 clientlib-folders

클라이언트측 라이브러리 폴더는 cq:ClientLibraryFolder 유형의 저장소 노드입니다. CND 표기법의 정의는 다음과 같습니다.

[cq:ClientLibraryFolder] > sling:Folder
  - dependencies (string) multiple
  - categories (string) multiple
  - embed (string) multiple
  - channels (string) multiple

각 cq:ClientLibraryFolder은(는) 몇 개의 지원 파일과 함께 JS 및/또는 CSS 파일 세트로 채워집니다(아래 참조). cq:ClientLibraryFolder의 중요한 속성은 다음과 같이 구성됩니다.

클라이언트 라이브러리 폴더에 런타임 시 단일 JS 및/또는 CSS 파일로 병합되는 하나 이상의 소스 파일이 포함되어 있는 경우. 생성된 파일의 이름은 .js 또는 .css 파일 이름 확장명을 가진 노드 이름입니다. 예를 들어, 이름이 cq.jquery인 라이브러리 노드는 cq.jquery.js 또는 cq.jquery.css인 생성된 파일을 생성합니다.

클라이언트 라이브러리 폴더에는 다음 항목이 포함되어 있습니다.

클라이언트측 라이브러리 폴더 만들기 creating-clientlib-folders

클라이언트 라이브러리는 /apps 아래에 있어야 합니다. 이 규칙은 콘텐츠 및 구성에서 코드를 더 잘 분리하는 데 필요합니다.

/apps 아래의 클라이언트 라이브러리에 액세스하려면 프록시 서블릿을 사용하십시오. ACL은 여전히 클라이언트 라이브러리 폴더에 적용되지만 allowProxy 속성이 true(으)로 설정된 경우 서블릿에서 /etc.clientlibs/을(를) 통해 콘텐츠를 읽을 수 있습니다.

클라이언트측 라이브러리 제공 serving-clientlibs

클라이언트 라이브러리 폴더가 필요에 따라 구성되면 프록시를 통해 클라이언트 라이브러리를 요청할 수 있습니다. 예:

allowProxy 속성을 사용하여 다음을 요청할 수 있습니다.

HTL을 통해 클라이언트 라이브러리 로드 loading-via-htl

Clientlib을 클라이언트 라이브러리 폴더에 저장하고 관리하면 HTL을 통해 액세스할 수 있습니다.

클라이언트 라이브러리는 data-sly-use을(를) 통해 액세스할 수 있는 AEM에서 제공하는 도우미 템플릿을 통해 로드됩니다. 도우미 템플릿은 data-sly-call을(를) 통해 호출할 수 있는 이 파일에서 사용할 수 있습니다.

각 도우미 템플릿에는 원하는 클라이언트 라이브러리를 참조하기 위한 categories 옵션이 필요합니다. 해당 옵션은 문자열 값의 배열이거나 쉼표로 구분된 값 목록을 포함하는 문자열일 수 있습니다.

HTL을 통한 clientlib 로드에 대한 자세한 내용은 HTL 설명서를 참조하십시오.

작성자의 클라이언트 라이브러리와 Publish 비교 clientlibs-author-publish

대부분의 clientlib은 AEM 게시 인스턴스에 필요합니다. 즉, 대부분의 clientlib의 목적은 컨텐츠의 최종 사용자 경험을 생성하는 것입니다. 게시 인스턴스의 clientlib에 대해 위에서 설명한 대로 🔗클라이언트 라이브러리 폴더를 통해 프론트엔드 빌드 도구를 사용하고 배포할 수 있습니다.

그러나 작성 환경을 사용자 지정하는 데 클라이언트 라이브러리가 필요한 경우가 있습니다. 예를 들어 대화 상자를 사용자 정의하려면 AEM 작성 인스턴스에 CSS 또는 JS의 작은 비트를 배포해야 할 수 있습니다.

작성자의 클라이언트 라이브러리 관리 clientlibs-on-author

작성자에 대해 클라이언트 라이브러리를 사용해야 하는 경우 게시와 동일한 방법을 사용하여 /apps에 클라이언트 라이브러리를 만들 수 있지만, 전체 프로젝트를 만드는 대신 /apps/.../clientlibs/foo에 직접 작성하여 관리할 수 있습니다.

그런 다음 클라이언트 라이브러리를 기본 제공 클라이언트 라이브러리 카테고리에 추가하여 작성 JS에 "후크"할 수 있습니다.

디버깅 도구 debugging-tools

AEM은 클라이언트 라이브러리 폴더를 디버깅하고 테스트하기 위한 몇 가지 도구를 제공합니다.

클라이언트 라이브러리 검색 discover-client-libraries

/libs/cq/granite/components/dumplibs/dumplibs 구성 요소는 시스템의 모든 클라이언트 라이브러리 폴더에 대한 정보 페이지를 생성합니다. /libs/granite/ui/content/dumplibs 노드에 리소스 유형으로 구성 요소가 있습니다. 페이지를 열려면 다음 URL을 사용합니다(필요에 따라 호스트 및 포트 변경).

https://<host>:<port>/libs/granite/ui/content/dumplibs.test.html

정보에는 라이브러리 경로 및 유형(CSS 또는 JS)과 라이브러리 속성의 값(예: 범주 및 종속성)이 포함됩니다. 페이지의 후속 테이블에는 각 카테고리 및 채널의 라이브러리가 표시됩니다.

생성된 출력 보기 see-generated-output

dumplibs 구성 요소에는 ui:includeClientLib 태그에 대해 생성된 소스 코드를 표시하는 테스트 선택기가 포함되어 있습니다. 이 페이지에는 js, css 및 테마 속성의 다양한 조합에 대한 코드가 포함되어 있습니다.

추가 클라이언트 라이브러리 폴더 기능 additional-features

AEM의 클라이언트 라이브러리 폴더에서 지원하는 몇 가지 다른 기능이 있습니다. 그러나 AEM as a Cloud Service에서는 이러한 기능이 필요하지 않으므로 사용하지 마십시오. 완성도를 위해 여기에 나열됩니다.

Adobe Granite HTML 라이브러리 관리자 html-library-manager

추가 클라이언트 라이브러리 설정은 https://<host>:<port>/system/console/configMgr에 있는 시스템 콘솔의 Adobe Granite HTML 라이브러리 관리자 패널을 통해 제어할 수 있습니다.

추가 폴더 속성 additional-folder-properties

추가 폴더 속성에는 종속성 및 임베드를 제어할 수 있는 기능이 포함되어 있지만 일반적으로 더 이상 필요하지 않으며 사용하지 않습니다.

종속성에 연결 linking-to-dependencies

클라이언트 라이브러리 폴더의 코드가 다른 라이브러리를 참조하면 다른 라이브러리를 종속성으로 식별합니다. 클라이언트 라이브러리 폴더를 참조하는 ui:includeClientLib 태그로 인해 HTML 코드에는 생성된 라이브러리 파일에 대한 링크와 종속성이 포함됩니다.

종속성은 다른 cq:ClientLibraryFolder이어야 합니다. 종속성을 식별하려면 다음 특성을 사용하여 cq:ClientLibraryFolder 노드에 속성을 추가하십시오.

예를 들어 /etc/clientlibs/myclientlibs/publicmain은(는) cq.jquery 라이브러리에 종속되어 있습니다. 기본 클라이언트 라이브러리를 참조하는 페이지는 다음 코드를 포함하는 HTML을 생성합니다.

<script src="/etc/clientlibs/foundation/cq.jquery.js" type="text/javascript">
<script src="/etc/clientlibs/mylibs/publicmain.js" type="text/javascript">

다른 라이브러리의 코드 포함 embedding-code-from-other-libraries

클라이언트 라이브러리의 코드를 다른 클라이언트 라이브러리에 포함할 수 있습니다. 런타임 시 포함 라이브러리의 생성된 JS 및 CSS 파일은 포함 라이브러리의 코드를 포함합니다.

포함 코드는 저장소의 보안 영역에 저장된 라이브러리에 대한 액세스를 제공하는 데 유용합니다.

앱별 클라이언트 라이브러리 폴더 app-specific-client-library-folders

모든 응용 프로그램 관련 파일을 응용 프로그램 폴더 /apps 아래에 보관하는 것이 좋습니다. 또한 /apps 폴더에 대한 웹 사이트 방문자의 액세스를 거부하는 것이 좋습니다. 두 모범 사례를 모두 충족하려면 /apps 아래의 클라이언트 라이브러리를 임베드하는 /etc 폴더 아래에 클라이언트 라이브러리 폴더를 만드십시오.

포함할 클라이언트 라이브러리 폴더를 식별하려면 categories 속성을 사용합니다. 라이브러리를 포함하려면 다음 속성 특성을 사용하여 포함 cq:ClientLibraryFolder 노드에 속성을 추가하십시오.

포함을 사용하여 요청 최소화 using-embedding-to-minimize-requests

경우에 따라 게시 인스턴스에 의해 일반 페이지에 대해 생성된 최종 HTML에 비교적 많은 <script>개의 요소가 포함되어 있을 수 있습니다.

이러한 경우 페이지 로드 시 앞뒤 요청 수가 줄어들도록 필요한 모든 클라이언트 라이브러리 코드를 단일 파일에 결합하는 것이 유용할 수 있습니다. 이렇게 하려면 cq:ClientLibraryFolder 노드의 포함 속성을 사용하여 필요한 라이브러리를 앱별 클라이언트 라이브러리에 embed할 수 있습니다.

CSS 파일의 경로 paths-in-css-files

CSS 파일을 포함할 때 생성된 CSS 코드는 포함 라이브러리에 상대적인 리소스에 대한 경로를 사용합니다. 예를 들어 공개적으로 액세스할 수 있는 라이브러리 /etc/client/libraries/myclientlibs/publicmain은(는) /apps/myapp/clientlib 클라이언트 라이브러리를 임베드합니다.

main.css 파일에 다음 스타일이 포함되어 있습니다.

body {
  padding: 0;
  margin: 0;
  background: url(images/bg-full.jpg) no-repeat center top;
  width: 100%;
}

publicmain 노드가 생성하는 CSS 파일에 원본 이미지의 URL을 사용하는 다음 스타일이 포함되어 있습니다.

body {
  padding: 0;
  margin: 0;
  background: url(../../../apps/myapp/clientlib/styles/images/bg-full.jpg) no-repeat center top;
  width: 100%;
}

HTML 출력에 포함된 파일 보기 see-embedded-files

포함된 코드의 원본을 추적하거나 포함된 클라이언트 라이브러리가 예상 결과를 생성하도록 하려면 런타임 시 포함된 파일의 이름을 볼 수 있습니다. 파일 이름을 보려면 debugClientLibs=true 매개 변수를 웹 페이지의 URL에 추가하십시오. 생성된 라이브러리에 포함된 코드 대신 @import 문이 포함되어 있습니다.

이전 다른 라이브러리의 코드 포함 섹션의 예제에서 /etc/client/libraries/myclientlibs/publicmain 클라이언트 라이브러리 폴더는 /apps/myapp/clientlib 클라이언트 라이브러리 폴더를 임베드합니다. 웹 페이지에 매개 변수를 추가하면 웹 페이지의 소스 코드에 다음과 같은 링크가 만들어집니다.

<link rel="stylesheet" href="/etc/clientlibs/mycientlibs/publicmain.css">

publicmain.css 파일을 열면 다음 코드가 표시됩니다.

@import url("/apps/myapp/clientlib/styles/main.css");

전처리기 사용 using-preprocessors

AEM에서는 플러그 가능한 전처리기를 허용하며 CSS 및 JavaScript용 YUI Compressor 및 AEM의 기본 전처리기로 설정된 JavaScript용 Google Closure Compiler(GCC)을(를) 지원합니다.

플러그 가능한 프리프로세서는 다음을 포함하여 유연하게 사용할 수 있습니다.

사용 usage

클라이언트 라이브러리 또는 시스템 전체에 대해 프로세서 구성을 구성할 수 있습니다.

clientlib 노드의 전처리기 구성이 OSGI 구성보다 우선합니다.

형식 및 예 format-and-examples

형식 format

config:= mode ":" processorName options*;
mode:= "default" | "min";
processorName := "none" | <name>;
options := ";" option;
option := name "=" value;

CSS용 YUI 압축기 축소 및 JS용 GCC yui-compressor-for-css-minification-and-gcc-for-js

cssProcessor: ["default:none", "min:yui"]
jsProcessor: ["default:none", "min:gcc;compilationLevel=advanced"]

사전 처리할 Typescript를 입력한 다음 축소 및 난독화할 GCC typescript-to-preprocess-and-then-gcc-to-minify-and-obfuscate

jsProcessor: [
   "default:typescript",
   "min:typescript",
   "min:gcc;obfuscate=true"
]

추가 GCC 옵션 additional-gcc-options

failOnWarning (defaults to "false")
languageIn (defaults to "ECMASCRIPT5")
languageOut (defaults to "ECMASCRIPT5")
compilationLevel (defaults to "simple") (can be "whitespace", "simple", "advanced")

GCC 옵션에 대한 자세한 내용은 GCC 설명서를 참조하십시오.

시스템 기본 축소기 설정 set-system-default-minifier

AEM에서 YUI가 기본 축소기로 설정됩니다. GCC로 변경하려면 다음 단계를 따르십시오.