Spring Boot 的常用 API 说明

1、SpringApplication 类

作用：用于启动 Spring Boot 的程序，根据传入的类的声明的注解来决定不同的启动方式

示例代码：

package org.ranger;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
//使用 SpringBoot 自动配置程序 
@SpringBootApplication 
public class Application {
     public static void main(String[] args) {
             //执行当前类,根据@SpringBootApplication 的配置,启动 SpringBoot 程序     
            SpringApplication.run(Application.class, args); 
     }
}

2、@EnableAutoConfiguration 注解

注解的声明：

@SuppressWarnings("deprecation") 
@Target(ElementType.TYPE) 
@Retention(RetentionPolicy.RUNTIME) 
@Documented @Inherited 
@AutoConfigurationPackage @Import(EnableAutoConfigurationImportSelector.class) 
public @interface EnableAutoConfiguration { 
    String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration"; 
    Class<?>[] exclude() default {};
    String[] excludeName() default {};
}

作用：启动程序时，告诉 SpringApplication 启动对象使用 SpringBoot 的默认配置

只要在 SpringBoot 项目的入口配置了 @EnableAutoConfiguration，SpringBoot 框架启动时就会自动根据你导入的 jar 包来加载 spring-boot-autoconfigure-1.5.4.RELEASE-sources.jar 中的 xxxAutoConfiguration 配置类，使用其默认配置。

属性说明：

　　exclude 属性：使用 Class 格式的方式，排除默认自动启动中不需要的配置类

       excludeName 属性：使用类的限制名的方式，排序默认自动启动中不需要的配置类

3、@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 { 
   @AliasFor(annotation = EnableAutoConfiguration.class, attribute = "exclude") 
   Class<?>[] exclude() default {};
   @AliasFor(annotation = EnableAutoConfiguration.class, attribute = "excludeName") 
   String[] excludeName() default {}; 
   @AliasFor(annotation = ComponentScan.class, attribute = "basePackages") 
   String[] scanBasePackages() default {}; 
   @AliasFor(annotation = ComponentScan.class, attribute = "basePackageClasses") 
   Class<?>[] scanBasePackageClasses() default {}; 
}

　　根据注解的声明可以得出：@SpringBootApplication 注解也是启动 Springboot 的默认配置。只是 在@EnableAutoConfiguration 注解的基础上增加了扫描包@ComponentScan 和 设置类为配置类 @SpringBootConfiguration 注解。实现了将给类设置为配置类、扫描指定范围的类创建对象到容器里面，并且自动加载Spring Boot默认配置。

属性说明：

　　① basePackages 属性 @SpringBootApplication 默认扫描的范围是使用该注解的当前的类的包以及子包,如果要指定其他 范围的包，可以是 basePackages 指定。

　　② basePackageClasses 属性 用于精确指定哪些类需要创建对象加载到 Spring 容器里面。

　　③ exclude 属性 通过 Class 的方式排除不扫描的类，就是该类不创建对象。

　　④ excludeName 属性 通过类的全限制名的方式，排除不扫描的类,指定的类不会在容器中创建对象。

4、@AutoConfigureBefore 注解

注解说明：

　　指定在 SpringBoot 框架自动配置的配置类执行完成之前，执行指定的自定义的配置类。 如果放在 Application 入口类，表示在所有自动配置的配置类还没有可以就先加载自定义的配置 类。

　　@AutoConfigureBefore 注解属性：

　　　　value:使用类的方式指定自动配置类

　　　　name：使用类的全限制名（字符串）类指定配置类

示例代码：

　　① 创建一个普通的类，没有任何注解

package cn.mgy.utils;
/** 
   * 创建一个没有扫描注入容器注解的类
   * @author ranger
* */ 
public class TestUtils { 
    /** 
      * 返回测试信息 
      * @return 
      */ 
      public String test(){ 
          return "-测试注入对象成功-"; 
      }
}

　　② 创建一个自定义配置类，注入普通的类的Spring容器

package cn.mgy.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

package cn.mgy.config;

import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import cn.mgy.utils.TestUtils;

/**
 * 创建一个自定义的配置类
 * @author ranger
 *
 */
@Configuration
public class MyConfiguration {
    /**
     * 返回一个对象到容器
     * @return
     */
    @Bean(name="testUtils")
    //表示如果Spring容器有TestUtils的对象就不执行这个方法在创建一次了。
    @ConditionalOnMissingBean(TestUtils.class)
    public TestUtils getTestUtils(){
        TestUtils testUtils=new TestUtils();
        return testUtils;
    }

}

　　③ 在入口类配置加入自定义配置类

package cn.mgy;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.AutoConfigureBefore;
import org.springframework.boot.autoconfigure.SpringBootApplication;

import cn.mgy.config.MyConfiguration;

//使用SpringBoot自动配置程序
@SpringBootApplication
//在自动配置的配置类之前启动自定义的配置类
@AutoConfigureBefore(value=MyConfiguration.class)
public class Application {
    
    public static void main(String[] args) {
        //执行当前类,根据@SpringBootApplication的配置,启动SpringBoot程序
        SpringApplication.run(Application.class, args);
        
    }

}

　　④ 在 Controller 里面使用这个注入的对象

package cn.mgy.controller;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

import cn.mgy.utils.TestUtils;

@Controller
public class HelloController {
    
    @Autowired
    private TestUtils testUtils;
    
    @RequestMapping(value="/")
    @ResponseBody
    public String say(){
        System.out.println(testUtils.test());
        return testUtils.test();
    }

}

　　⑤ 测试，成功

 

5、@AutoConfigureAfter注解

　　作用：指定在SpringBoot框架自动配置的配置类执行完成之后，然后执行指定的自定义的配置类。

6、@SpringBootTest注解

注解说明：用于使用JUnit测试SpringBoot程序，启动SpringBoot框架。测试SpringBoot一定要加上。

示例代码：

package cn.mgy.test;

import java.sql.SQLException;

import javax.sql.DataSource;

import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;

@RunWith(SpringJUnit4ClassRunner.class)
//如果不加该注解，无法启动SpringBoot
@SpringBootTest
public class DataSourceTest {
    
    @Autowired
    private DataSource dataSource;

    @Test
    public void dataSource() {
        try {
            System.out.println(dataSource.getConnection());
        } catch (SQLException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
    }

}