车流量 Restful API

RESTful是什么

RESTful，是目前最为流行的一种互联网软件架构。因为它结构清晰、符合标准、易于理解、扩展方便，所以正得到越来越多网站的采用。学习RESTful，首先要学习REST。

REST

• 资源（Resources） REST是"表现层状态转化"，其实REST省略了主语。"表现层"其实指的是"资源"的"表现层"。一张图片、一个文档、一个视频等。这些资源我们通过URI来定位，也就是一个URI表示一个资源。

• 表现层（Representation）
  资源是做一个具体的实体信息，他可以有多种的展现方式。例如一个txt文本信息，他可以输出成html、json、xml等格式，一个图片他可以jpg、png等方式展现
  URI确定一个资源，但是如何确定它的具体表现形式呢？应该在HTTP请求的头信息中用Accept和Content-Type字段指定，这两个字段才是对"表现层"的描述。

• 状态转化（State Transfer）
  访问一个网站，就代表了客户端和服务器的一个互动过程。在这个过程中，肯定涉及到数据和状态的变化。而HTTP协议是无状态的，那么这些状态肯定保存在服务器端，所以如果客户端想要通知服务器端改变数据和状态的变化，肯定要通过HTTP来通知它。具体来说，就是HTTP协议里面，四个表示操作方式的动词：GET、POST、PUT、DELETE。它们分别对应四种基本操作：GET用来获取资源，POST用来新建资源（也可以用于更新资源），PUT用来更新资源，DELETE用来删除资源。

  RESTful API

  符合REST设计风格的Web API称为RESTful API。也就是说，RESTful是REST架构风格在WEB上的应用

  实现功能

• 访问所有车流量数据
  GET: /api/<Authen>/all

• 访问近一周车流量数据
  GET: /api/<Authen>/near

• 访问指定路口(crossID)即指定网关所有车流量数据
  GET: /api/<Authen>/cross/<crossID>

• 访问指定路口(crossID)即指定网关近3分钟实时车流量数据
  GET: /api/<Authen>/cross/<crossID>/last3min

• 访问指定路口(crossID)即指定网关一段时间车流量数据
  GET: /api/<Authen>/cross/<crossID>/start=<startTime>&end=<endTime>

  代码部分

• 数据库部分Flow.js
  建立Schema：创建

  var FlowSchema = new Schema({
   CrossTrafficData:{
       CrossID: String,
       DeviceType: String,
       DateTime: String,
       Interval: Number,
       DataList:{
           Data:{
               LaneNo: String,
               Volume: Number,
               AvgOccupancy: Number,
               AvgHeadTime: Number,
               AvgLength: Number,
               AvgSpeed: Number,
               Saturation: Number,
               Density: Number,
               Pcu: Number,
               AveQueueLength: Number,
               Volume1: Number,
               Volume2: Number,
               Volume3: Number,
               Volume4: Number,
               Volume5: Number
           }
       }
   }   
  });

  //exports对象：
  var FlowOp = function(){};
  //定义各种函数。prototype表示是给FlowOp对象用的,通过callback返回数据
  FlowOp.prototype.<name_function> = function([parametres],callback){}
  //定义一个Model对象方便使用Model封装的方法
  var FlowModel = mongodb.mongoose.model('flowCar',FlowSchema);
  //Model对象的find方法，参数：条件，投射，CB
  //下面这句表示筛选出参数id值和时间段的文件，并且提取后去除_id和__v属性。查询结果返回给data_id_p，进入回调函数

  FlowModel.find({'CrossTrafficData.CrossID': id,'CrossTrafficData.DateTime': {"$gt": start, "$lte": end}},'-_id -__v',(err,data_id_p)=>{});

  //回调函数，将js的obj转换为json，然后给callback赋值，传递json数值

  var data_p_json= JSON.stringify({data_p});
  callback(err,data_p_json);

• 路由routedata.js
  //Json转XML，借助jsontoxml包并加入xml声明，之前传递的json就是obj

  router.get('/cross/:id/start=:timestart&end=:timeend', (req, res) => {
   CarFlow.findByCrossByPeriod(req.params.id, req.params.timestart, req.params.timeend, (err, obj) => {
       var data_xml = jsontoxml(obj);
       res.set('Content-Type', 'text/xml');
       var d = '<?xml version="1.0" encoding="utf-8"?>';
       res.send(d + data_xml);
   });
  });

  反思

  可以在Schema建立函数，并且导出一个Model对象是否封装更好？

  mySchema.methods.findByCByP = function(paras, cb){
   return this.find({type: this.type}, cb);
  }

  Reference

  Rest：https://github.com/astaxie/build-web-application-with-golang/blob/master/zh/08.3.md

有疑问加站长微信联系（非本文作者）