Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/playframework/play-ws
Standalone Play WS, an async HTTP client with fluent API
https://github.com/playframework/play-ws
asynchronous asynchttpclient http-client java playframework reactive reactive-streams scala
Last synced: 2 days ago
JSON representation
Standalone Play WS, an async HTTP client with fluent API
- Host: GitHub
- URL: https://github.com/playframework/play-ws
- Owner: playframework
- License: apache-2.0
- Created: 2016-12-07T23:00:14.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2024-12-02T00:44:03.000Z (20 days ago)
- Last Synced: 2024-12-11T00:28:07.037Z (11 days ago)
- Topics: asynchronous, asynchttpclient, http-client, java, playframework, reactive, reactive-streams, scala
- Language: Scala
- Homepage: https://www.playframework.com/documentation/latest/JavaWS
- Size: 2.17 MB
- Stars: 224
- Watchers: 15
- Forks: 85
- Open Issues: 75
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-java - Play WS - Typesafe client with reactive streams and caching. (Projects / HTTP Clients)
README
# Play WS Standalone
[](https://twitter.com/playframework)
[](https://discord.gg/g5s2vtZ4Fa)
[](https://github.com/playframework/playframework/discussions)
[](https://stackoverflow.com/tags/playframework)
[](https://www.youtube.com/channel/UCRp6QDm5SDjbIuisUpxV9cg)
[](https://www.twitch.tv/playframework)
[](https://opencollective.com/playframework)
[](https://github.com/playframework/play-ws/actions/workflows/build-test.yml)
[](https://mvnrepository.com/artifact/org.playframework/play-ws-standalone_2.13)
[](https://javadoc.io/doc/org.playframework/play-ws-standalone_2.13)
[](https://github.com/playframework/play-ws)
[](https://scala-steward.org)
[](https://mergify.com)
Play WS is a powerful HTTP Client library, originally developed by the Play team for use with Play Framework. It uses AsyncHttpClient for HTTP client functionality and has no Play dependencies.
We've provided some documentation here on how to use Play WS in your app (without Play). For more information on how to use Play WS in Play, please refer to the Play documentation.
## Getting Started
To get started, you can add `play-ahc-ws-standalone` as a dependency in SBT:
```scala
libraryDependencies += "org.playframework" %% "play-ahc-ws-standalone" % "LATEST_VERSION"
// Before version 3.0.0:
libraryDependencies += "com.typesafe.play" %% "play-ahc-ws-standalone" % "LATEST_VERSION"
```
Where you replace `LATEST_VERSION` with the version shown in this image: [](http://mvnrepository.com/artifact/org.playframework/play-ws-standalone_2.13).
This adds the standalone version of Play WS, backed by [AsyncHttpClient](https://github.com/AsyncHttpClient/async-http-client). This library contains both the Scala and Java APIs, under `play.api.libs.ws` and `play.libs.ws`.
To add XML and JSON support using Play-JSON or Scala XML, add the following:
```scala
libraryDependencies += "org.playframework" %% "play-ws-standalone-xml" % playWsStandaloneVersion
libraryDependencies += "org.playframework" %% "play-ws-standalone-json" % playWsStandaloneVersion
// Before version 3.0.0:
libraryDependencies += "com.typesafe.play" %% "play-ws-standalone-xml" % playWsStandaloneVersion
libraryDependencies += "com.typesafe.play" %% "play-ws-standalone-json" % playWsStandaloneVersion
```
## Shading
Play WS uses shaded versions of AsyncHttpClient and OAuth Signpost, repackaged under the `play.shaded.ahc` and `play.shaded.oauth` package names, respectively. Shading AsyncHttpClient means that the version of Netty used behind AsyncHttpClient is completely independent of the application and Play as a whole.
Specifically, shading AsyncHttpClient means that there are no version conflicts introduced between Netty 4.0 and Netty 4.1 using Play WS.
> **NOTE**: If you are developing play-ws and publishing `shaded-asynchttpclient` and `shaded-oauth` using `sbt publishLocal`, you need to be aware that updating `~/.ivy2/local` does not overwrite `~/.ivy2/cache` and so you will not see your updated shaded code until you remove it from cache. See http://eed3si9n.com/field-test for more details. This bug has been filed as https://github.com/sbt/sbt/issues/2687.
### Shaded AHC Defaults
Because Play WS shades AsyncHttpClient, the default settings are also shaded and so do not adhere to the AHC documentation. This means that the settings in `ahc-default.properties` and the AsyncHttpClient system properties are prepended with `play.shaded.ahc`, for example the `usePooledMemory` setting in the shaded version of AsyncHttpClient is defined like this:
```properties
play.shaded.ahc.org.asynchttpclient.usePooledMemory=true
```
### Typed Bodies
The type system in Play-WS has changed so that the request body and the response body can use richer types.
You can define your own BodyWritable or BodyReadable, but if you want to use the default out of the box settings, you can import the type mappings with the DefaultBodyReadables / DefaultBodyWritables.
#### Scala
```scala
import play.api.libs.ws.DefaultBodyReadables._
import play.api.libs.ws.DefaultBodyWritables._
```
More likely you will want the XML and JSON support:
```scala
import play.api.libs.ws.XMLBodyReadables._
import play.api.libs.ws.XMLBodyWritables._
```
or
```scala
import play.api.libs.ws.JsonBodyReadables._
import play.api.libs.ws.JsonBodyWritables._
```
To use a BodyReadable in a response, you must type the response explicitly:
```scala
import scala.concurrent.{ ExecutionContext, Future }
import play.api.libs.ws.StandaloneWSClient
import play.api.libs.ws.XMLBodyReadables._ // required
def handleXml(ws: StandaloneWSClient)(
implicit ec: ExecutionContext): Future[scala.xml.Elem] =
ws.url("...").get().map { response =>
response.body[scala.xml.Elem]
}
```
or using Play-JSON:
```scala
import scala.concurrent.{ ExecutionContext, Future }
import play.api.libs.json.JsValue
import play.api.libs.ws.StandaloneWSClient
import play.api.libs.ws.JsonBodyReadables._ // required
def handleJsonResp(ws: StandaloneWSClient)(
implicit ec: ExecutionContext): Future[JsValue] =
ws.url("...").get().map { response =>
response.body[JsValue]
}
```
Note that there is a special case: when you are streaming the response, then you should get the body as a Source:
```scala
import scala.concurrent.ExecutionContext
import org.apache.pekko.util.ByteString
import org.apache.pekko.stream.scaladsl.Source
import play.api.libs.ws.StandaloneWSClient
def useWSStream(ws: StandaloneWSClient)(implicit ec: ExecutionContext) =
ws.url("...").stream().map { response =>
val source: Source[ByteString, _] = response.bodyAsSource
val _ = source // do something with source
}
```
To POST, you should pass in a type which has an implicit class mapping of BodyWritable:
```scala
import scala.concurrent.ExecutionContext
import play.api.libs.ws.DefaultBodyWritables._ // required
def postExampleString(ws: play.api.libs.ws.StandaloneWSClient)(
implicit ec: ExecutionContext) = {
val stringData = "Hello world"
ws.url("...").post(stringData).map { response => /* do something */ }
}
```
You can also define your own custom BodyReadable:
```scala
import play.api.libs.ws.BodyReadable
import play.api.libs.ws.ahc.StandaloneAhcWSResponse
case class Foo(body: String)
implicit val fooBodyReadable = BodyReadable[Foo] { response =>
import play.shaded.ahc.org.asynchttpclient.{ Response => AHCResponse }
val ahcResponse = response.asInstanceOf[StandaloneAhcWSResponse].underlying[AHCResponse]
Foo(ahcResponse.getResponseBody)
}
```
or custom BodyWritable:
```scala
import org.apache.pekko.util.ByteString
import play.api.libs.ws.{ BodyWritable, InMemoryBody }
implicit val writeableOf_Foo: BodyWritable[Foo] = {
// https://tools.ietf.org/html/rfc6838#section-3.2
BodyWritable(foo => InMemoryBody(ByteString.fromString(foo.toString)), "application/vnd.company.category+foo")
}
```
#### Java
To use the default type mappings in Java, you should use the following:
```java
import play.libs.ws.DefaultBodyReadables;
import play.libs.ws.DefaultBodyWritables;
```
followed by:
```java
public class MyClient implements DefaultBodyWritables, DefaultBodyReadables {
public CompletionStage doStuff() {
return client.url("http://example.com").post(body("hello world")).thenApply(response ->
response.body(string())
);
}
}
```
Note that there is a special case: when you are using a stream, then you should get the body as a Source:
```java
class MyClass {
public CompletionStage> readResponseAsStream() {
return ws.url(url).stream().thenApply(response ->
response.bodyAsSource()
);
}
}
```
You can also post a Source:
```java
class MyClass {
public CompletionStage doStuff() {
Source source = fromSource();
return ws.url(url).post(body(source)).thenApply(response ->
response.body()
);
}
}
```
You can define a custom `BodyReadable`:
```java
import play.libs.ws.ahc.*;
import play.shaded.ahc.org.asynchttpclient.Response;
class FooReadable implements BodyReadable {
public Foo apply(StandaloneWSResponse response) {
Response ahcResponse = (Response) response.getUnderlying();
return Foo.serialize(ahcResponse.getResponseBody(StandardCharsets.UTF_8));
}
}
```
You can also define your own custom `BodyWritable`:
```java
public class MyClient {
private BodyWritable someOtherMethod(String string) {
org.apache.pekko.util.ByteString byteString = org.apache.pekko.util.ByteString.fromString(string);
return new DefaultBodyWritables.InMemoryBodyWritable(byteString, "text/plain");
}
}
```
## Instantiating a standalone client
The standalone client needs [Pekko](https://pekko.apache.org/) to handle streaming data internally:
### Scala
In Scala, the way to call out to a web service and close down the client:
```scala
package playwsclient
import org.apache.pekko.actor.ActorSystem
import org.apache.pekko.stream._
import play.api.libs.ws._
import play.api.libs.ws.ahc._
import scala.concurrent.Future
object ScalaClient {
import DefaultBodyReadables._
import scala.concurrent.ExecutionContext.Implicits._
def main(args: Array[String]): Unit = {
// Create Pekko system for thread and streaming management
implicit val system = ActorSystem()
system.registerOnTermination {
System.exit(0)
}
implicit val materializer = SystemMaterializer(system).materializer
// Create the standalone WS client
// no argument defaults to a AhcWSClientConfig created from
// "AhcWSClientConfigFactory.forConfig(ConfigFactory.load, this.getClass.getClassLoader)"
val wsClient = StandaloneAhcWSClient()
call(wsClient)
.andThen { case _ => wsClient.close() }
.andThen { case _ => system.terminate() }
}
def call(wsClient: StandaloneWSClient): Future[Unit] = {
wsClient.url("http://www.google.com").get().map { response =>
val statusText: String = response.statusText
val body = response.body[String]
println(s"Got a response $statusText: $body")
}
}
}
```
You can also create the standalone client directly from an AsyncHttpClient instance:
```scala
object ScalaClient {
def main(args: Array[String]): Unit = {
// Use
import play.shaded.ahc.org.asynchttpclient._
val asyncHttpClientConfig = new DefaultAsyncHttpClientConfig.Builder()
.setMaxRequestRetry(0)
.setShutdownQuietPeriod(0)
.setShutdownTimeout(0).build
val asyncHttpClient = new DefaultAsyncHttpClient(asyncHttpClientConfig)
val wsClient = new StandaloneAhcWSClient(asyncHttpClient)
/// ...
}
}
```
This is useful when there is an AsyncHttpClient configuration option that is not available in the WS config layer.
### Java
In Java the API is much the same:
```java
package playwsclient;
import org.apache.pekko.actor.ActorSystem;
import org.apache.pekko.stream.*;
import com.typesafe.config.ConfigFactory;
import play.libs.ws.*;
import play.libs.ws.ahc.*;
public class JavaClient implements DefaultBodyReadables {
private final StandaloneAhcWSClient client;
private final ActorSystem system;
public static void main(String[] args) {
// Set up Pekko materializer to handle streaming
final String name = "wsclient";
ActorSystem system = ActorSystem.create(name);
system.registerOnTermination(() -> System.exit(0));
Materializer materializer = SystemMaterializer.get(system).materializer();
// Create the WS client from the `application.conf` file, the current classloader and materializer.
StandaloneAhcWSClient ws = StandaloneAhcWSClient.create(
AhcWSClientConfigFactory.forConfig(ConfigFactory.load(), system.getClass().getClassLoader()),
materializer
);
JavaClient javaClient = new JavaClient(system, ws);
javaClient.run();
}
JavaClient(ActorSystem system, StandaloneAhcWSClient client) {
this.system = system;
this.client = client;
}
public void run() {
client.url("http://www.google.com").get()
.whenComplete((response, throwable) -> {
String statusText = response.getStatusText();
String body = response.getBody(string());
System.out.println("Got a response " + statusText);
})
.thenRun(() -> {
try {
client.close();
} catch (Exception e) {
e.printStackTrace();
}
})
.thenRun(system::terminate);
}
}
```
Likewise, you can provide the AsyncHttpClient client explicitly from configuration:
```java
public class JavaClient implements DefaultBodyReadables {
public static void main(String[] args) {
// ...
// Set up AsyncHttpClient directly from config
AsyncHttpClientConfig asyncHttpClientConfig =
new DefaultAsyncHttpClientConfig.Builder()
.setMaxRequestRetry(0)
.setShutdownQuietPeriod(0)
.setShutdownTimeout(0)
.build();
AsyncHttpClient asyncHttpClient = new DefaultAsyncHttpClient(asyncHttpClientConfig);
// Set up WSClient instance directly from asynchttpclient.
WSClient client = new AhcWSClient(asyncHttpClient, materializer);
// ...
}
}
```
## Caching
Play WS implements [HTTP Caching](https://tools.ietf.org/html/rfc7234) through CachingAsyncHttpClient, AhcHTTPCache and [CacheControl](https://github.com/playframework/cachecontrol), a minimal HTTP cache management library in Scala.
To create a standalone AHC client that uses caching, pass in an instance of AhcHttpCache with a cache adapter to the underlying implementation. For example, to use Caffeine as the underlying cache, you could use the following:
```scala
import scala.concurrent.Future
import java.util.concurrent.TimeUnit
import com.github.benmanes.caffeine.cache.{ Caffeine, Ticker }
import play.api.libs.ws.ahc.StandaloneAhcWSClient
import play.api.libs.ws.ahc.cache.{
AhcHttpCache, Cache, EffectiveURIKey, ResponseEntry
}
class CaffeineHttpCache extends Cache {
val underlying = Caffeine.newBuilder()
.ticker(Ticker.systemTicker())
.expireAfterWrite(365, TimeUnit.DAYS)
.build[EffectiveURIKey, ResponseEntry]()
def remove(key: EffectiveURIKey) =
Future.successful(Option(underlying.invalidate(key)))
def put(key: EffectiveURIKey, entry: ResponseEntry) =
Future.successful(underlying.put(key, entry))
def get(key: EffectiveURIKey) =
Future.successful(Option(underlying getIfPresent key ))
def close(): Unit = underlying.cleanUp()
}
def withCache(implicit m: org.apache.pekko.stream.Materializer): StandaloneAhcWSClient = {
implicit def ec = m.executionContext
val cache = new CaffeineHttpCache()
StandaloneAhcWSClient(httpCache = Some(new AhcHttpCache(cache)))
}
```
There are a number of guides that help with putting together Cache-Control headers:
* [Mozilla's Guide to HTTP caching](https://developer.mozilla.org/en-US/docs/Web/HTTP/Caching)
* [Mark Nottingham's Guide to Caching](https://www.mnot.net/cache_docs/)
* [HTTP Caching](https://developers.google.com/web/fundamentals/performance/optimizing-content-efficiency/http-caching)
* [REST Easy: HTTP Cache](http://odino.org/rest-better-http-cache/)
## Releasing a new version
See https://github.com/playframework/.github/blob/main/RELEASING.md
## License
Play WS is licensed under the Apache license, version 2. See the LICENSE file for more information.