Ở bài trước chúng ta đã có trang 404 và error handler cho MiniBlog, nhưng trang chủ và trang lỗi vẫn ghép HTML bằng chuỗi. Tiếp tục với series, bài này mình sẽ giới thiệu với mọi người về template engine EJS trong Express: cấu hình, res.render(), truyền dữ liệu, partial và cách EJS chống XSS.
1. Template engine là gì?
Template engine cho phép chúng ta viết giao diện trong các file template riêng. Khi chạy, nó thay các biến trong template bằng giá trị thật và tạo ra HTML gửi cho client.
Từ Bài 5 trang chủ MiniBlog được ghép bằng template string trong route. Cách này khó đọc khi trang dài ra, trộn giao diện với logic, và dễ dính lỗi XSS (phần 5). Express hỗ trợ nhiều template engine như Pug, hbs, EJS, series này dùng EJS (Embedded JavaScript) vì nó chỉ là HTML xen code JavaScript, không phải học cú pháp mới.
Các bạn cài EJS vào MiniBlog:
npm install ejs
Tại thời điểm viết bài, phiên bản mới nhất là EJS 7.0.2.
2. Cấu hình EJS và res.render().
Để dùng template engine, các bạn khai báo hai setting của ứng dụng:
view engine: tên template engine, cũng là phần mở rộng mặc định của file view (.ejs). Express tự nạp packageejs, không cần import trong code.views: thư mục chứa các file view, mặc định là thư mụcviewstrong thư mục đang chạy lệnh (process.cwd()). Mình khai báo rõ bằngimport.meta.dirname(thư mục chứaapp.js) để chạy từ đâu cũng đúng.
- app.js (thêm hai dòng sau const app = express();)
// Dùng EJS làm template engine, các file view nằm trong thư mục views/
app.set('view engine', 'ejs');
app.set('views', import.meta.dirname + '/views');
Sau đó trong route các bạn gọi res.render() với cú pháp như sau:
res.render(view, locals);
Trong đó:
viewlà đường dẫn file view tính từ thư mụcviews, có thể bỏ phần mở rộng.ejs.localslà object chứa dữ liệu truyền cho view, mỗi key thành một biến dùng được trong template. Có thể bỏ trống.
res.render() render view thành HTML rồi gửi cho client với header Content-Type: text/html. Nếu không tìm thấy file view, nó chuyển lỗi Failed to lookup view cho error handler. Ở chế độ production Express bật view cache: template chỉ được đọc và biên dịch một lần, còn HTML vẫn render lại mỗi request.
VD: Trang chủ MiniBlog giờ chỉ cần truyền tiêu đề và danh sách bài viết cho view index.
import express from 'express';
import posts from '../data/posts.js';
const router = express.Router();
// Trang chủ: render views/index.ejs
router.get('/', (req, res) => {
res.render('index', { title: 'MiniBlog', posts });
});
export default router;
3. Cú pháp EJS và truyền dữ liệu.
File EJS là HTML bình thường, code JavaScript được đặt trong các thẻ sau:
<% %>: chạy code (if, vòng lặp...), không in ra gì.<%= %>: in giá trị ra HTML đã được escape.<%- %>: in giá trị nguyên văn, không escape.<%# %>: comment, không chạy và không xuất hiện trong HTML.-%>: thẻ đóng xoá luôn dấu xuống dòng ngay sau nó.
Các key của locals (title, posts) dùng trực tiếp như biến. Các bạn tạo thư mục views và file view trang chủ:
<!DOCTYPE html>
<html lang="vi">
<head>
<meta charset="utf-8">
<title><%= title %></title>
</head>
<body>
<h1><%= title %></h1>
<%# Duyệt mảng posts, mỗi bài viết là một thẻ li %>
<% if (posts.length === 0) { %>
<p>Chưa có bài viết nào.</p>
<% } else { %>
<ul>
<% posts.forEach((post) => { %>
<li><a href="/posts/<%= post.slug %>"><%= post.title %></a></li>
<% }) %>
</ul>
<% } %>
</body>
</html>
Chạy npm run dev và mở http://localhost:3000 (kết quả đã lược bớt dòng trống):
curl http://localhost:3000
# ...
# <h1>MiniBlog</h1>
# <ul>
# <li><a href="/posts/nhung-tinh-nang-moi-trong-express-5">Những tính năng mới trong Express 5</a></li>
# <li><a href="/posts/route-trong-express-5">Route trong Express 5</a></li>
# </ul>
# ...
Các dòng chỉ chứa thẻ <% %> để lại dòng trống trong HTML, trình duyệt bỏ qua nên không ảnh hưởng giao diện.
Tương tự, trang lỗi ở Bài 7 chuyển sang view error:
<!DOCTYPE html>
<html lang="vi">
<head>
<meta charset="utf-8">
<title>Lỗi <%= status %></title>
</head>
<body>
<h1>Lỗi <%= status %></h1>
<p><%= message %></p>
<a href="/">Về trang chủ</a>
</body>
</html>
- middlewares/error-handler.js (thay dòng res.status(status).send(...) cuối hàm errorHandler)
res.status(status).render('error', { status, message });
curl -H "Accept: text/html" http://localhost:3000/abc
# ...
# <h1>Lỗi 404</h1>
# <p>Không tìm thấy trang</p>
# ...
4. Include và partial.
Partial là một đoạn template nhỏ được tách ra file riêng để dùng lại ở nhiều view. Các bạn chèn partial bằng hàm include():
<%- include(path, data) %>
Trong đó:
pathlà đường dẫn file partial, tính từ file đang gọiinclude(), có thể bỏ.ejs.datalà object dữ liệu truyền thêm cho partial. Các biến củares.render()partial tự thấy, nhưng biến tạo trong template (nhưposttrong vòng lặp) phải truyền vào. Có thể bỏ trống.
Luôn dùng <%- với include(), vì kết quả của nó đã là HTML, dùng <%= sẽ bị escape thành chữ.
VD: Mình tách thẻ <li> của một bài viết ra partial để sau này dùng lại ở trang tìm kiếm, trang tác giả.
- views/partials/post-item.ejs
<li><a href="/posts/<%= post.slug %>"><%= post.title %></a></li>
- views/index.ejs (thay dòng <li> trong vòng lặp, sửa comment phía trên thành "mỗi bài viết là một partial")
<% posts.forEach((post) => { %>
<%- include('partials/post-item', { post }) %>
<% }) %>
Trang chủ vẫn ra đúng hai bài viết như trước. Header, footer dùng chung cho mọi trang cũng làm bằng partial, mình sẽ hướng dẫn ở Bài 9.
5. Escape dữ liệu và XSS.
XSS (Cross-Site Scripting) là lỗi khi dữ liệu người dùng nhập, như tiêu đề bài viết, được in thẳng vào HTML. Nếu dữ liệu chứa thẻ <script>, đoạn script đó sẽ chạy trên trình duyệt của mọi người xem trang, VD: đánh cắp cookie đăng nhập.
<%= %> đổi các ký tự & < > " ' thành HTML entity nên script chỉ hiện ra như chữ. <%- %> thì không.
VD: Các bạn tạo file xss.js trong thư mục miniblog rồi chạy node xss.js. Hàm ejs.render() render một chuỗi template, đúng như res.render() làm với file.
- xss.js
import ejs from 'ejs';
// Giả sử tiêu đề do người dùng nhập vào form
const title = '<script>alert("XSS")</script>';
// <%= %>: escape trước khi in ra
console.log(ejs.render('<h2><%= title %></h2>', { title }));
// <h2><script>alert("XSS")</script></h2>
// <%- %>: in nguyên văn, script sẽ chạy trên trình duyệt
console.log(ejs.render('<h2><%- title %></h2>', { title }));
// <h2><script>alert("XSS")</script></h2>
Trang chủ cũ ở Bài 5 ghép ${post.title} vào chuỗi HTML nên mắc đúng lỗi thứ hai. Giờ nếu một bài viết có tiêu đề như trên, trang chủ MiniBlog in ra <script>... và trình duyệt chỉ hiển thị chữ.
Một số quy tắc khi dùng EJS:
- Mặc định dùng
<%= %>. Chỉ dùng<%- %>choinclude()và HTML các bạn tin tưởng. <%= %>chỉ an toàn trong nội dung HTML và thuộc tính có dấu nháy (title="..."), riêng URL do người dùng nhập (href,src) còn phải kiểm tra bắt đầu bằnghttp://hoặchttps://. Không in dữ liệu vào bên trong thẻ<script>, ở đó escape HTML không có tác dụng.- Không đưa dữ liệu người dùng vào tham số
viewhay làm cả objectlocals, VD:res.render('index', req.query). Tài liệu Express và EJS đều cảnh báo việc này có thể làm thay đổi cách template engine chạy hoặc gây XSS.
Thử xong các bạn xoá file xss.js.
Code đầy đủ của MiniBlog sau bài này nằm ở tag bai-08 trên GitHub; các thay đổi của riêng bài này: so sánh bai-07...bai-08.
6. Lời kết.
Như vậy là chúng ta đã tìm hiểu xong template engine EJS trong Express: cấu hình view engine, res.render(), cú pháp EJS, partial và escape dữ liệu để chống XSS. Hiện các trang của MiniBlog vẫn lặp lại phần <head> và chưa có CSS, bài sau mình sẽ giới thiệu với mọi người về file tĩnh và layout dùng chung trong Express.
Đăng ký nhận tin.
Chúng tôi chỉ gửi tối đa 2 lần trên 1 tháng. Tuyên bố không spam mail!





0 Comments