16個(gè)SpringBoot擴(kuò)展接口的總結(jié)和實(shí)例
CommandLineRunner
這個(gè)接口可以用來(lái)在Spring Boot應(yīng)用程序啟動(dòng)時(shí)執(zhí)行一些代碼。你可以實(shí)現(xiàn)它來(lái)做一些初始化的工作或者其他需要在應(yīng)用啟動(dòng)時(shí)執(zhí)行的任務(wù)。
@Component public class MyCommandLineRunner implements CommandLineRunner { @Override public void run(String... args) throws Exception { System.out.println("Spring Boot應(yīng)用程序啟動(dòng)時(shí)執(zhí)行的代碼"); // 在這里可以做一些初始化的工作或其他需要在啟動(dòng)時(shí)執(zhí)行的任務(wù) } }
ApplicationRunner
與CommandLineRunner類(lèi)似,這個(gè)接口可以在Spring Boot應(yīng)用程序啟動(dòng)時(shí)執(zhí)行一些代碼。不同的是,它提供了更加靈活的方法參數(shù),可以訪問(wèn)Spring應(yīng)用程序上下文和應(yīng)用程序參數(shù)。
@Component public class MyApplicationRunner implements ApplicationRunner { @Override public void run(ApplicationArguments args) throws Exception { System.out.println("Spring Boot應(yīng)用程序啟動(dòng)時(shí)執(zhí)行的代碼"); // 在這里可以訪問(wèn)Spring應(yīng)用程序上下文和應(yīng)用程序參數(shù),并做一些初始化的工作 } }
ServletContextInitializer
這個(gè)接口提供了一種初始化ServletContext的機(jī)制。你可以使用它來(lái)添加Servlet、Filter、Listener等到ServletContext中。
@Configuration public class MyServletContextInitializer implements ServletContextInitializer { @Override public void onStartup(ServletContext servletContext) throws ServletException { // 添加Servlet servletContext.addServlet("myServlet", new MyServlet()).addMapping("/myservlet"); // 添加Filter servletContext.addFilter("myFilter", new MyFilter()).addMappingForUrlPatterns(null, false, "/myfilter/*"); // 添加Listener servletContext.addListener(new MyListener()); } }
FilterRegistrationBean
這個(gè)類(lèi)是Spring Boot對(duì)Filter的封裝,你可以使用它來(lái)注冊(cè)Filter,并設(shè)置Filter的順序、URL匹配等。
@Configuration public class MyFilterConfiguration { @Bean public FilterRegistrationBean<MyFilter> myFilterRegistration() { FilterRegistrationBean<MyFilter> registration = new FilterRegistrationBean<>(); registration.setFilter(new MyFilter()); registration.addUrlPatterns("/myfilter/*"); registration.setOrder(1); return registration; } }
ServletRegistrationBean
這個(gè)類(lèi)是Spring Boot對(duì)Servlet的封裝,你可以使用它來(lái)注冊(cè)Servlet,并設(shè)置Servlet的URL路徑、加載順序等。
@Configuration public class MyServletConfiguration { @Bean public ServletRegistrationBean<MyServlet> myServletRegistration() { ServletRegistrationBean<MyServlet> registration = new ServletRegistrationBean<>(); registration.setServlet(new MyServlet()); registration.addUrlMappings("/myservlet"); registration.setLoadOnStartup(1); return registration; } }
HealthIndicator
這個(gè)接口用于定義應(yīng)用程序的健康檢查。你可以實(shí)現(xiàn)自定義的健康檢查邏輯,并通過(guò)HTTP接口暴露給監(jiān)控系統(tǒng)。
@Component public class MyHealthIndicator implements HealthIndicator { @Override public Health health() { // 自定義健康檢查邏輯 if (isHealth()) { return Health.up().build(); } else { return Health.down().withDetail("Error", "Something went wrong").build(); } } private boolean isHealth() { // 檢查應(yīng)用程序的健康狀態(tài),并返回相應(yīng)的健康信息 return true; // 健康 } }
MetricsExporter
這個(gè)接口用于導(dǎo)出應(yīng)用程序的指標(biāo)數(shù)據(jù)。你可以實(shí)現(xiàn)自定義的MetricsExporter接口,并將指標(biāo)數(shù)據(jù)導(dǎo)出到各種監(jiān)控系統(tǒng)。
@Component public class MyMetricsExporter implements MetricsExporter { @Override public Map<String, Object> export() { // 導(dǎo)出應(yīng)用程序的指標(biāo)數(shù)據(jù) Map<String, Object> metrics = new HashMap<>(); metrics.put("metric1", getMetric1()); metrics.put("metric2", getMetric2()); // ... return metrics; } private int getMetric1() { // 獲取指標(biāo)數(shù)據(jù)1 return 100; } private float getMetric2() { // 獲取指標(biāo)數(shù)據(jù)2 return 3.14f; } }
WebMvcConfigurer
這個(gè)接口用于配置Spring MVC的行為。你可以通過(guò)實(shí)現(xiàn)它來(lái)配置攔截器、消息轉(zhuǎn)換器、視圖解析器等。
@Configuration public class MyWebMvcConfigurer implements WebMvcConfigurer { @Override public void addInterceptors(InterceptorRegistry registry) { // 添加攔截器 registry.addInterceptor(new MyInterceptor()).addPathPatterns("/api/**"); } @Override public void configureMessageConverters(List<HttpMessageConverter<?>> converters) { // 配置消息轉(zhuǎn)換器 converters.add(new MyMessageConverter()); } @Override public void configureViewResolvers(ViewResolverRegistry registry) { // 配置視圖解析器 registry.jsp("/WEB-INF/views/", ".jsp"); } }
WebSecurityConfigurer
這個(gè)接口用于配置Spring Security的行為。你可以通過(guò)實(shí)現(xiàn)它來(lái)配置認(rèn)證、授權(quán)、安全過(guò)濾器等。
@Configuration @EnableWebSecurity public class MyWebSecurityConfigurer extends WebSecurityConfigurerAdapter { @Override protected void configure(HttpSecurity http) throws Exception { // 配置安全規(guī)則 http.authorizeRequests() .antMatchers("/api/admin/**").hasRole("ADMIN") .antMatchers("/api/user/**").hasAnyRole("ADMIN", "USER") .anyRequest().permitAll() .and().formLogin().permitAll(); } @Override protected void configure(AuthenticationManagerBuilder auth) throws
CommandLinePropertySource
這個(gè)接口用于從命令行參數(shù)中加載屬性。你可以實(shí)現(xiàn)它來(lái)自定義命令行參數(shù)的解析和加載邏輯。
1.實(shí)現(xiàn)PropertySource接口
public class CommandLinePropertySource extends PropertySource<String> { public CommandLinePropertySource(String name, Map<String, Object> source) { super(name, source); } @Override public Object getProperty(String name) { return this.source.get(name); } }
2.實(shí)現(xiàn)EnvironmentPostProcessor接口
@Component public class CustomEnvironmentPostProcessor implements EnvironmentPostProcessor { @Override public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) { Map<String, Object> map = new HashMap<>(); map.put("custom.property", "value"); environment.getPropertySources().addFirst( new CommandLinePropertySource("customCommandLineProperties", map)); } }
3.通過(guò)@Value注入使用
@Component public class MyBean { @Value("${custom.property}") private String customProperty; //... }
DataSourceInitializer
這個(gè)接口用于初始化數(shù)據(jù)庫(kù)。你可以實(shí)現(xiàn)它來(lái)執(zhí)行數(shù)據(jù)庫(kù)腳本,創(chuàng)建表結(jié)構(gòu)等。
1.實(shí)現(xiàn)DataSourceInitializer接口
public class CustomDataSourceInitializer implements DataSourceInitializer { @Override public void initialize(DataSource ds) { // 調(diào)用DataSource的初始化方法 ds.getConnection(); } }
2.在配置類(lèi)中指定DataSourceInitializer
@Configuration public class DataSourceConfig { @Bean public DataSourceInitializer dataSourceInitializer() { return new CustomDataSourceInitializer(); } }
3.添加初始化的DataSource
@Configuration public class DataSourceConfig { @Bean public DataSource dataSource() { // 初始化和配置DataSource bean } }
這樣Spring Boot在啟動(dòng)時(shí)會(huì)自動(dòng)調(diào)用CustomDataSourceInitializer來(lái)初始化配置好的DataSource。
主要步驟是實(shí)現(xiàn)DataSourceInitializer接口,并在配置類(lèi)中定義該bean,同時(shí)添加需要初始化的DataSource bean。
這樣可以自定義DataSource的初始化邏輯,比如提前獲取連接來(lái)驗(yàn)證連接信息等。
JmsListenerConfigurer
這個(gè)接口用于配置JMS消息監(jiān)聽(tīng)器。你可以通過(guò)實(shí)現(xiàn)它來(lái)設(shè)置目的地、消息轉(zhuǎn)換器等。
這是一個(gè)使用JmsListenerConfigurer來(lái)自定義JMS監(jiān)聽(tīng)器配置的示例:
1.實(shí)現(xiàn)JmsListenerConfigurer接口
@Component public class CustomJmsListenerConfigurer implements JmsListenerConfigurer { @Override public void configureJmsListeners(JmsListenerEndpointRegistrar registrar) { // 自定義注冊(cè)JMS監(jiān)聽(tīng)器 } }
2.注冊(cè)JMS監(jiān)聽(tīng)器
@Configuration public class JmsConfig { @Bean public JmsListenerContainerFactory<?> factory(ConnectionFactory connectionFactory) { DefaultJmsListenerContainerFactory factory = new DefaultJmsListenerContainerFactory(); factory.setConnectionFactory(connectionFactory); return factory; } @Bean public JmsListenerEndpointRegistrar registrar() { return new JmsListenerEndpointRegistrar(); } }
3.實(shí)現(xiàn)JMS監(jiān)聽(tīng)器
public class MyJmsListener { @JmsListener(destination = "someQueue") public void onMessage(String msg) { // handle message } }
通過(guò)JmsListenerConfigurer,我們可以全局定制JMS監(jiān)聽(tīng)器的配置,比如設(shè)置concurrency、異常handler等。
主要步驟是實(shí)現(xiàn)JmsListenerConfigurer接口,并注入JmsListenerEndpointRegistrar bean。
OAuth3AuthorizationRequestResolver
這個(gè)接口用于解析OAuth2的授權(quán)請(qǐng)求。你可以實(shí)現(xiàn)它來(lái)處理授權(quán)請(qǐng)求的邏輯。
以下是使用OAuth2AuthorizationRequestResolver接口來(lái)自定義OAuth2客戶端的授權(quán)請(qǐng)求處理過(guò)程的一個(gè)示例:
1.創(chuàng)建授權(quán)請(qǐng)求處理器
public class CustomRequestResolver implements OAuth2AuthorizationRequestResolver { @Override public OAuth2AuthorizationRequest resolve(HttpServletRequest request) { // 解析和處理授權(quán)請(qǐng)求 return authRequest; } }
2.在配置類(lèi)中聲明處理器
@Configuration @EnableOAuth2Client public class OAuth2Config { @Bean public OAuth2AuthorizationRequestResolver authorizationRequestResolver() { return new CustomRequestResolver(); } }
3.使用授權(quán)客戶端
@RestController public class TestController { @Autowired OAuth2AuthorizedClientService clientService; @GetMapping("/users") public String getUsers() { // 使用授權(quán)客戶端請(qǐng)求用戶資源 } }
主要思路是通過(guò)自定義的OAuth2AuthorizationRequestResolver解析授權(quán)請(qǐng)求,在授權(quán)完成后生成授權(quán)客戶端保存到容器中。
這樣可以自定義授權(quán)流程的相關(guān)處理,擴(kuò)展OAuth2客戶端的功能。
WebSocketMessageBrokerConfigurer
這個(gè)接口用于配置WebSocket消息代理。你可以通過(guò)實(shí)現(xiàn)它來(lái)配置消息代理、消息處理器等。
這里是一個(gè)使用WebSocketMessageBrokerConfigurer來(lái)自定義WebSocket消息代理的配置示例:
1.實(shí)現(xiàn)WebSocketMessageBrokerConfigurer
@Configuration public class CustomWebSocketConfig implements WebSocketMessageBrokerConfigurer { @Override public void configureMessageBroker(MessageBrokerRegistry registry) { // 配置消息代理 } @Override public void registerStompEndpoints(StompEndpointRegistry registry) { // 注冊(cè)STOMP端點(diǎn) } }
2.添加處理器
@Configuration public class WebSocketConfig { @Bean public CustomWebSocketConfig webSocketConfig() { return new CustomWebSocketConfig(); } }
3.編寫(xiě)WebSocket服務(wù)
@Controller public class WebSocketController { @MessageMapping("/chat") public void handleChat(Message msg) { // 處理WebSocket請(qǐng)求 } }
通過(guò)實(shí)現(xiàn)WebSocketMessageBrokerConfigurer接口,我們可以自定義消息代理的路由路徑、 STOMP端點(diǎn)、消息處理器等配置。
這可以根據(jù)具體需求調(diào)整WebSocket消息流轉(zhuǎn)相關(guān)的設(shè)置。
EmbeddedServletContainerCustomizer
這個(gè)接口用于自定義嵌入式Servlet容器。你可以通過(guò)實(shí)現(xiàn)它來(lái)配置Servlet容器的行為、監(jiān)聽(tīng)器、Servlet等。
這里是一個(gè)使用EmbeddedServletContainerCustomizer接口來(lái)自定義嵌入式Servlet容器的示例:
1.實(shí)現(xiàn)EmbeddedServletContainerCustomizer
@Component public class CustomContainerCustomizer implements EmbeddedServletContainerCustomizer { @Override public void customize(ConfigurableEmbeddedServletContainer container) { container.setPort(8888); } }
2.添加定制器組件
@SpringBootApplication public class Application { public static void main(String[] args) { SpringApplication.run(Application.class, args); } }
3.修改容器配置
server.port=8080
在應(yīng)用啟動(dòng)時(shí),CustomContainerCustomizer會(huì)被回調(diào)來(lái)修改容器的配置。
這里通過(guò)setPort方法將端口改為了8888,覆蓋了配置文件中的8080端口。
通過(guò)實(shí)現(xiàn)該接口,可以根據(jù)需求修改容器的相關(guān)配置,如端口、上下文路徑等。
CacheManagerCustomizer
這個(gè)接口用于定制緩存管理器。你可以通過(guò)實(shí)現(xiàn)它來(lái)配置緩存的行為、緩存策略等。
這里是一個(gè)使用CacheManagerCustomizer接口來(lái)自定義Spring Cache的示例:
1.實(shí)現(xiàn)CacheManagerCustomizer
@Configuration public class CustomCacheConfig implements CacheManagerCustomizer<ConcurrentMapCacheManager> { @Override public void customize(ConcurrentMapCacheManager cacheManager) { cacheManager.setCacheNames(Collections.singleton("customCache")); } }
2.聲明緩存管理器
@Configuration @EnableCaching public class CacheConfig { @Bean public ConcurrentMapCacheManager cacheManager() { return new ConcurrentMapCacheManager(); } }
3.使用自定義的緩存
@Cacheable("customCache") public User findUser(String username) { // ... }
通過(guò)CacheManagerCustomizer,我們可以自定義ConcurrentMapCacheManager的配置,如緩存名稱(chēng)、過(guò)期規(guī)則等。
主要步驟是實(shí)現(xiàn)接口,并聲明需要自定義的緩存管理器bean。
這樣可以根據(jù)需要調(diào)整Spring Cache的緩存行為。
以上就是16個(gè)SpringBoot擴(kuò)展接口的總結(jié)和實(shí)例的詳細(xì)內(nèi)容,更多關(guān)于SpringBoot擴(kuò)展接口的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章!
- 關(guān)于Springboot的擴(kuò)展點(diǎn)DisposableBean的原理解析
- springBoot?之spring.factories擴(kuò)展機(jī)制示例解析
- SpringBoot定時(shí)任務(wù)動(dòng)態(tài)擴(kuò)展ScheduledTaskRegistrar詳解
- SpringBoot擴(kuò)展點(diǎn)EnvironmentPostProcessor實(shí)例詳解
- 詳解Springboot快速搭建跨域API接口的步驟(idea社區(qū)版2023.1.4+apache-maven-3.9.3-bin)
- SpringBoot實(shí)現(xiàn)接口統(tǒng)一前綴
相關(guān)文章
springboot3+r2dbc響應(yīng)式編程實(shí)踐
本文主要介紹了springboot3+r2dbc響應(yīng)式編程實(shí)踐,文中通過(guò)示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2022-02-02SpringMVC多線程下無(wú)法獲取請(qǐng)求的原因和解決方法
從問(wèn)題出發(fā),逐步講透在SpringMVC中使用RequestContextHolder對(duì)象在多線程情況下無(wú)法獲取請(qǐng)求的真實(shí)原因,本文將和大家一起深入剖析SpringMVC多線程下無(wú)法獲取請(qǐng)求的原因和解決,需要的朋友可以參考下2024-04-04詳解java解決分布式環(huán)境中高并發(fā)環(huán)境下數(shù)據(jù)插入重復(fù)問(wèn)題
這篇文章主要介紹了java解決并發(fā)數(shù)據(jù)重復(fù)問(wèn)題 ,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2019-03-03java中List去除重復(fù)數(shù)據(jù)的5種方式總結(jié)
這篇文章主要給大家總結(jié)介紹了關(guān)于java中List去除重復(fù)數(shù)據(jù)的5種方式,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2021-01-01Springboot升級(jí)到2.7.2結(jié)合nacos遇到的坑及解決
這篇文章主要介紹了Springboot升級(jí)到2.7.2結(jié)合nacos遇到的坑及解決,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2024-06-06SpringData JPA快速上手之關(guān)聯(lián)查詢及JPQL語(yǔ)句書(shū)寫(xiě)詳解
JPA都有SpringBoot的官方直接提供的starter,而Mybatis沒(méi)有,直到SpringBoot 3才開(kāi)始加入到官方模版中,這篇文章主要介紹了SpringData JPA快速上手,關(guān)聯(lián)查詢,JPQL語(yǔ)句書(shū)寫(xiě)的相關(guān)知識(shí),感興趣的朋友一起看看吧2023-09-09Java Online Exam在線考試系統(tǒng)的實(shí)現(xiàn)
讀萬(wàn)卷書(shū)不如行萬(wàn)里路,只學(xué)書(shū)上的理論是遠(yuǎn)遠(yuǎn)不夠的,只有在實(shí)戰(zhàn)中才能獲得能力的提升,本篇文章手把手帶你用java+springboot+vue+jsp+mysql+maven實(shí)現(xiàn)Online Exam在線考試系統(tǒng),大家可以在過(guò)程中查缺補(bǔ)漏,提升水平2021-11-11Springcloud-nacos實(shí)現(xiàn)配置和注冊(cè)中心的方法
這篇文章主要介紹了Springcloud-nacos實(shí)現(xiàn)配置和注冊(cè)中心的方法,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2019-07-07