Skip to content

Commit 4b0717d

Browse files
committed
feat: add dynamic proxy support with Spring Cloud Gateway
- Implement `DynamicProxyGlobalFilter` for routing dynamic proxy requests based on configurable properties. - Introduce `SpringCloudProxyAutoConfiguration` enabling dynamic proxy functionality. - Create `DynamicProxyProperties` for centralized configuration (e.g., allowed schemes, path prefix, etc.). - Add Gradle and project configuration files to set up the project structure, dependencies, and publishing workflows. - Include Apache License and necessary metadata for open-source distribution.
0 parents  commit 4b0717d

25 files changed

Lines changed: 1232 additions & 0 deletions

.gitignore

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
.gradle
2+
build/
3+
!gradle/wrapper/gradle-wrapper.jar
4+
!**/src/main/**/build/
5+
!**/src/test/**/build/
6+
7+
### IntelliJ IDEA ###
8+
.idea/modules.xml
9+
.idea/jarRepositories.xml
10+
.idea/compiler.xml
11+
.idea/libraries/
12+
*.iws
13+
*.iml
14+
*.ipr
15+
out/
16+
!**/src/main/**/out/
17+
!**/src/test/**/out/
18+
19+
### Kotlin ###
20+
.kotlin
21+
22+
### Eclipse ###
23+
.apt_generated
24+
.classpath
25+
.factorypath
26+
.project
27+
.settings
28+
.springBeans
29+
.sts4-cache
30+
bin/
31+
!**/src/main/**/bin/
32+
!**/src/test/**/bin/
33+
34+
### NetBeans ###
35+
/nbproject/private/
36+
/nbbuild/
37+
/dist/
38+
/nbdist/
39+
/.nb-gradle/
40+
41+
### VS Code ###
42+
.vscode/
43+
44+
### Mac OS ###
45+
.DS_Store
46+
/.idea/

LICENSE

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

app/build.gradle.kts

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
plugins {
2+
id("buildsrc.convention.kotlin-jvm")
3+
id("buildsrc.convention.spring-kotlin")
4+
}
5+
6+
7+
dependencies {
8+
9+
implementation(project(":spring-cloud-proxy-spring-boot-starter"))
10+
11+
}
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
package org.openprojectx.spring.cloud.proxy.app
2+
3+
import org.springframework.boot.autoconfigure.SpringBootApplication
4+
import org.springframework.boot.runApplication
5+
6+
7+
@SpringBootApplication
8+
class SpringCloudProxyApplication
9+
10+
fun main(args: Array<String>) {
11+
12+
runApplication<SpringCloudProxyApplication>(*args)
13+
}
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
spring:
2+
application:
3+
name: spring-cloud-proxy
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
plugins {
2+
id("buildsrc.convention.kotlin-jvm")
3+
`kotlin-kapt`
4+
}
5+
6+
7+
dependencies {
8+
9+
api(project(":core"))
10+
11+
val bootBom = platform("org.springframework.boot:spring-boot-dependencies:${libs.versions.springBoot.get()}")
12+
val cloudBom = platform(libs.springCloudDependencies)
13+
14+
implementation(bootBom)
15+
implementation(cloudBom)
16+
kapt(bootBom)
17+
18+
implementation("org.springframework.boot:spring-boot-autoconfigure")
19+
api("org.springframework.boot:spring-boot-starter")
20+
kapt("org.springframework.boot:spring-boot-configuration-processor")
21+
implementation("org.springframework.cloud:spring-cloud-starter-gateway-server-webflux")
22+
23+
testImplementation("org.springframework.boot:spring-boot-starter-test")
24+
testImplementation("org.springframework.boot:spring-boot-starter-webflux-test")
25+
testImplementation("org.testcontainers:testcontainers-junit-jupiter:2.0.3")
26+
testImplementation("org.testcontainers:testcontainers:2.0.3")
27+
testRuntimeOnly("org.junit.platform:junit-platform-launcher")
28+
29+
30+
31+
}
Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
package org.openprojectx.spring.cloud.proxy.autoconfigure
2+
3+
import org.springframework.cloud.gateway.filter.GatewayFilterChain
4+
import org.springframework.cloud.gateway.filter.GlobalFilter
5+
import org.springframework.cloud.gateway.filter.RouteToRequestUrlFilter
6+
import org.springframework.cloud.gateway.support.ServerWebExchangeUtils.GATEWAY_REQUEST_URL_ATTR
7+
import org.springframework.core.Ordered
8+
import org.springframework.http.HttpStatus
9+
import org.springframework.web.server.ServerWebExchange
10+
import reactor.core.publisher.Mono
11+
import java.net.URI
12+
13+
internal class DynamicProxyGlobalFilter(
14+
private val properties: DynamicProxyProperties,
15+
) : GlobalFilter, Ordered {
16+
17+
override fun filter(exchange: ServerWebExchange, chain: GatewayFilterChain): Mono<Void> {
18+
val path = exchange.request.path.pathWithinApplication().value()
19+
val prefix = properties.normalizedPrefix()
20+
if (path != prefix && !path.startsWith("$prefix/")) return chain.filter(exchange)
21+
22+
val destination = try {
23+
destination(path, exchange.request.uri.rawQuery)
24+
} catch (exception: IllegalArgumentException) {
25+
return badRequest(exchange, exception.message ?: "Invalid dynamic proxy destination")
26+
}
27+
28+
exchange.attributes[GATEWAY_REQUEST_URL_ATTR] = destination
29+
return chain.filter(exchange)
30+
}
31+
32+
private fun destination(path: String, rawQuery: String?): URI {
33+
val parts = path.removePrefix(properties.normalizedPrefix()).removePrefix("/").split("/", limit = 4)
34+
require(parts.size == 4 && parts[3].isNotEmpty()) {
35+
"Expected /{scheme}/{host}/{port}/{target-path}"
36+
}
37+
38+
val (scheme, host, portText, target) = parts
39+
require(scheme.lowercase() in properties.allowedSchemes.map(String::lowercase)) {
40+
"Unsupported proxy scheme: $scheme"
41+
}
42+
require(host.isNotBlank()) { "Proxy host must not be blank" }
43+
val port = portText.toIntOrNull()
44+
require(port != null && port in 1..65535) { "Proxy port must be between 1 and 65535" }
45+
46+
val authority = URI(scheme.lowercase(), null, host, port, null, null, null).toASCIIString()
47+
// target and rawQuery came from the already parsed request URI. Reusing their raw forms avoids
48+
// turning an encoded value such as %20 into %2520 on the downstream request.
49+
return URI.create(buildString {
50+
append(authority).append('/').append(target)
51+
if (rawQuery != null) append('?').append(rawQuery)
52+
})
53+
}
54+
55+
private fun badRequest(exchange: ServerWebExchange, message: String): Mono<Void> {
56+
exchange.response.statusCode = HttpStatus.BAD_REQUEST
57+
val body = """{"error":"${message.jsonEscape()}"}""".toByteArray()
58+
exchange.response.headers.contentType = org.springframework.http.MediaType.APPLICATION_JSON
59+
return exchange.response.writeWith(Mono.just(exchange.response.bufferFactory().wrap(body)))
60+
}
61+
62+
// RouteToRequestUrlFilter first installs the route's placeholder URL; this filter then replaces it.
63+
override fun getOrder(): Int = RouteToRequestUrlFilter.ROUTE_TO_URL_FILTER_ORDER + 1
64+
}
65+
66+
internal fun DynamicProxyProperties.normalizedPrefix(): String =
67+
"/" + pathPrefix.trim().trim('/').also { require(it.isNotEmpty()) { "pathPrefix must not be blank" } }
68+
69+
private fun String.jsonEscape(): String = buildString {
70+
this@jsonEscape.forEach { character ->
71+
when (character) {
72+
'\\' -> append("\\\\")
73+
'"' -> append("\\\"")
74+
'\n' -> append("\\n")
75+
'\r' -> append("\\r")
76+
'\t' -> append("\\t")
77+
else -> append(character)
78+
}
79+
}
80+
}

0 commit comments

Comments
 (0)