Spring提供了兩種后台任務的方法,分別是:
- 調度任務,@Schedule
- 異步任務,@Async
當然,使用這兩個是有條件的,需要在spring應用的上下文中聲明<task:annotation-driven/>
當然,如果我們是基於java配置的,需要在配置哪里加多EnableScheduling
和@EnableAsync
就像下面這樣
1
2
3
4
5
6
|
@EnableScheduling
@EnableAsync
public class WebAppConfig {
....
}
|
除此之外,還是有第三方庫可以調用的,例如Quartz.
@Schedule
先看下@Schedule
怎么調用再說
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
|
public final static long ONE_DAY = 24 * 60 * 60 * 1000;
public final static long ONE_HOUR = 60 * 60 * 1000;
public void scheduledTask() {
System.out.println(
" 我是一個每隔一天就會執行一次的調度任務");
}
public void scheduleTask2() {
System.out.println(
" 我是一個執行完后,隔一小時就會執行的任務");
}
public void doSomething() {
// something that should execute periodically
}
public void ScheduledTask3() {
System.out.println(
" 我是一個每隔一分鍾就就會執行的任務");
}
|
需要注意的
-
關於最后一個,在指定時間執行的任務,里面使用的是
Cron表達式
,同時我們看到了兩個不一樣的面孔fixedDelay
&fixedRate
,前者fixedDelay
表示在指定間隔運行程序,例如這個程序在今晚九點運行程序,跑完這個方法后的一個小時,就會再執行一次,而后者fixedDelay
者是指,這個函數每隔一段時間就會被調用(我們這里設置的是一天),不管再次調度的時候,這個方法是在運行還是結束了。而前者就要求是函數運行結束后開始計時的,這就是兩者區別。 -
這個還有一個initialDelay的參數,是第一次調用前需要等待的時間,這里表示被調用后的,推遲一秒再執行,這適合一些特殊的情況。
-
我們在
serviceImpl
類寫這些調度任務時候,也需要在這些我們定義的serviceInterface
的借口中寫多這個接口,要不然會爆but not found in any interface(s) for bean JDK proxy.Either pull the method up to an interface or
@Async
有時候我們會調用一些特殊的任務,任務會比較耗時,重要的是,我們不管他返回的后果。這時候我們就需要用這類的異步任務啦,調用后就讓他去跑,不堵塞主線程,我們繼續干別的。代碼像下面這樣:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
|
public void AsyncTask(){
public void doSomeHeavyBackgroundTask(int sleepTime) {
try {
Thread.sleep(sleepTime);
}
catch (InterruptedException e) {
e.printStackTrace();
}
}
public Future<String> doSomeHeavyBackgroundTask() {
try {
Thread.sleep(
3000);
}
catch (InterruptedException e) {
e.printStackTrace();
}
return null;
}
public void printLog() {
System.out.println(
" i print a log ,time=" + System.currentTimeMillis());
}
}
|
我們寫個簡單的測試類來測試下
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
|
@RunWith(SpringJUnit4ClassRunner.class)
@WebAppConfiguration
@ContextConfiguration(classes = AsycnTaskConfig.class) //要聲明@EnableASync
public class AsyncTaskTest {
@Autowired
AsyncTask asyncTask;
@Test
public void AsyncTaskTest() throws InterruptedException {
if (asyncTask != null) {
asyncTask.doSomeHeavyBackgroundTask(4000);
asyncTask.printLog();
Thread.sleep(5000);
}
}
}
|
這感覺比我們手動開多一個線程方便多了,不想異步的話直接把@Async
去掉就可以了,另外如果你想要返回個結果的,這需要加多個Future<>,關於這個Future,完全可以寫多幾篇文章介紹,順便把FutureTask介紹了。如果想修改Spring boot的默認線程池配置,可以實現AsyncConfigurer.
需要注意的:
- 相對於
@scheduled
,這個可以有參數和返回個結果,因為這個是我們調用的,而調度的任務是spring調用的。 - 異步方法不能內部調用,只能像上面那樣,外部調用,否則就會變成阻塞主線程的同步任務啦!這個坑我居然跳下去了!例如下面這樣的。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
|
public void AsyncTask(){
public void fakeAsyncTaskTest(){
doSomeHeavyBackgroundTask(
4000);
printLog();
//你會發現,當你像這樣內部調用的時候,居然是同步執行的,不是異步的!!
}
public void doSomeHeavyBackgroundTask(int sleepTime) {
try {
Thread.sleep(sleepTime);
}
catch (InterruptedException e) {
e.printStackTrace();
}
}
public void printLog() {
System.out.println(
" i print a log ");
}
}
|
- 另外一點就是不要重復的掃描,這也會導致異步無效,具體的可以看這個stackoveflow的spring-async-not-working Issue。
- 關於異常處理,難免在這個異步執行過程中有異常發生,對於這個問題,spring提供的解決方案如下,實現 AsyncUncaughtExceptionHandler接口。
1
2
3
4
5
6
7
8
9
10
11
|
public class MyAsyncUncaughtExceptionHandler implements
AsyncUncaughtExceptionHandler {
public void handleUncaughtException(Throwable ex,
Method method, Object... params) {
// handle exception
}
}
|
寫好我們的異常處理后,我們需要配置一下,告訴spring,這個異常處理就是我們在運行異步任務時候,拋出錯誤時的異常終結者
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
|
public class AsyncConfig implements AsyncConfigurer {
public AsyncTask asyncBean() {
return new AsyncTask();
}
public Executor getAsyncExecutor() {
ThreadPoolTaskExecutor executor =
new ThreadPoolTaskExecutor();
executor.setCorePoolSize(
7);
executor.setMaxPoolSize(
42);
executor.setQueueCapacity(
11);
executor.setThreadNamePrefix(
"MyExecutor-");
executor.initialize();
return executor;
}
public AsyncUncaughtExceptionHandler getAsyncUncaughtExceptionHandler() {
return new MyAsyncUncaughtExceptionHandler();
}
}
|
Quartz登場
處理這兩個外,還有一個和spring整合的第三方庫叫Quartz
看了下官網的使用簡介,也是挺逗的,現在都習慣用maven,gradle之類來關系這些依賴了,他還叫人下載,也是不知為何,詳情點擊->
http://quartz-scheduler.org/documentation/quartz-2.2.x/quick-start
估計有可能是因為沒再維護了的原因吧,看了下,最新版2.2居然是Sep, 2013更新的…
居然是停更的,不過Quartz作為一個企業級應用的任務調度框架,還是一個可以的候選項目的。
這里不鋪開講,有興趣就去官網看下吧。整體用起來感覺是沒有spring自己的后台任務方便,不過也可以接受,只需要簡單的配置就可以使用了。