Akka实战：构建REST风格的微服务

时间 2019-11-08

标签 akka 实战构建 rest 风格微服繁體版

原文原文链接

使用Akka-Http构建REST风格的微服务，服务API应尽可能遵循REST语义，数据使用JSON格式交互。在有错误发生时应返回：{"errcode":409,"errmsg":"aa is invalid，the ID is expected to be bb"}相似的JSON错误消息。html

代码：react

代码

首先来看看代码文件结构：git

├── ApiRoute.scala
├── App.scala
├── ContextProps.scala
├── book
│   ├── Book.scala
│   ├── BookContextProps.scala
│   ├── BookRoute.scala
│   └── BookService.scala
└── news
    ├── News.scala
    ├── NewsContextProps.scala
    ├── NewsRoute.scala
    └── NewsService.scala

经过名字能够看出，App.scala是启动程序，以Route结尾的是API路由定义文件，Service结尾的就是服务实现代码了。ContextProps结尾的是服务与路由交互的上下文属性部分，Service的将会在ContextProps中实例化并传给各个Route。github

从目录结构上看，程序是按功能模块进行划分的。book相关的路由、服务、实体都定义在book包下。相应的，与news相关的代码则写于news包。数据库

首先来看看程序的启动文件，App.scala编程

def main(args: Array[String]): Unit = {
    Files.write(Paths.get("app.pid"), Utils.getPid.getBytes(Utils.CHARSET))

    val contextProps = new ContextProps

    val bindingFuture = Http().bindAndHandle(ApiRoute(contextProps), "0.0.0.0", 3333)

    bindingFuture.onComplete {
      case Success(binding) =>
        logger.info(binding.toString)
      case Failure(e) =>
        logger.error(e.getLocalizedMessage, e)
    }
  }

定义akka-http绑定的host和port，设置ContextProps，并把它传给ApiRoute。App.scala的代码仍是很简单的，接下来看看ApiRoute的实现。json

// 定义一个Health Check API，用户第3方工具（如：Nginx/Tengine）验证服务是否正常运行
  val healthCheck =
    path("health_check") {
      get { ctx =>
        logger.debug(ctx.request.toString)
        ctx.complete(HttpEntity.Empty)
      }
    }

  import me.yangbajing.akkaaction.util.JsonSupport._

  val customExceptionHandler = ExceptionHandler {
    case e: MessageException =>
      extractRequest { req =>
        val msg =
          s"""\nmethod: ${req.method}
             |uri: ${req.uri}
             |headers:
             |\t${req.headers.mkString("\n\t")}
             |$e""".stripMargin
        if (e.errcode > 500) logger.error(msg, e)
        else logger.warn(msg)

        complete(
          StatusCodes.getForKey(e.errcode) getOrElse StatusCodes.InternalServerError,
          JObject("errcode" -> JInt(e.errcode), "errmsg" -> JString(e.errmsg)))
      }
    case e: Exception =>
      extractRequest { req =>
        logger.error(req.toString, e)
        complete(
          StatusCodes.InternalServerError,
          JObject("errcode" -> JInt(500), "errmsg" -> JString(e.getLocalizedMessage)))
      }
  }

  def apply(props: ContextProps)(implicit ec: ExecutionContextExecutor, mat: Materializer) =
    handleExceptions(customExceptionHandler) {
      pathPrefix("api") {
        healthCheck ~
          NewsRoute(props) ~
          BookRoute(props)
      }
    }

代码有一点长，如今分别解说。api

customExceptionHandler并发

自定义的异常处理器，主要用于把自定义异常和系统异常转换成JSON消息输出，并设置相对应的HTTP状态码。app

apply

apply方法定义了实现的API路由，由代码能够看到news、book两个模块的路由分别由NewsRoute和BookRoute两个文件定义。把相同功能的路由、服务、实体定义在同一个逻辑上下文（包）中，我的认为是一种更好的微服务实践。

book模块详解

book
├── Book.scala
├── BookContextProps.scala
├── BookRoute.scala
└── BookService.scala

Book：实体
BookContextProps：上下文属性，服务将在此实例化。并把接口混入ContextProps中。
BookRoute：API路由定义
BookService：服务功能实现

BookRotue定义

pathPrefix("book") {
      pathEnd {
        post {
          entity(as[Book]) { book =>
            onSuccess(props.bookService.persist(book)) { result =>
              complete(StatusCodes.Created, result)
            }
          }
        }
      } ~
        path(Segment) { bookId =>
          get {
            complete(props.bookService.findOneById(bookId))
          } ~
            put {
              entity(as[Book]) { book =>
                complete(props.bookService.updateById(bookId, book))
              }
            } ~
            delete {
              complete(props.bookService.deleteById(bookId).map(id => Map("id" -> id)))
            }
        }

Akka-Http提供了高级routing DSL，能够很天然的定义出树型结构的RESTful风格的API。由代码可见，定义了4个API。分别对应insert、select、update、delete操做，由post、get、put和delete4个指令实现对应操做的HTTP方法。

pathPrefix、pathEnd和path3个路径定义指令的区别在于pathPrefix表明由它定义的路径还并未终结，在它下面还有子路径。而path则表明它已是最终的路径了，pathEnd是用于在使用了pathPrefix的状况下也能够直接访问由pathPrefix指定的路径。

Segment用于把由path定义的路径抽取成一个参数（bookId）。除了Segment用于抽取一个字符串类型，还有IntNumber和LongNumber用于抽取路径为Int或Long类型。

entity指令用于抽取HTTP请求的body部分，并经过as[T]方法将其自动解析为指定类型。这里使用到了akka提供的Unmarshaller特性。这里经过JsonSupport里定义的json4sUnmarshaller将用户请求提交的JSON字符串映射到Book类型。

implicit def json4sUnmarshaller[A: Manifest](implicit mat: Materializer): FromEntityUnmarshaller[A] =
    Unmarshaller.byteStringUnmarshaller
      .forContentTypes(MediaTypes.`application/json`)
      .mapWithCharset { (data, charset) =>
        val input = if (charset == HttpCharsets.`UTF-8`) data.utf8String else data.decodeString(charset.nioCharset().name)
        jsonSerialization.read(input)
      }

  implicit def json4sMarshaller[A <: AnyRef]: ToEntityMarshaller[A] =
    Marshaller.StringMarshaller.wrap(ContentType(MediaTypes.`application/json`, HttpCharsets.`UTF-8`))(v =>
      jsonSerialization.write[A](v))

天然json4sMarshaller则是把T类型的对象映射为JSON字符串响应给请求方。

BookService

再来看看BookService服务的实现。

def updateById(bookId: String, book: Book)(implicit ec: ExecutionContext): Future[Book] = Future {
    if (bookId != book.id)
      throw MeConflictMessage(s"${book.id} is invalid，the ID is expected to be $bookId")

    val newBooks = BookService.books.filterNot(_.id == bookId)
    if (newBooks.size == BookService.books.size)
      throw MeNotFoundMessage(s"$bookId not found")

    BookService.books ::= book
    book
  }

  def persist(book: Book)(implicit ec: ExecutionContext): Future[Book] = Future {
    if (BookService.books.exists(_.id == book.id))
      throw MeConflictMessage(s"${book.id} exsits")

    BookService.books ::= book
    book
  }

  def deleteById(bookId: String)(implicit ec: ExecutionContext): Future[String] = Future {
    val newBooks = BookService.books.filterNot(_.id == bookId)
    if (newBooks.size == BookService.books.size)
      throw MeNotFoundMessage(s"$bookId not found")

    BookService.books = newBooks
    bookId
  }

  def findOneById(bookId: String)(implicit ec: ExecutionContext): Future[Book] = Future {
    BookService.books.find(_.id == bookId).getOrElse(throw MeNotFoundMessage(s"$bookId not found"))
  }

看到每一个方法的返回值都被定义成了Future[T]，akka-http是一个基于akka-actor和akka-stream的异步HTTP工具集，使用Future能够提供整个系统的响应。咱们这里直接使用Future来模拟异步访问（数据库操做）。

在每一个方法中，咱们校验参数是否有效。若校验失败则直接抛出自定义异常。Future函数将捕获异常，由以前定义的customExceptionHandler自定义异常处理器来将自定义异常转换成JSON消息发送给调用方，并设置匹配的HTTP状态码。

测试

百闻不如一试，下载代码实际操做下（下载地址在文章开头）。

运行程序：

./sbt
akka-action > runMain me.yangbajing.akkaaction.restapi.App

依次执行docs/scripts/restapi目录下的测试脚本，查看各请求下REST API的返回值（须要系统安装curl）。

./get-book-aa.sh：正常返回ID为aa的书
./get-book-bb.sh：查找ID为bb的书返回404
./post-book.sh：建立一本ID为bb的书，返回201
./get-book-bb.sh：正确返回ID为bb的书
./put-book.hs：正确更新ID为bb的书
./put-book-invalid.sh：无效的更新ID为aa的书，返回409
./delete-book-aa.sh：成功的删除ID为aa的书
./get-book-aa.sh：再次查找ID为aa的书返回404
./delete-book-aa.sh：再次删除ID为aa的书时返回404

总结

akka-http是一个颇有意思的HTTP工具库，它完整的实现了客户端和服务端编程工具，还支持WebScoket。基于akka-actor和akka-stream，提供了高并发的异步编程模型。咱们能够很快捷的实现出一个响应式（Reactive）Web Service。其提供的routing DSL可方便的定义出一套树型结构的API，很天然的匹配到RESTful风格的API设计。