前言
本文講解了在Spring 應用中創建Bean的多種方式,包括自動創建,以及手動創建注入方式,實際開發中可以根據業務場景選擇合適的方案。
方式1:
使用Spring XML方式配置,該方式用於在純Spring 應用中,適用於簡單的小應用,當應用變得復雜,將會導致XMl配置文件膨脹 ,不利於對象管理。
<bean id="xxxx" class="xxxx.xxxx"/>
方式2:
使用@Component,@Service,@Controler,@Repository注解
這幾個注解都是同樣的功能,被注解的類將會被Spring 容器創建單例對象。
@Component : 側重於通用的Bean類
@Service:標識該類用於業務邏輯
@Controler:標識該類為Spring MVC的控制器類
@Repository: 標識該類是一個實體類,只有屬性和Setter,Getter
@Component
public class User{ }
當用於Spring Boot應用時,被注解的類必須在啟動類的根路徑或者子路徑下,否則不會生效。
如果不在,可以使用@ComponentScan標注掃描的路徑。
spring xml 也有相關的標簽<component-scan />
@ComponentScan(value={"com.microblog.blog","com.microblog.common"}) public class MicroblogBlogApplication { public static void main(String args[]){ SpringApplication.run(MicroblogBlogApplication.class,args); } }
方式3:
使用@Bean注解,這種方式用在Spring Boot 應用中。
@Configuration 標識這是一個Spring Boot 配置類,其將會掃描該類中是否存在@Bean 注解的方法,比如如下代碼,將會創建User對象並放入容器中。
@ConditionalOnBean 用於判斷存在某個Bean時才會創建User Bean.
這里創建的Bean名稱默認為方法的名稱user。也可以@Bean("xxxx")定義。
@Configuration public class UserConfiguration{ @Bean
@ConditionalOnBean(Location.class) public User user(){ return new User(); } }
Spring boot 還為我們提供了更多類似的注解。
也和方式2一樣,也會存在掃描路徑的問題,除了以上的解決方式,還有使用Spring boot starter 的解決方式
在resources下創建如下文件。META-INF/spring.factories.
Spring Boot 在啟動的時候將會掃描該文件,從何獲取到配置類UserConfiguration。
spring.factories.
org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.log.config.UserConfiguration
如果不成功,請引入該依賴
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
這個方式也是創建SpringBoot-starter的方式。
方式4:
使用注解@Import,也會創建對象並注入容器中
@Import(User.class) public class MicroblogUserWebApplication { public static void main(String args[]) { SpringApplication.run(MicroblogUserWebApplication.class, args); } }
方式5:
使用ImportSelector或者ImportBeanDefinitionRegistrar接口,配合@Import實現。
在使用一些Spring Boot第三方組件時,經常會看到@EnableXXX來使能相關的服務,這里以一個例子來實現。
創建測試類
@Slf4j public class House { public void run(){ log.info("House run ...."); } } @Slf4j public class User { public void run(){ log.info("User run ...."); } } @Slf4j public class Student { public void run(){ log.info("Student run ...."); } }
實現ImportSelector接口
selectImports方法的返回值為需要創建Bean的類名稱。這里創建User類。
@Slf4j public class MyImportSelector implements ImportSelector { @Override public String[] selectImports(AnnotationMetadata annotationMetadata) { log.info("MyImportSelector selectImports ..."); return new String[]{ User.class.getName()}; } }
實現ImportBeanDefinitionRegistrar接口
beanDefinitionRegistry.registerBeanDefinition用於設置需要創建Bean的類名稱。這里創建House類。
@Slf4j public class MyImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar { @Override public void registerBeanDefinitions(AnnotationMetadata annotationMetadata, BeanDefinitionRegistry beanDefinitionRegistry) { log.info("MyImportBeanDefinitionRegistrar registerBeanDefinitions ....."); BeanDefinition beanDefinition = new RootBeanDefinition(House.class.getName()); beanDefinitionRegistry.registerBeanDefinition(House.class.getName(),beanDefinition); } }
創建一個配置類
這里創建Student類。
@Configuration public class ImportAutoconfiguration { @Bean public Student student(){ return new Student(); } }
創建EnableImportSelector注解
EnableImportSelector注解上使用@Import,引入以上的三個類。
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Target(ElementType.TYPE)
@Import({MyImportSelector.class,ImportAutoconfiguration.class,MyImportBeanDefinitionRegistrar.class}) public @interface EnableImportSelector { String value(); }
測試
@EnableImportSelector(value = "xxx") @SpringBootApplication public class ImportDemoApplication { public static void main(String[] args) { ConfigurableApplicationContext context = SpringApplication.run(ImportDemoApplication.class, args); User user = context.getBean(User.class); user.run(); Student student = context.getBean(Student.class); student.run(); House house = context.getBean(House.class); house.run(); } }
輸出,可以看到,三個類User Student House都創建成功,都可從Spring 容器中獲取到。
2019-06-20 17:53:39.528 INFO 27255 --- [ main] com.springboot.importselector.pojo.User : User run .... 2019-06-20 17:53:39.530 INFO 27255 --- [ main] c.s.importselector.pojo.Student : Student run .... 2019-06-20 17:53:39.531 INFO 27255 --- [ main] c.springboot.importselector.pojo.House : House run ....
方式6
手動注入Bean容器,有些場景下需要代碼動態注入,以上方式都不適用。這時就需要創建 對象手動注入。
通過DefaultListableBeanFactory注入。
registerSingleton(String beanName,Object object);
這里手動使用new創建了一個Location對象。並注入容器中。
@Component
public class LocationRegister implements BeanFactoryAware {
@Override
public void setBeanFactory(BeanFactory beanFactory) throws BeansException {
DefaultListableBeanFactory listableBeanFactory = (DefaultListableBeanFactory)beanFactory;
//方式1
// Location location = new Location();
// listableBeanFactory.registerSingleton(Location.class.getName(),location);
//方式2
BeanDefinition locationBeanDefinition = new RootBeanDefinition(Location.class);
listableBeanFactory.registerBeanDefinition(Location.class.getName(),locationBeanDefinition);
}
}
這種方式的應用場景是為接口創建動態代理對象,並向SPRING容器注冊。
比如MyBatis中的Mapper接口,Mapper沒有實現類,啟動時創建動態代理對象,將該對象注冊到容器中,使用時只要@Autowired注入即可使用,調用接口方法將會被代理攔截,進而調用相關的SqlSession執行相關的SQL業務邏輯。
可以看以下它的繼承體系
DefaultListableBeanFactory 是ConfigurableListableBeanFactory的實現類。是對BeanFactory功能的擴展。
測試代碼和以上一樣
Location location = context.getBean(Location.class); location.run();
完結。
===========