NodeJS JWT 认证示例项目启动与配置教程

1. 项目目录结构及介绍

本项目为NodeJS JWT认证示例，目录结构如下：

nodejs-jwt-authentication-sample/
│
├── .gitignore                # 忽略文件列表
├── LICENSE                   # 项目许可证文件
├── README.md                 # 项目说明文件
│
├── anonymous-routes.js       # 匿名路由处理文件
├── config.json               # 配置文件
├── package.json              # 项目依赖及配置
├── protected-routes.js       # 受保护路由处理文件
├── quoter.js                 # 引用Chuck Norris语句的模块
├── quotes.json               # Chuck Norris语句数据文件
│
└── server.js                 # 服务器启动文件

• .gitignore：定义了在Git版本控制中需要忽略的文件和目录。
• LICENSE：项目的许可证信息，本项目采用MIT许可证。
• README.md：项目说明文件，包含了项目的基本信息和如何使用。
• anonymous-routes.js：处理不需要认证的API路由。
• config.json：项目配置文件，包含了JWT密钥等配置信息。
• package.json：定义了项目的依赖、脚本和元数据。
• protected-routes.js：处理需要JWT认证的API路由。
• quoter.js：用于获取Chuck Norris语句的模块。
• quotes.json：存储Chuck Norris语句的数据文件。
• server.js：项目的入口文件，用于启动服务器。

2. 项目的启动文件介绍

项目的启动文件为server.js。该文件负责初始化Express应用，设置中间件，定义路由，并启动HTTP服务器。

主要步骤如下：

1. 引入所需的模块和配置文件。
2. 初始化Express应用。
3. 设置中间件，例如用于解析JSON请求体的中间件。
4. 定义路由，包括匿名路由和需要认证的路由。
5. 设置HTTP服务器监听指定端口。

3. 项目的配置文件介绍

项目的配置文件为config.json。该文件包含了项目运行所需的配置信息，例如JWT密钥和API的基本信息。

配置文件示例内容如下：

{
  "secret": "your-secret-key",
  "tokenExpireTime": "1h",
  "refreshTokenExpireTime": "7d",
  "audience": "your-audience",
  "issuer": "your-issuer",
  "scope": "read write"
}

• secret：JWT密钥，用于签名和验证JWT。
• tokenExpireTime：访问令牌的过期时间。
• refreshTokenExpireTime：刷新令牌的过期时间。
• audience：令牌的受众。
• issuer：令牌的发行者。
• scope：令牌的范围。

在实际部署项目时，应确保配置文件中的信息是安全和合理的。避免使用默认值，并确保密钥等信息不会被泄露。