Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/deveth0/httpclient-spring-boot-starter

Spring Boot Starter to configure the Apache and Ok HttpClients
https://github.com/deveth0/httpclient-spring-boot-starter

feign httpclient proxy resttemplate spring spring-boot

Last synced: 24 days ago
JSON representation

Spring Boot Starter to configure the Apache and Ok HttpClients

Host: GitHub
URL: https://github.com/deveth0/httpclient-spring-boot-starter
Owner: deveth0
License: apache-2.0
Created: 2020-05-04T10:14:56.000Z (over 4 years ago)
Default Branch: develop
Last Pushed: 2021-07-23T04:42:47.000Z (over 3 years ago)
Last Synced: 2024-10-04T14:41:01.061Z (about 1 month ago)
Topics: feign, httpclient, proxy, resttemplate, spring, spring-boot
Language: Java
Size: 149 KB
Stars: 4
Watchers: 2
Forks: 5
Open Issues: 6
Metadata Files:
- Readme: README.md
- Changelog: changes.xml
- License: LICENSE

Awesome Lists containing this project

README

        # httpclient-spring-boot-starter

[![Build Status](https://travis-ci.com/deveth0/httpclient-spring-boot-starter.svg)](https://travis-ci.com/github/deveth0/httpclient-spring-boot-starter)

![Code scanning - action](https://github.com/deveth0/httpclient-spring-boot-starter/workflows/Code%20scanning%20-%20action/badge.svg)

[![Coverage Status](https://coveralls.io/repos/github/deveth0/httpclient-spring-boot-starter/badge.svg?branch=master)](https://coveralls.io/github/deveth0/httpclient-spring-boot-starter?branch=master)

[![Sonatype Nexus (Releases)](https://img.shields.io/nexus/r/de.dev-eth0.spring-boot.httpclient/httpclient-spring-boot-starter?color=brightgreen&label=release&server=https%3A%2F%2Foss.sonatype.org)](https://oss.sonatype.org/content/repositories/releases/de/dev-eth0/spring-boot/httpclient/httpclient-spring-boot-starter/)

[![Sonatype Nexus (Snapshots)](https://img.shields.io/nexus/s/de.dev-eth0.spring-boot.httpclient/httpclient-spring-boot-starter?color=brightgreen&label=snapshot&server=https%3A%2F%2Foss.sonatype.org)](https://oss.sonatype.org/content/repositories/snapshots/de/dev-eth0/spring-boot/httpclient/httpclient-spring-boot-starter/)

[![License](https://img.shields.io/github/license/deveth0/httpclient-spring-boot-starter?color=brightgreen)](http://www.apache.org/licenses/LICENSE-2.0.html)

This project provides a Spring-Boot Starter that enables the additional configuration of the used Httpclients. 

It supports the configuration of [OkHttp](https://square.github.io/okhttp/) and [Apache HttpClient](https://hc.apache.org/httpcomponents-client-ga/) which are also the supported Clients in Spring.

## Usage

The `httpclient-spring-boot-starter` brings most of the required configuration with it, therefor you only need to add it as a maven dependency and enable the desired Httpclient.

 

```

  de.dev-eth0.spring-boot.httpclient

  httpclient-spring-boot-starter

  LATEST-VERSION

```

Make sure, that you have either `org.apache.httpcomponents:httpclient` or `com.squareup.okhttp3:okhttp` declared as a dependency and enable the configuration as described in [spring-cloud-commons - http-clients](https://cloud.spring.io/spring-cloud-commons/reference/html/#http-clients).

This will make sure, that the `spring-cloud` dependencies use the custom client configurations.

 

### Feign

Feign uses a different configuration to enable the clients: `feign.okhttp.enabled` and `feign.httpclient.enabled`. 

### RestTemplate

To make sure, your RestTemplate uses the custom client, you need to configure it accordingly:

```

@Bean

public RestTemplate restTemplate(RestTemplateBuilder builder, ClientHttpRequestFactory clientHttpRequestFactory) {

  return builder.requestFactory(() -> clientHttpRequestFactory).build();

}

```

## Configuration 

All configuration values are prefixed with `http.client` (e.g. `http.client.timeouts.connectionTimeout`).

It's possible to configure the proxy based on the requested hostnames using the `hostPattern` config.

| Config | Description | Default | Example | 

|---|---|---|---|

| sslContext | SSL Version (optional) | `TLSv1.2` | `TLSv1.3` |

| timeouts.connectionTimeout (optional) | Connection Timeout in ms  | 5000 |  |

| timeouts.socketTimeout (optional) |  Socket Timeout in ms, for OkHttp this is used as readTimeout and writeTimeout | 10000  |

| proxies[] (optional) | Configuration for used proxy servers | | |

| proxies[].hostPatterns | Pattern for matching the hostname, empty matches all  | empty | `google.*`  |

| proxies[].proxyHost | Hostname or IP of the Proxy | | `10.0.9.1` or `corp-proxy.domain` |

| proxies[].proxyPort | Port of the Proxy (optional) | 3128 | |

| proxies[].proxyUser | Proxy user name (optional) | | `testUser`|

| proxies[].proxyPassword | Proxy password (optional) | | `testPassword` |

| keystore.path | Keystore file path | | `classpath:keystore.jks` |

| keystore.password | Keystore password | | `changeit` |

| keystore.type | Keystore type (optional) | | `PKCS12` |

| truststore.path | Truststore file path | | `classpath:truststore.jks` |

| truststore.password | Truststore password | | `changeit` |

| truststore.type | Truststore type (optional) | | `JKS` |

Example:

```

http:

  client:

    proxies:

      - hostPatterns: ["google.de]

        proxyHost: localhost

        proxyPort: 3333

        proxyUser: testUser

        proxyPassword: testPassword

    timeouts:

      connectionTimeout: 5000

      socketTimeout: 10000

```

## Sample Project

You can find a sample project which configures both `Feign` and `RestTemplate` to use either `OkHttp` or `Apache HttpClient` in `/httpclient-spring-boot-sample`.

The project includes the `spring-boot-maven-plugin` therefor you can simply run `mvn clean install spring:boot-run`. By default, the project uses `Apache HttpClient`, if you want to use `OkHttp`, you can use the following command:

```

SPRING_PROFILES_ACTIVE=okhttp mvn spring-boot:run

```

The project also contains a `docker-compose.yml` file which starts several local servers to demonstrate the usecases.