Skip to content

Latest commit

 

History

History
126 lines (93 loc) · 6.03 KB

README.md

File metadata and controls

126 lines (93 loc) · 6.03 KB
Raw

SHCF4J Build Status Maven Central Coverage Status

The Simple HTTP Client Facade for Java (SHCF4J) serves as a simple facade or abstraction for various HTTP client frameworks (e.g. java.net.HttpURLConnection, Apache HttpClient, etc.) allowing the end user to plug in the desired HTTP client framework at deployment time. This library idea originated from the The Simple Logging Facade for Java (SLF4J) progect. While SLF4J provides ready to use Logger instances, SHCF4J provides HTTP client builders that used for actual client creation and abstracts under the hood the entire creation and adoption to underlying implementation.

Motivation

A large number of HTTP client libraries exists in the java community, while using more than one in the same project adds more completixy to the code. In Addition to learning curve that is prerequisite for each library. The SHCF4J provides an abstraction layer for various libraries, that can be desided upon deployment.

In addition, SHCF4J enables cleaner code by declaring all possible exceptions as runtime ones, so its up to the developer decidions whether to handle them.

Dependencies

  • JRE 8

Use Cases

  • As standard for internal libraries that used across different microservice and perform HTTP calls.
  • Correct resource management for open HTTP connections. A content can be consumed only by provided callback - no easy way to expose an input stream.
  • Unified configuration for outgoing HTTPS requests like: the used protocol (TLSv1, TLSv1.1, etc.) & the used ciphers list. Can be very useful in applications that must have varios security compliancy.

Supported Providers

  • Apache HTTP Client 4.3+
  • Asynchronous HTTP Client 2.6+ (AHC2)
  • JDK11 HTTP Client

Installation

Binaries are deployed on both Maven central & JCenter repositories.

Version

SHC4J doesn't use SEMVER, and won't. Given a version number MAJOR.MINOR.FIX:

  • MAJOR = Huge refactoring
  • MINOR = New features and minor API changes, upgrading should require ~1 hour of work to adapt sources
  • FIX = No API change, just bug fixes, only those are source and binary compatible with same minor version

Code Examples

The HTTP client instances can be created in various ways. For example through any DI frameworks (see the example project) or just by putting a few lines of code.

Synchronous Client

SyncHttpClient syncHttpClient = HttpClientBuilderFactory
        .getHttpClientBuilder()
        .build();

The HTTP client instance can be customized with any supported configuration parameters (part of the shcf4j-api project). For example:

SyncHttpClient syncHttpClient = HttpClientBuilderFactory
        .getHttpClientBuilder()
        .setDefaultSocketConfig(
                SocketConfig
                        .builder()
                        .soTimeoutMilliseconds(5 * 1000)
                        .build())
        .build();

Request Execution Example:

HttpHost host = HttpHost
                .builder()
                .schemeName("https")
                .hostname("imperva.com")
                .port(443)
                .build();

HttpRequest request = HttpRequestBuilder
        .GET(URI.create("/hello/world"))
        .header("Accept", "application/json")
        .build();

String response = httpClient.execute(host, request, r -> r.getEntity().getResponseBody(StandardCharsets.UTF_8));

Asynchronous Client

AsyncHttpClient asyncHttpClient = HttpClientBuilderFactory
        .getHttpAsyncClientBuilder()
        .setDefaultSocketConfig(
                IOReactorConfig
                        .builder()
                        .connectTimeoutMilliseconds(1000)
                        .build())
        .setDefaultRequestConfig(
                RequestConfig
                        .builder()
                        .socketTimeoutMilliseconds(1000)
                        .build())
        .build();

Any request execution will immediately return a java.util.concurrent.CompletableFuture<HttpResponse> object that can be manipulated in both synchronous & asynchronous ways.

CompletableFuture<HttpResponse> cf = asyncRequester.execute(host, request);

What Happens Behind the Scenes?

The factory class uses Java java.util.ServiceLoader in order to find all com.imperva.shcf4j.spi.SHC4JServiceProvider instances. Then it uses the first found instance for all following requests.

Contributing

Found a bug? Think you've got an awesome feature you want to add? Contributions are welcome!

Submitting a Contribution

  1. Search for an existing issue. If none exists, create a new issue so that other contributors can keep track of what you are trying to add/fix and offer suggestions (or let you know if there is already an effort in progress). Be sure to clearly state the problem you are trying to solve and an explanation of why you want to use the strategy you're proposing to solve it
  2. Fork this repository on GitHub and create a branch for your feature
  3. Clone your fork and branch to your local machine
  4. Commit changes to your branch
  5. Push your work up to GitHub
  6. Submit a pull request so that we can review your changes

Make sure that you rebase your branch off of master before opening a new pull request. We might also ask you to rebase it if master changes after you open your pull request.

Acceptance Criteria

We love contributions, but it's important that your pull request adhere to some of the standards we maintain in this repository.

  • All tests must be passing!
  • All code changes require tests!
  • All code changes must be consistent with our checkstyle rules (use IntelliJ default formatting rules)
  • Great inline comments