Skip to content

Commit e9727b3

Browse files
committed
tests RestTemplate to use a proxy
1 parent bb85e1b commit e9727b3

File tree

13 files changed

+604
-0
lines changed

13 files changed

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

springboot-http-client-demo/README.md

+99
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
# Best practice about http client.
2+
3+
## TODO
4+
5+
- [x] Determine route in RestTemplate
6+
- [ ] Client side load balancer with Ribbon
7+
8+
---
9+
10+
11+
12+
> ## Start servers
13+
14+
; Server have only two endpoints.
15+
16+
1. "/data" : returns UUID random string
17+
2. "/alive" : returns 200 status code with empty body
18+
19+
20+
```aidl
21+
// start a server1 with 8080 port
22+
$ ./gradlew bootRun -PjvmArgs="-Dserver.port=8081"
23+
24+
// start a server2 with 8081 port
25+
$ ./gradlew bootRun -PjvmArgs="-Dserver.port=8082"
26+
27+
// start a server3 with 8082 port
28+
$ ./gradlew bootRun -PjvmArgs="-Dserver.port=8083"
29+
```
30+
31+
> ## Run RestTemplate examples
32+
33+
<a href="src/test/java/demo/resttemplate/RestTemplateProxyTest.java">**See tests with rest template**</a>
34+
35+
```
36+
$ ./gradlew test --tests RestTemplateProxyTest
37+
```
38+
39+
> ## RestTemplate with proxy route planner
40+
41+
```aidl
42+
// create a new RestTemplate instance with proxy configuration
43+
private RestTemplate build() {
44+
final HttpHost proxy = new HttpHost("proxy.example.com");
45+
final HttpClient httpClient
46+
= HttpClientBuilder.create()
47+
.setRoutePlanner(new DefaultProxyRoutePlanner(proxy) {
48+
49+
@Override
50+
public HttpHost determineProxy(HttpHost target,
51+
HttpRequest request,
52+
HttpContext context) {
53+
54+
return getActiveHost().orElse(hosts[0]);
55+
}
56+
}).build();
57+
58+
return new RestTemplate(new HttpComponentsClientHttpRequestFactory(httpClient));
59+
}
60+
61+
// returns active http host
62+
private Optional<HttpHost> getActiveHost() {
63+
final int start = atomicInteger.getAndIncrement();
64+
65+
for (int i = 0; i < hosts.length; i++) {
66+
final int idx = (start + i) % hosts.length;
67+
final HttpHost targetHost = hosts[idx];
68+
69+
CloseableHttpResponse response = null;
70+
try {
71+
HttpGet request = new HttpGet(targetHost.toURI().concat("/alive"));
72+
73+
response = httpClient.execute(request);
74+
75+
if (response.getStatusLine().getStatusCode() == 200) {
76+
return Optional.of(targetHost);
77+
}
78+
} catch (IOException e) {
79+
// ignore
80+
} finally {
81+
if (response != null) {
82+
try {
83+
response.close();
84+
} catch (IOException e) {
85+
e.printStackTrace();
86+
}
87+
}
88+
}
89+
}
90+
91+
return Optional.empty();
92+
}
93+
```
94+
95+
---
96+
97+
## References
98+
99+
- https://docs.spring.io/spring-boot/docs/current/reference/html/howto.html#howto-http-clients-proxy-configuration
+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
plugins {
2+
id 'org.springframework.boot' version '2.2.1.RELEASE'
3+
id 'io.spring.dependency-management' version '1.0.8.RELEASE'
4+
id 'java'
5+
}
6+
7+
group = 'me.zaccoding'
8+
version = '0.0.1-SNAPSHOT'
9+
sourceCompatibility = '1.8'
10+
11+
configurations {
12+
developmentOnly
13+
runtimeClasspath {
14+
extendsFrom developmentOnly
15+
}
16+
compileOnly {
17+
extendsFrom annotationProcessor
18+
}
19+
}
20+
21+
repositories {
22+
mavenCentral()
23+
}
24+
25+
dependencies {
26+
implementation 'org.springframework.boot:spring-boot-starter-web'
27+
compileOnly 'org.projectlombok:lombok'
28+
developmentOnly 'org.springframework.boot:spring-boot-devtools'
29+
annotationProcessor 'org.projectlombok:lombok'
30+
// https://mvnrepository.com/artifact/org.apache.httpcomponents/httpclient
31+
compile group: 'org.apache.httpcomponents', name: 'httpclient', version: '4.5.10'
32+
testImplementation('org.springframework.boot:spring-boot-starter-test') {
33+
exclude group: 'org.junit.vintage', module: 'junit-vintage-engine'
34+
}
35+
}
36+
37+
test {
38+
useJUnitPlatform()
39+
}
40+
41+
42+
bootRun {
43+
// jvm options
44+
if (project.hasProperty('jvmArgs')) {
45+
jvmArgs project.jvmArgs.split('\\s+')
46+
}
47+
48+
// arguments
49+
if (project.hasProperty('args')) {
50+
args project.args.split('\\s+')
51+
}
52+
}
Binary file not shown.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
#Wed Dec 04 00:25:14 KST 2019
2+
distributionUrl=https\://services.gradle.org/distributions/gradle-5.6.4-all.zip
3+
distributionBase=GRADLE_USER_HOME
4+
distributionPath=wrapper/dists
5+
zipStorePath=wrapper/dists
6+
zipStoreBase=GRADLE_USER_HOME

springboot-http-client-demo/gradlew

+172
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,172 @@
1+
#!/usr/bin/env sh
2+
3+
##############################################################################
4+
##
5+
## Gradle start up script for UN*X
6+
##
7+
##############################################################################
8+
9+
# Attempt to set APP_HOME
10+
# Resolve links: $0 may be a link
11+
PRG="$0"
12+
# Need this for relative symlinks.
13+
while [ -h "$PRG" ] ; do
14+
ls=`ls -ld "$PRG"`
15+
link=`expr "$ls" : '.*-> \(.*\)$'`
16+
if expr "$link" : '/.*' > /dev/null; then
17+
PRG="$link"
18+
else
19+
PRG=`dirname "$PRG"`"/$link"
20+
fi
21+
done
22+
SAVED="`pwd`"
23+
cd "`dirname \"$PRG\"`/" >/dev/null
24+
APP_HOME="`pwd -P`"
25+
cd "$SAVED" >/dev/null
26+
27+
APP_NAME="Gradle"
28+
APP_BASE_NAME=`basename "$0"`
29+
30+
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
31+
DEFAULT_JVM_OPTS=""
32+
33+
# Use the maximum available, or set MAX_FD != -1 to use that value.
34+
MAX_FD="maximum"
35+
36+
warn () {
37+
echo "$*"
38+
}
39+
40+
die () {
41+
echo
42+
echo "$*"
43+
echo
44+
exit 1
45+
}
46+
47+
# OS specific support (must be 'true' or 'false').
48+
cygwin=false
49+
msys=false
50+
darwin=false
51+
nonstop=false
52+
case "`uname`" in
53+
CYGWIN* )
54+
cygwin=true
55+
;;
56+
Darwin* )
57+
darwin=true
58+
;;
59+
MINGW* )
60+
msys=true
61+
;;
62+
NONSTOP* )
63+
nonstop=true
64+
;;
65+
esac
66+
67+
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
68+
69+
# Determine the Java command to use to start the JVM.
70+
if [ -n "$JAVA_HOME" ] ; then
71+
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
72+
# IBM's JDK on AIX uses strange locations for the executables
73+
JAVACMD="$JAVA_HOME/jre/sh/java"
74+
else
75+
JAVACMD="$JAVA_HOME/bin/java"
76+
fi
77+
if [ ! -x "$JAVACMD" ] ; then
78+
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
79+
80+
Please set the JAVA_HOME variable in your environment to match the
81+
location of your Java installation."
82+
fi
83+
else
84+
JAVACMD="java"
85+
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
86+
87+
Please set the JAVA_HOME variable in your environment to match the
88+
location of your Java installation."
89+
fi
90+
91+
# Increase the maximum file descriptors if we can.
92+
if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
93+
MAX_FD_LIMIT=`ulimit -H -n`
94+
if [ $? -eq 0 ] ; then
95+
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
96+
MAX_FD="$MAX_FD_LIMIT"
97+
fi
98+
ulimit -n $MAX_FD
99+
if [ $? -ne 0 ] ; then
100+
warn "Could not set maximum file descriptor limit: $MAX_FD"
101+
fi
102+
else
103+
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
104+
fi
105+
fi
106+
107+
# For Darwin, add options to specify how the application appears in the dock
108+
if $darwin; then
109+
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
110+
fi
111+
112+
# For Cygwin, switch paths to Windows format before running java
113+
if $cygwin ; then
114+
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
115+
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
116+
JAVACMD=`cygpath --unix "$JAVACMD"`
117+
118+
# We build the pattern for arguments to be converted via cygpath
119+
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
120+
SEP=""
121+
for dir in $ROOTDIRSRAW ; do
122+
ROOTDIRS="$ROOTDIRS$SEP$dir"
123+
SEP="|"
124+
done
125+
OURCYGPATTERN="(^($ROOTDIRS))"
126+
# Add a user-defined pattern to the cygpath arguments
127+
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
128+
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
129+
fi
130+
# Now convert the arguments - kludge to limit ourselves to /bin/sh
131+
i=0
132+
for arg in "$@" ; do
133+
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
134+
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
135+
136+
if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
137+
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
138+
else
139+
eval `echo args$i`="\"$arg\""
140+
fi
141+
i=$((i+1))
142+
done
143+
case $i in
144+
(0) set -- ;;
145+
(1) set -- "$args0" ;;
146+
(2) set -- "$args0" "$args1" ;;
147+
(3) set -- "$args0" "$args1" "$args2" ;;
148+
(4) set -- "$args0" "$args1" "$args2" "$args3" ;;
149+
(5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
150+
(6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
151+
(7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
152+
(8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
153+
(9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
154+
esac
155+
fi
156+
157+
# Escape application args
158+
save () {
159+
for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
160+
echo " "
161+
}
162+
APP_ARGS=$(save "$@")
163+
164+
# Collect all arguments for the java command, following the shell quoting and substitution rules
165+
eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
166+
167+
# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
168+
if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
169+
cd "$(dirname "$0")"
170+
fi
171+
172+
exec "$JAVACMD" "$@"

0 commit comments

Comments
 (0)