今天跟同事討論了一下在Spring Boot中,是使用@Configuration和@Bean的組合來創(chuàng)建Bean還是直接使用 @Service等注解放在類上的方式。筆者傾向于使用第一種,即@Configuration和@Bean的組合。
先來看一個例子,目標(biāo)是創(chuàng)建SearchService的一個Bean。
直接使用@Service的方式:
// SearchService.java
package li.koly.search;
import java.util.List;
public interface SearchService {
List<Object> search(String q);
}
// ElasticSearchServiceImpl.java
package li.koly.search;
import org.springframework.stereotype.Service;
import java.util.Arrays;
import java.util.List;
@ServiceComponent
public class ElasticSearchServiceImpl implements SearchService {
@Override
public List<Object> search(String q) {
return Arrays.asList("hello", q);
}
}
// Application.java
package li.koly.search;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.List;
@SpringBootApplication
@RestController
public class Application {
@Autowired
private SearchService searchService;
@GetMapping("/search")
public List<Object> hello(String q) {
return searchService.search(q);
}
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
啟動Application,瀏覽器訪問:http://localhost:8081/search?q=koly,頁面顯示:["hello","koly"]
使用@Configuration和@Bean的方式:
// ElasticSearchServiceImpl.java
package li.koly.search;
import java.util.Arrays;
import java.util.List;
public class ElasticSearchServiceImpl implements SearchService {
@Override
public List<Object> search(String q) {
return Arrays.asList("hello", q);
}
}
// AppConfig.java
package li.koly.search;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class AppConfig {
@Bean
public SearchService searchService() {
return new ElasticSearchServiceImpl();
}
}
相比直接使用@Service的代碼,多了一個AppConfig類,移除了放在ElasticSearchServiceImpl上面的@Service注解。一眼看去,代碼和類還多了。那么使用后者的好處是什么呢?
筆者認(rèn)為,好處有:
關(guān)注點(diǎn)分離
使用@Configuration和@Bean的方式,Bean的創(chuàng)建全部放到了一個地方,接口及其實(shí)現(xiàn)完全跟Bean創(chuàng)建沒有了關(guān)系。
如果Bean的創(chuàng)建需要改動,那么只需要查看并修改對應(yīng)的Configuration類就行,并不需要去到對應(yīng)的Java Bean進(jìn)行改動。比如可能有時候Bean創(chuàng)建需要同@Scope或者@Profile配合,此時只需要修改Configuration類就行了。
單一職責(zé)
@service注解本身就承擔(dān)了兩個職責(zé):
- 一是Bean的創(chuàng)建;
- 二是將一個類標(biāo)識為一個服務(wù)。
Indicates that an annotated class is a "Service", originally defined by Domain-Driven
Design (Evans, 2003) as "an operation offered as an interface that stands alone in the
model, with no encapsulated state."
上面是Spring對于@Service注解的說明。也就是說@Service實(shí)際上表示了DDD中的無狀態(tài)的,獨(dú)立的,以接口的形式提供的一個操作。
而采用@Bean和@Configuration配合的方式,Bean的創(chuàng)建交給了單獨(dú)的類,而Service的標(biāo)識交給了Java中的Interface以及類的名字。這點(diǎn)在Spring Data也有所體現(xiàn),比如Repository就是通過名字來標(biāo)識,如CrudRepository。因此Service也通過名字來體現(xiàn)。具體層次定義,通過名字而不依賴Spring提供的注解,便于根據(jù)項目提供更多的層次,比如Mapper層,Validator層等。
另為,本身Bean和Service就是兩個維度的概念。一個關(guān)于具體實(shí)現(xiàn),另一個關(guān)于DDD中的概念。
更靈活
使用@Bean的方式,能夠創(chuàng)建庫里面的類的實(shí)例。如果使用@Service的方式,沒辦法在庫里面對應(yīng)的類上添加@Service注解。
least knowledge(最小知識原則)
最小知識原則的意思是:
完成功能需要的技術(shù)或者知識越少越好,這樣才能保證項目簡單,同時降低項目的學(xué)習(xí)難度。
由于使用@Service無法創(chuàng)建類庫中的類的實(shí)例,因此在遇到類似需求時,不得不使用@Configuration和@Bean的形式。此時,整個項目中就同時存在@Service,@Configuration和@Bean等注解,而這些注解所做的事情都是一樣的,即Bean的創(chuàng)建。
使用@Service,很有可能出現(xiàn)@Service,@Component,@Configuration和@Bean同時存在的情況。
而使用@Configuration和@Bean則完全可以不使用@Service和@Component,符合最小知識原則。
最后,順便說一句,之前Spring的Bean創(chuàng)建是在xml里面,后面使用了Java做配置。不使用xml的主要原因是xml不夠簡潔,且沒有編譯時檢查等功能,而不是說需要將Bean的創(chuàng)建分散到各個類里。
綜上,筆者更傾向與使用@Configuration和@Bean的方式。
參考資料:
[1] https://stackoverflow.com/questions/10604298/spring-component-versus-bean