Springboot常用注解

Spring相关注解类

Conditional相关注解

 

@SpringBootApplication

      包含@SpringBootConfiguration、@EnableAutoConfiguration、@ComponentScan注解

 

@SpringBootConfiguration

      包含 @Configuration 注解

 

@EnableAutoConfiguration

      开启自动配置功能，将所有符合条件的 @Configuration 配置类加载到容器

 

@Configuration

       @Configuration用于定义配置类，用来代替 applicationContext.xml 配置文件，被注解的类内部包含有一个或多个被@Bean注解的方法，这些方法将会被AnnotationConfigApplicationContext或AnnotationConfigWebApplicationContext类进行扫描，并用于构建bean定义，初始化Spring容器。

 

             @Configuration标注在类上，等价于<Beans></Beans>。

 

             @Bean标注在方法上(返回某个实例的方法)，等价于<Bean></Bean>。默认的bean名称与标注的方法名相同。默认作用域为singleton作用域，可通过@Scope(“prototype”)设置为原型作用域。

 

             配置类不可以是final类型、不可以是匿名类、嵌套的configuration必须是静态类。

             @Configuration继承@Component，可以被@ComponentScan注解自动扫描。

 

//@Configuration和@Bean结合使用
@Configuration
public class TestConfiguration {
    public TestConfiguration() {
        System.out.println("容器启动初始化...");
    }

    @Bean(name="testBean", initMethod="start", destroyMethod="cleanUp")
    @Scope("prototype")
    public TestBean testBean() {
        return new TestBean();
    }
}

//使用外部变量
@Configuration
@PropertySource("classpath:/com/seasy/app.properties")
public class AppConfig {
    @Inject Environment env;

    @Value("${bean.name}") 
	private String beanName;

    @Bean
    public MyBean myBean() {
        return new MyBean(env.getProperty("bean.name"));
    }
}


//在@configuration中引入spring的xml配置文件
@Configuration
@ImportResource("classpath:applicationContext.xml")
public class WebConfig {
	
}

//在@configuration中引入其它注解配置
@Configuration
@Import(TestConfiguration.class)
public class WebConfig {
	
}

   

@ComponentScan

       该注解默认会自动扫描该类所在包下所有的配置类，相当于之前的 <context:component-scan>。

          useDefaultFilters属性的默认值为true，也就是说spring默认会自动发现被 @Component、@Controller、@Service和@Repository 标注的类，并注册进容器中。

 

@ConfigurationProperties

      读取配置文件的信息，并自动封装成实体类。

      默认是从application.properties属性文件中获取配置信息的，如果要从其他属性文件中获取，可以结合 @PropertySource 注解使用。

 

      有以下几种使用方式：

            和 @Component 注解一起使用：

@Component
@PropertySource("classpath:demo1.properties")
@ConfigurationProperties(prefix="seasy.connection")
public class ConfigBean{
	private String serverIp;
	private String serverPort;
	private boolean enabled;
	private AddressBean address;
	private List<AddressBean> addressList;
	private Map<String, AddressBean> addressMap;

	//getter and setter	
}

 

         demo1.properties属性文件：

seasy.connection.serverIp=192.168.1.1
seasy.connection.serverPort=4001
seasy.connection.enabled=true

#convert to bean
seasy.connection.address.province=GuangDong
seasy.connection.address.city=GuangZhou

#convert to list
seasy.connection.addressList[0].province=GuangDong
seasy.connection.addressList[0].city=GuangZhou
seasy.connection.addressList[1].province=ShangHai
seasy.connection.addressList[1].city=ShangHai2
seasy.connection.addressList[2].province=Beijing
seasy.connection.addressList[2].city=Beijing2

#convert to map
seasy.connection.addressMap.ADDR1.province=GuangDong
seasy.connection.addressMap.ADDR1.city=GuangZhou
seasy.connection.addressMap.ADDR2.province=ShangHai
seasy.connection.addressMap.ADDR2.city=ShangHai2
seasy.connection.addressMap.ADDR3.province=Beijing
seasy.connection.addressMap.ADDR3.city=Beijing2

 

              和 @bean 注解一起使用：此方式不能从自定义属性文件中加载

@Bean
@ConfigurationProperties(prefix="seasy.connection")
public ConfigBean getConfigBean(){
	return new ConfigBean();
}

 

              通过 @EnableConfigurationProperties 注解使 @ConfigurationProperties 标注的类生效：

@ConfigurationProperties(prefix="seasy.connection")
public class ConfigBean{

}

@Configuration
@EnableConfigurationProperties(ConfigBean.class)
public class MailConfiguration {
    @Autowired 
	private ConfigBean configBean;
}

 

@EnableConfigurationProperties

       一般要配合 @ConfigurationProperties 注解使用，用来开启对 @ConfigurationProperties 注解配置Bean的支持。

 

@Import

         用于导入特定的类来动态创建bean实例，支持以下几种方式：

         1、导入普通Java类，将其作为Spring bean注入到Spring容器中

                @Import({SquareBean.class, CircularBean.class})

 

         2、导入 @Configuration注解 标注的配置类

                @Import({SeasyConfiguration.class})

 

         3、导入实现ImportSelector接口的实现类

                public class MyImportSelector implements  ImportSelector{

                       public String[] selectImports(AnnotationMetadata importingClassMetadata) {

                               return new String[]{"com.zhang.bean.Triangle"};

                       }

                }

                @Import({MyImportSelector.class})

 

         4、导入实现ImportBeanDefinitionRegistrar接口的实现类

                public class MyImportBeanDefinitionRegistrar  implements ImportBeanDefinitionRegistrar{

                       public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {

                              RootBeanDefinition rootBeanDefinition = new RootBeanDefinition(Rectangle.class);

                              registry.registerBeanDefinition("rectangle", rootBeanDefinition);

                       }

                }

                @Import({MyImportBeanDefinitionRegistrar.class})