使用Finatra构建优雅的REST API：Twitter技术栈实战-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00768/article/details/148464433

使用Finatra构建优雅的REST API：Twitter技术栈实战

52-technologies-in-2016 Let's learn a new technology every week. A new technology blog every Sunday in 2016. 项目地址: https://gitcode.com/gh_mirrors/52/52-technologies-in-2016

Finatra是Twitter开源的一个基于Scala语言的REST API框架，它构建在Twitter的Scala技术栈之上，包括twitter-server、finagle和twitter-util等组件。本文将带你深入了解如何使用Finatra构建一个完整的REST API应用。

技术栈概述

Finatra的核心构建在以下几个Twitter开源项目之上：

Finagle：一个高性能的RPC系统，用于构建高并发服务器
Twitter Server：定义了Twitter内部服务器的标准模板
Twitter-Util：提供了一系列Scala实用工具库

Finatra 2.x版本相比1.x有显著的性能提升，据官方文档称性能提高了50倍。

开发环境准备

在开始之前，请确保你的开发环境满足以下要求：

Scala 2.11.7或更高版本
JDK 8
推荐使用IntelliJ IDEA Community Edition作为开发IDE

项目实战：构建体重追踪应用

我们将开发一个名为"Fitman"的体重追踪应用，用户可以每周记录自己的体重和状态信息。

第一步：创建项目结构

使用SBT创建一个新的Scala项目，项目结构如下：

fitman/
├── src/
│   ├── main/
│   │   └── scala/
│   │       └── com/
│   │           └── example/
│   │               └── FitmanApp.scala
│   └── test/
│       └── scala/
│           └── com/
│               └── example/
│                   └── HelloControllerFeatureTest.scala
└── build.sbt

第二步：配置项目依赖

在build.sbt中添加必要的依赖：

name := "fitman"
version := "1.0"
scalaVersion := "2.11.7"

lazy val versions = new {
  val finatra = "2.1.2"
  val logback = "1.1.3"
}

libraryDependencies += "com.twitter.finatra" % "finatra-http_2.11" % versions.finatra
libraryDependencies += "com.twitter.finatra" % "finatra-slf4j_2.11" % versions.finatra
libraryDependencies += "ch.qos.logback" % "logback-classic" % versions.logback

第三步：创建基础服务器

创建一个基础的Finatra HTTP服务器：

import com.twitter.finatra.http.HttpServer

object FitmanApp extends FitmanServer

class FitmanServer extends HttpServer {
  override protected def configureHttp(router: HttpRouter): Unit = {
    // 这里将配置路由
  }
}

第四步：实现Hello World端点

添加第一个控制器和路由：

import com.twitter.finagle.http.Request
import com.twitter.finatra.http.routing.HttpRouter
import com.twitter.finatra.http.{Controller, HttpServer}

class HelloController extends Controller {
  get("/hello") { request: Request =>
    "Fitman says hello"
  }
}

class FitmanServer extends HttpServer {
  override protected def configureHttp(router: HttpRouter): Unit = {
    router.add(new HelloController)
  }
}

启动应用后，访问http://localhost:8888/hello将看到返回的问候信息。

第五步：实现体重记录功能

定义体重数据模型：

import org.joda.time.Instant

case class Weight(
  user: String,
  weight: Int,
  status: Option[String],
  postedAt: Instant = Instant.now()
)

实现体重记录控制器：

import com.twitter.finagle.http.Request
import com.twitter.finatra.http.Controller
import com.twitter.inject.Logging
import scala.collection.mutable

class WeightResource extends Controller with Logging {
  private val db = mutable.Map[String, List[Weight]()
  
  post("/weights") { weight: Weight =>
    val weightsForUser = db.get(weight.user) match {
      case Some(weights) => weights :+ weight
      case None => List(weight)
    }
    db.put(weight.user, weightsForUser)
    response.created.location(s"/weights/${weight.user}")
  }
  
  get("/weights/:user") { request: Request =>
    db.getOrElse(request.params("user"), List())
  }
}

第六步：添加输入验证

Finatra提供了丰富的验证注解：

import com.twitter.finatra.validation.{NotEmpty, Range}

case class Weight(
  @NotEmpty user: String,
  @Range(min = 30, max = 200) weight: Int,
  status: Option[String],
  postedAt: Instant = Instant.now()
)

当输入不符合要求时，Finatra会自动返回400 Bad Request响应。

第七步：实现集成测试

Finatra提供了强大的测试支持：

import com.twitter.finagle.http.Status
import com.twitter.finatra.http.test.EmbeddedHttpServer
import com.twitter.inject.server.FeatureTest

class WeightResourceFeatureTest extends FeatureTest {
  override val server = new EmbeddedHttpServer(new FitmanServer)

  "WeightResource" should {
    "Save user weight when POST request is made" in {
      server.httpPost(
        path = "/weights",
        postBody = """{"user":"test","weight":85}""",
        andExpect = Status.Created
      )
    }
    
    "Return bad request for invalid input" in {
      server.httpPost(
        path = "/weights",
        postBody = """{"weight":85}""",
        andExpect = Status.BadRequest
      )
    }
  }
}

高级特性

1. 管理接口

Finatra默认提供了一个管理接口，访问地址为http://localhost:9990/admin。这个接口提供了系统监控、性能分析等功能。

2. 服务器配置

可以通过多种方式配置服务器：

class FitmanServer extends HttpServer {
  override protected def defaultFinatraHttpPort: String = ":8080"
  override protected def defaultHttpServerName: String = "FitMan"
  
  // 其他配置...
}

3. 日志记录

Finatra使用SLF4J API进行日志记录，推荐使用Logback作为实现：

class WeightResource extends Controller with Logging {
  get("/weights") { request: Request =>
    info("Processing weights request")
    // 业务逻辑
  }
}