io microsphere spring webmvc handler ReversedProxyHandlerMapping

ReversedProxyHandlerMapping

Type: Class | Module: microsphere-spring-webmvc | Package: io.microsphere.spring.webmvc.handler | Since: 1.0.0

Source: microsphere-spring-webmvc/src/main/java/io/microsphere/spring/webmvc/handler/ReversedProxyHandlerMapping.java

Overview

The performance optimization HandlerMapping to process the forwarded request from the reversed proxy web server, e.g, Spring Cloud Netflix Zuul, Spring Cloud Gateway or others. The request must have a header named WebEndpointMapping#ID_HEADER_NAME "microsphere_wem_id", which is a string presenting WebEndpointMapping#getId() the id of endpoint, used to locate the actual WebEndpointMapping#getEndpoint() endpoint easily, such as HandlerMethod, org.springframework.web.servlet.function.HandlerFunction and Controller.

As a result, ReversedProxyHandlerMapping has the higher precedence than others, which ensures that it prioritizes HandlerMapping#getHandler(HttpServletRequest) getting the handler and avoid the duplication that was executed by the reversed proxy. As regards the details of WebEndpointMapping#getEndpoint() endpoint, it's recommended to read the JavaDoc of WebEndpointMapping#getEndpoint().

For now, ReversedProxyHandlerMapping only supports to get the handlers from RequestMappingHandlerMapping.

Declaration

public class ReversedProxyHandlerMapping extends AbstractHandlerMapping implements ApplicationListener<WebEndpointMappingsReadyEvent>

Author: Mercy

Version Information

• Introduced in: 1.0.0
• Current Project Version: 0.2.27-SNAPSHOT

Version Compatibility

This component is tested and compatible with the following Java versions:

Java Version	Status
Java 17	✅ Compatible
Java 21	✅ Compatible
Java 25	✅ Compatible

Usage

Maven Dependency

Add the following dependency to your pom.xml:

<dependency>
    <groupId>io.github.microsphere-projects</groupId>
    <artifactId>microsphere-spring-webmvc</artifactId>
    <version>${microsphere-spring.version}</version>
</dependency>

Tip: Use the BOM (microsphere-spring-dependencies) for consistent version management. See the Getting Started guide.

Import

import io.microsphere.spring.webmvc.handler.ReversedProxyHandlerMapping;

API Reference

Public Methods

Method	Description
onApplicationEvent

See Also

• WebEndpointMapping
• AbstractUrlHandlerMapping
• AbstractHandlerMethodMapping
• HandlerMetadataWebEndpointMappingFactory
• RequestMappingMetadataWebEndpointMappingFactory
• RequestMappingInfoHandlerMapping

---

This documentation was auto-generated from the source code of microsphere-spring.