diff --git a/spring-cloud-gateway/2.0.0.M2/ghpages.sh b/spring-cloud-gateway/2.0.0.M2/ghpages.sh new file mode 100644 index 00000000..57c5da3a --- /dev/null +++ b/spring-cloud-gateway/2.0.0.M2/ghpages.sh @@ -0,0 +1,330 @@ +#!/bin/bash -x + +set -e + +# Set default props like MAVEN_PATH, ROOT_FOLDER etc. +function set_default_props() { + # The script should be executed from the root folder + ROOT_FOLDER=`pwd` + echo "Current folder is ${ROOT_FOLDER}" + + if [[ ! -e "${ROOT_FOLDER}/.git" ]]; then + echo "You're not in the root folder of the project!" + exit 1 + fi + + # Prop that will let commit the changes + COMMIT_CHANGES="no" + MAVEN_PATH=${MAVEN_PATH:-} + echo "Path to Maven is [${MAVEN_PATH}]" + REPO_NAME=${PWD##*/} + echo "Repo name is [${REPO_NAME}]" + SPRING_CLOUD_STATIC_REPO=${SPRING_CLOUD_STATIC_REPO:-git@github.com:spring-cloud/spring-cloud-static.git} + echo "Spring Cloud Static repo is [${SPRING_CLOUD_STATIC_REPO}" +} + +# Check if gh-pages exists and docs have been built +function check_if_anything_to_sync() { + git remote set-url --push origin `git config remote.origin.url | sed -e 's/^git:/https:/'` + + if ! (git remote set-branches --add origin gh-pages && git fetch -q); then + echo "No gh-pages, so not syncing" + exit 0 + fi + + if ! [ -d docs/target/generated-docs ] && ! [ "${BUILD}" == "yes" ]; then + echo "No gh-pages sources in docs/target/generated-docs, so not syncing" + exit 0 + fi +} + +function retrieve_current_branch() { + # Code getting the name of the current branch. For master we want to publish as we did until now + # http://stackoverflow.com/questions/1593051/how-to-programmatically-determine-the-current-checked-out-git-branch + # If there is a branch already passed will reuse it - otherwise will try to find it + CURRENT_BRANCH=${BRANCH} + if [[ -z "${CURRENT_BRANCH}" ]] ; then + CURRENT_BRANCH=$(git symbolic-ref -q HEAD) + CURRENT_BRANCH=${CURRENT_BRANCH##refs/heads/} + CURRENT_BRANCH=${CURRENT_BRANCH:-HEAD} + fi + echo "Current branch is [${CURRENT_BRANCH}]" + git checkout ${CURRENT_BRANCH} || echo "Failed to check the branch... continuing with the script" +} + +# Switches to the provided value of the release version. We always prefix it with `v` +function switch_to_tag() { + git checkout v${VERSION} +} + +# Build the docs if switch is on +function build_docs_if_applicable() { + if [[ "${BUILD}" == "yes" ]] ; then + ./mvnw clean install -P docs -pl docs -DskipTests + fi +} + +# Get the name of the `docs.main` property +# Get whitelisted branches - assumes that a `docs` module is available under `docs` profile +function retrieve_doc_properties() { + MAIN_ADOC_VALUE=$("${MAVEN_PATH}"mvn -q \ + -Dexec.executable="echo" \ + -Dexec.args='${docs.main}' \ + --non-recursive \ + org.codehaus.mojo:exec-maven-plugin:1.3.1:exec) + echo "Extracted 'main.adoc' from Maven build [${MAIN_ADOC_VALUE}]" + + + WHITELIST_PROPERTY=${WHITELIST_PROPERTY:-"docs.whitelisted.branches"} + WHITELISTED_BRANCHES_VALUE=$("${MAVEN_PATH}"mvn -q \ + -Dexec.executable="echo" \ + -Dexec.args="\${${WHITELIST_PROPERTY}}" \ + org.codehaus.mojo:exec-maven-plugin:1.3.1:exec \ + -P docs \ + -pl docs) + echo "Extracted '${WHITELIST_PROPERTY}' from Maven build [${WHITELISTED_BRANCHES_VALUE}]" +} + +# Stash any outstanding changes +function stash_changes() { + git diff-index --quiet HEAD && dirty=$? || (echo "Failed to check if the current repo is dirty. Assuming that it is." && dirty="1") + if [ "$dirty" != "0" ]; then git stash; fi +} + +# Switch to gh-pages branch to sync it with current branch +function add_docs_from_target() { + local DESTINATION_REPO_FOLDER + if [[ -z "${DESTINATION}" && -z "${CLONE}" ]] ; then + DESTINATION_REPO_FOLDER=${ROOT_FOLDER} + elif [[ "${CLONE}" == "yes" ]]; then + mkdir -p ${ROOT_FOLDER}/target + local clonedStatic=${ROOT_FOLDER}/target/spring-cloud-static + if [[ ! -e "${clonedStatic}/.git" ]]; then + echo "Cloning Spring Cloud Static to target" + git clone ${SPRING_CLOUD_STATIC_REPO} ${clonedStatic} && git checkout gh-pages + else + echo "Spring Cloud Static already cloned - will pull changes" + cd ${clonedStatic} && git checkout gh-pages && git pull origin gh-pages + fi + DESTINATION_REPO_FOLDER=${clonedStatic}/${REPO_NAME} + mkdir -p ${DESTINATION_REPO_FOLDER} + else + if [[ ! -e "${DESTINATION}/.git" ]]; then + echo "[${DESTINATION}] is not a git repository" + exit 1 + fi + DESTINATION_REPO_FOLDER=${DESTINATION}/${REPO_NAME} + mkdir -p ${DESTINATION_REPO_FOLDER} + echo "Destination was provided [${DESTINATION}]" + fi + cd ${DESTINATION_REPO_FOLDER} + git checkout gh-pages + git pull origin gh-pages + + # Add git branches + ################################################################### + if [[ -z "${VERSION}" ]] ; then + copy_docs_for_current_version + else + copy_docs_for_provided_version + fi + commit_changes_if_applicable +} + + +# Copies the docs by using the retrieved properties from Maven build +function copy_docs_for_current_version() { + if [[ "${CURRENT_BRANCH}" == "master" ]] ; then + echo -e "Current branch is master - will copy the current docs only to the root folder" + for f in docs/target/generated-docs/*; do + file=${f#docs/target/generated-docs/*} + if ! git ls-files -i -o --exclude-standard --directory | grep -q ^$file$; then + # Not ignored... + cp -rf $f ${ROOT_FOLDER}/ + git add -A ${ROOT_FOLDER}/$file + fi + done + COMMIT_CHANGES="yes" + else + echo -e "Current branch is [${CURRENT_BRANCH}]" + # http://stackoverflow.com/questions/29300806/a-bash-script-to-check-if-a-string-is-present-in-a-comma-separated-list-of-strin + if [[ ",${WHITELISTED_BRANCHES_VALUE}," = *",${CURRENT_BRANCH},"* ]] ; then + mkdir -p ${ROOT_FOLDER}/${CURRENT_BRANCH} + echo -e "Branch [${CURRENT_BRANCH}] is whitelisted! Will copy the current docs to the [${CURRENT_BRANCH}] folder" + for f in docs/target/generated-docs/*; do + file=${f#docs/target/generated-docs/*} + if ! git ls-files -i -o --exclude-standard --directory | grep -q ^$file$; then + # Not ignored... + # We want users to access 1.0.0.RELEASE/ instead of 1.0.0.RELEASE/spring-cloud.sleuth.html + if [[ "${file}" == "${MAIN_ADOC_VALUE}.html" ]] ; then + # We don't want to copy the spring-cloud-sleuth.html + # we want it to be converted to index.html + cp -rf $f ${ROOT_FOLDER}/${CURRENT_BRANCH}/index.html + git add -A ${ROOT_FOLDER}/${CURRENT_BRANCH}/index.html + else + cp -rf $f ${ROOT_FOLDER}/${CURRENT_BRANCH} + git add -A ${ROOT_FOLDER}/${CURRENT_BRANCH}/$file + fi + fi + done + COMMIT_CHANGES="yes" + else + echo -e "Branch [${CURRENT_BRANCH}] is not on the white list! Check out the Maven [${WHITELIST_PROPERTY}] property in + [docs] module available under [docs] profile. Won't commit any changes to gh-pages for this branch." + fi + fi +} + +# Copies the docs by using the explicitly provided version +function copy_docs_for_provided_version() { + local FOLDER=${DESTINATION_REPO_FOLDER}/${VERSION} + mkdir -p ${FOLDER} + echo -e "Current tag is [v${VERSION}] Will copy the current docs to the [${FOLDER}] folder" + for f in ${ROOT_FOLDER}/docs/target/generated-docs/*; do + file=${f#${ROOT_FOLDER}/docs/target/generated-docs/*} + copy_docs_for_branch ${file} ${FOLDER} + done + COMMIT_CHANGES="yes" + CURRENT_BRANCH="v${VERSION}" +} + +# Copies the docs from target to the provided destination +# Params: +# $1 - file from target +# $2 - destination to which copy the files +function copy_docs_for_branch() { + local file=$1 + local destination=$2 + if ! git ls-files -i -o --exclude-standard --directory | grep -q ^${file}$; then + # Not ignored... + # We want users to access 1.0.0.RELEASE/ instead of 1.0.0.RELEASE/spring-cloud.sleuth.html + if [[ ("${file}" == "${MAIN_ADOC_VALUE}.html") || ("${file}" == "${REPO_NAME}.html") ]] ; then + # We don't want to copy the spring-cloud-sleuth.html + # we want it to be converted to index.html + cp -rf $f ${destination}/index.html + git add -A ${destination}/index.html + else + cp -rf $f ${destination} + git add -A ${destination}/$file + fi + fi +} + +function commit_changes_if_applicable() { + if [[ "${COMMIT_CHANGES}" == "yes" ]] ; then + COMMIT_SUCCESSFUL="no" + git commit -a -m "Sync docs from ${CURRENT_BRANCH} to gh-pages" && COMMIT_SUCCESSFUL="yes" || echo "Failed to commit changes" + + # Uncomment the following push if you want to auto push to + # the gh-pages branch whenever you commit to master locally. + # This is a little extreme. Use with care! + ################################################################### + if [[ "${COMMIT_SUCCESSFUL}" == "yes" ]] ; then + git push origin gh-pages + fi + fi +} + +# Switch back to the previous branch and exit block +function checkout_previous_branch() { + # If -version was provided we need to come back to root project + cd ${ROOT_FOLDER} + git checkout ${CURRENT_BRANCH} || echo "Failed to check the branch... continuing with the script" + if [ "$dirty" != "0" ]; then git stash pop; fi + exit 0 +} + +# Assert if properties have been properly passed +function assert_properties() { +echo "VERSION [${VERSION}], DESTINATION [${DESTINATION}], CLONE [${CLONE}]" +if [[ "${VERSION}" != "" && (-z "${DESTINATION}" && -z "${CLONE}") ]] ; then echo "Version was set but destination / clone was not!"; exit 1;fi +if [[ ("${DESTINATION}" != "" && "${CLONE}" != "") && -z "${VERSION}" ]] ; then echo "Destination / clone was set but version was not!"; exit 1;fi +if [[ "${DESTINATION}" != "" && "${CLONE}" == "yes" ]] ; then echo "Destination and clone was set. Pick one!"; exit 1;fi +} + +# Prints the usage +function print_usage() { +cat </` +- if the destination switch is passed (-d) then the script will check if the provided dir is a git repo and then will + switch to gh-pages of that repo and copy the generated docs to `docs//` + +USAGE: + +You can use the following options: + +-v|--version - the script will apply the whole procedure for a particular library version +-d|--destination - the root of destination folder where the docs should be copied. You have to use the full path. + E.g. point to spring-cloud-static folder. Can't be used with (-c) +-b|--build - will run the standard build process after checking out the branch +-c|--clone - will automatically clone the spring-cloud-static repo instead of providing the destination. + Obviously can't be used with (-d) + +EOF +} + + +# ========================================== +# ____ ____ _____ _____ _____ _______ +# / ____|/ ____| __ \|_ _| __ \__ __| +# | (___ | | | |__) | | | | |__) | | | +# \___ \| | | _ / | | | ___/ | | +# ____) | |____| | \ \ _| |_| | | | +# |_____/ \_____|_| \_\_____|_| |_| +# +# ========================================== + +while [[ $# > 0 ]] +do +key="$1" +case ${key} in + -v|--version) + VERSION="$2" + shift # past argument + ;; + -d|--destination) + DESTINATION="$2" + shift # past argument + ;; + -b|--build) + BUILD="yes" + ;; + -c|--clone) + CLONE="yes" + ;; + -h|--help) + print_usage + exit 0 + ;; + *) + echo "Invalid option: [$1]" + print_usage + exit 1 + ;; +esac +shift # past argument or value +done + +assert_properties +set_default_props +check_if_anything_to_sync +if [[ -z "${VERSION}" ]] ; then + retrieve_current_branch +else + switch_to_tag +fi +build_docs_if_applicable +retrieve_doc_properties +stash_changes +add_docs_from_target +checkout_previous_branch \ No newline at end of file diff --git a/spring-cloud-gateway/2.0.0.M2/images/spring_cloud_gateway_diagram.png b/spring-cloud-gateway/2.0.0.M2/images/spring_cloud_gateway_diagram.png new file mode 100644 index 00000000..25ffbcce Binary files /dev/null and b/spring-cloud-gateway/2.0.0.M2/images/spring_cloud_gateway_diagram.png differ diff --git a/spring-cloud-gateway/2.0.0.M2/index.html b/spring-cloud-gateway/2.0.0.M2/index.html new file mode 100644 index 00000000..ea8bb1a4 --- /dev/null +++ b/spring-cloud-gateway/2.0.0.M2/index.html @@ -0,0 +1,1398 @@ + + + + + + + +Spring Cloud Gateway + + + + + +
+
+
+
+

2.0.0.M2

+
+
+

This project provides an API Gateway built on top of the Spring Ecosystem, including: Spring 5, Spring Boot 2 and Project Reactor. Spring Cloud Gateway aims to provide a simple, yet effective way to route to APIs and provide cross cutting concerns to them such as: security, monitoring/metrics, and resiliency.

+
+
+
+
+

How to Include Spring Cloud Gateway

+
+
+

To include Spring Cloud Gateway in your project use the starter with group org.springframework.cloud +and artifact id spring-cloud-starter-gateway. See the Spring Cloud Project page +for details on setting up your build system with the current Spring Cloud Release Train.

+
+
+

If you include the starter, but, for some reason, you do not want the gateway to be enabled, set spring.cloud.gateway.enabled=false.

+
+
+
+
+

Glossary

+
+
+
    +
  • +

    Route: Route the basic building block of the gateway. It is defined by an ID, a destination URI, a collection of predicates and a collection of filters. A route is matched if aggregate predicate is true.

    +
    • +
  • +

    Predicate: This is a Java 8 Function Predicate. The input type is a Spring Framework ServerWebExchange. This allows developers to match on anything from the HTTP request, such as headers or parameters.

    +
    • +
  • +

    Filter: These are instances Spring Framework WebFilter constructed in with a specific factory. Here, requests and responses can be modified before or after sending the downstream request.

    +
    • +
+
+
+
+
+

How It Works

+
+
+
+Spring Cloud Gateway Diagram +
+
+
+

Clients make requests to Spring Cloud Gateway. If the Gateway Handler Mapping determines that a request matches a Route, it is sent to the Gateway Web Handler. This handler runs sends the request through a filter chain that is specific to the request. The reason the filters are divided by the dotted line, is that filters may execute logic before the proxy request is sent or after. All "pre" filter logic is executed, then the proxy request is made. After the proxy request is made, the "post" filter logic is executed.

+
+
+
+
+

Route Predicate Factories

+
+
+

Spring Cloud Gateway matches routes as part of the Spring WebFlux HandlerMapping infrastructure. Spring Cloud Gateway includes many built-in Route Predicate Factorys. All of these predicates match on different attributes of the HTTP request. Multiple Route Predicate Factorys can be combined and are combined via logical and.

+
+
+

After Route Predicate Factory

+
+

The After Route Predicate Factory takes one parameter, a datetime. This predicate matches requests that happen after the current datetime.

+
+
+
application.yml
+
+
spring:
+  cloud:
+    gateway:
+      routes:
+      # =====================================
+      - id: after_route
+        uri: http://example.org
+        predicates:
+        - After=2017-01-20T17:42:47.789-07:00[America/Denver]
+
+
+
+

This route matches any request after Jan 20, 2017 17:42 Mountain Time (Denver).

+
+
+
+

Before Route Predicate Factory

+
+

The Before Route Predicate Factory takes one parameter, a datetime. This predicate matches requests that happen before the current datetime.

+
+
+
application.yml
+
+
spring:
+  cloud:
+    gateway:
+      routes:
+      # =====================================
+      - id: before_route
+        uri: http://example.org
+        predicates:
+        - Before=2017-01-20T17:42:47.789-07:00[America/Denver]
+
+
+
+

This route matches any request before Jan 20, 2017 17:42 Mountain Time (Denver).

+
+
+
+

Between Route Predicate Factory

+
+

The Between Route Predicate Factory takes two parameters, datetime1 and datetime2. This predicate matches requests that happen after datetime1 and before datetime2. The datetime2 parameter must be after datetime1.

+
+
+
application.yml
+
+
spring:
+  cloud:
+    gateway:
+      routes:
+      # =====================================
+      - id: between_route
+        uri: http://example.org
+        predicates:
+        - Betweeen=2017-01-20T17:42:47.789-07:00[America/Denver], 2017-01-21T17:42:47.789-07:00[America/Denver]
+
+
+
+

This route matches any request after Jan 20, 2017 17:42 Mountain Time (Denver) and before Jan 21, 2017 17:42 Mountain Time (Denver). This could be useful for maintenance windows.

+
+
+
+

Cookie Route Predicate Factory

+
+

The Cookie Route Predicate Factory takes two parameters, the cookie name and a regular expression. This predicate matches cookies that have the given name and the value matches the regular expression.

+
+
+
application.yml
+
+
spring:
+  cloud:
+    gateway:
+      routes:
+      # =====================================
+      - id: cookie_route
+        uri: http://example.org
+        predicates:
+        - Cookie=chocolate, ch.p
+
+
+
+

This route matches the request has a cookie named chocolate who’s value matches the ch.p regular expression.

+
+
+
+

Header Route Predicate Factory

+
+

The Header Route Predicate Factory takes two parameters, the header name and a regular expression. This predicate matches with a header that has the given name and the value matches the regular expression.

+
+
+
application.yml
+
+
spring:
+  cloud:
+    gateway:
+      routes:
+      # =====================================
+      - id: header_route
+        uri: http://example.org
+        predicates:
+        - Header=X-Request-Id, \d+
+
+
+
+

This route matches if the request has a header named X-Request-Id whos value matches the \d+ regular expression (has a value of one or more digits).

+
+
+
+

Host Route Predicate Factory

+
+

The Host Route Predicate Factory takes one parameter: the host name pattern. The pattern is an Ant style pattern with . as the separator. This predicates matches the Host header that matches the pattern.

+
+
+
application.yml
+
+
spring:
+  cloud:
+    gateway:
+      routes:
+      # =====================================
+      - id: host_route
+        uri: http://example.org
+        predicates:
+        - Host=**.somehost.org
+
+
+
+

This route would match if the request has a Host header has the value www.somehost.org or beta.somehost.org.

+
+
+
+

Method Route Predicate Factory

+
+

The Method Route Predicate Factory takes one parameter: the HTTP method to match.

+
+
+
application.yml
+
+
spring:
+  cloud:
+    gateway:
+      routes:
+      # =====================================
+      - id: method_route
+        uri: http://example.org
+        predicates:
+        - Method=GET
+
+
+
+

This route would match if the request method was a GET.

+
+
+
+

Path Route Predicate Factory

+
+

The Path Route Predicate Factory takes one parameter: a Spring PathMatcher pattern.

+
+
+
application.yml
+
+
spring:
+  cloud:
+    gateway:
+      routes:
+      # =====================================
+      - id: host_route
+        uri: http://example.org
+        predicates:
+        - Path=/foo/{segment}
+
+
+
+

This route would match if the request path was, for example: /foo/1 or /foo/bar.

+
+
+

This predicate extracts the URI template variables (like segment defined in the example above) as a map of names and values and places it in the ServerWebExchange.getAttributes() with a key defined in PathRoutePredicate.URL_PREDICATE_VARS_ATTR. Those values are then available for use by WebFilter Factorys

+
+
+
+

Query Route Predicate Factory

+
+

The Query Route Predicate Factory takes two parameters: a required param and an optional regexp.

+
+
+
application.yml
+
+
spring:
+  cloud:
+    gateway:
+      routes:
+      # =====================================
+      - id: query_route
+        uri: http://example.org
+        predicates:
+        - Query=baz
+
+
+
+

This route would match if the request contained a baz query parameter.

+
+
+
application.yml
+
+
spring:
+  cloud:
+    gateway:
+      routes:
+      # =====================================
+      - id: query_route
+        uri: http://example.org
+        predicates:
+        - Query=foo, ba.
+
+
+
+

This route would match if the request contained a foo query parameter whose value matched the ba. regexp, so bar and baz would match.

+
+
+
+

RemoteAddr Route Predicate Factory

+
+

The RemoteAddr Route Predicate Factory takes a list (min size 1) of CIDR-notation strings, e.g. 192.168.0.1/16 (where 192.168.0.1 is an IP address and 16 is a subnet mask.

+
+
+
application.yml
+
+
spring:
+  cloud:
+    gateway:
+      routes:
+      # =====================================
+      - id: remoteaddr_route
+        uri: http://example.org
+        predicates:
+        - RemoteAddr=192.168.1.1/24
+
+
+
+

This route would match if the remote address of the request was, for example, 192.168.1.10.

+
+
+
+
+
+

WebFilter Factorys

+
+
+

Route filters allow the modification of the incoming HTTP request or outgoing HTTP response in some manner. Route filters are scoped to a particular route. Spring Cloud Gateway includes many built-in WebFilter Factories.

+
+
+

AddRequestHeader WebFilter Factory

+
+

The AddRequestHeader WebFilter Factory takes a name and value parameter.

+
+
+
application.yml
+
+
spring:
+  cloud:
+    gateway:
+      routes:
+      # =====================================
+      - id: add_request_header_route
+        uri: http://example.org
+        filters:
+        - AddRequestHeader=X-Request-Foo, Bar
+
+
+
+

This will add X-Request-Foo:Bar header to the downstream request’s headers for all matching requests.

+
+
+
+

AddRequestParameter WebFilter Factory

+
+

The AddRequestParameter WebFilter Factory takes a name and value parameter.

+
+
+
application.yml
+
+
spring:
+  cloud:
+    gateway:
+      routes:
+      # =====================================
+      - id: add_request_parameter_route
+        uri: http://example.org
+        filters:
+        - AddRequestParameter=foo, bar
+
+
+
+

This will add foo=bar to the downstream request’s query string for all matching requests.

+
+
+
+

AddResponseHeader WebFilter Factory

+
+

The AddResponseHeader WebFilter Factory takes a name and value parameter.

+
+
+
application.yml
+
+
spring:
+  cloud:
+    gateway:
+      routes:
+      # =====================================
+      - id: add_request_header_route
+        uri: http://example.org
+        filters:
+        - AddResponseHeader=X-Response-Foo, Bar
+
+
+
+

This will add X-Response-Foo:Bar header to the downstream response’s headers for all matching requests.

+
+
+
+

Hystrix WebFilter Factory

+
+

The Hystrix WebFilter Factory takes a single name parameters, which is the name of the HystrixCommand. (More options might be added in future releases).

+
+
+
application.yml
+
+
spring:
+  cloud:
+    gateway:
+      routes:
+      # =====================================
+      - id: hytstrix_route
+        uri: http://example.org
+        filters:
+        - Hystrix=myCommandName
+
+
+
+

This wraps the remaining filters in a HystrixCommand with command name myCommandName.

+
+
+
+

PrefixPath WebFilter Factory

+
+

The PrefixPath WebFilter Factory takes a single prefix parameter.

+
+
+
application.yml
+
+
spring:
+  cloud:
+    gateway:
+      routes:
+      # =====================================
+      - id: prefixpath_route
+        uri: http://example.org
+        filters:
+        - PrefixPath=/mypath
+
+
+
+

This will prefix /mypath to the path of all matching requests. So a request to /hello, would be sent to /mypath/hello.

+
+
+
+

RequestRateLimiter WebFilter Factory

+
+

The RequestRateLimiter WebFilter Factory takes three parameters: replenishRate, burstCapacity & keyResolverName.

+
+
+

replenishRate is how many requests per second do you want a user to be allowed to do.

+
+
+

burstCapacity TODO: document burst capacity

+
+
+

keyResolverName is the name of a bean that implements the KeyResolver interface.

+
+
+
KeyResolver.java
+
+
public interface KeyResolver {
+	Mono<String> resolve(ServerWebExchange exchange);
+}
+
+
+
+

The KeyResolver interface allows pluggable strategies to derive the key for limiting requests. In future milestones, there will be some KeyResolver implementations.

+
+
+

The redis implementation is based off of work done at Stripe. It requires the use of the spring-boot-starter-data-redis-reactive Spring Boot starter.

+
+
+
application.yml
+
+
spring:
+  cloud:
+    gateway:
+      routes:
+      # =====================================
+      - id: requestratelimiter_route
+        uri: http://example.org
+        filters:
+        - RequestRateLimiter=10, 20, userKeyResolver
+
+
+
+
Config.java
+
+
@Bean
+KeyResolver userKeyResolver() {
+    return exchange -> Mono.just(exchange.getRequest().getQueryParams().getFirst("user"));
+}
+
+
+
+

This defines a request rate limit of 10 per user. The KeyResolver is a simple one that gets the user request parameter (note: this is not recommended for production).

+
+
+
+

RedirectTo WebFilter Factory

+
+

The RedirectTo WebFilter Factory takes a status and a url parameter. The status should be a 300 series redirect http code, such as 301. The url should be a valid url. This will be the value of the Location header.

+
+
+
application.yml
+
+
spring:
+  cloud:
+    gateway:
+      routes:
+      # =====================================
+      - id: prefixpath_route
+        uri: http://example.org
+        filters:
+        - RedirectTo=302, http://acme.org
+
+
+
+

This will send a status 302 with a Location:http://acme.org header to perform a redirect.

+
+
+
+

RemoveNonProxyHeaders WebFilter Factory

+
+

The RemoveNonProxyHeaders WebFilter Factory removes headers from forwarded requests. The default list of headers that is removed comes from the IETF.

+
+
+
The default removed headers are:
+
    +
  • +

    Connection

    +
    • +
  • +

    Keep-Alive

    +
    • +
  • +

    Proxy-Authenticate

    +
    • +
  • +

    Proxy-Authorization

    +
    • +
  • +

    TE

    +
    • +
  • +

    Trailer

    +
    • +
  • +

    Transfer-Encoding

    +
    • +
  • +

    Upgrade

    +
    • +
+
+
+

To change this, set the spring.cloud.gateway.filter.remove-non-proxy-headers.headers property to the list of header names to remove.

+
+
+
+

RemoveRequestHeader WebFilter Factory

+
+

The RemoveRequestHeader WebFilter Factory takes a name parameter. It is the name of the header to be removed.

+
+
+
application.yml
+
+
spring:
+  cloud:
+    gateway:
+      routes:
+      # =====================================
+      - id: removerequestheader_route
+        uri: http://example.org
+        filters:
+        - RemoveRequestHeader=X-Request-Foo
+
+
+
+

This will remove the X-Request-Foo header before it is sent downstream.

+
+
+
+

RemoveResponseHeader WebFilter Factory

+
+

The RemoveResponseHeader WebFilter Factory takes a name parameter. It is the name of the header to be removed.

+
+
+
application.yml
+
+
spring:
+  cloud:
+    gateway:
+      routes:
+      # =====================================
+      - id: removeresponseheader_route
+        uri: http://example.org
+        filters:
+        - RemoveResponseHeader=X-Response-Foo
+
+
+
+

This will remove the X-Response-Foo header from the response before it is returned to the gateway client.

+
+
+
+

RewritePath WebFilter Factory

+
+

The RewritePath WebFilter Factory takes a path regexp parameter and a replacement parameter. This uses Java regular expressions for a flexible way to rewrite the request path.

+
+
+
application.yml
+
+
spring:
+  cloud:
+    gateway:
+      routes:
+      # =====================================
+      - id: rewritepath_route
+        uri: http://example.org
+        - Path=/foo/**
+        filters:
+        - RewritePath=/foo/(?<segment>.*), /$\{segment}
+
+
+
+

For a request path of /foo/bar, this will set the path to /bar before making the downstream request. Notice the $\ which is replaced with $ because of the YAML spec.

+
+
+
+

SecureHeaders WebFilter Factory

+
+

The SecureHeaders WebFilter Factory adds a number of headers to the response at the reccomendation from this blog post.

+
+
+
The following headers are added (allong with default values):
+
    +
  • +

    X-Xss-Protection:1; mode=block

    +
    • +
  • +

    Strict-Transport-Security:max-age=631138519

    +
    • +
  • +

    X-Frame-Options:DENY

    +
    • +
  • +

    X-Content-Type-Options:nosniff

    +
    • +
  • +

    Referrer-Policy:no-referrer

    +
    • +
  • +

    Content-Security-Policy:default-src 'self' https:; font-src 'self' https: data:; img-src 'self' https: data:; object-src 'none'; script-src https:; style-src 'self' https: 'unsafe-inline'

    +
    • +
  • +

    X-Download-Options:noopen

    +
    • +
  • +

    X-Permitted-Cross-Domain-Policies:none

    +
    • +
+
+
+

To change the default values set the appropriate property in the spring.cloud.gateway.filter.secure-headers namespace:

+
+
+
Property to change:
+
    +
  • +

    xss-protection-header

    +
    • +
  • +

    strict-transport-security

    +
    • +
  • +

    frame-options

    +
    • +
  • +

    content-type-options

    +
    • +
  • +

    referrer-policy

    +
    • +
  • +

    content-security-policy

    +
    • +
  • +

    download-options

    +
    • +
  • +

    permitted-cross-domain-policies

    +
    • +
+
+
+
+

SetPath WebFilter Factory

+
+

The SetPath WebFilter Factory takes a path template parameter. It offers a simple way to manipulate the request path by allowing templated segments of the path. This uses the uri templates from Spring Framework. Multiple matching segments are allowed.

+
+
+
application.yml
+
+
spring:
+  cloud:
+    gateway:
+      routes:
+      # =====================================
+      - id: setpath_route
+        uri: http://example.org
+        predicates:
+        - Path=/foo/{segment}
+        filters:
+        - SetPath=/{segment}
+
+
+
+

For a request path of /foo/bar, this will set the path to /bar before making the downstream request.

+
+
+
+

SetResponseHeader WebFilter Factory

+
+

The SetResponseHeader WebFilter Factory takes name and value parameters.

+
+
+
application.yml
+
+
spring:
+  cloud:
+    gateway:
+      routes:
+      # =====================================
+      - id: setresponseheader_route
+        uri: http://example.org
+        filters:
+        - SetResponseHeader=X-Response-Foo, Bar
+
+
+
+

This WebFilter replaces all headers with the given name, rather than adding. So if the downstream server responded with a X-Response-Foo:1234, this would be replaced with X-Response-Foo:Bar, which is what the gateway client would receive.

+
+
+
+

SetStatus WebFilter Factory

+
+

The SetStatus WebFilter Factory takes a single status parameter. It must be a valid Spring HttpStatus. It may be the integer value 404 or the string representation of the enumeration NOT_FOUND.

+
+
+
application.yml
+
+
spring:
+  cloud:
+    gateway:
+      routes:
+      # =====================================
+      - id: setstatusstring_route
+        uri: http://example.org
+        filters:
+        - SetStatus=BAD_REQUEST
+      - id: setstatusint_route
+        uri: http://example.org
+        filters:
+        - SetStatus=401
+
+
+
+

In either case, the HTTP status of the response will be set to 401.

+
+
+
+
+
+

Global Filters

+
+
+

The GlobalFilter interface has the same signature as WebFilter. These are special filters that are conditionally applied to all routes. (This interface and usage are subject to change in future milestones).

+
+
+

LoadBalancerClient Filter

+
+

The LoadBalancerClientFilter looks for a URI in the exchange attribute ServerWebExchangeUtils.GATEWAY_REQUEST_URL_ATTR. If the url has a lb scheme (ie lb://myservice), it will use the Spring Cloud LoadBalancerClient to resolve the name (myservice in the previous example) to an actual host and port and replace the URI in the same attribute. The unmodified original url is placed in the ServerWebExchangeUtils.GATEWAY_ORIGINAL_REQUEST_URL_ATTR attribute.

+
+
+
+

Netty Routing Filter

+
+

The Netty Routing Filter runs if the url located in the ServerWebExchangeUtils.GATEWAY_REQUEST_URL_ATTR exchange attribute has a http or https scheme. It uses the Netty HttpClient to make the downstream proxy request. The response is put in the ServerWebExchangeUtils.CLIENT_RESPONSE_ATTR exchange attribute for use in a later filter. (There is an experimental WebClientHttpRoutingFilter that performs the same function, but does not require netty)

+
+
+
+

Netty Write Response Filter

+
+

The NettyWriteResponseFilter runs if there is a Netty HttpClientResponse in the ServerWebExchangeUtils.CLIENT_RESPONSE_ATTR exchange attribute. It is run after all other filters have completed and writes the proxy response back to the gateway client response. (There is an experimental WebClientWriteResponseFilter that performs the same function, but does not require netty)

+
+
+
+

RouteToRequestUrl Filter

+
+

The RouteToRequestUrlFilter runs if there is a Route object in the ServerWebExchangeUtils.GATEWAY_ROUTE_ATTR exchange attribute. It creates a new URI, based off of the request URI, but updated with the URI attribute of the Route object. The new URI is placed in the `ServerWebExchangeUtils.GATEWAY_REQUEST_URL_ATTR exchange attribute`.

+
+
+
+

Websocket Routing Filter

+
+

The Websocket Routing Filter runs if the url located in the ServerWebExchangeUtils.GATEWAY_REQUEST_URL_ATTR exchange attribute has a ws or wss scheme. It uses the Spring Web Socket infrastructure to forward the Websocket request downstream.

+
+
+
+
+
+

Configuration

+
+
+

Configuration for Spring Cloud Gateway is driven by a collection of `RouteDefinitionLocator`s.

+
+
+
RouteDefinitionLocator.java
+
+
public interface RouteDefinitionLocator {
+	Flux<RouteDefinition> getRouteDefinitions();
+}
+
+
+
+

By default, a PropertiesRouteDefinitionLocator loads properties using Spring Boot’s @ConfigurationProperties mechanism.

+
+
+

The configuration examples above all use a shortcut notation that uses positional arguments rather than named ones. The two examples below are equivalent:

+
+
+
application.yml
+
+
spring:
+  cloud:
+    gateway:
+      routes:
+      # =====================================
+      - id: setstatus_route
+        uri: http://example.org
+        filters:
+        - name: SetStatus
+          args:
+            status: 401
+      - id: setstatusshortcut_route
+        uri: http://example.org
+        filters:
+        - SetStatus=401
+
+
+
+

For some usages of the gateway, properties will be adequate, but some production use cases will benefit from loading configuration from an external source, such as a database. Future milestone versions will have RouteDefinitionLocator implementations based off of Spring Data Repositories such as: Redis, MongoDB and Cassandra.

+
+
+

Fluent Java Routes API

+
+

To allow for simple configuration in Java, there is a fluent API defined in the Routes class.

+
+
+
Config.java
+
+
// static imports from WebFilterFactories and RoutePredicates
+@Bean
+public RouteLocator customRouteLocator(ThrottleWebFilterFactory throttle) {
+    return Routes.locator()
+            .route("test")
+                .uri("http://httpbin.org:80")
+                .predicate(host("**.abc.org").and(path("/image/png")))
+                .addResponseHeader("X-TestHeader", "foobar")
+                .and()
+            .route("test2")
+                .uri("http://httpbin.org:80")
+                .predicate(path("/image/webp"))
+                .add(addResponseHeader("X-AnotherHeader", "baz"))
+                .and()
+            .build();
+}
+
+
+
+

This style also allows for more custom predicate assertions. The predicates defined by RouteDefinitionLocator beans are combined using logical and. By using the fluent Java API, you can use the and(), or() and negate() operators on the Predicate class.

+
+
+
+
+
+

Actuator API

+
+
+

TODO: document the /gateway actuator endpoint

+
+
+
+
+

Developer Guide

+
+
+

TODO: overview of writing custom integrations

+
+
+

Writing Custom Route Predicate Factorys

+
+

TODO: document writing Custom Route Predicate Factorys

+
+
+
+

Writing Custom WebFilter Factorys

+
+

TODO: document writing Custom WebFilter Factorys

+
+
+
+

Writing Custom Global Filters

+
+

TODO: document writing Custom Global Filters

+
+
+
+

Writing Custom Route Locators and Writers

+
+

TODO: document writing Custom Route Locators and Writers

+
+
+
+
+
+

Building a Simple Gateway Using Spring MVC

+
+
+

Spring Cloud Gateway provides a utility object called ProxyExchange which you can use inside a regular Spring MVC handler as a method parameter. It supports basic downstream HTTP exchanges via methods that mirror the HTTP verbs, or forwarding to a local handler via the forward() method.

+
+
+

Example (proxying a request to "/test" downstream to a remote server):

+
+
+
+
@RestController
+@SpringBootApplication
+public class GatewaySampleApplication {
+
+	@Value("${remote.home}")
+	private URI home;
+
+	@GetMapping("/test")
+	public ResponseEntity<?> proxy(ProxyExchange<Object> proxy) throws Exception {
+		return proxy.uri(home.toString() + "/image/png").get();
+	}
+
+}
+
+
+
+

There are convenience methods on the ProxyExchange to enable the handler method to discover and enhance the URI path of the incoming request. For example you might want to extract the trailing elements of a path to pass them downstream:

+
+
+
+
@GetMapping("/proxy/path/**")
+public ResponseEntity<?> proxyPath(ProxyExchange<?> proxy) throws Exception {
+  String path = proxy.path("/proxy/path/");
+  return proxy.uri(home.toString() + "/foos/" + path).get();
+}
+
+
+
+

All the features of Spring MVC are available to Gateway handler methods. So you can inject request headers and query parameters, for instance, and you can constrain the incoming requests with declarations in the mapping annotation. See the documentation for @RequestMapping in Spring MVC for more details of those features.

+
+
+

Headers can be added to the downstream response using the header() methods on ProxyExchange.

+
+
+

You can also manipulate response headers (and anything else you like in the response) by adding a mapper to the get() etc. method. The mapper is a Function that takes the incoming ResponseEntity and converts it to an outgoing one.

+
+
+

First class support is provided for "sensitive" headers ("cookie" and "authorization" by default) which are not passed downstream, and for "proxy" headers (x-forwarded-*).

+
+
+
+
+ + + + + \ No newline at end of file