parseplatform/parse-server

Parse Server 镜像文档

镜像概述和主要用途

Parse Server 是一个开源后端服务，可部署到任何能运行 Node.js 的基础设施。它提供了与原 Parse 托管服务兼容的 API，支持数据存储、用户认证、云代码（Cloud Code）、实时查询（Live Query）和 GraphQL 等功能，适用于快速构建移动应用、Web 应用的后端服务，或作为原 Parse 服务的替代方案。

!https://github.com/parse-community/parse-server/raw/master/.github/parse-server-logo.png

核心功能和特性

• 多数据库支持：兼容 MongoDB 4.0+ 和 PostgreSQL 11+（需配合 PostGIS 2.2+）
• REST API：提供完整的 RESTful API，支持数据的增删改查、用户管理、文件存储等
• 云代码（Cloud Code）：支持自定义业务逻辑，通过 JavaScript 编写服务器端函数
• 实时查询（Live Query）：允许客户端实时接收数据变更通知
• GraphQL 支持：提供 GraphQL API，简化数据查询和操作
• 用户认证与安全：支持***验证、密码重置、账户锁定策略、密码复杂度控制
• 自定义路由：可扩展的路由系统，支持添加自定义页面和业务流程
• 本地化：支持多语言页面和邮件模板
• 灵活的文件存储：支持多种文件存储适配器（本地文件系统、云存储等）

兼容性

Node.js

MongoDB

PostgreSQL

使用场景和适用范围

• 快速开发移动应用（iOS/Android）和 Web 应用的后端服务
• 需要自定义后端逻辑和灵活部署的项目
• 从原 Parse 托管服务迁移的应用
• 需要实时数据同步功能的应用（如聊天、协作工具）
• 需要 GraphQL API 支持的现代化应用开发

使用方法和配置说明

本地运行

1. 安装依赖：

   bash
   npm install -g parse-server mongodb-runner
   

2. 启动 MongoDB：

   bash
   mongodb-runner start
   

3. 启动 Parse Server：

   bash
   parse-server --appId APPLICATION_ID --masterKey MASTER_KEY --databaseURI mongodb://localhost/test
   

   注意：如果全局安装（-g）因权限问题失败（npm ERR! code 'EACCES'），请参考 npm 权限修复指南。

Docker 容器运行

构建和启动 MongoDB

bash
# 拉取 Parse Server 代码
git clone https://github.com/parse-community/parse-server
cd parse-server

# 构建 Docker 镜像
docker build --tag parse-server .

# 启动 MongoDB 容器
docker run --name my-mongo -d mongo

启动 Parse Server 容器

bash
docker run --name my-parse-server \
  -v config-vol:/parse-server/config \
  -p 1337:1337 \
  --link my-mongo:mongo \
  -d parse-server \
  --appId APPLICATION_ID \
  --masterKey MASTER_KEY \
  --databaseURI mongodb://mongo/test

使用云代码：如需启用云代码，添加 -v cloud-code-vol:/parse-server/cloud --cloud /parse-server/cloud/main.js 参数（确保 main.js 位于 cloud-code-vol 目录中）。

保存对象示例

使用 REST API 保存对象：

bash
curl -X POST \
  -H "X-Parse-Application-Id: APPLICATION_ID" \
  -H "Content-Type: application/json" \
  -d '{"score":1337,"playerName":"Sean Plott","cheatMode":false}' \
  http://localhost:1337/parse/classes/GameScore

响应示例：

json
{
  "objectId": "2ntvSpRGIK",
  "createdAt": "2016-03-11T23:51:48.050Z"
}

查询对象：

bash
curl -X GET \
  -H "X-Parse-Application-Id: APPLICATION_ID" \
  http://localhost:1337/parse/classes/GameScore

连接 SDK

Parse 提供各主流平台的 SDK（iOS、Android、JavaScript 等），配置 SDK 连接 Parse Server 时需指定 serverURL，例如：

javascript
// JavaScript SDK 示例
Parse.initialize("APPLICATION_ID");
Parse.serverURL = "http://localhost:1337/parse";

配置选项详解

基本选项

客户端密钥选项

如需要求客户端提供密钥，可配置以下参数（设置后所有请求需包含对应密钥）：

• clientKey
• javascriptKey
• restAPIKey
• dotNetKey

邮件验证和密码重置

需配置邮件适配器实现***验证和密码重置功能，示例配置：

javascript
const server = ParseServer({
  ...otherOptions,
  verifyUserEmails: true, // 启用邮箱验证
  emailVerifyTokenValidityDuration: 2 * 60 * 60, // 验证令牌有效期 2 小时
  emailAdapter: {
    module: 'parse-server-sendgrid-adapter', // 示例：SendGrid 适配器
    options: {
      apiKey: 'SENDGRID_API_KEY',
      fromAddress: 'noreply@example.com'
    }
  }
});

常用邮件适配器：

• parse-server-sendgrid-adapter（SendGrid）
• parse-server-mailgun-adapter-template（Mailgun）
• parse-server-simple-ses-adapter（AWS SES）

密码和账户策略

配置账户安全策略示例：

javascript
const server = ParseServer({
  ...otherOptions,
  accountLockout: {
    duration: 5, // 账户锁定 5 分钟
    threshold: 3, // 3 次登录失败后锁定
    unlockOnPasswordReset: true // 密码重置后解锁
  },
  passwordPolicy: {
    validatorPattern: /^(?=.*[a-z])(?=.*[A-Z])(?=.*[0-9])(?=.{8,})$/, // 8位以上，含大小写字母和数字
    doNotAllowUsername: true, // 密码不可包含用户名
    maxPasswordHistory: 5 // 禁止重用最近 5 次密码
  }
});

自定义路由（实验性功能）

通过 pages 配置添加自定义路由，示例：

javascript
const api = new ParseServer({
  ...otherOptions,
  pages: {
    enableRouter: true, // 启用自定义路由（实验性）
    customRoutes: [{
      method: 'GET',
      path: 'custom_route',
      handler: async request => {
        // 自定义逻辑
        return { file: 'custom_page.html' }; // 返回 HTML 文件
      }
    }]
  }
});

访问路径：https://[parseServerPublicUrl]/[parseMount]/[pagesEndpoint]/[appId]/custom_route

保留路径：verify_email、resend_verification_email、choose_password、request_password_reset 为系统内置路径，不可自定义。

环境变量配置

所有配置选项可通过环境变量设置，例如：

• PARSE_SERVER_APP_ID：对应 appId
• PARSE_SERVER_MASTER_KEY：对应 masterKey
• PARSE_SERVER_DATABASE_URI：对应 databaseURI

部署示例

Docker Compose 配置

yaml
version: '3'
services:
  mongo:
    image: mongo
    container_name: my-mongo
    restart: always
    volumes:
      - mongo-data:/data/db

  parse-server:
    build: .
    container_name: my-parse-server
    restart: always
    ports:
      - "1337:1337"
    volumes:
      - config-vol:/parse-server/config
      - cloud-code-vol:/parse-server/cloud
    environment:
      - PARSE_SERVER_APP_ID=APPLICATION_ID
      - PARSE_SERVER_MASTER_KEY=MASTER_KEY
      - PARSE_SERVER_DATABASE_URI=mongodb://mongo/test
      - PARSE_SERVER_CLOUD=/parse-server/cloud/main.js
    depends_on:
      - mongo

volumes:
  mongo-data:
  config-vol:
  cloud-code-vol:

更多资源

• 官方文档
• API 参考
• 云代码指南
• https://github.com/parse-community/parse-server
• 社区论坛