App[后端开发] Wiki

开发

部署测试流程

$ ssh qiaobutang@10.1.1.223
$ cd apptest
$ jps -lvm | grep 8888
$ kill <pid>
$ ./start_resume.sh

Restful API规范

API 命名规则

URL Pattern Matching

Notice:

• 获取Id用: 抽取器ObjectIdExtractor

case req @ Req("group" :: ObjectIdExtractor(groupId) :: "post" :: Nil, "json", PostRequest)

• 提取其它参数
  现统一采用重req获取的方式，client端也会把参数不放在URL Path中

subject <- req.param("subject").failMsg("请输入主题")

如下方式会存在问题

case req @ Req("jobs" :: suffix :: Nil, "json", GetRequest) if suffix == "recommend"
//warning 如果不加守卫，可能会把别的API(如： jobs/apply/.. )给匹配到

• 常量首字母大写

val Suffix = "recommend"
case req @ Req("jobs" :: Suffix :: Nil, "json", GetRequest)

返回值结构

基本结构

一个api 返回的基本json结构

{
   "resultCode": status code
   "resultBody": {
     ...
   }
   ....
}

返回值类型

每个API的返回值类型为Box[JObject]

type DispatchPF = PartialFunction[Req, Box[JObject]]

返回方式

//1. Full
Full(error ~ ("failureCauses" -> fieldError.map(_.msg.toString())))
//2. Box.legacyNullTest
Box.legacyNullTest {
  "categories" -> BBSGroup.Categories.values.toList.sortBy(_.id).map(categoryInfo)
}
//3. Box.map
getAccountId_!(req).map { accountId =>
   ("json" -> "ok")
}

status code

forbidden 403

• 不存在此api
• sig不正确

Notice: 目前还未有需要主动返回403的情况

error 400

触发原因：

• failMsg(...)
• error ~ ("failureCause" -> "该用户没有删除权限")

基本结构：

{
   "resultCode": 400
   "failureCause" : "...."
}

Notice: 建议调用errorWith(msg)方法取代直接返回 error ~ ("failureCause" -> msg)

NotFound 404

对于一些resource/{id}的请求，在查找不到（包含逻辑删除）该id的对象时返回notFound

case req @ Req("group" :: "post" :: ObjectIdExtractor(postId) :: "like" :: Nil, "json", PostRequest) =>
  getAccountId_!(req).map { accountId =>
    BBSPost.getLiveById(postId).map[JObject] { post =>
      ...
    }.getOrElse(notFound)
}

自定义code

自定义: 和client端商量后选取一个code, 作为某个api的返回值
作用域： 仅限于单个api中

complete(406) //告诉client端，重复操作了

Notice: 加注释

NoMessage

对于Post等不需要返回数据的请求, 返回NoMessage

case req @ Req("group" :: ObjectIdExtractor(groupId) :: "join" :: Nil, "json", PostRequest) =>
  getAccountId_!(req).map { accountId =>
    ...
    NoMessage
  }

Error Message

failureCause 单个错误提示

errorWith(msg)
error ~ ("failureCause" -> msg)

failureCauses 多个错误提示

error ~ ("failureCauses" -> fieldError.map(_.msg.toString()))

代码结构

包结构

com.qiaobutang.resume.app
                       |_App.scala (主入口)
                          |_api (存放resource)
                             |_Group.scala
                             |_Job.scala
                             |_Career.scala
                             |_....scala

Getting Started

• 添加Resource
  在com.qiaobutang.resume.app.api包下新建{Resource}.scala

    object Resource extends AppResource {
      ...
    }

• 实现serve方法

val serve: DispatchPF = {
  ...
}

• 在serve方法内添加URL Pattern matching

val serve: DispatchPF = {
    case Req("path" :: Nil, "json", GetRequest) => {
      ...
    }
    ...

• 在App的services方法中添加Resource

override val services: LiftRules.DispatchPF =
    List(..., Resource).map { r => ...

app package object

• 放置与JObject无关的公共方法
• 图片分辨率Map

RangeQuery

3n+1规则

Getting Started

查询优化

• 尽量避免在循环遍历中（map, fold...）中发送查询请求；通过获取ids，发送In查询来得到结果集并根据需要做groupBy来生成Map, 在循环遍历中查询Map

其它通用组件

Default Resolution

获取默认分辨率

defaultResolution(req: Req)

SocialProfile

获取用户头像，性别，昵称等社交信息

Scene.getSocialProfile(resolution: String)(accountId: ObjectId)

图片上传

Group.uploadImageAndGetIds(req: Req, imageModel: MongoModelMeta[T], accountId: ObjectId)