框架学习-SpringBoot核心注解

一、入口类和@SpringBootApplication

Spring Boot的项目一般都会有"Application"的入口类，入口类中会有main方法，这是一个标准的Java应用程序的入口方法。@SpringBootApplication注解是Spring Boot的核心注解，它其实是一个组合注解，我们打开@SpringBootApplication注解的源码可以看到：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(excludeFilters = @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class))
public @interface SpringBootApplication {
 
    Class<?>[] exclude() default {};
 
    String[] excludeName() default {};
 
    @AliasFor(annotation = ComponentScan.class, attribute = "basePackages")
    String[] scanBasePackages() default {};
 
 
    @AliasFor(annotation = ComponentScan.class, attribute = "basePackageClasses")
    Class<?>[] scanBasePackageClasses() default {};
 
}

@SpringBootApplication本身就是一个注解，而它的注解描述上又有许多的注解定义，这叫“组合注解”，引用了@SpringBootApplication注解，其本身的注解也是全部生效的。
在上面的注解解释分别如下：

(1)@Target(ElementType.TYPE)
@Target表示注解的作用目标，ElementType指作用目标的类型：

@Target(ElementType.TYPE)   //接口、类、枚举、注解
@Target(ElementType.FIELD) //字段、枚举的常量
@Target(ElementType.METHOD) //方法
@Target(ElementType.PARAMETER) //方法参数
@Target(ElementType.CONSTRUCTOR)  //构造函数
@Target(ElementType.LOCAL_VARIABLE)//局部变量
@Target(ElementType.ANNOTATION_TYPE)//注解
@Target(ElementType.PACKAGE) ///包   

(2)@Retention(RetentionPolicy.RUNTIME)

@Retention代表注解的保留位置，其中的RetentionPolicy代表保留规则：
@Retention(RetentionPolicy.SOURCE)   //注解仅存在于源码中，在class字节码文件中不包含
@Retention(RetentionPolicy.CLASS)     // 默认的保留策略，注解会在class字节码文件中存在，但运行时无法获得，
@Retention(RetentionPolicy.RUNTIME)  // 注解会在class字节码文件中存在，在运行时可以通过反射获取到

(3)@Documented
说明该注解将被包含在javadoc中

(4)@Inherited
说明子类可以继承父类中的该注解

(5)@SpringBootConfiguration
对于“@SpringBootConfiguration”注解，打开其源码：

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

我们可以发现它也是一个“组合注解”，不难发现它其实就是对@Configuration的包装 我们可以认为是@Configuration注解。在项目中推荐使用@SpringBootConfiguration替代@Configuration注解。

(6)@EnableAutoConfiguration
该注解表示“开启自动配置”。这个注解官网说是 让Spring自动去进行一些配置，那我们点进来看

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import(EnableAutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {
}

可以看到它是由 @AutoConfigurationPackage，@Import(EnableAutoConfigurationImportSelector.class)这两个而组成的，我们先说@AutoConfigurationPackage，他是说：让包中的类以及子包中的类能够被自动扫描到spring容器中。 我们来看@Import(EnableAutoConfigurationImportSelector.class)这个是核心，之前我们说自动配置，那他到底帮我们配置了什么，怎么配置的？

public class EnableAutoConfigurationImportSelector
      extends AutoConfigurationImportSelector {
 
   @Override
   protected boolean isEnabled(AnnotationMetadata metadata) {
      if (getClass().equals(EnableAutoConfigurationImportSelector.class)) {
         return getEnvironment().getProperty(
               EnableAutoConfiguration.ENABLED_OVERRIDE_PROPERTY, Boolean.class,
               true);
      }
      return true;
   }
 
}

可以看到他继承了AutoConfigurationImportSelector我们继续来AutoConfigurationImportSelector，这个类有一个方法

public String[] selectImports(AnnotationMetadata annotationMetadata) {
   if (!isEnabled(annotationMetadata)) {
      return NO_IMPORTS;
   }
   try {
      AutoConfigurationMetadata autoConfigurationMetadata = AutoConfigurationMetadataLoader
            .loadMetadata(this.beanClassLoader);
      AnnotationAttributes attributes = getAttributes(annotationMetadata);
      List<String> configurations = getCandidateConfigurations(annotationMetadata,
            attributes);
      configurations = removeDuplicates(configurations);
      configurations = sort(configurations, autoConfigurationMetadata);
      Set<String> exclusions = getExclusions(annotationMetadata, attributes);
      checkExcludedClasses(configurations, exclusions);
      configurations.removeAll(exclusions);
      configurations = filter(configurations, autoConfigurationMetadata);
      fireAutoConfigurationImportEvents(configurations, exclusions);
      return configurations.toArray(new String[configurations.size()]);
   }
   catch (IOException ex) {
      throw new IllegalStateException(ex);
   }
}

这个类会帮你扫描那些类自动去添加到程序当中。我们可以看到getCandidateConfigurations()这个方法，他的作用就是引入系统已经加载好的一些类，到底是那些类呢，我们点进去看一下

protected List<String> getCandidateConfigurations(AnnotationMetadata metadata,
      AnnotationAttributes attributes) {
   List<String> configurations = SpringFactoriesLoader.loadFactoryNames(
         getSpringFactoriesLoaderFactoryClass(), getBeanClassLoader());
   Assert.notEmpty(configurations,
         "No auto configuration classes found in META-INF/spring.factories. If you "
               + "are using a custom packaging, make sure that file is correct.");
   return configurations;
}

这个类回去寻找的一个目录为META-INF/spring.factories，也就是说他帮你加载让你去使用也就是在这个META-INF/spring.factories目录装配的，他在哪里？

我们点进spring.factories来看

 我们可以发现帮我们配置了很多类的全路径，比如你想整合redis，或者说Servlet 

 所以我们的EnableAutoConfiguration主要作用就是让你自动去配置，但并不是所有都是创建好的，是根据你程序去进行决定

(7)@ComponentScan
该注解会自动扫描包路径下面的所有@Controller、@Service、@Repository、@Component 的类，不配置包路径的话，在Spring Boot中默认扫描@SpringBootApplication所在类的同级目录以及子目录下的相关注解。

二、关闭自动配置
通过上面的描述，我们可以知道，Spring Boot会根据项目中配置的jar包依赖，自动做出配置，而Spring Boot支持的配置非常多，我们可以在样例工程下观察引入的spring-boot-autoconfigure依赖，下面引入了非常多的依赖：

很多时候，我们也许不需要这么多的依赖引入，此时我们可以关闭自动配置来解决这个问题。
例如我们不需要自动配置Redis，可以这样设置：

package cn.springboot.test;
 
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.data.redis.RedisAutoConfiguration;
 
@SpringBootApplication(exclude={RedisAutoConfiguration.class})
//Sprnig Boot项目的核心注解，主要目的是开启自动配置
public class SpringbootTestSimpleApplication {
    //该main方法作为项目启动的入口
    public static void main(String[] args) {
        SpringApplication.run(SpringbootTestSimpleApplication.class, args);
    }
}

即使用“exclude”参数来排除不需要的自动配置依赖。

三、自定义Banner

这个字符画就是Spring Boot的Banner，我们是可以自定义该字符画的。
首先我们来定义一个字符画，推荐一个网站：http://www.bootschool.net/ascii
打开后，我们随便输入一串字，例如“SpringBoot”：

我们将该字符画存储到一个txt中，然后保存为“banner.txt”的文件，放入测试工程的resources静态资源文件夹下：

 然后重启项目，会看到banner已经变成我们自定义的了： 

当然我们也可以关闭banner，在启动类中，定义一个SpringApplication，将其banner属性设置为“Mode.off”即可： 

package cn.springboot.test;
 
import org.springframework.boot.Banner.Mode;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
 
@SpringBootApplication
//Sprnig Boot项目的核心注解，主要目的是开启自动配置
public class SpringbootTestSimpleApplication {
    //该main方法作为项目启动的入口
    public static void main(String[] args) {
        //SpringApplication.run(SpringbootTestSimpleApplication.class, args);
        SpringApplication springApplication = new SpringApplication(SpringbootTestSimpleApplication.class);
        springApplication.setBannerMode(Mode.OFF);
        springApplication.run(args);
    }
}