HTML 서비스: 템플릿 HTML

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

스크립틀릿

Apps Script 템플릿에는 'scriptlet'이라고 하는 특수 태그 3개가 포함될 수 있습니다. 스크립틀릿 내에서 일반 Apps Script 파일에서 작동하는 모든 코드를 작성할 수 있습니다. 스크립틀릿은 다른 코드 파일에 정의된 함수를 호출하거나 전역 변수를 참조하거나 Apps Script API 중 하나를 사용할 수 있습니다. 코드 파일이나 다른 템플릿에 정의된 함수로는 호출할 수 없다는 점에 유의하여 스크립틀릿 내에 함수와 변수를 정의할 수도 있습니다.

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

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 객체로 변환합니다.

표준 스크립틀릿

<? ... ?> 구문을 사용하는 표준 스크립틀릿은 페이지에 콘텐츠를 명시적으로 출력하지 않고 코드를 실행합니다. 그러나 이 예에 표시된 것처럼 Scriptlet 내부의 코드의 결과는 계속해서 Scriptlet 외부의 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 will always be served!</p>
    <? } else  { ?>
      <p>This will never be served.</p>
    <? } ?>
  </body>
</html>

스크립틀릿 인쇄

<?= ... ?> 문법을 사용하는 scriptlet을 출력하면 컨텍스트 이스케이프를 사용하여 코드의 결과를 페이지에 출력합니다.

컨텍스트 이스케이프 처리는 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>

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

스크립틀릿 강제 인쇄

<?!= ... ?> 문법을 사용하는 강제 출력 스크립틀릿은 컨텍스트 이스케이프를 방지한다는 점을 제외하면 스크립트 인쇄와 비슷합니다.

컨텍스트 이스케이프 처리는 스크립트가 신뢰할 수 없는 사용자 입력을 허용하는 경우 중요합니다. 반면에, 스크립트의 출력에 지정된 대로 정확히 삽입하려는 HTML 또는 스크립트가 의도적으로 포함되어 있는 경우 강제로 인쇄해야 합니다.

일반적으로 HTML 또는 자바스크립트를 변경하지 않고 인쇄해야 하는 경우가 아니라면 스크립틀릿을 강제 인쇄하는 대신 스크립틀릿을 인쇄하는 것이 좋습니다.

스크립틀릿의 Apps Script 코드

Scriptlet은 일반 JavaScript 실행으로 제한되지 않습니다. 또한 다음 세 가지 기술을 사용하여 템플릿에 Apps Script 데이터에 대한 액세스 권한을 부여할 수 있습니다.

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

템플릿에서 Apps Script 함수 호출

Scriptlet은 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()

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()

getCodeWithComments()getCode()와 유사하지만 평가된 코드를 원래 템플릿과 나란히 표시되는 주석으로 반환합니다.

평가된 코드 살펴보기

평가된 코드의 두 샘플에서 가장 먼저 눈에 띄는 것은 HtmlService.initTemplate() 메서드가 생성한 암시적 output 객체입니다. 이 메서드는 템플릿 자체만 사용하면 되므로 문서화되지 않습니다. output는 예외적으로 이름이 지정된 두 속성인 __$가 있는 특수한 HtmlOutput 객체로, append()appendUntrusted() 호출을 위한 약식 표현입니다.

output에는 하나 이상의 특수 속성 $out가 있습니다. 이 특수 속성은 이러한 특수 속성을 보유하지 않은 일반 HtmlOutput 객체를 나타냅니다. 템플릿은 코드 끝에 일반 객체를 반환합니다.

이제 이 구문을 이해했으므로 코드의 나머지 부분을 쉽게 따라할 수 있습니다. 스크립틀릿 외부의 HTML 콘텐츠(예: b 태그)는 컨텍스트 이스케이프 처리 없이 output._ =를 통해 추가되고, 스크립트릿은 자바스크립트(scriptlet 유형에 따라 컨텍스트 이스케이프 사용 여부와 관계없이) 자바스크립트로 추가됩니다.

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

댓글 계층 구조

평가된 코드는 행 번호를 유지하므로 스크립틀릿 내의 코멘트가 다른 스크립틀릿과 심지어 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 will print 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. */ ?>