คุณผสมโค้ด Apps Script และ HTML เพื่อสร้างหน้าแบบไดนามิกโดยใช้ความพยายามน้อยที่สุดได้ หากคุณใช้ภาษาเทมเพลตที่ผสมโค้ดและ HTML เช่น PHP, ASP หรือ JSP ไวยากรณ์ก็ควรจะคุ้นเคย
Scriptlet
เทมเพลตของ Apps Script จะมีแท็กพิเศษที่เรียกว่า Scriptlet ได้ 3 แท็ก ใน Scriptlet คุณสามารถเขียนโค้ดใดก็ได้ที่จะทำงานในไฟล์ Apps Script ปกติ โดย Scriptlet สามารถเรียกฟังก์ชันที่กำหนดไว้ในไฟล์โค้ดอื่นๆ, อ้างอิงตัวแปรร่วม หรือใช้ Apps Script API ใดก็ได้ คุณยังกำหนดฟังก์ชันและตัวแปรภายใน Scriptlet ได้ โดยมีข้อควรระวังว่าฟังก์ชันที่กำหนดไว้ในไฟล์โค้ดหรือเทมเพลตอื่นๆ จะไม่สามารถเรียกใช้ฟังก์ชันดังกล่าวได้
หากวางตัวอย่างด้านล่างลงในเครื่องมือแก้ไขสคริปต์ เนื้อหาของแท็ก <?= ... ?>
(สคริปต์เล็ตการพิมพ์) จะปรากฏเป็นตัวเอียง โค้ดตัวเอียงนั้นจะทำงานบนเซิร์ฟเวอร์ก่อนที่หน้าเว็บจะแสดงให้ผู้ใช้เห็น เนื่องจากโค้ด Scriptlet ทำงานก่อนการแสดงหน้าเว็บ จึงทำงานได้เพียง 1 ครั้งต่อหน้า ซึ่งต่างจาก JavaScript ฝั่งไคลเอ็นต์หรือฟังก์ชัน Apps Script ที่คุณเรียกใช้ผ่าน google.script.run
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>
โปรดทราบว่าฟังก์ชัน doGet()
สำหรับ HTML ที่ใช้เทมเพลตแตกต่างจากตัวอย่างสำหรับการสร้างและการแสดง HTML พื้นฐาน ฟังก์ชันที่แสดงที่นี่จะสร้างออบเจ็กต์ HtmlTemplate
จากไฟล์ HTML จากนั้นเรียกใช้เมธอด evaluate()
เพื่อเรียกใช้ Scriptlet และแปลงเทมเพลตเป็นออบเจ็กต์ HtmlOutput
ที่สคริปต์สามารถแสดงต่อผู้ใช้ได้
Scriptlet มาตรฐาน
Scriptlet มาตรฐานที่ใช้ไวยากรณ์ <? ... ?>
เรียกใช้โค้ดโดยไม่แสดงเนื้อหาในหน้าเว็บอย่างชัดแจ้ง อย่างไรก็ตาม ตามตัวอย่างนี้ ผลลัพธ์ของโค้ดภายใน Scriptlet ยังคงส่งผลต่อเนื้อหา HTML นอก Scriptlet ดังนี้
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>
การพิมพ์สคริปต์ขนาดเล็ก
การพิมพ์สคริปต์ ซึ่งใช้ไวยากรณ์ <?= ... ?>
จะแสดงผลลัพธ์ของโค้ดในหน้าโดยใช้ Escape ตามบริบท
การกำหนดเป็นอักขระหลีกตามบริบทหมายความว่า Apps Script จะติดตามบริบทของเอาต์พุตในหน้าเว็บ เช่น ภายในแอตทริบิวต์ HTML ภายในแท็ก script
ฝั่งไคลเอ็นต์ หรือที่อื่นๆ และเพิ่มอักขระหลีกโดยอัตโนมัติ
เพื่อป้องกันการโจมตีแบบ Cross-site Scripting (XSS)
ในตัวอย่างนี้ Scriptlet การพิมพ์ตัวแรกจะแสดงผลสตริงโดยตรง ตามด้วย Scriptlet มาตรฐานที่ตั้งค่าอาร์เรย์และลูป ตามด้วย Scriptlet การพิมพ์อีกตัวหนึ่งเพื่อแสดงเนื้อหาของอาร์เรย์
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!" เท่านั้น
การบังคับพิมพ์ Scriptlet
สคริปต์เล็ตการบังคับพิมพ์ซึ่งใช้ไวยากรณ์ <?!= ... ?>
เหมือนกับการพิมพ์สคริปต์ เว้นแต่ว่าจะหลีกเลี่ยงการ Escape ตามบริบท
การ Escape ตามบริบทเป็นสิ่งสำคัญหากสคริปต์ของคุณอนุญาตการป้อนข้อมูลของผู้ใช้ที่ไม่น่าเชื่อถือ ในทางตรงกันข้าม คุณจะต้องบังคับให้พิมพ์หากเอาต์พุตของ Scriptlet จงใจมี HTML หรือสคริปต์ที่คุณต้องการแทรกตรงตามที่ระบุ
ตามกฎทั่วไป ให้ใช้ Scriptlet พิมพ์ แทนที่จะบังคับให้พิมพ์ Scriptlet ยกเว้นกรณีที่คุณทราบว่าจะต้องพิมพ์ HTML หรือ JavaScript โดยไม่มีการเปลี่ยนแปลง
โค้ด Apps Script ใน Scriptlet
Scriptlet ไม่ได้จำกัดอยู่ที่การเรียกใช้ JavaScript ปกติ แต่คุณยังสามารถใช้เทคนิค 3 อย่างต่อไปนี้เพื่อให้เทมเพลตเข้าถึงข้อมูล 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 ใน Scriptlet โดยตรงได้อีกด้วย ตัวอย่างนี้ได้รับผลลัพธ์เดียวกันกับตัวอย่างก่อนหน้านี้โดยการโหลดข้อมูลในเทมเพลตแทนการโหลดผ่านฟังก์ชันแยกต่างหาก
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>
เทมเพลตการแก้ไขข้อบกพร่อง
เทมเพลตอาจเป็นเรื่องยากที่จะแก้ไขข้อบกพร่องเนื่องจากโค้ดที่คุณเขียนไม่ได้ดำเนินการโดยตรง แต่เซิร์ฟเวอร์จะแปลงเทมเพลตของคุณเป็นโค้ด แล้วจึงเรียกใช้โค้ดที่ได้นั้น
หากไม่แน่ชัดว่าเทมเพลตตีความสคริปต์ของคุณอย่างไร วิธีการแก้ไขข้อบกพร่อง 2 วิธีในชั้นเรียน 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()
แต่จะแสดงโค้ดที่ประเมินเป็นความคิดเห็นที่ปรากฏคู่กับเทมเพลตเดิม
แนะนำโค้ดที่ประเมิน
สิ่งแรกที่คุณจะเห็นในตัวอย่างโค้ดที่ประเมินคือออบเจ็กต์ output
โดยนัยที่สร้างโดยเมธอด HtmlService.initTemplate()
วิธีการนี้ไม่มีการบันทึกข้อมูลเนื่องจากมีเพียงเทมเพลตเท่านั้นที่ต้องใช้ output
เป็นออบเจ็กต์ HtmlOutput
พิเศษที่มีพร็อพเพอร์ตี้ 2 รายการที่มีชื่อผิดปกติ ได้แก่ _
และ _$
ซึ่งย่อสำหรับการเรียก append()
และ appendUntrusted()
output
มีพร็อพเพอร์ตี้พิเศษอีก 1 รายการ $out
ซึ่งอ้างถึงออบเจ็กต์ HtmlOutput
ปกติที่ไม่มีพร็อพเพอร์ตี้พิเศษเหล่านี้ เทมเพลตจะแสดงออบเจ็กต์ปกติที่ส่วนท้ายของโค้ด
เมื่อเข้าใจไวยากรณ์แล้ว โค้ดที่เหลือควรจะทำตามได้ง่าย เนื้อหา HTML นอก Scriptlet (เช่น แท็ก b
) จะต่อท้ายโดยใช้ output._ =
(ไม่มี บริบท Escape)
และสคริปต์เล็ตจะต่อท้ายเป็น JavaScript (โดยมีหรือไม่มีการ Escape ตามบริบท
ขึ้นอยู่กับประเภทของ Scriptlet)
โปรดทราบว่าโค้ดที่ประเมินจะเก็บหมายเลขบรรทัดจากเทมเพลตไว้ หากคุณพบข้อผิดพลาดขณะเรียกใช้โค้ดที่ประเมิน เส้นจะตรงกับเนื้อหาที่เทียบเท่าในเทมเพลต
ลำดับขั้นของความคิดเห็น
เนื่องจากโค้ดที่ประเมินจะเก็บรักษาหมายเลขบรรทัดไว้ ความคิดเห็นภายใน Scriptlet จึงอาจแสดงความคิดเห็นเกี่ยวกับ 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. */ ?>