Tìm hiểu về require trong Node.js

Vấn đề

Node.js sử dụng CommonJS để triển khai hệ thống module và require là lệnh để yêu cầu sử dụng một module trong một file xác định. Chức năng cơ bản của require đó là nó sẽ đọc một file, thực thi và sau đó trả lại các đối tượng được exports.
Ví dụ một module như sau:

console.log("example.js");

const invisible = function () {
  console.log("invisible");
}

exports.message = "hi";

exports.say = function () {
  console.log(exports.message);
}

Khi đó:

var example = require('./example.js')
console.log(example);

Chúng ta sẽ thấy kết quả như là:

example.js
{
  message: "hi",  
  say: [Function]
}

Hoặc chúng ta cũng có thể sử dụng module.exports để exports ra một hàm hoặc một đối tượng mới.

Ví dụ:

module.exports = function () {
  console.log("hello world");
}

Khi đó

require('./example2.js')(); // return "hello world"

Một điều cần lưu ý là mỗi lần require một tệp đã được require trước đó, các đối tượng được exports sẽ được lưu vào bộ nhớ đệm (cache) và sử dụng lại.

Ví dụ:

node> require('./example.js')
example.js
{ message: 'hi', say: [Function] }
node> require('./example.js')
{ message: 'hi', say: [Function] }
node> require('./example.js').message = "hey" // gán message thành "hey"
'hey'
node> require('./example.js') // lúc này chúng ta sẽ nghĩ require giống như là yêu cầu require mới lại file...  
example.js
{ message: 'hey', say: [Function] } // nhưng kết quả message đã bị gán thành "hey"

Như các bạn có thể thấy ở trên, example.js được require một lần duy nhất, sau đó tất cả các lệnh gọi require tiếp theo sẽ chỉ lấy ra trong bộ nhớ đệm, thay vì đọc lại tệp. Điều này đôi khi có thể tạo ra một số trường hợp không mong muốn như ở ví dụ trên khi chúng ta vô tình thay đổi các thuộc tính.

Các quy tắc về require có thể hơi phức tạp, nhưng có một số quy tắc chung đơn giản như là nếu tệp không bắt đầu bằng "./" hoặc "/", thì nó được coi là built-in module (core), hoặc là một phần phụ thuộc trong thư mục node_modules. Nếu tệp bắt đầu bằng "./" thì nó được coi là tệp với đường dẫn tương đối. Nếu tệp bắt đầu bằng "/", nó được coi là tệp với đường dẫn tuyệt đối.

Lưu ý: có thể bỏ qua đuôi ".js", require sẽ tự động thêm vào nếu cần.

Ngoài ra, nếu chúng ta require chỉ đến cấp thư mục nó sẽ tự động tìm file index.js, nếu không có sẽ gây ra một lỗi module không tồn tại.