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接口。

相关推荐
二哈赛车手17 分钟前
新人笔记---hermes定时功能设计,具体讲解以及可优化点
java·人工智能·笔记·spring·ai·typescript
ZWZhangYu22 分钟前
从 Dify 实践理解大模型上下文缓存
java·后端·spring
小羊没烦恼!1 小时前
关于分布式锁原理的一些学习与思考-redis分布式锁,zookeeper分布式锁
java·服务器·网络·学习·负载均衡
Fuyo_11192 小时前
C++ AVL树保姆级详解:从平衡因子到四大旋转机制
java·c++·算法
Sarvartha2 小时前
Date、LocalDate、LocalTime、LocalDateTime、DateTimeFormatter类
java
阿俊-全栈开发2 小时前
LikeShop 多商户 Java 版商城微服务模块拆分与部署架构演进实践
java·微服务·架构·likeshop开源商城·多商户源码
Wang's Blog3 小时前
Java 项目实战:交友项目 - 联系人列表
java·开发语言·交友
我命由我123453 小时前
访客系统形式(有用户概念、无用户概念)
java·开发语言·前端·javascript·python·产品运营·产品经理
香蕉大香蕉(06敬畏市场)4 小时前
MySQL 单点详解(01)
java·数据库·mysql·面试·博客·实习
LaughingZhu4 小时前
Product Hunt 热榜 2026-10-30:Empacer、Scape、Floot in ChatGPT
java·前端·数据库·人工智能·chatgpt·notion