@SpringBootApplication用法

一、@SpringBootApplication注解一般放在项目的一个启动类上,用来把启动类注入到容器中,用来定义容器扫描的范围,用来加载classpath环境中一些bean。因为,从@SpringBootApplication的源码中可以看出,

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(excludeFilters = {
        @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
        @Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
public @interface SpringBootApplication {

@SpringBootApplication注解主要包装了@SpringBootConfiguration、@EnableAutoConfiguration和@ComponentScan注解。

1、@SpringBootConfiguration主要用来把bean注入到容器中,因为该注解又封装了@Configuration注解。

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Configuration
public @interface SpringBootConfiguration {

}

而@Configuration注解又封装了@Component注解,@Component注解主要用来把一个bean注入到容器中。

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface Configuration {

因此,@SpringBootConfiguration注解就拥有了@Component注解的功能,用来把一个bean注入到容器中。
2、@EnableAutoConfiguration这个注释告SpringBoot“猜”你将如何想配置Spring,基于你已经添加jar依赖项。如果spring-boot-starter-web已经添加Tomcat和Spring MVC,这个注释自动将假设您正在开发一个web应用程序并添加相应的spring设置。自动配置被设计用来和“Starters”一起更好的工作,但这两个概念并不直接相关。您可以自由挑选starter依赖项以外的jar包,springboot仍将尽力自动配置您的应用程序。
3、@ComponentScan注解主要用来指定扫描容器的范围。
所以@SpringBootApplication同时拥有三种注解的功能。

二、下面通过示例演示@SpringBootApplication的用法。

1、首先自定义一个Person 类,并注入到容器中。

package com.example.beans;
import org.springframework.boot.SpringBootConfiguration;
import org.springframework.context.annotation.Configuration;

/*@SpringBootConfiguration注解包装了@Configuration注解,而@Configuration注解又包装了@Component注解,所以此地用三者注解中的任何一个都可以。*/
@SpringBootConfiguration
//@Configuration
public class Person {

}

然后在启动类中获取Person类对应的bean

package com.example.demo;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;
import com.example.beans.Person;

@SpringBootApplication
public class App {

    public static void main(String[] args) {
        SpringApplication.run(App.class, args);
        SpringApplication app = new SpringApplication(App.class);
        ConfigurableApplicationContext context = app.run(args);
        Person person = (Person) context.getBean("person");
        System.out.println(person);
    }
}

运行启动类,会报一个找不到person bean的异常。因为@SpringBootApplication注解默认只扫描该注解注解类所在的包,即默认只扫描com.example.demo包下的bean,但是person bean对应的类在com.example.beans下,所以在启动类中获取不到person bean。

2、可以用@SpringBootApplication注解中的scanBasePackages属性显示指定要扫描的包的范围。

package com.example.demo;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;
import com.example.beans.Person;

/*指定扫描com.example包下的所有bean*/
@SpringBootApplication(scanBasePackages="com.example")
public class App {

    public static void main(String[] args) {
        SpringApplication.run(App.class, args);
        SpringApplication app = new SpringApplication(App.class);
        ConfigurableApplicationContext context = app.run(args);
        Person person = (Person) context.getBean("person");
        System.out.println(person);
    }
}

运行启动类,会获取到person的bean。

3、可以用@SpringBootApplication注解中的scanBasePackageClasses属性显示指定要扫描的类。

package com.example.demo;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;
import com.example.beans.Person;

/*显示指定只扫描Person类,程序中只能加载Person类对应的bean*/
@SpringBootApplication(scanBasePackageClasses=Person.class)
public class App {

    public static void main(String[] args) {
        SpringApplication.run(App.class, args);
        SpringApplication app = new SpringApplication(App.class);
        ConfigurableApplicationContext context = app.run(args);
        Person person = (Person) context.getBean("person");
        System.out.println(person);
    }
}

运行启动类,会获取到person的bean。

4、可以用@SpringBootApplication注解中的exclude属性显示指定要排除的类。
首先建一个Animal类,

package com.example.beans;
import org.springframework.boot.SpringBootConfiguration;
import org.springframework.context.annotation.Configuration;

@SpringBootConfiguration
public class Animal {

}

在启动类中获取bean

package com.example.demo;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;
import com.example.beans.Animal;
import com.example.beans.Person;

/*exclude排除掉了扫描的类*/
@SpringBootApplication(scanBasePackages="com.example", exclude=Animal.class)
public class App {

    public static void main(String[] args) {
        SpringApplication.run(App.class, args);
        SpringApplication app = new SpringApplication(App.class);
        ConfigurableApplicationContext context = app.run(args);
        /*可以获取到person的bean*/
        Person person = (Person) context.getBean("person");
        System.out.println(person);
        /*获取不到Animal类型的bean*/
        Animal animal = context.getBean(Animal.class);
        System.out.println(animal);
    }
}

运行启动类,只能获取到person的bean,不能获取关于Animal类型的bean。

5、可以用@SpringBootApplication注解中的excludeName属性显示指定要排除的类的名字。

package com.example.demo;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;

import com.example.beans.Animal;
import com.example.beans.Person;

@SpringBootApplication(scanBasePackages="com.example", excludeName="com.example.beans.Animal")
public class App {

    public static void main(String[] args) {
        SpringApplication.run(App.class, args);
        SpringApplication app = new SpringApplication(App.class);
        ConfigurableApplicationContext context = app.run(args);
        /*可以获取perosn的bean*/
        Person person = (Person) context.getBean("person");
        System.out.println(person);
        /*获取不到Animal类型的bean*/
        Animal animal = context.getBean(Animal.class);
        System.out.println(animal);
    }
}

运行启动类,可以获取到person的bean,但是获取不到Animal类型的bean。

你可能感兴趣的:(@SpringBootApplication用法)