최신 웹 사이트는 복잡한 JavaScript 및 CSS 코드를 기반으로 하는 클라이언트측 처리에 상당히 의존합니다. 이 코드의 제공을 구성하고 최적화하는 것은 복잡한 문제가 될 수 있습니다.
이 문제를 해결하기 위해 AEM에서는 클라이언트측 라이브러리 폴더를 제공하여 보관소에 클라이언트측 코드를 저장하고 카테고리로 구성하고 각 코드 카테고리가 클라이언트에 제공될 시기와 방법을 정의할 수 있습니다. 그런 다음 클라이언트측 라이브러리 시스템은 최종 웹 페이지에 올바른 링크를 만들어 올바른 코드를 로드합니다.
페이지의 HTML에 클라이언트측 라이브러리(즉, JS 또는 CSS 파일)를 포함하는 표준 방법은 해당 페이지의 JSP에 <script>
또는 <link>
태그를 포함시켜 해당 파일의 경로를 포함하는 것입니다. 예,
...
<head>
...
<script type="text/javascript" src="/etc/clientlibs/granite/jquery/source/1.8.1/jquery-1.8.1.js"></script>
...
</head>
...
이 방법은 AEM에서 작동하지만 페이지와 구성 요소가 복잡해질 때 문제를 초래할 수 있습니다. 이러한 경우 동일한 JS 라이브러리의 여러 복사본이 최종 HTML 출력에 포함될 수 있는 위험이 있습니다. 이를 방지하고 클라이언트측 라이브러리 AEM의 논리적 구성을 허용하려면 클라이언트측 라이브러리 폴더를 사용합니다.
클라이언트측 라이브러리 폴더는 cq:ClientLibraryFolder
유형의 저장소 노드입니다. CND 표기법의 정의입니다.
[cq:ClientLibraryFolder] > sling:Folder
- dependencies (string) multiple
- categories (string) multiple
- embed (string) multiple
- channels (string) multiple
기본적으로 cq:ClientLibraryFolder
노드는 /apps
, /libs
및 /etc
저장소의 하위 트리(이러한 기본값 및 기타 설정은 시스템 콘솔의 Adobe HTML 라이브러리 관리자 패널을 통해 제어할 수 있습니다.
각 cq:ClientLibraryFolder
은 몇 개의 지원 파일과 함께 JS 및/또는 CSS 파일 세트로 채워집니다(아래 참조). cq:ClientLibraryFolder
의 속성은 다음과 같이 구성됩니다.
categories
:이 가을 내에 JS 및/또는 CSS 파일 세트가 있는 범주를 cq:ClientLibraryFolder
식별합니다. 다중 값이 있는 categories
속성은 라이브러리 폴더를 둘 이상의 카테고리에 포함할 수 있도록 합니다(유용할 수 있는 방법은 아래 참조).
dependencies
:이 라이브러리 폴더가 종속된 다른 클라이언트 라이브러리 카테고리 목록입니다. 예를 들어, 2개의 cq:ClientLibraryFolder
노드 F
및 G
가 지정된 경우 F
의 파일에 제대로 기능하기 위해 G
의 다른 파일이 필요한 경우, G
의 categories
중 적어도 하나가 F
의 dependencies
에 있어야 합니다.
embed
:다른 라이브러리의 코드를 포함하는 데 사용됩니다. 노드 F가 노드 G와 H를 포함하는 경우 결과 HTML은 노드 G 및 H의 컨텐츠가 포함됩니다.
allowProxy
:클라이언트 라이브러리가 아래에 있으면 이 등록 정보 /apps
는 프록시 서블릿을 통해 클라이언트 라이브러리에 액세스할 수 있습니다. 아래의 클라이언트 라이브러리 폴더 찾기 및 프록시 클라이언트 라이브러리 서블릿 사용을 참조하십시오.
HTL은 AEM 사이트 개발을 위해 선호되는 기술이므로 AEM에 클라이언트측 라이브러리를 포함하는 데 HTL을 사용해야 합니다. 그러나 JSP를 사용하여 수행할 수도 있습니다.
HTL에서 클라이언트 라이브러리는 AEM에서 제공하는 도우미 템플릿을 통해 로드되며, 이 템플릿은 data-sly-use
를 통해 액세스할 수 있습니다. 이 파일에서 사용할 수 있는 템플릿 세 개를 data-sly-call
에서 호출할 수 있습니다.
각 헬퍼 템플릿에는 원하는 클라이언트 라이브러리를 참조하기 위한 categories
옵션이 필요합니다. 이 옵션은 문자열 값의 배열이거나 쉼표로 구분된 값 목록을 포함하는 문자열일 수 있습니다.
자세한 내용 및 사용 예는 HTML 템플릿 언어 시작하기 문서를 참조하십시오.
생성된 HTML 페이지의 클라이언트 라이브러리에 링크를 추가하려면 JSP 코드에 ui:includeClientLib
태그를 추가합니다. 라이브러리를 참조하려면 ui:includeClientLib
노드의 categories
속성 값을 사용합니다.
<%@taglib prefix="ui" uri="https://www.adobe.com/taglibs/granite/ui/1.0" %>
<ui:includeClientLib categories="<%= categories %>" />
예를 들어 /etc/clientlibs/foundation/jquery
노드는 값 cq.jquery
의 categories 속성을 가진 cq:ClientLibraryFolder
유형입니다. JSP 파일의 다음 코드는 라이브러리를 참조합니다.
<ui:includeClientLib categories="cq.jquery"/>
생성된 HTML 페이지에는 다음 코드가 포함되어 있습니다.
<script type="text/javascript" src="/etc/clientlibs/foundation/jquery.js"></script>
JS, CSS 또는 테마 라이브러리 필터링에 대한 특성을 비롯한 자세한 내용은 ui:includeClientLib을 참조하십시오.
<cq:includeClientLib>
이전에는 클라이언트 라이브러리를 포함하는 데 일반적으로 사용되었던 이전 버전은 AEM 5.6 이후 더 이상 사용되지 않습니다. 대신 위에 설명된 대로 <ui:includeClientLib>
사용해야 합니다.
cq:ClientLibraryFolder
노드를 만들어 JavaScript 및 CSS 스타일 시트 라이브러리를 정의하고 HTML 페이지에서 사용할 수 있도록 만듭니다. 노드의 categories
속성을 사용하여 해당 노드가 속하는 라이브러리 범주를 식별합니다.
노드에는 런타임에 단일 JS 및/또는 CSS 파일로 병합되는 하나 이상의 소스 파일이 포함되어 있습니다. 생성된 파일의 이름은 .js
또는 .css
파일 이름 확장명을 가진 노드 이름입니다. 예를 들어, cq.jquery
라이브러리 노드는 cq.jquery.js
또는 cq.jquery.css
라는 생성된 파일을 생성합니다.
클라이언트 라이브러리 폴더에는 다음 항목이 포함됩니다.
병합할 JS 및/또는 CSS 소스 파일입니다.
이미지 파일과 같이 CSS 스타일을 지원하는 리소스입니다.
참고: 하위 폴더를 사용하여 소스 파일을 구성할 수 있습니다.
생성된 JS 및/또는 CSS 파일에 병합할 소스 파일을 식별하는 js.txt
파일 및/또는 하나 css.txt
파일.
위젯의 클라이언트 라이브러리와 관련된 요구 사항에 대한 자세한 내용은 위젯 사용 및 확장을 참조하십시오.
웹 클라이언트에 cq:ClientLibraryFolder
노드에 액세스할 수 있는 권한이 있어야 합니다. 저장소의 보안 영역에서 라이브러리를 표시할 수도 있습니다(아래 다른 라이브러리의 코드 포함 참조).
/apps
아래에 있는 클라이언트 라이브러리 폴더는 /libs
에 유사한 이름이 같은 폴더보다 우선합니다. 예를 들어 /apps/cq/ui/widgets
은 /libs/cq/ui/widgets
보다 우선합니다. 이러한 라이브러리가 동일한 범주에 속하는 경우 /apps
아래의 라이브러리가 사용됩니다.
이전 버전에서는 클라이언트 라이브러리 폴더가 저장소의 /etc/clientlibs
아래에 있었습니다. 이 기능은 여전히 지원되지만 클라이언트 라이브러리가 /apps
아래에 있는 것이 좋습니다. 다른 스크립트 근처에 있는 클라이언트 라이브러리를 찾기 위한 것으로, 일반적으로 /apps
및 /libs
아래에 있습니다.
클라이언트 라이브러리 폴더 아래의 정적 리소스는 resources이라는 폴더에 있어야 합니다. 이미지와 같은 정적 리소스가 없는 경우 폴더 resources에 게시 인스턴스에서 참조할 수 없습니다. 다음은 한 예입니다.https://localhost:4503/etc.clientlibs/geometrixx/components/clientlibs/resources/example.gif
컨텐츠 및 구성에서 코드를 보다 잘 분리하려면 /apps
아래에서 클라이언트 라이브러리를 찾아 /etc.clientlibs
속성을 활용하여 이 라이브러리를 노출하는 것이 좋습니다.allowProxy
/apps
아래의 클라이언트 라이브러리에 액세스하려면 프록시 서버가 사용됩니다. ACL은 여전히 클라이언트 라이브러리 폴더에 적용되지만 allowProxy
속성이 true
로 설정된 경우 서블릿은 /etc.clientlibs/
을 통해 컨텐츠를 읽을 수 있도록 허용합니다.
정적 리소스는 클라이언트 라이브러리 폴더 아래의 리소스 아래에 있는 경우에만 프록시를 통해 액세스할 수 있습니다.
예:
/apps/myproject/clientlibs/foo
에 clientlib이 있습니다./apps/myprojects/clientlibs/foo/resources/icon.png
에 정적 이미지가 있습니다.그런 다음 foo
의 allowProxy
속성을 true로 설정합니다.
/etc.clientlibs/myprojects/clientlibs/foo.js
을(를) 요청할 수 있습니다./etc.clientlibs/myprojects/clientlibs/foo/resources/icon.png
을 통해 이미지를 참조할 수 있습니다.프록시 클라이언트 라이브러리를 사용할 때 AEM Dispatcher 구성을 사용하려면 Extension 클라이언트가 있는 URI가 허용되도록 업데이트해야 할 수 있습니다.
Adobe은 클라이언트 라이브러리를 /apps
아래에서 찾고 프록시 서블릿을 사용하여 사용할 수 있도록 하는 것이 좋습니다. 그러나 여전히 공용 사이트에 /apps
또는 /libs
경로를 통해 직접 제공되는 항목이 포함되지 않아야 합니다.
웹 브라우저에서 CRXDE Lite을 엽니다(https://localhost:4502/crx/de).
클라이언트 라이브러리 폴더를 찾을 폴더를 선택하고 만들기 > 노드 만들기를 클릭합니다.
라이브러리 파일의 이름을 입력하고 [유형] 목록에서 cq:ClientLibraryFolder
을 선택합니다. 확인을 클릭한 다음 모두 저장을 클릭합니다.
라이브러리가 속하는 카테고리 또는 범주를 지정하려면 cq:ClientLibraryFolder
노드를 선택하고 다음 속성을 추가한 다음 모두 저장을 클릭합니다.
어떤 방법으로든 라이브러리 폴더에 소스 파일을 추가할 수 있습니다. 예를 들어 WebDav 클라이언트를 사용하여 파일을 복사하거나 파일을 직접 만들고 컨텐츠를 수동으로 작성합니다.
참고: 원할 경우 소스 파일을 하위 폴더에 구성할 수 있습니다.
클라이언트 라이브러리 폴더를 선택하고 만들기 > 파일 만들기를 클릭합니다.
파일 이름 상자에 다음 파일 이름 중 하나를 입력하고 [확인]을 클릭합니다.
js.txt
: 이 파일 이름을 사용하여 JavaScript 파일을 생성합니다.css.txt
: 이 파일 이름을 사용하여 계단식 스타일 시트를 생성합니다.파일을 열고 다음 텍스트를 입력하여 소스 파일 경로의 루트를 식별합니다.
#base=*[root]*
[root]
*를 TXT 파일을 기준으로 소스 파일이 포함된 폴더의 경로로 바꿉니다. 예를 들어 소스 파일이 TXT 파일과 동일한 폴더에 있는 경우 다음 텍스트를 사용합니다.#base=.
다음 코드는 루트를 cq:ClientLibraryFolder
노드 아래에 mobile이라는 폴더로 설정합니다.
#base=mobile
#base=[root]
아래의 줄에 루트에 상대적인 소스 파일의 경로를 입력합니다. 각 파일 이름을 별도의 줄에 배치합니다.
모두 저장을 클릭합니다.
클라이언트 라이브러리 폴더의 코드가 다른 라이브러리를 참조하는 경우 다른 라이브러리를 종속성으로 식별합니다. JSP에서 클라이언트 라이브러리 폴더를 참조하는 ui:includeClientLib
태그로 인해 HTML 코드가 생성된 라이브러리 파일에 대한 링크 및 종속성을 포함하도록 합니다.
종속성은 다른 cq:ClientLibraryFolder
이어야 합니다. 종속성을 식별하려면 다음 속성을 사용하여 cq:ClientLibraryFolder
노드에 속성을 추가하십시오.
예를 들어 / etc/clientlibs/myclientlibs/publicmain
은 cq.jquery
라이브러리에 대한 종속성을 갖습니다. 기본 클라이언트 라이브러리를 참조하는 JSP는 다음 코드를 포함하는 HTML을 생성합니다.
<script src="/etc/clientlibs/foundation/cq.jquery.js" type="text/javascript">
<script src="/etc/clientlibs/mylibs/publicmain.js" type="text/javascript">
클라이언트 라이브러리의 코드를 다른 클라이언트 라이브러리에 포함할 수 있습니다. 런타임에 포함 라이브러리의 생성된 JS 및 CSS 파일에는 포함된 라이브러리의 코드가 포함되어 있습니다.
포함 코드는 저장소의 보안 영역에 저장된 라이브러리에 대한 액세스를 제공하는 데 유용합니다.
모든 응용 프로그램 관련 파일을 응용 프로그램 폴더에 /app
아래로 유지하는 것이 좋습니다. 또한 /app
폴더에 대한 웹 사이트 방문자의 액세스를 거부하는 것이 좋습니다. 두 가지 모범 사례를 모두 충족하려면 /app
아래에 있는 클라이언트 라이브러리를 포함하는 /etc
폴더 아래에 클라이언트 라이브러리 폴더를 만듭니다.
categories 속성을 사용하여 포함할 클라이언트 라이브러리 폴더를 식별합니다. 라이브러리를 포함하려면 다음 속성 특성을 사용하여 cq:ClientLibraryFolder
포함 노드에 속성을 추가합니다.
cq:ClientLibraryFolder
값입니다.경우에 따라 게시 인스턴스에서 일반적인 페이지에 대해 생성된 최종 HTML에 비교적 많은 수의 <script>
요소가 포함되어 있습니다. 특히 사이트에서 분석 또는 타깃팅을 위해 클라이언트 컨텍스트 정보를 사용하고 있는 경우입니다. 예를 들어, 최적화되지 않은 프로젝트에서는 페이지에 대한 HTML에서 다음 <script>
요소 시리즈를 찾을 수 있습니다.
<script type="text/javascript" src="/etc/clientlibs/granite/jquery.js"></script>
<script type="text/javascript" src="/etc/clientlibs/granite/utils.js"></script>
<script type="text/javascript" src="/etc/clientlibs/granite/jquery/granite.js"></script>
<script type="text/javascript" src="/etc/clientlibs/foundation/jquery.js"></script>
<script type="text/javascript" src="/etc/clientlibs/foundation/shared.js"></script>
<script type="text/javascript" src="/etc/clientlibs/foundation/personalization/kernel.js"></script>
이러한 경우 필요한 모든 클라이언트 라이브러리 코드를 하나의 파일에 결합하여 페이지 로드 시 뒤로 요청 수를 줄이는 데 유용합니다. 이렇게 하려면 cq:ClientLibraryFolder
노드의 embed 속성을 사용하여 embed
필요한 라이브러리를 앱별 클라이언트 라이브러리에 포함할 수 있습니다.
다음 클라이언트 라이브러리 카테고리는 AEM에 포함됩니다. 특정 사이트의 기능에 필요한 항목만 포함해야 합니다. 그러나 여기에 나열된 순서를 유지해야 합니다.
browsermap.standard
browsermap
jquery-ui
cq.jquery.ui
personalization
personalization.core
personalization.core.kernel
personalization.clientcontext.kernel
personalization.stores.kernel
personalization.kernel
personalization.clientcontext
personalization.stores
cq.collab.comments
cq.collab.feedlink
cq.collab.ratings
cq.collab.toggle
cq.collab.forum
cq.cleditor
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%;
}
클라이언트 라이브러리 폴더의 channels
속성을 사용하여 라이브러리를 사용하는 모바일 그룹을 식별합니다. channels
속성은 동일한 범주의 라이브러리가 다른 장치 기능에 대해 디자인된 경우에 유용합니다.
클라이언트 라이브러리 폴더를 장치 그룹과 연결하려면 cq:ClientLibraryFolder
노드에 다음 특성을 사용하여 속성을 추가하십시오.
예를 들어 다음 표는 cq.widgets
범주의 각 클라이언트 라이브러리 폴더에 대한 channels
속성 값을 나열합니다.
클라이언트 라이브러리 폴더 | 채널 속성 값 |
---|---|
/libs/cq/analytics/widgets |
!touch |
/libs/cq/analytics/widgets/themes/default |
!touch |
/libs/cq/cloudserviceconfigs/widgets |
!touch |
/libs/cq/searchpromote/widgets |
!touch |
/libs/cq/searchpromote/widgets/themes/default |
[값 없음] |
/libs/cq/touch/widgets |
touch |
/libs/cq/touch/widgets/themes/default |
touch |
/libs/cq/ui/widgets |
!touch |
/libs/cq/ui/widgets/themes/default |
!touch |
AEM은 플러그형 프리프로세서를 지원하고 CSS 및 JavaScript용 YUI Compressor 및 YUI가 AEM 기본 프리프로세서로 설정된 JavaScript용 Google Closure Compiler(GCC)에 대한 지원을 제공합니다.
플러그형 프리프로세서를 사용하면 다음과 같은 유연한 사용 방법을 이용할 수 있습니다.
기본적으로 AEM은 YUI 압축기를 사용합니다. 알려진 문제 목록은 YUI 압축기 GitHub 설명서를 참조하십시오. 특정 클라이언트용 GCC 압축기로 전환하면 YUI를 사용할 때 발생하는 몇 가지 문제를 해결할 수 있습니다.
클라이언트 라이브러리에 축소 라이브러리를 배치하지 마십시오. 대신 Raw 라이브러리를 제공하고, 분류가 필요한 경우 프리프로세서의 옵션을 사용합니다.
클라이언트 라이브러리 또는 시스템 전체에 따라 프리프로세서 구성을 구성할 수 있습니다.
clientlibrary 노드에 multivalue 속성 cssProcessor
및 jsProcessor
을(를) 추가합니다.
또는 HTML 라이브러리 관리자 OSGi 구성을 통해 시스템 기본 구성을 정의합니다.
clientlib 노드의 프리프로세서 구성이 OSGI 구성보다 우선합니다.
config:= mode ":" processorName options*;
mode:= "default" | "min";
processorName := "none" | <name>;
options := ";" option;
option := name "=" value;
cssProcessor: ["default:none", "min:yui"]
jsProcessor: ["default:none", "min:gcc;compilationLevel=advanced"]
jsProcessor: [
"default:typescript",
"min:typescript",
"min:gcc;obfuscate=true"
]
failOnWarning (defaults to "false")
languageIn (defaults to "ECMASCRIPT5")
languageOut (defaults to "ECMASCRIPT5")
compilationLevel (defaults to "simple") (can be "whitespace", "simple", "advanced")
GCC 옵션에 대한 자세한 내용은 GCC 설명서를 참조하십시오.
AEM에서 YUI가 기본 미니에이치로 설정됩니다. GCC로 변경하려면 다음 단계를 수행합니다.
https://localhost:4502/system/console/configMgr에서 Apache Felix 구성 관리자로 이동합니다.
Adobe Granite HTML 라이브러리 관리자를 찾아 편집합니다.
Minify 옵션을 활성화합니다(아직 활성화되지 않은 경우).
JS 프로세서 기본 구성 값을 min:gcc
로 설정합니다.
세미콜론(예:)으로 분리된 경우 옵션을 전달할 수 있습니다.min:gcc;obfuscate=true
.
저장을 클릭하여 변경 내용을 저장합니다.
AEM은 클라이언트 라이브러리 폴더를 디버깅하고 테스트하는 몇 가지 도구를 제공합니다.
포함된 코드의 원점을 추적하거나 포함된 클라이언트 라이브러리에서 예상 결과를 산출하는지 확인하려면 런타임에 포함된 파일의 이름을 볼 수 있습니다. 파일 이름을 보려면 웹 페이지의 URL에 debugClientLibs=true
매개 변수를 추가합니다. 생성된 라이브러리에는 포함된 코드 대신 @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");
웹 브라우저의 주소 상자에서 HTML의 URL에 다음 텍스트를 추가합니다.
?debugClientLibs=true
페이지가 로드되면 페이지 소스를 봅니다.
파일을 열고 소스 코드를 보려면 링크 요소의 href로 제공되는 링크를 클릭합니다.
/libs/cq/granite/components/dumplibs/dumplibs
구성 요소는 시스템의 모든 클라이언트 라이브러리 폴더에 대한 정보 페이지를 생성합니다. /libs/granite/ui/content/dumplibs
노드에는 구성 요소가 리소스 유형으로 있습니다. 페이지를 열려면 다음 URL을 사용합니다(필요에 따라 호스트 및 포트 변경).
https://<host>:<port>/libs/granite/ui/content/dumplibs.test.html
이 정보에는 라이브러리 경로 및 유형(CSS 또는 JS), 범주 및 종속성 등의 라이브러리 속성 값이 포함됩니다. 페이지의 다음 표는 각 카테고리와 채널의 라이브러리를 보여줍니다.
dumplibs
구성 요소에는 ui:includeClientLib
태그에 대해 생성된 소스 코드를 표시하는 테스트 선택기가 포함되어 있습니다. 페이지에는 다양한 js, css 및 테마 속성 조합에 대한 코드가 포함되어 있습니다.
다음 방법 중 하나를 사용하여 [테스트 출력] 페이지를 엽니다.
dumplibs.html
페이지에서 출력 테스트텍스트를 보려면여기를 클릭하십시오.
웹 브라우저에서 다음 URL을 엽니다(필요에 따라 다른 호스트 및 포트 사용).
http://<host>:<port>/libs/granite/ui/content/dumplibs.html
기본 페이지에는 categories 속성에 대한 값이 없는 태그에 대한 출력이 표시됩니다.
범주에 대한 출력을 보려면 클라이언트 라이브러리의 categories
속성 값을 입력하고 쿼리 제출을 클릭합니다.
HTML 라이브러리 관리자 서비스는 cq:ClientLibraryFolder
태그를 처리하고 런타임에 라이브러리를 생성합니다. 환경, 개발 또는 제작의 유형에 따라 서비스를 구성하는 방법이 결정됩니다.
서비스 구성에 대한 자세한 내용은 AEM HTML 라이브러리 관리자를 참조하십시오.