Express.js：app.locals vs res.locals vs req.session

JS

Express.JS是一种流行的Node.JS框架，它提供了简洁而灵活的方法来构建Web应用程序。在Express.JS中，有三个关键的变量用于在应用程序的不同部分共享数据和状态，它们分别是app.locals、res.locals和req.session。本文将详细介绍这三个变量的作用和使用方式，并通过案例代码来说明它们的用法。

app.locals：全局应用程序变量

在Express.JS中，app.locals是一个全局应用程序变量，可以在整个应用程序的不同部分访问和使用。这个变量通常用于存储和共享应用程序的配置设置、全局变量和其他常量。在应用程序中的任何地方，可以通过app.locals来访问这些变量。

下面是一个例子，展示了如何在应用程序中使用app.locals来存储全局变量：

// 设置全局变量
app.locals.siteName = 'My Express App';
// 在路由处理程序中访问全局变量
app.get('/', (req, res) => {
  res.render('index', {
    title: 'Home',
    siteName: app.locals.siteName
  });
});

在上面的例子中，我们使用app.locals来存储应用程序的名称，并在路由处理程序中访问这个变量。这样做的好处是，在整个应用程序中都可以方便地访问和使用这个全局变量。

res.locals：响应局部变量

res.locals是一个响应局部变量，用于在特定请求的生命周期内共享数据和状态。这个变量通常用于在路由处理程序中将数据传递给视图模板，以供渲染使用。在每个HTTP请求完成后，res.locals的值将被重置。

下面是一个例子，展示了如何在路由处理程序中使用res.locals来传递数据给视图模板：

app.get('/users/:id', (req, res) => {
  // 模拟从数据库获取用户信息
  const user = {
    id: req.params.id,
    name: 'John Doe',
    emAIl: 'john@example.com'
  };
  res.locals.user = user;
  res.render('user', {
    title: 'User Profile'
  });
});

在上面的例子中，我们在路由处理程序中使用res.locals来传递用户信息给user视图模板。通过这种方式，我们可以在视图模板中访问和显示用户信息。

req.session：会话变量

req.session是一个会话变量，用于在不同请求之间存储和共享用户的会话数据。这个变量通常用于存储用户的身份验证状态、购物车内容、用户偏好设置等。在Express.JS中，req.session使用了第三方中间件（如express-session）来实现会话功能。

下面是一个例子，展示了如何在应用程序中使用req.session来存储和使用用户的会话数据：

// 使用express-session中间件
app.use(session({
  secret: 'my-secret-key',
  resave: false,
  saveUninitialized: true
}));
// 在路由处理程序中使用req.session
app.get('/login', (req, res) => {
  // 模拟用户登录
  req.session.user = {
    id: 1,
    name: 'John Doe',
    emAIl: 'john@example.com'
  };
  res.send('Logged in successfully');
});
app.get('/profile', (req, res) => {
  // 检查用户是否登录
  if (req.session.user) {
    res.send(<code>Welcome back, ${req.session.user.name}!</code>);
  } else {
    res.send('Please login first');
  }
});

在上面的例子中，我们使用了express-session中间件来实现会话功能。在登录路由处理程序中，我们将用户信息存储在req.session.user中，以便在其他请求中使用。在个人资料路由处理程序中，我们检查req.session.user是否存在来确定用户是否已登录。

在本文中，我们详细介绍了Express.JS中的app.locals、res.locals和req.session这三个变量的作用和使用方式。app.locals用于存储和共享全局应用程序变量，res.locals用于在特定请求的生命周期内传递数据给视图模板，而req.session用于在不同请求之间存储和共享用户的会话数据。通过合理地使用这些变量，我们可以更好地管理和共享应用程序的数据和状态，提高开发效率和用户体验。

参考代码：

const express = require('express');
const session = require('express-session');
const app = express();
// 设置全局变量
app.locals.siteName = 'My Express App';
// 使用express-session中间件
app.use(session({
  secret: 'my-secret-key',
  resave: false,
  saveUninitialized: true
}));
// 路由处理程序
app.get('/', (req, res) => {
  // 在路由处理程序中访问全局变量
  res.render('index', {
    title: 'Home',
    siteName: app.locals.siteName
  });
});
app.get('/users/:id', (req, res) => {
  // 模拟从数据库获取用户信息
  const user = {
    id: req.params.id,
    name: 'John Doe',
    emAIl: 'john@example.com'
  };
  // 在路由处理程序中传递数据给视图模板
  res.locals.user = user;
  res.render('user', {
    title: 'User Profile'
  });
});
app.get('/login', (req, res) => {
  // 模拟用户登录
  req.session.user = {
    id: 1,
    name: 'John Doe',
    emAIl: 'john@example.com'
  };
  res.send('Logged in successfully');
});
app.get('/profile', (req, res) => {
  // 检查用户是否登录
  if (req.session.user) {
    res.send(<code>Welcome back, ${req.session.user.name}!</code>);
  } else {
    res.send('Please login first');
  }
});
app.listen(3000, () => {
  console.log('Server is running on port 3000');
});

参考链接：

- Express.JS官方文档：JS.com/">https://expressJS.com/

- Express.JS：app.locals vs res.locals vs req.session：https://stackoverflow.com/questions/26370094/express-JS-app-locals-vs-res-locals