Spray handle Post request

2017-06-22 本文已影响185人 HelloMyUniverse

应用rest层使用的是spray库，之前使用GET REQUEST比较多，
现在用到POST　REQUEST了，现在记录总结下

HTTP/1.1 协议规定的 HTTP 请求方法有 OPTIONS、GET、HEAD、POST、PUT、DELETE、TRACE、CONNECT 这几种。其中 POST 一般用来向服务端提交数据，本文主要讨论 POST 提交数据的几种方式。
我们知道，HTTP 协议是以 ASCII 码传输，建立在 TCP/IP 协议之上的应用层规范。规范把 HTTP 请求分为三个部分：状态行、请求头、消息主体。类似于下面这样：

<method> <request-URL> <version>
<headers>
<entity-body>```

![Paste_Image.png](https://img.haomeiwen.com/i4276875/2543a84f50894944.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)

> 协议规定 POST 提交的数据必须放在消息主体（entity-body）中，但协议并没有规定数据必须使用什么编码方式。实际上，开发者完全可以自己决定消息主体的格式，只要最后发送的 HTTP 请求满足上面的格式就可以。
但是，数据发送出去，还要服务端解析成功才有意义。一般服务端语言如 php、python 等，以及它们的 framework，都内置了自动解析常见数据格式的功能。服务端通常是根据请求头（headers）中的 Content-Type 字段来获知请求中的消息主体是用何种方式编码，再对主体进行解析。所以说到 POST 提交数据方案，包含了 Content-Type 和消息主体编码方式两部分。下面就正式开始介绍它们。
POST 提交数据方式有四种：
1. application/x-www-form-urlencoded
2. multipart/form-data
3. application/json
4. text/xml
***
spray 如何 handle 这些 request

##### 1. application/x-www-form-urlencoded
> 这应该是最常见的 POST 提交数据的方式了。浏览器的原生 <form> 表单，如果不设置 enctype 属性，那么最终就会以 application/x-www-form-urlencoded 方式提交数据。请求类似于下面这样（无关的请求头在本文中都省略掉了）：

POST http://www.example.com HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8
title=test&sub%5B%5D=1&sub%5B%5D=2&sub%5B%5D=3

> 首先，Content-Type 被指定为 application/x-www-form-urlencoded；其次，提交的数据按照 key1=val1&key2=val2 的方式进行编码，key 和 val 都进行了 URL 转码。大部分服务端语言都对这种方式有很好的支持。例如 PHP 中，$_POST['title'] 可以获取到 title 的值，$_POST['sub'] 可以得到 sub 数组。
很多时候，我们用 Ajax 提交数据时，也是使用这种方式。例如 [JQuery](http://jquery.com/) 和 [QWrap](http://www.qwrap.com/) 的 Ajax，Content-Type 默认值都是「application/x-www-form-urlencoded;charset=utf-8」。

spray handle

path("uploadMeasurementItems") {
post {
detach() {
entity(as[FormData]) {
measurementItems =>
{
complete(s"""--token: ${measurementItems.fields(0) _2}""")
/if (measurementItems.token == AuthorityConfig.authorityToken){
new MeasurementItemsService(measurementItems).upload2Redshift match {
case true => complete(200,"ok,upload measurementItems success")
case false => complete(500,"inner server error")
}
//Todo: 解析数据，粗略保证数据正确性，如检测data不为空，本地暂存，定时批量解析数据并连接redshift入库
//complete("measurementItems type: " + measurementItems.flag + "measurementItems data: " + measurementItems.measurementItem)
}
else {
complete(401,"token error,access denied")
}/
}

重点在与 FormData class
源码：

package spray.http

import spray.http.HttpHeaders._

sealed trait HttpForm {
type FieldType
def fields: Seq[FieldType]
}

/**

Model for application/x-www-form-urlencoded form data.
*/
case class FormData(fields: Seq[(String, String)]) extends HttpForm { // TODO: better FormData(query: Uri.Query)?
type FieldType = (String, String)
}

object FormData {
val Empty = FormData(Seq.empty)
def apply(fields: Map[String, String]): FormData = this(fields.toSeq)
}

根据注释也可以看到　case class FormData  Model for `application/x-www-form-urlencoded` form data
于是　entity-body　中的多个　key-value　转换成
有一个名为　fields　的Seq(String,String)类型字段,
那么我们就可以通过处理field字段来获得我们想要的参数

##### 2. multipart/form-data
在同一个源代码文件中还定义了`multipart/form-data`的handle　case class

/**

Model for multipart/form-data content as defined in RFC 2388.
All parts must contain a Content-Disposition header with a type form-data
and a name parameter that is unique
*/
case class MultipartFormData(fields: Seq[BodyPart]) extends HttpForm { // TODO: fields: BodyPart* is probably better
type FieldType = BodyPart
def get(partName: String): Option[BodyPart] = fields.find(.name.exists( == partName))
}

object MultipartFormData {
val Empty = MultipartFormData(Seq.empty)
def apply(fields: Map[String, BodyPart]): MultipartFormData = this{
fields.map {
case (key, value) ⇒ value.copy(headers = Content-Disposition("form-data", Map("name" -> key)) +: value.headers)
}(collection.breakOut)
}
}

根据源码我们也可以看到，我们的entity-body 被转换成了fields: Seq[BodyPart]，还定义了　get 方法
> 这种方式一般用来上传文件，各大服务端语言对它也有着良好的支持。
上面提到的这两种 POST 数据的方式，都是浏览器原生支持的，而且现阶段标准中原生 <form> 表单也[只支持这两种方式](http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4)（通过 <form> 元素的 enctype
 属性指定，默认为 application/x-www-form-urlencoded
。其实 enctype
 还支持 text/plain
，不过用得非常少）。
随着越来越多的 Web 站点，尤其是 WebApp，全部使用 Ajax 进行数据交互之后，我们完全可以定义新的数据提交方式，给开发带来更多便利。

##### 3.　application/json
>　application/json 这个 Content-Type 作为响应头大家肯定不陌生。实际上，现在越来越多的人把它作为请求头，用来告诉服务端消息主体是序列化后的 JSON 字符串。由于 JSON 规范的流行，除了低版本 IE 之外的各大浏览器都原生支持 JSON.stringify，服务端语言也都有处理 JSON 的函数，使用 JSON 不会遇上什么麻烦。
JSON 格式支持比键值对复杂得多的结构化数据，这一点也很有用。记得我几年前做一个项目时，需要提交的数据层次非常深，我就是把数据 JSON 序列化之后来提交的。不过当时我是把 JSON 字符串作为 val，仍然放在键值对里，以 x-www-form-urlencoded 方式提交。

之前用AJAX都是使用json来交换信息

> 这种方案，可以方便的提交复杂的结构化数据，特别适合 RESTful 的接口。各大抓包工具如 Chrome 自带的开发者工具、Firebug、Fiddler，都会以树形结构展示 JSON 数据，非常友好。

path("uploadMeasurementItems"/"another") {
post {
detach() {
entity(as[MeasurementItems]) {
measurementItems =>
{
//complete(s"""--token: ${measurementItems.fields(0)}""")
if (measurementItems.token == AuthorityConfig.authorityToken){
new MeasurementItemsService(measurementItems).upload2Redshift match {
case true => complete(200,"ok,upload measurementItems success")
case false => complete(500,"inner server error")
}
//Todo: 解析数据，粗略保证数据正确性，如检测data不为空，本地暂存，定时批量解析数据并连接redshift入库
//complete("measurementItems type: " + measurementItems.flag + "measurementItems data: " + measurementItems.measurementItem)
}
else {
complete(401,"token error,access denied")
}
}

当然这种方式要定义自定义　case class 的 unmashaller

object MeasurementItemsJsonImplicits extends DefaultJsonProtocol {
implicit val CustomerInfoJson = jsonFormat9(CustomerInfo)
implicit val MeasurementItemDetailJson = jsonFormat2(MeasurementItemDetail)
implicit val MeasurementItemInfoJson = jsonFormat2(MeasurementItemInfo)
implicit val AnalysisReportJson = jsonFormat6(AnalysisReport)
implicit val MeasurementItemsJson = jsonFormat9(MeasurementItems)
}


##### ４.text/xml
暂时没用过

参考：[四种常见的 POST 提交数据方式](https://imququ.com/post/four-ways-to-post-data-in-http.html)

Spray handle Post request

猜你喜欢

热点阅读