映射 (mappings)

终端节点提供有关应用程序请求映射的信息。mappingsspring-doc.cn

检索映射

要检索映射,请向 发出请求,如以下基于 curl 的示例所示:GET/actuator/mappingsspring-doc.cn

$ curl 'http://localhost:36887/actuator/mappings' -i -X GET \
    -H 'accept-encoding: gzip' \
    -H 'user-agent: ReactorNetty/1.2.0' \
    -H 'accept: */*'

生成的响应类似于以下内容:spring-doc.cn

HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v3+json
Transfer-Encoding: chunked
Date: Thu, 21 Nov 2024 16:02:59 GMT
Content-Length: 5342

{
  "contexts" : {
    "application" : {
      "mappings" : {
        "dispatcherServlets" : {
          "dispatcherServlet" : [ {
            "handler" : "Actuator web endpoint 'mappings'",
            "predicate" : "{GET [/actuator/mappings], produces [application/vnd.spring-boot.actuator.v3+json || application/vnd.spring-boot.actuator.v2+json || application/json]}",
            "details" : {
              "handlerMethod" : {
                "className" : "org.springframework.boot.actuate.endpoint.web.servlet.AbstractWebMvcEndpointHandlerMapping.OperationHandler",
                "name" : "handle",
                "descriptor" : "(Ljakarta/servlet/http/HttpServletRequest;Ljava/util/Map;)Ljava/lang/Object;"
              },
              "requestMappingConditions" : {
                "consumes" : [ ],
                "headers" : [ ],
                "methods" : [ "GET" ],
                "params" : [ ],
                "patterns" : [ "/actuator/mappings" ],
                "produces" : [ {
                  "mediaType" : "application/vnd.spring-boot.actuator.v3+json",
                  "negated" : false
                }, {
                  "mediaType" : "application/vnd.spring-boot.actuator.v2+json",
                  "negated" : false
                }, {
                  "mediaType" : "application/json",
                  "negated" : false
                } ]
              }
            }
          }, {
            "handler" : "Actuator root web endpoint",
            "predicate" : "{GET [/actuator], produces [application/vnd.spring-boot.actuator.v3+json || application/vnd.spring-boot.actuator.v2+json || application/json]}",
            "details" : {
              "handlerMethod" : {
                "className" : "org.springframework.boot.actuate.endpoint.web.servlet.WebMvcEndpointHandlerMapping.WebMvcLinksHandler",
                "name" : "links",
                "descriptor" : "(Ljakarta/servlet/http/HttpServletRequest;Ljakarta/servlet/http/HttpServletResponse;)Ljava/util/Map;"
              },
              "requestMappingConditions" : {
                "consumes" : [ ],
                "headers" : [ ],
                "methods" : [ "GET" ],
                "params" : [ ],
                "patterns" : [ "/actuator" ],
                "produces" : [ {
                  "mediaType" : "application/vnd.spring-boot.actuator.v3+json",
                  "negated" : false
                }, {
                  "mediaType" : "application/vnd.spring-boot.actuator.v2+json",
                  "negated" : false
                }, {
                  "mediaType" : "application/json",
                  "negated" : false
                } ]
              }
            }
          }, {
            "handler" : "org.springframework.boot.actuate.autoconfigure.endpoint.web.documentation.MappingsEndpointServletDocumentationTests$ExampleController#example()",
            "predicate" : "{POST [/], params [a!=alpha], headers [X-Custom=Foo], consumes [application/json || !application/xml], produces [text/plain]}",
            "details" : {
              "handlerMethod" : {
                "className" : "org.springframework.boot.actuate.autoconfigure.endpoint.web.documentation.MappingsEndpointServletDocumentationTests.ExampleController",
                "name" : "example",
                "descriptor" : "()Ljava/lang/String;"
              },
              "requestMappingConditions" : {
                "consumes" : [ {
                  "mediaType" : "application/json",
                  "negated" : false
                }, {
                  "mediaType" : "application/xml",
                  "negated" : true
                } ],
                "headers" : [ {
                  "name" : "X-Custom",
                  "value" : "Foo",
                  "negated" : false
                } ],
                "methods" : [ "POST" ],
                "params" : [ {
                  "name" : "a",
                  "value" : "alpha",
                  "negated" : true
                } ],
                "patterns" : [ "/" ],
                "produces" : [ {
                  "mediaType" : "text/plain",
                  "negated" : false
                } ]
              }
            }
          }, {
            "handler" : "ResourceHttpRequestHandler [classpath [META-INF/resources/webjars/]]",
            "predicate" : "/webjars/**"
          }, {
            "handler" : "ResourceHttpRequestHandler [classpath [META-INF/resources/], classpath [resources/], classpath [static/], classpath [public/], ServletContext [/]]",
            "predicate" : "/**"
          } ]
        },
        "servletFilters" : [ {
          "servletNameMappings" : [ ],
          "urlPatternMappings" : [ "/*" ],
          "name" : "requestContextFilter",
          "className" : "org.springframework.boot.web.servlet.filter.OrderedRequestContextFilter"
        }, {
          "servletNameMappings" : [ ],
          "urlPatternMappings" : [ "/*" ],
          "name" : "formContentFilter",
          "className" : "org.springframework.boot.web.servlet.filter.OrderedFormContentFilter"
        } ],
        "servlets" : [ {
          "mappings" : [ "/" ],
          "name" : "dispatcherServlet",
          "className" : "org.springframework.web.servlet.DispatcherServlet"
        } ]
      }
    }
  }
}

响应结构

响应包含应用程序映射的详细信息。 在响应中找到的项目取决于 Web 应用程序的类型(反应式或基于 Servlet)。 下表描述了响应的常见元素的结构:spring-doc.cn

路径 类型 描述

contextsspring-doc.cn

Objectspring-doc.cn

以 id 为键的应用程序上下文。spring-doc.cn

contexts.*.mappingsspring-doc.cn

Objectspring-doc.cn

上下文中的映射,按 mapping type 键控。spring-doc.cn

contexts.*.mappings.dispatcherServletsspring-doc.cn

Objectspring-doc.cn

Dispatcher Servlet 映射(如果有)。spring-doc.cn

contexts.*.mappings.servletFiltersspring-doc.cn

Arrayspring-doc.cn

Servlet 过滤器映射(如果有)。spring-doc.cn

contexts.*.mappings.servletsspring-doc.cn

Arrayspring-doc.cn

Servlet 映射(如果有)。spring-doc.cn

contexts.*.mappings.dispatcherHandlersspring-doc.cn

Objectspring-doc.cn

Dispatcher 处理程序映射(如果有)。spring-doc.cn

contexts.*.parentIdspring-doc.cn

Stringspring-doc.cn

父应用程序上下文的 ID(如果有)。spring-doc.cn

以下各节介绍了 中可能找到的条目。contexts.*.mappingsspring-doc.cn

Dispatcher Servlet 响应结构

使用 Spring MVC 时,响应包含下面的任何请求映射的详细信息。 下表描述了响应的这一部分的结构:DispatcherServletcontexts.*.mappings.dispatcherServletsspring-doc.cn

路径 类型 描述

*spring-doc.cn

Arrayspring-doc.cn

Dispatcher Servlet 映射(如果有),按 Dispatcher Servlet Bean 名称进行键控。spring-doc.cn

*.[].detailsspring-doc.cn

Objectspring-doc.cn

有关映射的其他特定于实现的详细信息。自选。spring-doc.cn

*.[].handlerspring-doc.cn

Stringspring-doc.cn

映射的处理程序。spring-doc.cn

*.[].predicatespring-doc.cn

Stringspring-doc.cn

映射的谓词。spring-doc.cn

*.[].details.handlerMethodspring-doc.cn

Objectspring-doc.cn

将处理对此映射的请求的方法(如果有)的详细信息。spring-doc.cn

*.[].details.handlerMethod.classNamespring-doc.cn

Variesspring-doc.cn

方法类的完全限定名称。spring-doc.cn

*.[].details.handlerMethod.namespring-doc.cn

Variesspring-doc.cn

方法的名称。spring-doc.cn

*.[].details.handlerMethod.descriptorspring-doc.cn

Variesspring-doc.cn

Java 语言规范中指定的方法的描述符。spring-doc.cn

*.[].details.requestMappingConditionsspring-doc.cn

Objectspring-doc.cn

请求映射条件的详细信息。spring-doc.cn

*.[].details.requestMappingConditions.consumesspring-doc.cn

Variesspring-doc.cn

consumes 条件的详细信息spring-doc.cn

*.[].details.requestMappingConditions.consumes.[].mediaTypespring-doc.cn

Variesspring-doc.cn

使用的媒体类型。spring-doc.cn

*.[].details.requestMappingConditions.consumes.[].negatedspring-doc.cn

Variesspring-doc.cn

媒体类型是否为否定。spring-doc.cn

*.[].details.requestMappingConditions.headersspring-doc.cn

Variesspring-doc.cn

headers 条件的详细信息。spring-doc.cn

*.[].details.requestMappingConditions.headers.[].namespring-doc.cn

Variesspring-doc.cn

标头的名称。spring-doc.cn

*.[].details.requestMappingConditions.headers.[].valuespring-doc.cn

Variesspring-doc.cn

标头的必需值(如果有)。spring-doc.cn

*.[].details.requestMappingConditions.headers.[].negatedspring-doc.cn

Variesspring-doc.cn

该值是否为反值。spring-doc.cn

*.[].details.requestMappingConditions.methodsspring-doc.cn

Variesspring-doc.cn

已处理的 HTTP 方法。spring-doc.cn

*.[].details.requestMappingConditions.paramsspring-doc.cn

Variesspring-doc.cn

params 条件的详细信息。spring-doc.cn

*.[].details.requestMappingConditions.params.[].namespring-doc.cn

Variesspring-doc.cn

参数的名称。spring-doc.cn

*.[].details.requestMappingConditions.params.[].valuespring-doc.cn

Variesspring-doc.cn

参数的必需值(如果有)。spring-doc.cn

*.[].details.requestMappingConditions.params.[].negatedspring-doc.cn

Variesspring-doc.cn

该值是否为反值。spring-doc.cn

*.[].details.requestMappingConditions.patternsspring-doc.cn

Variesspring-doc.cn

标识映射处理的路径的模式。spring-doc.cn

*.[].details.requestMappingConditions.producesspring-doc.cn

Variesspring-doc.cn

produce 条件的详细信息。spring-doc.cn

*.[].details.requestMappingConditions.produces.[].mediaTypespring-doc.cn

Variesspring-doc.cn

生成的媒体类型。spring-doc.cn

*.[].details.requestMappingConditions.produces.[].negatedspring-doc.cn

Variesspring-doc.cn

媒体类型是否为否定。spring-doc.cn

Servlet 响应结构

使用 Servlet 堆栈时,响应包含下面任何映射的详细信息。 下表描述了响应的这一部分的结构:Servletcontexts.*.mappings.servletsspring-doc.cn

路径 类型 描述

[].mappingsspring-doc.cn

Arrayspring-doc.cn

Servlet 的映射。spring-doc.cn

[].namespring-doc.cn

Stringspring-doc.cn

Servlet 的名称。spring-doc.cn

[].classNamespring-doc.cn

Stringspring-doc.cn

Servlet 的类名spring-doc.cn

Servlet 过滤器响应结构

使用 Servlet 堆栈时,响应包含下面任何映射的详细信息。 下表描述了响应的这一部分的结构:Filtercontexts.*.mappings.servletFiltersspring-doc.cn

路径 类型 描述

[].servletNameMappingsspring-doc.cn

Arrayspring-doc.cn

过滤器映射到的 Servlet 的名称。spring-doc.cn

[].urlPatternMappingsspring-doc.cn

Arrayspring-doc.cn

过滤器映射到的 URL 模式。spring-doc.cn

[].namespring-doc.cn

Stringspring-doc.cn

筛选器的名称。spring-doc.cn

[].classNamespring-doc.cn

Stringspring-doc.cn

过滤器的类名spring-doc.cn

Dispatcher 处理程序响应结构

使用 Spring WebFlux 时,响应包含下面任何请求映射的详细信息。 下表描述了响应的这一部分的结构:DispatcherHandlercontexts.*.mappings.dispatcherHandlersspring-doc.cn

路径 类型 描述

*spring-doc.cn

Arrayspring-doc.cn

调度程序处理程序映射(如果有),以调度程序处理程序 Bean 名称为键。spring-doc.cn

*.[].detailsspring-doc.cn

Objectspring-doc.cn

有关映射的其他特定于实现的详细信息。自选。spring-doc.cn

*.[].handlerspring-doc.cn

Stringspring-doc.cn

映射的处理程序。spring-doc.cn

*.[].predicatespring-doc.cn

Stringspring-doc.cn

映射的谓词。spring-doc.cn

*.[].details.requestMappingConditionsspring-doc.cn

Objectspring-doc.cn

请求映射条件的详细信息。spring-doc.cn

*.[].details.requestMappingConditions.consumesspring-doc.cn

Variesspring-doc.cn

consumes 条件的详细信息spring-doc.cn

*.[].details.requestMappingConditions.consumes.[].mediaTypespring-doc.cn

Variesspring-doc.cn

使用的媒体类型。spring-doc.cn

*.[].details.requestMappingConditions.consumes.[].negatedspring-doc.cn

Variesspring-doc.cn

媒体类型是否为否定。spring-doc.cn

*.[].details.requestMappingConditions.headersspring-doc.cn

Variesspring-doc.cn

headers 条件的详细信息。spring-doc.cn

*.[].details.requestMappingConditions.headers.[].namespring-doc.cn

Variesspring-doc.cn

标头的名称。spring-doc.cn

*.[].details.requestMappingConditions.headers.[].valuespring-doc.cn

Variesspring-doc.cn

标头的必需值(如果有)。spring-doc.cn

*.[].details.requestMappingConditions.headers.[].negatedspring-doc.cn

Variesspring-doc.cn

该值是否为反值。spring-doc.cn

*.[].details.requestMappingConditions.methodsspring-doc.cn

Variesspring-doc.cn

已处理的 HTTP 方法。spring-doc.cn

*.[].details.requestMappingConditions.paramsspring-doc.cn

Variesspring-doc.cn

params 条件的详细信息。spring-doc.cn

*.[].details.requestMappingConditions.params.[].namespring-doc.cn

Variesspring-doc.cn

参数的名称。spring-doc.cn

*.[].details.requestMappingConditions.params.[].valuespring-doc.cn

Variesspring-doc.cn

参数的必需值(如果有)。spring-doc.cn

*.[].details.requestMappingConditions.params.[].negatedspring-doc.cn

Variesspring-doc.cn

该值是否为反值。spring-doc.cn

*.[].details.requestMappingConditions.patternsspring-doc.cn

Variesspring-doc.cn

标识映射处理的路径的模式。spring-doc.cn

*.[].details.requestMappingConditions.producesspring-doc.cn

Variesspring-doc.cn

produce 条件的详细信息。spring-doc.cn

*.[].details.requestMappingConditions.produces.[].mediaTypespring-doc.cn

Variesspring-doc.cn

生成的媒体类型。spring-doc.cn

*.[].details.requestMappingConditions.produces.[].negatedspring-doc.cn

Variesspring-doc.cn

媒体类型是否为否定。spring-doc.cn

*.[].details.handlerMethodspring-doc.cn

Objectspring-doc.cn

将处理对此映射的请求的方法(如果有)的详细信息。spring-doc.cn

*.[].details.handlerMethod.classNamespring-doc.cn

Stringspring-doc.cn

方法类的完全限定名称。spring-doc.cn

*.[].details.handlerMethod.namespring-doc.cn

Stringspring-doc.cn

方法的名称。spring-doc.cn

*.[].details.handlerMethod.descriptorspring-doc.cn

Stringspring-doc.cn

Java 语言规范中指定的方法的描述符。spring-doc.cn

*.[].details.handlerFunctionspring-doc.cn

Objectspring-doc.cn

将处理对此映射的请求的函数(如果有)的详细信息。spring-doc.cn

*.[].details.handlerFunction.classNamespring-doc.cn

Stringspring-doc.cn

函数类的完全限定名称。spring-doc.cn