scalaj-http 使用教程

scalaj-http 使用教程

scalaj-http Simple scala wrapper for HttpURLConnection. OAuth included. 项目地址: https://gitcode.com/gh_mirrors/sc/scalaj-http

1. 项目介绍

scalaj-http 是一个简单且功能齐全的 Scala HTTP 客户端库，它封装了 Java 的 HttpURLConnection。该库提供了零依赖、跨编译版本（支持 Scala 2.10、2.11、2.12 和 2.13-M3）、OAuth v1 请求签名、自动支持 gzip 和 deflate 编码、易于添加查询字符串或表单参数、多部分文件上传等功能。

2. 项目快速启动

2.1 安装

在 build.sbt 文件中添加以下依赖：

libraryDependencies += "org.scalaj" %% "scalaj-http" % "2.4.2"

2.2 基本使用

以下是一个简单的 GET 请求示例：

import scalaj.http._

object Main extends App {
  val response: HttpResponse[String] = Http("http://foo.com/search").param("q", "monkeys").asString
  println(response.body)
  println(response.code)
  println(response.headers)
  println(response.cookies)
}

2.3 POST 请求

以下是一个简单的 POST 请求示例：

import scalaj.http._

object Main extends App {
  val response: HttpResponse[String] = Http("http://foo.com/add")
    .postForm(Seq("name" -> "jon", "age" -> "29"))
    .asString
  println(response.body)
}

3. 应用案例和最佳实践

3.1 OAuth v1 请求签名

以下是一个使用 OAuth v1 进行请求签名的示例：

import scalaj.http._

object Main extends App {
  val consumer = Token("key", "secret")
  val response = Http("https://api.twitter.com/oauth/request_token")
    .postForm(Seq("oauth_callback" -> "oob"))
    .oauth(consumer)
    .asToken

  println("Go to https://api.twitter.com/oauth/authorize?oauth_token=" + response.body.key)
  val verifier = Console.readLine("Enter verifier: ").trim

  val accessToken = Http("https://api.twitter.com/oauth/access_token")
    .postForm()
    .oauth(consumer, response.body, verifier)
    .asToken

  println(Http("https://api.twitter.com/1.1/account/settings.json")
    .oauth(consumer, accessToken.body)
    .asString)
}

3.2 处理响应

以下是一个处理响应的示例，直接解析响应的 InputStream：

import scalaj.http._

object Main extends App {
  val response: HttpResponse[Map[String, String]] = Http("http://foo.com")
    .execute(parser = inputStream => Json.parse[Map[String, String]](inputStream))
  println(response.body)
}

4. 典型生态项目

4.1 sttp

sttp 是另一个流行的 Scala HTTP 客户端库，提供了更现代的 API 和异步支持。如果你需要更高级的功能和更好的异步处理，可以考虑使用 sttp。

4.2 http4s

http4s 是一个功能强大的 Scala HTTP 客户端和服务器库，基于 Cats 和 FS2 构建。它提供了完全的类型安全、异步和函数式编程支持。

4.3 JDK 11+ HttpClient

如果你使用的是 JDK 11 或更高版本，并且希望依赖最小化，可以直接使用 JDK 自带的 HttpClient 库。

---

通过以上内容，你应该能够快速上手并使用 scalaj-http 进行 HTTP 请求。如果你有更多高级需求，可以参考官方文档或探索其他生态项目。

scalaj-http Simple scala wrapper for HttpURLConnection. OAuth included. 项目地址: https://gitcode.com/gh_mirrors/sc/scalaj-http