nodejs怎么返回json数据

Node.js如何返回JSON数据：从基础到实践的全面指南

在Web开发中,JSON（JavaScript Object Notation）因其轻量级、易读性和与JavaScript的天然兼容性，已成为前后端数据交互的主流格式，Node.js作为基于Chrome V8引擎的JavaScript运行时，凭借其异步I/O特性，成为构建API服务的热门选择，本文将详细介绍Node.js返回JSON数据的多种方法，从基础实现到进阶优化，帮助你这一核心技能。

基础实现：使用原生Node.js HTTP模块返回JSON

Node.js内置了http和https模块，无需安装额外依赖即可创建HTTP服务并返回JSON数据，以下是基础步骤：

创建HTTP服务并设置响应头

返回JSON数据的关键在于正确设置响应头，告诉客户端返回的是JSON格式，通常需要设置两个头信息：

• Content-Type: application/json：声明响应体为JSON格式（字符集建议使用utf-8，避免中文乱码）。
• Access-Control-Allow-Origin: *（可选）：跨域请求时，允许所有来源访问（生产环境建议指定具体域名）。

示例代码

// 1. 引入http模块
const http = require('http');
// 2. 定义要返回的JSON数据
const jsonData = {
    code: 200,
    message: "success",
    data: {
        id: 1,
        name: "Node.js JSON示例",
        timestamp: new Date().toISOString()
    }
};
// 3. 创建HTTP服务器
const server = http.createServer((req, res) => {
    // 设置响应头：Content-Type为application/json，字符集utf-8
    res.writeHead(200, { 
        'Content-Type': 'application/json; charset=utf-8',
        'Access-Control-Allow-Origin': '*' // 允许跨域（开发环境用）
    });
    // 将JSON对象转换为字符串并返回
    res.end(JSON.stringify(jsonData));
});
// 4. 监听端口，启动服务
const PORT = 3000;
server.listen(PORT, () => {
    console.log(`服务器运行在 http://localhost:${PORT}`);
});

关键点解析

• JSON.stringify()：将JavaScript对象/数组转换为JSON字符串，若需格式化输出（如缩进），可添加第三个参数（如JSON.stringify(jsonData, null, 2)），但会增加响应体积，生产环境建议关闭。
• 字符集charset=utf-8：避免返回的JSON中包含中文时出现乱码（如"message": "你好"）。
• 状态码200：表示请求成功，可根据业务需求调整（如404、500等）。

进阶实现：使用Express框架简化开发

原生http模块写法较为繁琐，实际开发中更常用Express框架——一个简洁、灵活的Node.js Web应用框架，它封装了HTTP细节，让返回JSON更简单。

安装Express

npm init -y # 初始化package.json
npm install express # 安装Express

示例代码

const express = require('express');
const app = express();
const PORT = 3000;
// 定义JSON数据
const jsonData = {
    code: 200,
    message: "Express返回JSON示例",
    data: {
        id: 2,
        name: "Express框架",
        timestamp: new Date().toISOString()
    }
};
// 创建路由：GET /api/json
app.get('/api/json', (req, res) => {
    // Express提供了res.json()方法，自动设置Content-Type并序列化对象
    res.json(jsonData);
});
// 启动服务
app.listen(PORT, () => {
    console.log(`Express服务器运行在 http://localhost:${PORT}`);
});

Express的优势

• res.json()：自动将对象转换为JSON字符串，并设置Content-Type: application/json，无需手动调用JSON.stringify()和res.writeHead()。
• 路由管理：支持GET、POST等多种HTTP方法，方便定义API接口。
• 中间件支持：可通过中间件统一处理跨域（如cors中间件）、日志等，避免重复代码。

跨域处理（使用cors中间件）

如果前端与Node.js服务不在同源域名下，需处理跨域问题，安装cors中间件：

npm install cors

然后在Express中使用：

const cors = require('cors');
app.use(cors()); // 全局启用跨域（所有接口均可跨域）
// 或针对特定路由启用
// app.get('/api/json', cors(), (req, res) => { ... });

动态数据：从数据库查询并返回JSON

实际业务中,JSON数据通常来自数据库（如MySQL、MongoDB等），以下以MongoDB（Node.js常用数据库）为例，演示查询数据并返回JSON的流程。

安装依赖

npm install mongodb # MongoDB驱动

示例代码（连接MongoDB并返回用户列表）

const express = require('express');
const { MongoClient } = require('mongodb');
const app = express();
const PORT = 3000;
// MongoDB连接字符串（确保MongoDB服务已启动）
const url = 'mongodb://localhost:27017';
const dbName = 'testDB';
const client = new MongoClient(url);
// 模拟用户数据（实际应从数据库查询）
const mockUsers = [
    { id: 1, name: '张三', age: 25 },
    { id: 2, name: '李四', age: 30 }
];
// 定义路由：GET /api/users
app.get('/api/users', async (req, res) => {
    try {
        // 连接MongoDB（实际开发建议在应用启动时连接，而非每次请求都连）
        await client.connect();
        const db = client.db(dbName);
        const users = db.collection('users').find({}).toArray(); // 查询所有用户
        // 返回JSON数据
        res.json({
            code: 200,
            message: '获取用户列表成功',
            data: await users
        });
    } catch (error) {
        res.status(500).json({
            code: 500,
            message: '服务器内部错误',
            error: error.message
        });
    } finally {
        // 关闭连接（实际开发建议用连接池管理）
        await client.close();
    }
});
app.listen(PORT, () => {
    console.log(`服务器运行在 http://localhost:${PORT}`);
});

关键点解析

• 异步操作：数据库查询是异步的，需使用async/await或Promise处理，避免阻塞事件循环。
• 错误处理：用try-catch捕获数据库连接或查询错误，返回友好的错误JSON（如500状态码）。
• 连接管理：频繁创建和关闭数据库连接会影响性能，生产环境建议使用连接池（如MongoDB的MongoClient默认启用连接池）。

进阶优化：统一响应格式与错误处理

实际项目中,API的响应格式需要统一（如所有接口均返回code、message、data字段），错误处理也需要规范，以下是优化方案：

统一响应格式中间件

// 统一成功响应
const successResponse = (data, message = 'success') => ({
    code: 200,
    message,
    data
});
// 统一错误响应
const errorResponse = (code, message, error = null) => ({
    code,
    message,
    error: error ? error.message : null
});
// 使用示例
app.get('/api/user/:id', (req, res) => {
    const userId = req.params.id;
    const user = mockUsers.find(u => u.id === parseInt(userId));
    if (user) {
        res.json(successResponse(user, '获取用户成功'));
    } else {
        res.status(404).json(errorResponse(404, '用户不存在'));
    }
});

全局错误处理中间件

Express支持全局错误处理中间件,捕获未处理的异常，避免返回HTML错误页面（默认行为）。

// 定义全局错误处理中间件（需放在所有路由之后）
app.use((err, req, res, next) => {
    console.error(err.stack); // 打印错误堆栈（开发环境）
    res.status(500).json(errorResponse(500, '服务器内部错误', err));
});
// 测试接口：触发错误
app.get('/api/error', (req, res) => {
    throw new Error('这是一个测试错误');
});

常见问题与解决方案

中文乱码

现象：返回的JSON中包含中文时，显示为"message": "\u4f60\u597d"（Unicode编码）。
原因：未设置