HTML 서비스: 템플릿 HTML

템플릿을 사용하면 Google Apps Script 코드와 HTML을 혼합하여 최소한의 노력으로 동적 페이지를 빌드할 수 있습니다. PHP, ASP, JSP와 같이 코드와 HTML을 혼합하는 템플릿 언어를 사용한 적이 있다면 구문이 익숙할 것입니다.

스크립틀릿

Apps Script 템플릿에는 스크립틀릿이라는 세 가지 특수 태그가 포함될 수 있습니다. 스크립틀릿 내에서 일반적인 Apps Script 파일에서 작동하는 코드를 작성할 수 있습니다. 스크립틀릿은 다른 코드 파일에 정의된 함수를 호출하거나, 전역 변수를 참조하거나, Apps Script API를 사용할 수 있습니다. 스크립틀릿 내에서 함수와 변수를 정의할 수도 있지만, 코드 파일 또는 다른 템플릿에 정의된 함수에서 호출할 수는 없습니다.

다음 예시를 스크립트 편집기에 붙여넣으면 <?= ... ?> 태그 (인쇄 스크립틀릿)의 콘텐츠가 기울임꼴로 표시됩니다. 이 코드는 페이지가 사용자에게 제공되기 전에 서버에서 실행됩니다. 스크립틀릿 코드는 페이지가 제공되기 전에 실행되므로 페이지당 한 번만 실행할 수 있습니다. `google.script.run`을 통해 호출하는 클라이언트 측 JavaScript 또는 Apps Script 함수와 달리 스크립틀릿은 페이지가 로드된 후 다시 실행할 수 없습니다.google.script.run

Code.gs

function doGet() {
  return HtmlService
      .createTemplateFromFile('Index')
      .evaluate();
}

Index.html

<!DOCTYPE html>
<html>
  <head>
    <base target="_top">
  </head>
  <body>
    Hello, World! The time is <?= new Date() ?>.
  </body>
</html>

템플릿 HTML의 doGet 함수는 기본 HTML을 만들고 제공하는 예시 와 다릅니다. 여기에 표시된 함수 는 HTML 파일에서 HtmlTemplate 객체를 생성한 다음 evaluate 메서드를 호출하여 스크립틀릿을 실행하고 템플릿을 스크립트가 사용자에게 제공할 수 있는 HtmlOutput 객체로 변환합니다.

표준 스크립틀릿

<? ... ?> 구문을 사용하는 표준 스크립틀릿은 콘텐츠를 페이지에 명시적으로 출력하지 않고 코드를 실행합니다. 하지만 이 예시에서 볼 수 있듯이 스크립틀릿 내부의 코드 결과 는 스크립틀릿 외부의 HTML 콘텐츠에 영향을 줄 수 있습니다.

Code.gs

function doGet() {
  return HtmlService
      .createTemplateFromFile('Index')
      .evaluate();
}

Index.html

<!DOCTYPE html>
<html>
  <head>
    <base target="_top">
  </head>
  <body>
    <? if (true) { ?>
      <p>This is always served!</p>
    <? } else  { ?>
      <p>This is never served.</p>
    <? } ?>
  </body>
</html>

<?= ... ?> 구문을 사용하는 인쇄 스크립틀릿은 상황별 이스케이핑을 사용하여 코드 결과를 페이지에 출력합니다.

상황별 이스케이핑은 Apps Script가 페이지의 출력 컨텍스트(HTML 속성 내부, 클라이언트 측 script 태그 내부 또는 기타 위치)를 추적하고 교차 사이트 스크립팅(XSS) 공격으로부터 보호하기 위해 이스케이프 문자를 자동으로 추가한다는 의미입니다.

이 예시에서 첫 번째 인쇄 스크립틀릿은 문자열을 직접 출력합니다. 그 뒤에는 배열과 루프를 설정하는 표준 스크립틀릿이 나오고, 배열의 콘텐츠를 출력하는 또 다른 인쇄 스크립틀릿이 나옵니다.

Code.gs

function doGet() {
  return HtmlService
      .createTemplateFromFile('Index')
      .evaluate();
}

Index.html

<!DOCTYPE html>
<html>
  <head>
    <base target="_top">
  </head>
  <body>
    <?= 'My favorite Google products:' ?>
    <? var data = ['Gmail', 'Docs', 'Android'];
      for (var i = 0; i < data.length; i++) { ?>
        <b><?= data[i] ?></b>
    <? } ?>
  </body>
</html>

인쇄 스크립틀릿은 첫 번째 문의 값만 출력합니다. 나머지 문은 표준 스크립틀릿에 포함된 것처럼 동작합니다. 예를 들어 스크립틀릿 <?= 'Hello, world!'; 'abc' ?>는 'Hello, world!'만 출력합니다.

강제 인쇄 스크립틀릿

<?!= ... ?> 구문을 사용하는 강제 인쇄 스크립틀릿은 상황별 이스케이핑을 피한다는 점을 제외하고 인쇄 스크립틀릿과 같습니다.

스크립트에서 신뢰할 수 없는 사용자 입력을 허용하는 경우 상황별 이스케이핑이 중요합니다. 반대로 스크립틀릿의 출력에 의도적으로 지정된 대로 정확하게 삽입하려는 HTML 또는 스크립트가 포함되어 있는 경우 강제 인쇄해야 합니다.

일반적으로 HTML 또는 JavaScript를 변경하지 않고 인쇄해야 하는 경우를 제외하고 강제 인쇄 스크립틀릿 대신 인쇄 스크립틀릿을 사용하세요.

스크립틀릿의 Apps Script 코드

스크립틀릿은 일반 JavaScript 실행으로 제한되지 않습니다. 다음 세 가지 기법 중 하나를 사용하여 템플릿에 Apps Script 데이터에 대한 액세스 권한을 부여할 수도 있습니다.

하지만 템플릿 코드는 페이지가 사용자에게 제공되기 전에 실행되므로 이러한 기법은 페이지에 초기 콘텐츠만 제공할 수 있습니다. 페이지에서 Apps Script 데이터에 대화형으로 액세스하려면 대신 google.script.run API를 사용하세요.

템플릿에서 Apps Script 함수 호출

스크립틀릿은 Apps Script 코드 파일 또는 라이브러리에 정의된 함수를 호출할 수 있습니다. 이 예시에서는 스프레드시트에서 템플릿으로 데이터를 가져온 다음 데이터에서 HTML 표를 구성하는 한 가지 방법을 보여줍니다.

Code.gs

function doGet() {
  return HtmlService
      .createTemplateFromFile('Index')
      .evaluate();
}

function getData() {
  return SpreadsheetApp
      .openById('1234567890abcdefghijklmnopqrstuvwxyz')
      .getActiveSheet()
      .getDataRange()
      .getValues();
}

Index.html

<!DOCTYPE html>
<html>
  <head>
    <base target="_top">
  </head>
  <body>
    <? var data = getData(); ?>
    <table>
      <? for (var i = 0; i < data.length; i++) { ?>
        <tr>
          <? for (var j = 0; j < data[i].length; j++) { ?>
            <td><?= data[i][j] ?></td>
          <? } ?>
        </tr>
      <? } ?>
    </table>
  </body>
</html>

Apps Script API 직접 호출

스크립틀릿에서 Apps Script 코드를 직접 사용할 수도 있습니다. 이 예시에서는 별도의 함수를 통하지 않고 템플릿 자체에서 데이터를 로드하여 이전 예시와 동일한 결과를 얻습니다.

Code.gs

function doGet() {
  return HtmlService
      .createTemplateFromFile('Index')
      .evaluate();
}

Index.html

<!DOCTYPE html>
<html>
  <head>
    <base target="_top">
  </head>
  <body>
    <? var data = SpreadsheetApp
        .openById('1234567890abcdefghijklmnopqrstuvwxyz')
        .getActiveSheet()
        .getDataRange()
        .getValues(); ?>
    <table>
      <? for (var i = 0; i < data.length; i++) { ?>
        <tr>
          <? for (var j = 0; j < data[i].length; j++) { ?>
            <td><?= data[i][j] ?></td>
          <? } ?>
        </tr>
      <? } ?>
    </table>
  </body>
</html>

템플릿에 변수 푸시

마지막으로 객체의 속성 으로 변수를 할당하여 템플릿에 변수를 푸시할 수 있습니다.HtmlTemplate 이 예시에서도 이전 예시와 동일한 결과를 얻습니다.

Code.gs

function doGet() {
  var t = HtmlService.createTemplateFromFile('Index');
  t.data = SpreadsheetApp
      .openById('1234567890abcdefghijklmnopqrstuvwxyz')
      .getActiveSheet()
      .getDataRange()
      .getValues();
  return t.evaluate();
}

Index.html

<!DOCTYPE html>
<html>
  <head>
    <base target="_top">
  </head>
  <body>
    <table>
      <? for (var i = 0; i < data.length; i++) { ?>
        <tr>
          <? for (var j = 0; j < data[i].length; j++) { ?>
            <td><?= data[i][j] ?></td>
          <? } ?>
        </tr>
      <? } ?>
    </table>
  </body>
</html>

템플릿 디버그

템플릿은 작성한 코드가 직접 실행되지 않으므로 디버그하기 어려울 수 있습니다. 대신 서버는 템플릿을 코드로 변환한 다음 결과 코드를 실행합니다.

템플릿이 스크립틀릿을 해석하는 방법이 명확하지 않은 경우 두 디버깅 메서드를 HtmlTemplate 클래스에서 사용하면 상황을 더 잘 파악할 수 있습니다.

getCode 함수

The getCode 함수 는 서버가 템플릿에서 만드는 코드가 포함된 문자열을 반환합니다. 코드를 로깅한 다음 스크립트 편집기에 붙여넣으면 일반적인 Apps Script 코드처럼 실행하고 디버그 할 수 있습니다.

다음은 Google 제품 목록을 다시 표시하는 템플릿과 getCode의 결과입니다.

Code.gs

function myFunction() {
  Logger.log(HtmlService
      .createTemplateFromFile('Index')
      .getCode());
}

Index.html

<!DOCTYPE html>
<html>
  <head>
    <base target="_top">
  </head>
  <body>
    <?= 'My favorite Google products:' ?>
    <? var data = ['Gmail', 'Docs', 'Android'];
      for (var i = 0; i < data.length; i++) { ?>
        <b><?= data[i] ?></b>
    <? } ?>
  </body>
</html>

로그 (평가됨)

(function() { var output = HtmlService.initTemplate(); output._ =  '<!DOCTYPE html>\n';
  output._ =  '<html>\n' +
    '  <head>\n' +
    '    <base target=\"_top\">\n' +
    '  </head>\n' +
    '  <body>\n' +
    '    '; output._$ =  'My favorite Google products:' ;
  output._ =  '    ';  var data = ['Gmail', 'Docs', 'Android'];
        for (var i = 0; i < data.length; i++) { ;
  output._ =  '        <b>'; output._$ =  data[i] ; output._ =  '</b>\n';
  output._ =  '    ';  } ;
  output._ =  '  </body>\n';
  output._ =  '</html>';
  /* End of user code */
  return output.$out.append('');
})();

getCodeWithComments 함수

The getCodeWithComments function is similar to getCode(), but returns the evaluated code as comments that appear side-by-side with the original template.

평가된 코드 살펴보기

평가된 코드의 샘플에서 가장 먼저 눈에 띄는 것은 HtmlService.initTemplate 메서드로 생성된 암시적 output 객체입니다. 이 메서드는 템플릿 자체에서만 사용해야 하므로 문서화되지 않습니다. output은 HtmlOutput 호출의 약어인 _ 및 _$라는 비정상적인 이름의 속성이 두 개 있는 특수 append 및 appendUntrusted 객체입니다.

output 에는 이러한 특수 속성이 없는 일반 HtmlOutput 객체를 참조하는 $out이라는 특수 속성이 하나 더 있습니다. 템플릿은 코드 끝에 일반 객체를 반환합니다.

이제 이 구문을 이해했으므로 나머지 코드를 따라갈 수 있습니다. 스크립틀릿 외부의 HTML 콘텐츠 (예: b 태그)는 output._ = (상황별 이스케이핑 없음)를 사용하여 추가되고 스크립틀릿은 JavaScript로 추가됩니다 (스크립틀릿 유형에 따라 상황별 이스케이핑이 있거나 없음).

평가된 코드는 템플릿의 줄 번호를 유지합니다. 평가된 코드를 실행하는 중에 오류가 발생하면 줄이 템플릿의 해당 콘텐츠에 해당합니다.

주석 계층 구조

평가된 코드는 줄 번호를 유지하므로 스크립틀릿 내부의 주석이 다른 스크립틀릿과 HTML 코드까지 주석 처리할 수 있습니다. 다음 예시에서는 주석의 몇 가지 놀라운 효과를 보여줍니다.

<? var x; // a comment ?> This sentence won't print because a comment begins
inside a scriptlet on the same line.

<? var y; // ?> <?= "This sentence won't print because a comment begins inside
a scriptlet on the same line.";
output.append("This sentence prints because it's on the next line, even though
it's in the same scriptlet.") ?>

<? doSomething(); /* ?>
This entire block is commented out,
even if you add a */ in the HTML
or in a <script> */ </script> tag,
<? until you end the comment inside a scriptlet. */ ?>