Spring:如何查看Spring应用对外提供了哪些API接口?

在开发Spring应用时一般都会通过Controller层对外提供API接口,另外Spring自身也会隐式的提供一些API接口。这里就有一个问题,在应用启动时,Controller层API接口和隐式API接口到底有哪些能真正对外提供服务呢?

下面先把方法提供了出来,然后再详细讲解。

一、配置方法

以spring和logback的如下版本进行说明

spring-webmvc-5.3.31.jar

logback-classic-1.2.12.jar

logback-core-1.2.12.jar

logback.xml

XML 复制代码
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
	<property name="LOG_HOME" value="/applog" />
	<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
		<encoder>
			<pattern>%msg%n</pattern>
		</encoder>
	</appender>
	<appender name="rollingFile" class="ch.qos.logback.core.rolling.RollingFileAppender">
		<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
			<fileNamePattern>${LOG_HOME}/app.%d{yyyy-MM-dd}.log</fileNamePattern>
		</rollingPolicy>
		<encoder>
			<pattern>%d|%-5p|%t|%logger|%C.%M[%L]|%m%n</pattern>
		</encoder>
	</appender>

	<root level="info" additivity="false">
		<appender-ref ref="rollingFile" />
	</root>
	<logger name="com.test" level="INFO" additivity="false">
		<appender-ref ref="rollingFile" />
	</logger>
	<logger name="_org.springframework.web.servlet.HandlerMapping.Mappings" level="DEBUG" additivity="false">
		<appender-ref ref="rollingFile" />
	</logger>
	<logger name="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping" level="DEBUG" additivity="false">
		<appender-ref ref="rollingFile" />
	</logger>

</configuration>

spring应用启动后会打印如下日志:

红色框是由配置_org.springframework.web.servlet.HandlerMapping.Mappings打印的,这个配置前的下划线是必须有的,没有下划线的话是打印不出来的。打印出的内容就是这个spring应用支持的API接口及它对应的Controller类和方法,其中既包含用户自定义的(比如:SseController),也包含Spring隐式提供的(比如:BasicErrorController)。

绿色框是由配置org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping打印的,它显示了spring应用总共提供了多少个API接口。

通过上述配置,就能打印出这个spring应用实际能够提供的API接口。如果用户自定义的Controller中的API接口在这里没有显示出来,就需要查一下代码或配置中是否存在什么问题了。

二、配置说明

红色框中打印的内容是由如下代码生成的:

org.springframework.web.servlet.handler.AbstractHandlerMethodMapping

其中mappingsLogger是在如下类中定义的:

org.springframework.web.servlet.handler.AbstractHandlerMapping

而为什么要加下划线,是因为调用了如下方法:

org.springframework.core.log.LogDelegateFactory

绿色框中打印的内容是由如下代码生成的:

org.springframework.web.servlet.handler.AbstractHandlerMethodMapping

经过以上讲解,应该已经清楚说明怎样配置及为什么要这样配置了,以后开发spring应用时只要采用以上方法就能比较方便的查看所有API接口。

相关推荐
yaoxin5211231 小时前
507. Java 反射 - 在 BeanFactory 中实现依赖注入
java·开发语言
OPEN-F1 小时前
C++模板教程:变参模板、折叠表达式与SFINAE
java·开发语言·c++
2601_962072212 小时前
SpringMVC进阶(自定义拦截器以及异常处理)
java
2601_962073813 小时前
Spring全面详解(基础版)
java·后端·spring
谢亮_vipxieliang4 小时前
ValidX分组验证详解:不同场景使用不同验证规则
java·spring boot·后端·spring cloud·eclipse·hibernate
wuminyu4 小时前
深入剖析 Panama Off-heap 的性能损耗与开销
java·linux·c语言·jvm·c++
pnoker5 小时前
IoT DC3 AI 能力:Agentic Center 的设计与边界
java·人工智能·物联网·大模型·spring ai
凤山老林5 小时前
Spring Boot 集成 Spring Vault:集中式密钥管理与动态凭证轮换
spring boot·后端·spring·vault·集中式秘钥管理
xiaoqiMikko5 小时前
一条 CVSS 9.0 的 RCE,advisory 里没写修复版是哪个 —— fastjson 16723 的字段考古
java·安全
程序员贺加贝5 小时前
一次 SaaS ERP 主数据生命周期设计:Policy、PreCheck 与结构化阻断原因
java·后端·架构·saas