Parse-Server 所见所闻所用

Parse-compatible API server module for Node/Express

目录

---

• 1.简介
• 2.查询
• 3.云代码

介绍

---

Parse-Server 是一款开源的、基于nodejs的后端框架 ， 可以基于它进行产品的后端restful api的开发 ，用于提高中小型应用的开发效率。
github地址

优点：

1. 通用接口支持（post , get , put ,delete）： 不同表名进行不同表的操作。
2. 默认使用mongodb作为数据库 ：可直接操作数据，无需第三方数据库orm。
3. 支持通用查询筛选 ：分页、条件筛选(关联与非关联字段)、排序等。
4. 支持云代码 : trigger ，自定义云函数的支持，方便编写业务逻辑。
5. 可结合express ： 拓展方便。

缺点：

1. 对于一些功能较复杂的需求就不太适合。
2. 数据库操作功能有限。

使用场景：
适合一些资讯类应用、没有太复杂的业务逻辑

Demo

---

一. 环境准备

1. nodejs : 自行下载安装 -> 官网
2. mongodb : 可用docker安装,或者 npm install -g mongodb-runner
3. parse-server : npm install -g parse-server

运行：

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

这样，一个通用的后端restful api服务器不用谢任何的代码就搭建完毕，可用对外提供服务了，

二. 使用

很多应用都用banner模块，用于首页展示，下面实现banner管理功能来演示，其实不用写代码就已经完成了。

接口文档：

接口地址： http://localhost:1337
header    :   {"X-Parse-Application-Id: APPLICATION_ID"}

# ***** BANNER *****

#### POST  /parse/classes/banner
 /*
    body : {
        link    : string ,
        title   : string ,
        uri     : string 
    }
*/

#### GET  /parse/classes/banner

#### GET  /parse/classes/banner/:_id 
 /*
    params : {
        _id    : objectId 
    }
*/

#### PUT  /parse/classes/banner/:_id  
 /*
    params : {
        _id    : objectId 
    }

    body : {
        link?    : string ,
        title?   : string ,
        uri?     : string 
    }
*/

#### DELETE  /parse/classes/banner/:_id
 /*
    params : {
        _id    : objectId
    }
*/

查询

一个后端api，免不了的就是数据的查询（前端、后台管理）。
对数据的查询我们通常有以下需求：

• 简单查询、返回某表的所有数据
• 基本数据操作
  • 分页 （skip、limit、count）
  • 排序
  • 数据精简
• 数据筛选 (精确匹配、模糊匹配)
  • 直接字段筛选
  • 引用字段筛选

下面以一个例子解析，对于以上查询需求，在parse-server中是如何操作的：

** 数据结构：**

_User = {
    name: String
}

Banner = {
    url: String,
    title: String,
    user: {
        type: mongoose.Schema.Types.ObjectId,
        ref: '_User'
    }
}

** 操作：**

1. 简单查询
    http://localhost:1337/parse/classes/banner

2. 分页（一页10条数据）
    第一页 ：http://localhost:1337/parse/classes/banner?limit=10&skip=0&count=true
    第二页 ：http://localhost:1337/parse/classes/banner?limit=10&skip=10&count=true

3. 排序
    正序 ： http://localhost:1337/parse/classes/banner?order=createdAt
    倒序 ： http://localhost:1337/parse/classes/banner?order=-createdAt

4. 数据精简
    只返回url和title字段：http://localhost:1337/parse/classes/banner?keys=url,title

5. 直接字段筛选
    筛选出title='活动’的数据: http://localhost:1337/parse/classes/banner?where={"title":"活动"}

6. 引用字段筛选
    因为banner中user字段是引用字段，指向另外一张_User表，
    如果想找出用户名为“管理员”发表的所有banner，如下： 
    http://localhost:1337/parse/classes/banner?where={"user":{"$inQuery":{"where":{"name":"管理员"},"className":"_User"}}}

7. 模糊匹配
    获取title包含“山”的banner ： http://localhost:1337/parse/classes/banner?where={"title":{"$regex":"山"}}

以上是对数据查询的普遍需求，如果需要更多的帮助，可以观看官网

注意：在提交数据的时候，如果需要将字段指向另外一张表，字段格式如下：

"user":{"__type":"Pointer","className":"_User","objectId":"OExWiU5QCl"}

云代码

对于一个应用，业务逻辑是必须有的，所以parse-server提供了云代码，让用户可以编写业务逻辑代码。

云代码分两种：

1. 云函数
2. 钩子函数 hook

• beforeSave
• afterSave
• beforeDelete
• afterDelete

启动云代码模式：

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

在cloud目录下，parse-server会读取main.js文件。

下面实现一个云函数（获取banner的数量）:

Parse.Cloud.define("bannerCount", function(request, response) {
  var query = new Parse.Query("banner");
  query.find({
    success: function(results) {
      response.success(results.length);
    },
    error: function() {
      response.error("failed");
    }
  });
});

访问云函数：

http://localhost:1337/parse/functions/bannerCount

下面实现一个钩子函数 （删除banner以后发送短信给管理员）:

Parse.Cloud.afterDelete('banner', function(request, response) {
    //短信发送代码
    if(成功){
        response.success();
    }else{
        response.error("failed");
    }
});

如果需要更多的帮助，可以观看cloudcode文档

结合express实例：

var express = load('express');
var ParseServer = load('parse-server').ParseServer;
var env = load('./config/env');
var busboy = load('connect-busboy');
var app = new express();

process.env.NODE_TLS_REJECT_UNAUTHORIZED = "0";

var api = new ParseServer({
    databaseURI: env.parse.databaseURI,
    cloud: env.parse.cloud,
    appId: env.parse.appId,
    masterKey: env.parse.masterKey,
    serverURL: env.parse.serverURL
});

app.all('*', function(req, res, next) {
   const headers = [
        'X-Authorization-Token',
        'Content-Type',
        'X-Requested-With',
        'X-Error-Extra',
        'X-APP-PLATFORM',
        'X-Parse-Application-Id',
        'x-parse-rest-api-key',
        'x-parse-session-token'
    ];
    res.header('Access-Control-Allow-Origin', '*');
    res.header('Access-Control-Allow-Methods', 'PUT, GET, POST, DELETE, OPTIONS');
    res.header('Access-Control-Allow-Headers', headers.join(','));
     // intercept OPTIONS method
    if ('OPTIONS' == req.method) {
      res.send(200);
    }
    else {
      next();
    }
});

app.use('/parse', api);

module.exports = app;

附上资源链接：

SDK : 前往