passport-local-mongoose 使用指南

passport-local-mongoose 使用指南

passport-local-mongoosePassport-Local Mongoose is a Mongoose plugin that simplifies building username and password login with Passport项目地址:https://gitcode.com/gh_mirrors/pa/passport-local-mongoose

一、项目目录结构及介绍

passport-local-mongoose 是一个集成在 Express 应用中的插件，它结合了 passport-local 策略和 Mongoose 模型来简化基于本地身份验证的过程。下面是典型项目中该插件涉及的目录结构示例及其描述：

.
├── models           # 用户模型存放处，通常包含由 passport-local-mongoose 插件增强的用户 Schema。
│   └── user.js      # 包含用户认证逻辑的模型文件。
├── routes           # 应用路由定义，包括登录、注册、注销等认证相关的路径处理。
├── server.js        # 主入口文件，启动 Express 服务器并配置中间件。
├── config           # 可选，可能包含数据库连接字符串、passport 配置等相关设置。
├── views            # 视图文件夹，用于存放 EJS 或其他模板引擎的视图文件。
├── package.json     # 项目依赖和脚本命令定义。
└── node_modules     # 自动安装的项目依赖库。

• models 目录下的 user.js 文件通常会引入 passport-local-mongoose 并应用到用户的 Mongoose Schema 上，实现密码加密存储和用户名/密码验证功能。
• routes 负责处理 HTTP 请求，如 /login, /logout, 和 /register 等，确保这些操作正确触发认证流程。
• server.js 是应用的核心文件，设置 Express 服务器，配置 Passport 和数据库连接。
• config 可以用来存放配置项，但在这个特定的项目示例中，配置往往直接写入 server.js。

二、项目的启动文件介绍

项目启动主要通过 server.js 或命名为类似的应用主文件。此文件负责以下核心任务：

1. 初始化 Express 应用: 创建 Express 实例。
2. 配置模板引擎: 如指定使用 EJS 作为视图引擎。
3. 中间件配置: 包括解析请求体（如使用 body-parser）、设置会话管理 (express-session)、初始化 Passport.js 并配置其使用的策略（这里特指 passport-local）。
4. 数据库连接: 常见于连接 MongoDB 数据库，使用 Mongoose 模块。
5. 路由绑定: 将 URL 路径与对应的处理函数关联起来。
6. 监听端口: 启动服务器并监听指定端口（如 3000）。

示例代码片段：

const express = require('express');
const bodyParser = require('body-parser');
const session = require('express-session');
const passport = require('passport');
const LocalStrategy = require('passport-local').Strategy;
const mongoose = require('mongoose');
const passportLocalMongoose = require('passport-local-mongoose');

// ...数据库连接代码...

const app = express();

// 设置视图引擎
app.set('view engine', 'ejs');

// 中间件设置
app.use(bodyParser.urlencoded({ extended: true }));
app.use(session({
    secret: 'your-secret-key',
    resave: false,
    saveUninitialized: false
}));
app.use(passport.initialize());
app.use(passport.session());

// Passport 的策略配置
passport.use(new LocalStrategy(User.authenticate()));
passport.serializeUser(User.serializeUser());
passport.deserializeUser(User.deserializeUser());

// 路由配置
require('./routes')(app); // 假设路由被定义在单独的文件里

// 启动服务器
app.listen(3000, () => {
    console.log('Server started on port 3000');
});

三、项目的配置文件介绍

对于 passport-local-mongoose 项目，配置主要分布在几个部分：

• 数据库连接: 直接在 server.js 中或专门的配置文件内完成，利用 Mongoose 连接到 MongoDB。

• Passport 配置: 在同一文件或通过导入的方式定义 Passport 局部策略、序列化与反序列化用户方法。这一步确保用户的身份可以在请求之间保持。

• 环境变量或密钥: 有时为了安全性，敏感数据（如数据库密码、应用秘密等）会被存储在环境变量或.env文件中，并非直接硬编码在配置文件内。

// 示例数据库连接配置
mongoose.connect("mongodb://localhost/auth_demo_app", { useNewUrlParser: true });

// 示例 Passport 局部策略配置
passport.use(new LocalStrategy(User.authenticate()));

// 用户序列化和反序列化
passport.serializeUser((user, done) => done(null, user.id));
passport.deserializeUser((id, done) => 
    User.findById(id, (err, user) => done(err, user))
);

总结来说，虽然具体的配置细节可能因项目而异，但以上框架提供了使用 passport-local-mongoose 的基本结构和配置指导。确保理解每个组件的作用，以便有效集成并运行你的应用。

passport-local-mongoosePassport-Local Mongoose is a Mongoose plugin that simplifies building username and password login with Passport项目地址:https://gitcode.com/gh_mirrors/pa/passport-local-mongoose