Spring-boot

[TOC]

Spring boot方便了用户去创建一个独立的，基于spring的应用，你可以直接运行。大多数的spring boot 应用不需要太多的配置。

maven 设置

org.springframework.bootspring-boot-starter-parent1.4.2.RELEASE

org.springframework.bootspring-boot-starter-web

org.springframework.bootspring-boot-maven-plugin

并不是所有的应用都需要继承直spring-boot-starter-parent, 如果你有自己的parent，你可以使用如下的Maven配置

org.springframework.bootspring-boot-dependencies1.4.2.RELEASEpomimport

使用spring-boot-maven-plugin来打包为可执行的包

代码结构

建议使用自定义的package，默认的default 包会造成使用@ComponentScan, @EntityScan, @SpringBootApplication声明的application 出现问题，每个jar包中的每个class都会被读取

application类的位置

应用主Class 建议放在package的根目录下， @EnableAutoConfiguration一般放在主Class之上，同时也隐含着该目录为操作的基本目录，比如你定义了一个JPA的应用，则spring会在@@EnableAutoConfiguration定义的package中搜索@Entity申明的实例。

同时使用一个根目录，可以在申明@CompanentScan时不用去设置basePackage属性， t同时当主类在根目录的时候，你也可以使用@SpringBootApplication 注解。

com
 +- example
     +- myproject
         +- Application.java
         |
         +- domain
         |   +- Customer.java
         |   +- CustomerRepository.java
         |
         +- service
         |   +- CustomerService.java
         |
         +- web
             +- CustomerController.java

如下Application.java 中申明了主类，同时也设置了@Configuration

package com.example.myproject;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;

@Configuration
@EnableAutoConfiguration
@ComponentScan
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

}

Configuration class

spring boot 喜欢基于java的配置, 尽管SpringApplication.run()可以使用xml配置源来启动。建议你的主要配置源是一个@Configuration 的类，通常将主入口main()方法所在的类标记为主@Configuration类

引入附加的Configuration类

你不需要将所有的@Configuration都放在一个单独的类中，@Import注解可以引入额外的配置类。同时你也可以使用@ComponentScan来自动的引入Spring的组件，包括@Configuration类

1.定义配置类

public class EncodingConfiguration {
    private static final Logger logger = Logger.getLogger(EncodingConfiguration.class);

    public CharacterEncodingFilter characterEncodingFilter() {
        logger.info("re-set the character encoding filter");
        CharacterEncodingFilter filter = new CharacterEncodingFilter();
        filter.setEncoding("utf-8");
        filter.setForceEncoding(true);
        return filter;
    }
}

2.通过@Import导入到@Configuration类中

@Configuration
@EnableAutoConfiguration
@ComponentScan
@ImportResource("classpath:recommend-servlet.xml")
@Import(EncodingConfiguration.class)
public class Application {
    public static void main(String[] args) throws Exception {
        SpringApplication app = new SpringApplication(Application.class);
        app.run(args);
    }
}

引入XML 配置

如果你执意要使用xml的配置，那我们建议你使用一个@Configuration类，然后通过@ImportResource来加载xml的配置

Auto-Configuration

Spring Boot自动配置功能，可以自动的加载依赖的jar包中的配置。如HSQLDB在你的classpath中，你不需要手动配置任何的数据库连接，springboot会自动的加载到内存中。

你可以通过@ENableAutoConfiguration或者@SpringBootApplication注解@Configuration类来控制自动加载

逐步替换Auto-configuration

自动加载配置功能是非侵害的，如果你需要定义自己的配置来取代自动配置就比较麻烦了。比如你想添加自己的DataSource实例，默认的配置就需要被置后

在运行应用的时候，使用--debug,可以看到当前自动加载的所有配置信息。

让指定配置的自动加载失效

可以使用@EnableAutoConfiguration的exclude属性来指定某些配置自动加载失效

@Configuration
@EnableAutoConfiguration(exclude={DataSourceAutoConfiguration.class})
public class MyConfiguration {
}

如果类不在你的classpath中，可以使用excludeName属性指定全名。同样你可以使用spring.autoconfigure.exclude来指定一个列表

Spring Bean 以及依赖注入

你可以很容易的使用任何Sprping Framework的技术来定义你的bean，并注入。通过@ComponentScan 查找你的beans，然后通过@Autowired来注入

如果你按照之前我们建议的那样，将应用的主类放在根目录下，那你可以使用没有任何参数的@ComponentScan，应用中所有的组件(@Componenet, @Service,@Repository,@Controller等)都会被自动注册

package com.example.service;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class DatabaseAccountService implements AccountService {

private final RiskAssessor riskAssessor;

@Autowired
public DatabaseAccountService(RiskAssessor riskAssessor) {
this.riskAssessor = riskAssessor;
}

// ...

}

使用 @SpringBootApplication 注解

spring boot 需要在主类上标记@Configuration, @EnableAutoConfiguration,@ComponentScan，而且使用非常频繁，所以spring boot提供了@SpringBootApplication来取代

package com.example.myproject;

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

@SpringBootApplication // same as @Configuration @EnableAutoConfiguration @ComponentScan
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

}

运行应用

运行一个打包的应用

$ java -jar target/myproject-0.0.1-SNAPSHOT.jar

也可以运行自带的debugger来调试程序

$ java -Xdebug -Xrunjdwp:server=y,transport=dt_socket,address=8000,suspend=n \
   -jar target/myproject-0.0.1-SNAPSHOT.jar

使用maven插件

mvn spring-boot:run

SpringBoot特征

SpringApplication

SpringApplication 提供了一种方便的方式来构造一个Spring 的应用。在大多数情况下，你可以执行静态方法SpringApplication.run来直接运行

public static void main(String[] args) {
    SpringApplication.run(MySpringConfiguration.class, args);
}

启动失败

当启动失败时，已经注册的FailureAnalyzers就会提示识别到的错误信息，并提供一个建议来修复问题。 SpringBoot提供了很多FailureAnalyzer的实现，我们也可以很方便的自己实现如果没有任何的错误被Analyzer捕获，可以展现全部的自动配置信息来查看问题所在，

org.springframework.boot.autoconfigure.logging.AutoConfigurationReportLoggingInitializer.

定制banner

banner是指应用启动的时候所打印的信息。可以通过在classpath添加一个banner.txt文件或者设置banner.localtion来指向新的文件来修改内容。文件的编码可以通过banner.charset来设置，默认为utf-8. 除了文本文件，还可以添加banner.gif，banner.jpg或者 banner.png 到我们的classpath,或者设置参数banner.imag.location. 图片会被转为ASCII码来呈现

定制SpringApplication

如果默认的SpringApplication不符合你的要求，你可以创建一个本地的实例，然后定制他。类如，你如果想关掉bunner，则可以

public static void main(String[] args) {
    SpringApplication app = new SpringApplication(MySpringConfiguration.class);
    app.setBannerMode(Banner.Mode.OFF);
    app.run(args);
}

PreviousSpring NextZookeeper

Last updated 6 years ago

Was this helpful?