HTL 시작하기 getting-started-with-htl

HTML 템플릿 언어(HTL)는 HTML에 대한 Adobe Experience Manager의 기본 및 권장 서버측 템플릿 시스템입니다. 모든 HTML 서버측 템플릿 시스템과 마찬가지로 HTL 파일은 HTML 자체와 런타임 시 평가할 몇 가지 기본 프레젠테이션 논리 및 변수를 지정하여 브라우저로 전송되는 출력을 정의합니다.

이 문서는 HTL의 목적에 대한 개요와 더불어 언어의 기본 개념 및 구성에 대한 소개를 제공합니다.

HTL 레이어 layers

AEM에서 여러 레이어가 HTL을 정의합니다.

이 HTL 설명서는 HTL을 사용한 AEM 솔루션 개발에 중점을 둡니다. 따라서 모든 세 가지 레이어를 다루며 필요한 경우 외부 리소스를 연결합니다.

HTL의 기본 개념 fundamental-concepts-of-htl

HTML 템플릿 언어는 표현식 언어를 사용하여 콘텐츠 조각을 렌더링된 마크업에 삽입하고 HTML5 데이터 속성을 사용하여 마크업 블록(예: 조건 또는 반복)에 대한 명령문을 정의합니다. HTL이 Java Servlet으로 컴파일되면 표현식과 HTL 데이터 속성은 모두 전적으로 서버측에서 평가되며 결과 HTML에는 아무것도 표시되지 않습니다.

블록 및 표현식 blocks-and-expressions

다음은 template.html 파일에 있는 그대로 포함될 수 있는 첫 번째 예입니다.

<h1 data-sly-test="${properties.jcr:title}">
    ${properties.jcr:title}
</h1>

두 가지 다른 종류의 구문을 구별할 수 있습니다.

두 구문에 대한 자세한 내용은 HTL 사양을 참조하십시오.

SLY 요소 the-sly-element

HTL의 핵심 개념은 블록 문을 정의하기 위해 기존 HTML 요소를 재사용할 수 있는 가능성을 제공하는 것입니다. 이렇게 다시 사용하면 명령문이 시작하고 끝나는 위치를 정의하기 위해 추가 구분 기호를 삽입할 필요가 없습니다. 마크업에 주석을 다는 것은 정적 HTML을 HTML의 유효성을 손상시키지 않고 동적 템플릿으로 비간섭적으로 변환하여 정적 파일로도 적절히 표시할 수 있도록 합니다.

단, 블록 문이 삽입되어야 하는 정확한 위치에 기존 요소가 없는 경우도 있을 수 있습니다. 이러한 경우 특수 sly 요소를 삽입할 수 있습니다. 이 요소는 첨부된 블록 문을 실행하고 그에 따라 콘텐츠를 표시하는 동안 출력에서 자동으로 제거됩니다.

다음 예제는

<sly data-sly-test="${properties.jcr:title && properties.jcr:description}">
    <h1>${properties.jcr:title}</h1>
    <p>${properties.jcr:description}</p>
</sly>

다음 HTML과 같은 것을 출력하지만 jcr:title 및 jcr:description 속성이 모두 정의되어 있고 둘 다 비어 있지 않은 경우에만:

<h1>MY TITLE</h1>
<p>MY DESCRIPTION</p>

유념해야 할 한 가지는 기존 요소에 블록 문으로 주석을 추가할 수 없는 경우에만 sly 요소를 사용하는 것입니다. 이유는 sly 요소가 언어에서 제공하는 값이 정적 HTML을 동적으로 만들 때 변경하지 않도록 하기 때문입니다.

예를 들어 이전 예제가 div 요소 내부에 래핑된 경우 추가된 sly 요소는 남용이 됩니다.

<div>
    <sly data-sly-test="${properties.jcr:title && properties.jcr:description}">
        <h1>${properties.jcr:title}</h1>
        <p>${properties.jcr:description}</p>
    </sly>
</div>

그리고 div 요소에 다음 조건으로 주석을 추가할 수 있습니다.

<div data-sly-test="${properties.jcr:title && properties.jcr:description}">
    <h1>${properties.jcr:title}</h1>
    <p>${properties.jcr:description}</p>
</div>

HTL 댓글 htl-comments

다음 예제의 첫 번째 라인에서는 HTL 댓글을 두 번째 라인에서는 HTML 주석을 보여 줍니다.

<!--/* An HTL Comment */-->
<!-- An HTML Comment -->

HTL 댓글은 JavaScript와 유사한 추가 구문이 있는 HTML 주석입니다. 프로세서는 전체 HTL 댓글과 그 안의 모든 항목을 무시하여 출력에서 제거합니다.

그러나 표준 HTML 주석의 콘텐츠는 전달되고 주석 내의 표현식이 평가됩니다.

HTML 주석은 HTL 댓글을 포함할 수 없으며 그 반대의 경우도 마찬가지입니다.

특수 컨텍스트 special-contexts

HTL을 최대한 활용하려면 HTML 구문을 기반으로 하는 HTL의 결과를 잘 이해하는 것이 중요합니다.

자세한 내용은 HTL 사양의 표시 컨텍스트 섹션을 참조하십시오.

요소 및 속성 이름 element-and-attribute-names

표현식은 HTML 텍스트 또는 속성 값에만 배치할 수 있지만 요소 이름이나 속성 이름에는 배치할 수 없습니다. 그렇지 않으면 더 이상 유효한 HTML이 아닙니다. 요소 이름을 동적으로 설정하려면 원하는 요소에 data-sly-element 문을 사용할 수 있으며, 특성 이름을 동적으로 설정하려면 여러 특성을 한 번에 설정하는 경우에도 data-sly-attribute 문을 사용할 수 있습니다.

<h1 data-sly-element="${myElementName}" data-sly-attribute="${myAttributeMap}">...</h1>

블록 문이 없는 컨텍스트 contexts-without-block-statements

HTL은 블록 문을 정의하기 위해 데이터 속성을 사용하므로 다음 컨텍스트 내에서 이러한 블록 문을 정의할 수 없으며 표현식만 사용할 수 있습니다.

그 이유는 이러한 컨텍스트의 콘텐츠가 HTML이 아닌 텍스트이고 포함된 HTML 요소가 단순 문자 데이터로 간주되기 때문입니다. 따라서 실제 HTML 요소가 없으면 data-sly 특성도 실행할 수 없습니다.

이러한 접근은 상당한 제한처럼 들릴 수 있다. 그러나 HTML 템플릿 언어는 유효한 HTML 출력만 생성해야 하므로 이 언어가 선호됩니다. 아래 액세스 논리를 위한 Use-API 섹션에서는 템플릿에서 추가 논리를 호출하는 방법을 소개합니다. 이러한 컨텍스트에 대한 복잡한 출력을 준비하는 데 필요한 경우 이 방법을 사용할 수 있습니다. 백 엔드에서 프론트엔드 스크립트로 데이터를 보내려면 구성 요소의 논리로 JSON 문자열을 생성하고 간단한 HTL 표현식을 사용하여 데이터 속성에 배치합니다.

다음 예제는 HTML 주석의 동작을 보여 주지만 스크립트 또는 스타일 요소에서 동일한 동작이 관찰됩니다.

<!--
    The title is: ${properties.jcr:title}
    <h1 data-sly-test="${properties.jcr:title}">${properties.jcr:title}</h1>
-->

다음 HTML과 같은 것을 출력합니다.

<!--
    The title is: MY TITLE
    <h1 data-sly-test="MY TITLE">MY TITLE</h1>
-->

명시적 컨텍스트 필요 explicit-contexts-required

아래 자동 컨텍스트 인식 이스케이프 섹션에 설명된 대로 HTL의 한 가지 목표는 모든 표현식에 컨텍스트 인식 이스케이프를 자동으로 적용하여 XSS(크로스 사이트 스크립팅) 취약성 유발의 위험을 줄이는 것입니다. HTL은 HTML 마크업에서 표현식의 컨텍스트를 감지하지만 인라인 JavaScript 또는 CSS는 분석하지 않으므로 개발자는 이러한 표현식에 대한 정확한 컨텍스트를 지정해야 합니다.

올바른 이스케이프 결과를 적용하지 않으면 XSS 취약성이 발생하므로 HTL은 컨텍스트가 선언되지 않은 경우 스크립트 및 스타일 컨텍스트에 있는 모든 표현식의 출력을 제거합니다.

다음은 스크립트 및 스타일 내부에 배치된 표현식에 대한 컨텍스트를 설정하는 방법의 예입니다.

<script> var trackingID = "${myTrackingID @ context='scriptString'}"; </script>
<style> a { font-family: "${myFont @ context='styleString'}"; } </style>

이스케이프 제어 방법에 대한 자세한 내용은 HTL 사양의 표현식 언어 표시 컨텍스트 섹션을 참조하십시오.

HTL의 일반 기능 general-capabilities-of-htl

이 섹션에서는 HTML 템플릿 언어의 일반적인 기능을 빠르게 살펴봅니다.

액세스 논리를 위한 Use-API use-api-for-accessing-logic

HTML 템플릿 언어(HTL) Java Use-API를 사용하면 HTL 파일이 data-sly-use를 통해 사용자 지정 Java 클래스의 도우미 메서드에 액세스할 수 있습니다. 이 프로세스를 사용하면 모든 복잡한 비즈니스 논리를 Java 코드에 캡슐화할 수 있지만 HTL 코드는 직접 마크업 생성만 처리합니다.

자세한 내용은 HTL Java Use-API 문서를 참조하십시오.

자동 컨텍스트 인식 이스케이프 automatic-context-aware-escaping

다음 예를 생각해 보십시오.

<p data-sly-use.logic="logic.js">
    <a href="${logic.link}" title="${logic.title}">
        ${logic.text}
    </a>
</p>

대부분의 템플릿 언어에서 이 예제는 잠재적으로 XSS(크로스 사이트 스크립팅) 취약점을 생성할 수 있습니다. 모든 변수가 자동으로 HTML 이스케이프되는 경우에도 href 속성은 여전히 특정 URL로 이스케이프되어야 하기 때문입니다. 이러한 생략은 쉽게 무시될 수 있고 자동화된 방식으로 발견하기 어렵기 때문에 가장 일반적인 오류 중 하나입니다.

이를 위해 HTML 템플릿 언어는 변수가 배치된 컨텍스트에 따라 각 변수를 자동으로 이스케이프합니다. HTL이 HTML 구문을 이해한다는 사실 덕분에 이 접근 방식이 가능합니다.

다음 logic.js 파일을 가정합니다.

use(function () {
    return {
        link:  "#my link's safe",
        title: "my title's safe",
        text:  "my text's safe"
    };
});

초기 예제는 다음과 같은 결과를 출력합니다.

<p>
    <a href="#my%20link%27s%20safe" title="my title&#39;s safe">
        my text&#39;s safe
    </a>
</p>

HTL은 URI 컨텍스트에 대해 href 및 src 속성을 이스케이프해야 한다는 것을 알고 있으므로 두 속성이 어떻게 다르게 이스케이프되었는지 확인합니다. 또한 URI가 javascript:로 시작했다면 컨텍스트가 명시적으로 다른 것으로 변경된 경우 외에는 속성이 완전히 제거되었을 것입니다.

이스케이프 제어 방법에 대한 자세한 내용은 HTL 사양의 표현식 언어 표시 컨텍스트 섹션을 참조하십시오.

빈 속성 자동 제거 automatic-removal-of-empty-attributes

다음 예를 생각해 보십시오.

<p class="${properties.class}">some text</p>

class 속성의 값이 비어 있으면 HTML 템플릿 언어는 자동으로 전체 class 특성을 출력에서 제거합니다.

다시 말하지만, HTL이 HTML 구문을 이해하고 따라서 값이 비어 있지 않은 경우에만 동적 값이 있는 속성을 조건부로 표시할 수 있기 때문에 이 프로세스가 가능합니다. 마크업을 유효하지 않고 읽을 수 없게 만들 수 있는 속성에 조건 블록을 추가하는 것을 방지하기 때문에 매우 편리합니다.

또한 표현식에 배치된 변수의 유형이 중요합니다.

다음은 부울 표현식을 사용하여 부울 HTML 속성을 제어하는 방법의 예입니다.

<input type="checkbox" checked="${properties.isChecked}"/>

속성 설정의 경우data-sly-attribute 문도 유용할 수 있습니다.

HTL의 일반적인 패턴 common-patterns-with-htl

이 섹션에서는 몇 가지 일반적인 시나리오를 소개합니다. HTML 템플릿 언어로 이러한 시나리오를 해결하는 가장 좋은 방법을 설명합니다.

클라이언트 라이브러리 로드 loading-client-libraries

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

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

다음은 두 가지 짧은 예입니다.

여러 클라이언트 라이브러리를 한 번에 완전히 로드 loading-multiple-client-libraries-fully-at-once

<sly data-sly-use.clientlib="/libs/granite/sightly/templates/clientlib.html"
     data-sly-call="${clientlib.all @ categories=['myCategory1', 'myCategory2']}"/>

페이지의 다른 섹션에서 클라이언트 라이브러리 참조 referencing-a-client-library-in-different-sections-of-a-page

<!doctype html>
<html data-sly-use.clientlib="/libs/granite/sightly/templates/clientlib.html">
    <head>
        <!-- HTML meta-data -->
        <sly data-sly-call="${clientlib.css @ categories='myCategory'}"/>
    </head>
    <body>
        <!-- page content -->
        <sly data-sly-call="${clientlib.js @ categories='myCategory'}"/>
    </body>
</html>

이 예제에서 HTML head과(와) body 요소가 별도의 파일에 있는 경우 clientlib.html 템플릿은 필요한 각 파일에 로드되어야 합니다.

HTL 사양의 템플릿 및 호출 문 섹션은 이러한 템플릿을 선언하고 호출하는 방법에 대한 자세한 내용을 제공합니다.

클라이언트에 데이터 전달 passing-data-to-the-client

일반적으로(특히, HTL의 경우) 데이터를 클라이언트에 전달하는 가장 훌륭하고 우아한 방법은 data 속성을 사용하는 것입니다.

다음 예제에서는 클라이언트에 전달하기 위해 개체를 JSON(Java로도 가능)으로 직렬화하는 방법을 보여 줍니다. 그런 다음 data 특성에 쉽게 배치할 수 있습니다.

<!--/* template.html file: */-->
<div data-sly-use.logic="logic.js" data-json="${logic.json}">...</div>

/* logic.js file: */
use(function () {
    var myData = {
        str: "foo",
        arr: [1, 2, 3]
    };

    return {
        json: JSON.stringify(myData)
    };
});

거기에서 클라이언트측 JavaScript가 해당 속성에 액세스하고 JSON을 다시 구문 분석하는 방법을 쉽게 상상할 수 있습니다. 이 접근 방식은 클라이언트 라이브러리에 배치할 해당 JavaScript입니다(예: ).

var elements = document.querySelectorAll("[data-json]");
for (var i = 0; i < elements.length; i++) {
    var obj = JSON.parse(elements[i].dataset.json);
    //console.log(obj);
}

클라이언트측 템플릿 작업 working-with-client-side-templates

특수 컨텍스트의 제한 해제 섹션에서 설명된 기술을 합법적으로 사용할 수 있는 한 가지 특별한 경우는 scrip 요소 내에 있는 클라이언트측 템플릿(예: 핸들바)을 작성하는 것입니다. 이 경우 이 기술을 안전하게 사용할 수 있는 이유는 script 요소에 가정한 대로 JavaScript가 포함되지 않고 추가 HTML 요소가 포함되기 때문입니다. 다음은 작동 방식의 예입니다.

<!--/* template.html file: */-->
<script id="entry-section" type="text/template"
    data-sly-include="entry-section.html"></script>

<!--/* entry-section.html file: */-->
<div class="entry-section">
    <h2 data-sly-test="${properties.entrySectionTitle}">
        ${properties.entrySectionTitle}
    </h2>
    {{#each entry}}<h3><a href="{{link}}">{{title}}</a></h3>{{/each}}
</div>

Handlebars 템플릿 콘텐츠가 자체 파일에 격리되어 있으므로 script 요소의 태그에는 명시적 컨텍스트 없이 HTL 블록 문이 포함될 수 있습니다. 또한 이 예에서는 서버측 실행 HTL(h2 요소에서와 같이)이 핸들바(h3 요소에 표시된)와 같은 클라이언트측 실행 템플릿 언어와 어떻게 혼합될 수 있는지 보여 줍니다.

그러나 보다 현대적인 기술은 HTML template 요소를 대신 사용하는 것입니다. 그러면 템플릿의 콘텐츠를 별도의 파일로 분리할 필요가 없다는 이점이 있기 때문입니다.

특수 컨텍스트의 제한 해제 lifting-limitations-of-special-contexts

스크립트, 스타일 및 주석 컨텍스트의 제한을 피해야 하는 특별한 경우에는 해당 콘텐츠를 별도의 HTL 파일로 격리할 수 있습니다. HTL은 자체 파일의 모든 항목을 표준 HTML 조각으로 해석하여 포함된 위치에서 제한된 컨텍스트를 무시합니다.

예를 보려면 더 아래에 있는 클라이언트측 템플릿 작업 섹션을 참조하십시오.