Ở bài trước MiniBlog đã render giao diện bằng EJS, nhưng mỗi view tự lặp lại phần <head> và chưa có chút CSS nào. 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ề file tĩnh và layout trong Express: express.static(), thư mục public, dotfiles ở Express 5, layout dùng chung bằng partial và res.locals.
1. File tĩnh và express.static().
File tĩnh là các file được gửi nguyên nội dung cho trình duyệt: CSS, JavaScript phía trình duyệt, ảnh, font... Express phục vụ chúng bằng built-in middleware express.static() mà mình đã điểm qua ở Bài 6, với cú pháp như sau:
app.use(express.static(root, options));
Trong đó:
rootlà thư mục chứa file tĩnh. Đường dẫn tương đối được tính từ thư mục chạy lệnhnode, nên giốngviewsở Bài 8, mình dùngimport.meta.dirname.optionslà object cấu hình, VD:dotfiles(phần 2),maxAge(thời gian trình duyệt cache file). Có thể bỏ trống.
express.static() ghép URL của request với root để tìm file. Tìm thấy thì gửi file kèm Content-Type theo phần mở rộng, không thấy thì gọi next() để request đi tiếp tới các router và trang 404 phía sau.
VD: Các bạn tạo thư mục public trong miniblog và gắn middleware vào app.js, ngay trước hai dòng app.use() của router.
- app.js (đoạn thêm vào)
// Phục vụ file tĩnh (CSS, ảnh...) trong thư mục public/
app.use(express.static(import.meta.dirname + '/public'));
Tiếp theo là file CSS cho cả trang web:
/* Giao diện chung của MiniBlog */
body {
max-width: 760px;
margin: 0 auto;
padding: 0 16px;
font-family: system-ui, sans-serif;
}
.site-header {
display: flex;
justify-content: space-between;
align-items: center;
border-bottom: 1px solid #ddd;
}
nav a.active {
font-weight: bold;
}
.site-footer {
color: #888;
}
Tên thư mục public không nằm trong URL: file public/css/style.css có địa chỉ /css/style.css. Chạy npm run dev rồi kiểm tra (kết quả đã lược bớt):
curl -I http://localhost:3000/css/style.css
# HTTP/1.1 200 OK
# Cache-Control: public, max-age=0
# ETag: W/"168-1a1ddd47ac3"
# Content-Type: text/css; charset=utf-8
curl http://localhost:3000/css/khong-co.css
# {"message":"Không tìm thấy trang"}
File không tồn tại đi tới middleware 404 ở Bài 7. Muốn có tiền tố riêng thì mount kèm path: app.use('/static', express.static(...)) cho địa chỉ /static/css/style.css. Ở production, tài liệu Express khuyên để reverse proxy cache file tĩnh (Bài 25).
2. Dotfiles trong Express 5.
Dotfiles là file hoặc thư mục có tên bắt đầu bằng dấu chấm, như .env, .git, .well-known. Ở Express 5, tùy chọn dotfiles mặc định là 'ignore' và áp dụng cho cả thư mục trên đường dẫn: express.static() coi như file không tồn tại. Express 4 thì vẫn phục vụ file trong thư mục như .well-known (xem Bài 1).
VD: Các bạn tạo thử file public/.well-known/hello.txt với nội dung bất kỳ rồi gọi:
curl http://localhost:3000/.well-known/hello.txt
# {"message":"Không tìm thấy trang"}
Tùy chọn dotfiles nhận ba giá trị:
'ignore'(mặc định): coi như không có file (404).'deny': từ chối (403). Dofallthroughmặc định làtrue, cả hai trường hợp đều chỉ gọinext()nên MiniBlog vẫn trả trang 404.'allow': phục vụ như file bình thường.
Một số dịch vụ cần đọc file trong .well-known (VD: Let's Encrypt khi cấp chứng chỉ HTTPS). Thay vì 'allow' cho cả thư mục public, tài liệu nâng cấp của Express khuyên chỉ mở đúng thư mục đó:
app.use('/.well-known', express.static(import.meta.dirname + '/public/.well-known', { dotfiles: 'allow' }));
app.use(express.static(import.meta.dirname + '/public'));
Với hai dòng trên, /.well-known/hello.txt trả về nội dung file, còn các dotfile khác vẫn bị ẩn. MiniBlog chưa cần nên các bạn xoá thư mục public/.well-known vừa tạo.
Lưu ý: dotfiles chỉ là lớp bảo vệ phụ. Mọi thứ trong public đều có thể bị tải về, nên đừng bao giờ đặt .env, code server hay file cấu hình vào đó.
3. Layout dùng chung bằng partial.
Layout là phần khung giống nhau ở mọi trang: <head>, header, menu, footer. EJS không có tính năng layout riêng, README của EJS hướng dẫn dùng hai partial header và footer, include ở đầu và cuối mỗi view.
<!DOCTYPE html>
<html lang="vi">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title><%= title %> | <%= siteName %></title>
<link rel="stylesheet" href="/css/style.css">
</head>
<body>
<header class="site-header">
<a href="/"><%= siteName %></a>
<nav>
<a href="/" class="<%= currentPath === '/' ? 'active' : '' %>">Trang chủ</a>
<a href="/gioi-thieu" class="<%= currentPath === '/gioi-thieu' ? 'active' : '' %>">Giới thiệu</a>
</nav>
</header>
<main>
</main>
<footer class="site-footer">
<p><%= siteName %> - Học Express 5 cùng toidicode.com</p>
</footer>
</body>
</html>
title lấy từ res.render(), còn siteName và currentPath mình tạo ở phần 4 (các bạn làm xong phần 4 rồi hãy chạy thử). Giờ mỗi view chỉ còn phần nội dung riêng:
<%- include('partials/header') %>
<h1><%= title %></h1>
<%# Duyệt mảng posts, mỗi bài viết là một partial %>
<% if (posts.length === 0) { %>
<p>Chưa có bài viết nào.</p>
<% } else { %>
<ul>
<% posts.forEach((post) => { %>
<%- include('partials/post-item', { post }) %>
<% }) %>
</ul>
<% } %>
<%- include('partials/footer') %>
- views/error.ejs (error handler chỉ truyền status, message nên mình tự truyền title cho header)
<%- include('partials/header', { title: 'Lỗi ' + status }) %>
<h1>Lỗi <%= status %></h1>
<p><%= message %></p>
<a href="/">Về trang chủ</a>
<%- include('partials/footer') %>
Để thấy layout được dùng lại, mình thêm trang giới thiệu:
<%- include('partials/header') %>
<h1><%= title %></h1>
<p><%= siteName %> là ứng dụng blog nhiều tác giả mà chúng ta xây dựng trong series Học Express 5.</p>
<%- include('partials/footer') %>
- routes/pages.js (sửa title của trang chủ thành 'Bài viết mới' và thêm route trước dòng export default router;)
// Trang giới thiệu: render views/about.ejs
router.get('/gioi-thieu', (req, res) => {
res.render('about', { title: 'Giới thiệu' });
});
4. res.locals và app.locals.
Ngoài dữ liệu truyền qua res.render(), view còn đọc được biến từ hai nơi:
app.locals: biến của cả ứng dụng, tồn tại suốt lúc ứng dụng chạy, VD: tên trang web.res.locals: biến của riêng một request, mất đi khi response gửi xong, VD: đường dẫn hiện tại, người dùng đang đăng nhập.
Khi trùng tên, dữ liệu của res.render() được ưu tiên nhất, sau đó đến res.locals rồi app.locals. Thường chúng ta gán res.locals trong một middleware để mọi view đều có biến đó. Các bạn thêm hai đoạn sau vào app.js:
- app.js (đoạn đầu sau hai dòng app.set(), đoạn sau ngay sau app.use(morgan('dev'));)
// Biến dùng chung cho mọi view, tồn tại suốt vòng đời ứng dụng
app.locals.siteName = 'MiniBlog';
// ...
// Biến riêng của từng request: đường dẫn hiện tại để tô đậm menu
app.use((req, res, next) => {
res.locals.currentPath = req.path;
next();
});
Middleware này đặt trước các router và trang 404 nên view nào cũng có currentPath, kể cả trang lỗi. Thiếu nó, EJS sẽ báo lỗi currentPath is not defined.
curl http://localhost:3000/gioi-thieu
# ...
# <title>Giới thiệu | MiniBlog</title>
# ...
# <a href="/" class="">Trang chủ</a>
# <a href="/gioi-thieu" class="active">Giới thiệu</a>
# ...
Mở http://localhost:3000 trên trình duyệt, các bạn sẽ thấy trang chủ, trang giới thiệu và trang 404 có chung header, footer và CSS, mục menu của trang hiện tại được tô đậm. Giống locals ở Bài 8, không dùng dữ liệu người dùng gửi lên làm key của res.locals hay app.locals.
Code đầy đủ của MiniBlog sau bài này nằm ở tag bai-09 trên GitHub; các thay đổi của riêng bài này: so sánh bai-08...bai-09.
5. Lời kết.
Như vậy là chúng ta đã tìm hiểu xong file tĩnh và layout trong Express: express.static() với thư mục public, dotfiles ở Express 5, layout bằng partial header/footer, res.locals và app.locals. MiniBlog giờ đã có giao diện chung nhưng vẫn chỉ đọc dữ liệu, bài sau mình sẽ giới thiệu với mọi người về xử lý form trong Express để tạo bài viết mới.
Đă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