學 無 止 境 ， 與 君 共 勉 。
場景
很多時候當我們完成某些業務後需要給使用者推送相關訊息提醒。對於這種非核心業務功能我們可以拿出來，建立一個事件去非同步執行，從而實現核心業務和子業務的解耦。
實現
定義事件類 Event
建立一個類，繼承ApplicationEvent，並重寫建構函式。ApplicationEvent是Spring提供的所有應用程式事件擴充套件類。
public class NoticeEvent extends ApplicationEvent {
private static final Logger logger = LoggerFactory.getLogger(NoticeEvent.class);
/**
* 接受資訊
*/
private String message;
public NoticeEvent(String message) {
super(message);
this.message = message;
logger.info("add event success! message: {}", message);
}
public String getMessage() {
return message;
}
}
複製程式碼建立事件監聽類 Listener
建立一個用於監聽指定事件的類，需要實現ApplicationListener介面，說明它是一個應用程式事件的監聽類。注意這裡需要加上@Component註解，將其注入Spring容器中。
@Component
public class NoticeListener implements ApplicationListener<NoticeEvent> {
private static final Logger logger = LoggerFactory.getLogger(NoticeListener.class);
@Override
public void onApplicationEvent(NoticeEvent noticeEvent) {
logger.info("listener get event, sleep 2 second...");
try {
Thread.sleep(2000);
} catch (InterruptedException e) {
e.printStackTrace();
}
logger.info("event message is : {}", noticeEvent.getMessage());
}
}
複製程式碼事件釋出
事件釋出很簡單，只需要使用Spring 提供的ApplicationEventPublisher來發布自定義事件
@RestController
@RequestMapping("/event")
public class EventController {
private static final Logger logger = LoggerFactory.getLogger(EventController.class);
@Autowired
private ApplicationEventPublisher applicationEventPublisher;
@GetMapping("/notice/{message}")
public void notice(@PathVariable(name = "message") String message) {
logger.info("begin >>>>>>");
applicationEventPublisher.publishEvent(new NoticeEvent(message));
logger.info("end <<<<<<");
}
}
複製程式碼測試
啟動服務，訪問介面 http://localhost:8080/event/notice/hello
[nio-8080-exec-1] o.y.n.event.controller.EventController : begin >>>>>>
[nio-8080-exec-1] org.ylc.note.event.event.NoticeEvent : add event success! message: hello
[nio-8080-exec-1] org.ylc.note.event.event.NoticeListener : listener get event, sleep 2 second...
[nio-8080-exec-1] org.ylc.note.event.event.NoticeListener : event message is : hello
[nio-8080-exec-1] o.y.n.event.controller.EventController : end <<<<<<
複製程式碼執行成功了，但是通過控制檯列印資訊發現這裡並沒有非同步執行
非同步執行
預設是沒有開啟非同步的，我們需要手動配置開啟非同步功能，很簡單，只需要在配置類上加上@EnableAsync註解就行了，該註解用於宣告啟用Spring的非同步方法執行功能，需要和@Configuration註解一起使用，我們可以直接加在啟動類上。然後在監聽方法上加上@Async註解，說明當前方法使用非同步去執行。
@Async
@Override
public void onApplicationEvent(NoticeEvent noticeEvent) {
logger.info("listener get event, sleep 2 second...");
try {
Thread.sleep(2000);
} catch (InterruptedException e) {
e.printStackTrace();
}
logger.info("event message is : {}", noticeEvent.getMessage());
}
複製程式碼重啟服務，重新訪問介面：
[nio-8080-exec-1] o.y.n.event.controller.EventController : begin >>>>>>
[nio-8080-exec-1] org.ylc.note.event.event.NoticeEvent : add event success! message: hello
[nio-8080-exec-1] o.y.n.event.controller.EventController : end <<<<<<
[ task-1] org.ylc.note.event.event.NoticeListener : listener get event, sleep 2 second...
[ task-1] org.ylc.note.event.event.NoticeListener : event message is : hello
複製程式碼可以發現已經實現了非同步功能，主執行緒為nio-8080-exec-1，監聽執行緒為 task-1。從瀏覽器反應可以看出，介面直接返回了，並沒有等監聽執行緒執行完後才返回。
自定義非同步執行緒池
開啟非同步後，會使用Spring內部預設的執行緒池，我們可以自定義這個執行緒池。建立配置類(加上@Configuration)，實現AsyncConfigurer介面，重寫Executor方法。這裡我們可以將原先配置在啟動類上的@EnableAsync註解放到這個類上。
@Configuration
@EnableAsync
public class AsyncConfig implements AsyncConfigurer {
private final Logger log = LoggerFactory.getLogger(this.getClass());
/**
* 自定義非同步執行緒池，若不重寫會使用預設的執行緒池
*/
@Override
public Executor getAsyncExecutor() {
ThreadPoolTaskExecutor taskExecutor = new ThreadPoolTaskExecutor();
// 核心執行緒數
taskExecutor.setCorePoolSize(2);
// 最大執行緒數
taskExecutor.setMaxPoolSize(10);
// 佇列大小
taskExecutor.setQueueCapacity(15);
// 執行緒名的字首
taskExecutor.setThreadNamePrefix("async-thread-");
taskExecutor.initialize();
return taskExecutor;
}
/**
* 捕捉IllegalArgumentException異常
*/
@Override
public AsyncUncaughtExceptionHandler getAsyncUncaughtExceptionHandler() {
return new MyAsyncExceptionHandler();
}
class MyAsyncExceptionHandler implements AsyncUncaughtExceptionHandler {
@Override
public void handleUncaughtException(Throwable throwable, Method method, Object... objects) {
log.info("TASK Exception message - " + throwable.getMessage());
log.info("Method name - " + method.getName());
for (Object param : objects) {
log.info("Parameter value - " + param);
}
}
}
}
複製程式碼重啟服務，重新訪問介面：
[nio-8080-exec-1] o.y.n.event.controller.EventController : begin >>>>>>
[nio-8080-exec-1] org.ylc.note.event.event.NoticeEvent : add event success! message: hello
[nio-8080-exec-1] o.s.s.concurrent.ThreadPoolTaskExecutor : Initializing ExecutorService
[nio-8080-exec-1] o.y.n.event.controller.EventController : end <<<<<<
[ async-thread-1] org.ylc.note.event.event.NoticeListener : listener get event, sleep 2 second...
[ async-thread-1] org.ylc.note.event.event.NoticeListener : event message is : hello
複製程式碼控制檯中非同步執行緒名變成我們定義的 async-thread-X ，說明配置成功了。
訪問原始碼
所有程式碼均上傳至Github上，方便大家訪問
日常求贊
創作不易，如果各位覺得有幫助，求點贊支援