Springboot内置ApplicationListener--AnsiOutputApplicationListener

本文深入剖析Spring Boot中AnsiOutputApplicationListener的作用机制。该监听器在应用启动时,根据spring.output.ansi.enabled属性配置控制台的ANSI输出状态,实现对控制台输出颜色和样式的动态调整。

源码分析

本文源代码基于 Springboot 2.1.0

package org.springframework.boot.context.config;

import org.springframework.boot.ansi.AnsiOutput;
import org.springframework.boot.ansi.AnsiOutput.Enabled;
import org.springframework.boot.context.event.ApplicationEnvironmentPreparedEvent;
import org.springframework.boot.context.properties.bind.Binder;
import org.springframework.context.ApplicationListener;
import org.springframework.core.Ordered;
import org.springframework.core.env.ConfigurableEnvironment;

/**
 * An ApplicationListener that configures AnsiOutput depending on the
 * value of the property spring.output.ansi.enabled. See Enabled for valid
 * values.
 * 应用启动过程中当ApplicationEnvironmentPreparedEvent发生时配置AnsiOutput,
 * 具体的来说是从环境属性中按类型AnsiOutput.Enabled取出spring.output.ansi.enabled的值,
 * 如果存在的话则是用设置值调用类AnsiOutput静态方法setEnabled(Enabled enabled)。
 * 
 * @author Raphael von der Grün
 * @author Madhura Bhave
 * @since 1.2.0
 */
public class AnsiOutputApplicationListener
		implements ApplicationListener<ApplicationEnvironmentPreparedEvent>, Ordered {

	@Override
	public void onApplicationEvent(ApplicationEnvironmentPreparedEvent event) {
		ConfigurableEnvironment environment = event.getEnvironment();
		Binder.get(environment)
				.bind("spring.output.ansi.enabled", AnsiOutput.Enabled.class)
				.ifBound(AnsiOutput::setEnabled);
		AnsiOutput.setConsoleAvailable(environment
				.getProperty("spring.output.ansi.console-available", Boolean.class));
	}

	@Override
	public int getOrder() {
		// Apply after ConfigFileApplicationListener has called EnvironmentPostProcessors
		return ConfigFileApplicationListener.DEFAULT_ORDER + 1;
	}

}

相关文章

Springboot内置ApplicationListener

### 如何在 Spring Boot 2.7 中实现和使用 `ApplicationListener` #### 创建自定义事件 为了创建一个自定义事件,在Spring Boot中,这个事件应该继承于`ApplicationEvent`类。这一步骤确保了新创建的事件能够被Spring的应用程序上下文识别并处理。 ```java public class CustomEvent extends ApplicationEvent { private String message; public CustomEvent(Object source, String message) { super(source); this.message = message; } public String getMessage() { return message; } } ``` [^1] #### 实现 `ApplicationListener` 接口 对于监听上述自定义事件而言,可以通过实现`ApplicationListener<CustomEvent>`接口的方式完成。当实现了该接口的方法`onApplicationEvent()`之后,每当有对应的事件发生时,此方法就会被执行,从而达到监听的效果。 ```java @Component public class CustomEventListener implements ApplicationListener<CustomEvent> { @Override public void onApplicationEvent(CustomEvent event) { System.out.println("Received custom event - " + event.getMessage()); } } ``` 另一种方式是通过`@EventListener`注解来简化这一过程: ```java @Component public class AnnotatedCustomEventListener { @EventListener public void handleCustomEvent(CustomEvent event) { System.out.println("Annotated listener received an event - " + event.getMessage()); } } ``` [^4] #### 发布事件 最后,要触发这些监听器的动作,则需发布相应的事件实例给`ApplicationEventPublisher`。通常情况下,可以在任何地方获取到当前应用上下文中的`ApplicationEventPublisher`并通过它来广播事件。 ```java @Autowired private ApplicationEventPublisher applicationEventPublisher; // Somewhere in your code where you want to publish the event. applicationEventPublisher.publishEvent(new CustomEvent(this, "Hello from a custom event!")); ``` [^3] 以上就是在Spring Boot 2.7版本里整合`ApplicationListener`进行事件监听与处理的具体做法。
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值