Skip to content

Commit cb46ab6

Browse files
candrewscandrews
committed
Initial commit
0 parents  commit cb46ab6

21 files changed

+1631
-0
lines changed

‎.github/workflows/gradle.yml

+71
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
name: Java CI with Gradle
2+
3+
on:
4+
push:
5+
pull_request:
6+
workflow_dispatch:
7+
inputs:
8+
releaseVersion:
9+
description: release version
10+
required: true
11+
jobs:
12+
build:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v2
16+
- name: Set up Java 11
17+
uses: actions/setup-java@v1
18+
with:
19+
java-version: 11
20+
- name: Cache Gradle wrapper and packages
21+
uses: actions/cache@v2
22+
with:
23+
path: |
24+
~/.gradle/caches
25+
~/.gradle/wrapper
26+
key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*') }}
27+
restore-keys: |
28+
${{ runner.os }}-gradle-
29+
- name: Set Up Signing
30+
if: github.ref == 'refs/heads/master' || github.ref == 'refs/heads/master'
31+
run: |
32+
echo '${{secrets.GPG_SECRET_KEYS}}' | gpg --import --armor --no-tty --batch --yes # GPG_SECRET_KEYS created with: gpg --export-secret-keys --armor
33+
gpg --export-secret-keys > ~/.gnupg/secring.gpg
34+
git config --local user.email "[email protected]"
35+
git config --local user.name "Craig Andrews (GitHub Actions)"
36+
git config --local user.signingKey "${GPG_KEY_ID: -8}"
37+
git config --local commit.gpgsign true
38+
git config --local user.signingkey "${GPG_KEY_ID}"
39+
[ -d ~/.gradle ] || mkdir ~/.gradle
40+
echo "signing.secretKeyRingFile=$HOME/.gnupg/secring.gpg" > ~/.gradle/gradle.properties
41+
echo "signing.keyId=${GPG_KEY_ID: -8}" >> ~/.gradle/gradle.properties
42+
echo "signing.gnupg.useLegacyGpg=true" >> ~/.gradle/gradle.properties
43+
echo "signing.password=" >> ~/.gradle/gradle.properties
44+
env:
45+
GPG_KEY_ID: ${{ secrets.GPG_KEY_ID }}
46+
- name: Build
47+
run: ./gradlew build
48+
- name: Publish
49+
if: github.ref == 'refs/heads/master' && github.event_name != 'workflow_dispatch'
50+
run: |
51+
./gradlew publish
52+
env:
53+
GITHUB_ACTOR: ${{ github.actor }}
54+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
55+
OSSRH_USERNAME: ${{ secrets.OSSRH_USERNAME }}
56+
OSSRH_PASSWORD: ${{ secrets.OSSRH_PASSWORD }}
57+
- name: Release
58+
if: github.event_name == 'workflow_dispatch'
59+
run: |
60+
rm build/libs -rf
61+
./gradlew release -Prelease.useAutomaticVersion=true -Prelease.releaseVersion=${{ github.event.inputs.releaseVersion }}
62+
env:
63+
GITHUB_ACTOR: ${{ github.actor }}
64+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
65+
OSSRH_USERNAME: ${{ secrets.OSSRH_USERNAME }}
66+
OSSRH_PASSWORD: ${{ secrets.OSSRH_PASSWORD }}
67+
- name: Upload artifacts
68+
uses: actions/upload-artifact@v2
69+
with:
70+
name: Package
71+
path: build/libs

‎.gitignore

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
.gradle
2+
bin/
3+
build/
4+
!gradle/wrapper/gradle-wrapper.jar
5+
!**/src/main/**
6+
!**/src/test/**
7+
8+
### STS ###
9+
.attach_pid*
10+
hs_err_pid*
11+
.apt_generated
12+
.classpath
13+
.factorypath
14+
.project
15+
.settings
16+
.springBeans
17+
.sts4-cache
18+
19+
### IntelliJ IDEA ###
20+
.idea
21+
*.iws
22+
*.iml
23+
*.ipr
24+
out/
25+
26+
### NetBeans ###
27+
/nbproject/private/
28+
/nbbuild/
29+
/dist/
30+
/nbdist/
31+
/.nb-gradle/
32+
33+
### VS Code ###
34+
.vscode/

‎LICENSE.txt

+202
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
https://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "{}"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright {yyyy} {name of copyright owner}
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
https://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎README.md

+74
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Java HttpClient for Spring Web Client Boot Starter
2+
[![javadoc](https://javadoc.io/badge2/com.integralblue/java-httpclient-webclient-spring-boot-starter/javadoc.svg)](https://javadoc.io/doc/com.integralblue/java-httpclient-webclient-spring-boot-starter)
3+
![Maven Central](https://img.shields.io/maven-central/v/com.integralblue/java-httpclient-webclient-spring-boot-starter)
4+
![GitHub](https://img.shields.io/github/license/candrews/java-httpclient-webclient-spring-boot-starter)
5+
6+
The Java HttpClient for Spring Web Client Boot Starter provides a quick and easy way to use [Java 11's HttpClient](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpClient.html) as [Spring WebClient's](https://docs.spring.io/spring-boot/docs/2.3.4.RELEASE/reference/htmlsingle/#boot-features-webclient) client HTTP connector.
7+
8+
By default, [Spring WebClient will try to use Reactor Netty then Jetty Client as it's client HTTP connector](https://docs.spring.io/spring-boot/docs/2.3.4.RELEASE/reference/htmlsingle/#boot-features-webclient-runtime). This starter will instead use Java 11's HTTP client.
9+
10+
Benefits of using this starter include:
11+
* not needing additional dependencies such as on Netty or Eclipse
12+
* getting the benefits and features of Java's built in HttpClient
13+
* Being able to use tooling for Java's HttpClient, such as [HttpClientMock](https://github.com/PGSSoft/HttpClientMock)
14+
15+
## Using This Starter
16+
To use this starter, you need:
17+
* Java 11 (or later)
18+
* Spring Boot 2.3.0 (or later)
19+
* Spring WebClient, which is included in Spring WebFlux
20+
21+
### Add the Dependency
22+
23+
Add a dependency on this starter your dependency manager of choice, making sure to use the latest version: ![Maven Central](https://img.shields.io/maven-central/v/com.integralblue/java-httpclient-webclient-spring-boot-starter)
24+
25+
For Gradle:
26+
```groovy
27+
dependencies {
28+
runtimeOnly 'com.integralblue:java-httpclient-webclient-spring-boot-starter:VERSION'
29+
}
30+
```
31+
32+
For Maven:
33+
```xml
34+
<dependency>
35+
<groupId>com.integralblue</groupId>
36+
<artifactId>java-httpclient-webclient-spring-boot-starter</artifactId>
37+
<version>VERSION</version>
38+
<scope>runtime</scope>
39+
</dependency>
40+
```
41+
42+
### Use the Autowired WebClient.Builder
43+
44+
Follow the advice given in the Spring Boot documentation under [Calling REST Services with WebClient](https://docs.spring.io/spring-boot/docs/2.3.4.RELEASE/reference/htmlsingle/#boot-features-webclient) when using `WebClient` by autowiring an instance of `WebClient.Builder` and using that to create the `WebClient` instance.
45+
46+
For example:
47+
```java
48+
@Service
49+
public class MyService {
50+
51+
private final WebClient webClient;
52+
53+
public MyService(WebClient.Builder webClientBuilder) {
54+
this.webClient = webClientBuilder.baseUrl("https://example.org").build();
55+
}
56+
57+
public Mono<Details> someRestCall(String name) {
58+
return this.webClient.get().uri("/{name}/details", name)
59+
.retrieve().bodyToMono(Details.class);
60+
}
61+
```
62+
63+
`WebClient.create()` and `WebClient.builder().build()` will not apply the customizations from this starter meaning `WebClient`s created using those approaches will not use Java 11's HttpClient.
64+
65+
## Future of This Starter
66+
Eventually, a future version of Spring will likely include this functionality. Follow [the Pull Request for JDK 11 HttpClient integration with WebClient](https://github.com/spring-projects/spring-framework/pull/23432/) for more information.
67+
68+
## Developing the Starter
69+
This project requires Java 11 (or later).
70+
Import this Gradle project using your IDE of choice.
71+
Or, if you don't want to use an IDE, you can run the project from the command line: `./gradlew build` The test suite will run and a jar will be output at [build/libs/](build/libs/).
72+
73+
### Eclipse
74+
The Project Lombok Eclipse integration must be setup. See the Eclipse instructions on [Project Lombok's site](https://projectlombok.org/features/index.html).

0 commit comments

Comments
 (0)