Spring Boot 学习之基础篇（一）

该系列并非完全原创，官方文档、作者

Spring Boot 是由 Pivotal 团队提供的全新框架，其设计目的是用来简化新 Spring 应用的初始搭建以及开发过程。该框架使用了特定的方式来进行配置，从而使开发人员不再需要定义样板化的配置。

一、环境搭建

创建一个Maven项目，结构如图，文件目录可忽略。如何创建Maven项目

1、添加依赖

在 pom.xml 文件中添加如下依赖

<!-- 定义公共资源版本 -->
<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.0.1.RELEASE</version>
    <relativePath /> 
</parent>

<properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    <java.version>1.8</java.version>
</properties>

<dependencies>
    <!-- 上边引入 parent，因此 下边无需指定版本 -->
    <!-- 包含 mvc,aop 等jar资源 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
</dependencies>

<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
        </plugin>
    </plugins>
</build>

2、创建目录和配置文件

在resources 源文件目录，创建 application.properties 文件、static 和 templates 的文件夹。
application.properties：用于配置项目运行所需的配置数据。
static：用于存放静态资源，如：css、js、图片等。

templates：用于存放模板文件。

3、创建启动类

在src根目录下建立，一定要在根目录，看源码默认扫描此类所在包下的所有注解。

/**
 该注解指定项目为springboot，由此类当作程序入口，自动装配 web 依赖的环境
**/
@SpringBootApplication
public class SpringbootApplication {

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

4、启动项目

在 SpringbootApplication 文件中右键 Run as -> Java Application。图就不上了

二、热部署

pom.xml修改并添加

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-devtools</artifactId>
	<scope>runtime</scope>
</dependency>

<build>
	<plugins>
		<plugin>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-maven-plugin</artifactId>
			<configuration>
				<!-- 没有该配置，devtools 不生效 -->
				<fork>true</fork>
			</configuration>
		</plugin>
	</plugins>
</build>

ctrl+s保存后，再启动项目，随便创建/修改一个文件并保存，会发现控制台打印 springboot 重新加载文件的信息。

三、多环境

如初图，按照我在SGM的开发规则，application.properties 是 springboot 在运行中所需要的配置信息。
当我们在开发阶段，本地机器开发，测试的时候用测试服务器测试，上线时使用正式环境的服务器。
这三种环境需要的配置信息都不一样，当切换环境运行项目时，需要手动的修改多出配置信息，非常容易出错。
为了解决上述问题，springboot 提供多环境配置的机制，让开发者非常容易的根据需求而切换不同的配置环境。
在 src/main/resources 目录下创建三个配置文件:
application-local.properties：用于本地环境
application-qa.properties：用于测试环境
application-prod.properties：用于生产环境

可以在这个三个配置文件中设置不同的信息，application.properties 配置公共的信息。

在 application.properties 中配置：

spring.profiles.active=local

表示激活application-local.properties文件配置，springboot 会加载使用 application.properties 和 application-local.properties 配置文件的信息。

在application-local.properties配置加上

server.port = 8081

再重新启动项目发现只能用8081端口访问了（如果被占用会报错的，再修改）

四、配置日志

1、配置日志文件

spring boot 默认会加载 classpath:logback-spring.xml 或者 classpath:logback-spring.groovy。
如需要自定义文件名称，在 application.properties 中配置 logging.config 选项即可。

在 src/main/resources 下创建 logback-spring.xml 文件，内容如下：

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!-- 文件输出格式 -->
    <property name="PATTERN" value="%-12(%d{yyyy-MM-dd HH:mm:ss.SSS}) |-%-5level [%thread] %c [%L] -| %msg%n" />
    <!-- local文件路径 -->
    <property name="LOCAL_FILE_PATH" value="E:/Eclipse/workspace/sgm/phil-springboot/log" />
    <!-- pro文件路径 -->
    <property name="PRO_FILE_PATH" value="/midware/logfiles" />
    
     <!-- 本地环境 -->
    <springProfile name="local">
        <!-- 每天产生一个文件 -->
        <appender name="LOCAL_FILE_PATH" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <!-- 文件路径 -->
            <file>${LOCAL_FILE_PATH}</file>
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <!-- 文件名称 -->
                <fileNamePattern>${LOCAL_FILE_PATH}/info.%d{yyyy-MM-dd}.log</fileNamePattern>
                <!-- 文件最大保存历史数量 -->
                <MaxHistory>100</MaxHistory>
            </rollingPolicy>
            <layout class="ch.qos.logback.classic.PatternLayout">
                <pattern>${PATTERN}</pattern>
            </layout>
        </appender>
        <root level="info">
            <appender-ref ref="LOCAL_FILE_PATH" />
        </root>
    </springProfile>
    
    <!-- 测试环境 -->
    <springProfile name="qa">
        <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
            <encoder>
                <pattern>${PATTERN}</pattern>
            </encoder>
        </appender>
        <logger name="com.phil.springboot" level="debug"/>
        <root level="info">
            <appender-ref ref="CONSOLE" />
        </root>
    </springProfile>
    
    <!-- 生产环境 -->
    <springProfile name="prod">
        <appender name="PROD_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <file>${PRO_FILE_PATH}</file>
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <fileNamePattern>${PRO_FILE_PATH}/warn.%d{yyyy-MM-dd}.log</fileNamePattern>
                <MaxHistory>100</MaxHistory>
            </rollingPolicy>
            <layout class="ch.qos.logback.classic.PatternLayout">
                <pattern>${PATTERN}</pattern>
            </layout>
        </appender>
        <root level="warn">
            <appender-ref ref="PROD_FILE" />
        </root>
    </springProfile>

其中，springProfile 标签的 name 属性对应 application.properties 中的 spring.profiles.active 的配置。

即 spring.profiles.active 的值可以看作是日志配置文件中对应的 springProfile 是否生效的开关。

2、配置 log4j2

添加并修改依赖

<!-- log4j2 -->
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter</artifactId>
	<exclusions>
		<exclusion>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-logging</artifactId>
		</exclusion>
	</exclusions>
</dependency>

配置日志文件

pring boot 默认会加载 classpath:log4j2.xml 或者 classpath:log4j2-spring.xml。
如需要自定义文件名称，在 application.properties 中配置 logging.config 选项即可。
log4j2.xml 文件内容如下：

<?xml version="1.0" encoding="utf-8"?>
<configuration>
    <properties>
        <!-- 文件输出格式 -->
        <property name="PATTERN">%d{yyyy-MM-dd HH:mm:ss.SSS} |-%-5level [%thread] %c [%L] -| %msg%n</property>
    </properties>
    <appenders>
        <Console name="CONSOLE" target="system_out">
            <PatternLayout pattern="${PATTERN}" />
        </Console>
    </appenders>
    <loggers>
        <logger name="com.phil.springboot" level="debug"/>
        <root level="info"><!-- 默認是debug -->
            <appenderref ref="CONSOLE" />
        </root>
    </loggers>
</configuration>

log4j2 不能像 logback 那样在一个文件中设置多个环境的配置数据，只能命名 3 个不同名的日志文件，分别在 application-local，application-qa和 application-prod 中配置 logging.config 选项。(我没做)

除了在日志配置文件中设置参数之外，还可以在 application-*.properties 中设置，日志相关的配置：

logging.config                    # 日志配置文件路径，如 classpath:logback-spring.xml
logging.exception-conversion-word # 记录异常时使用的转换词
logging.file                      # 记录日志的文件名称，如：test.log
logging.level.*                   # 日志映射，如：logging.level.root=WARN，logging.level.org.springframework.web=DEBUG
logging.path                      # 记录日志的文件路径，如：d:/
logging.pattern.console           # 向控制台输出的日志格式，只支持默认的 logback 设置。
logging.pattern.file              # 向记录日志文件输出的日志格式，只支持默认的 logback 设置。
logging.pattern.level             # 用于呈现日志级别的格式，只支持默认的 logback 设置。
logging.register-shutdown-hook    # 初始化时为日志系统注册一个关闭钩子

五、常用注解

@Configuration                 # 作用于类上，相当于一个 xml 配置文件
@Bean                          # 作用于方法上，相当于 xml 配置中的 <bean>
@SpringBootApplication         # Spring Boot的核心注解，是一个组合注解，用于启动类上
@EnableAutoConfiguration       # 启用自动配置，允许加载第三方 Jar 包的配置
@ComponentScan                 # 默认扫描 @SpringBootApplication 所在类的同级目录以及它的子目录
@PropertySource                # 加载 properties 文件
@Value                         # 将配置文件的属性注入到 Bean 中特定的成员变量
@EnableConfigurationProperties # 开启一个特性，让配置文件的属性可以注入到 Bean 中，与 @ConfigurationProperties 结合使用
@ConfigurationProperties       # 关联配置文件中的属性到 Bean 中
@Import                        # 加载指定 Class 文件，其生命周期被 Spring 管理
@ImportResource                # 加载 xml 文件

六、读取配置文件

1、属性装配

有两种方式：使用 @Value 注解和 Environment 对象。

在application-local.properties 中添加如下自定义配置

userName=root
password=root

创建配置类如下

package com.phil.springboot.config;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;

@Configuration
public class EnvironmentValueConfig {

	@Value("${userName}")
	private String userName;
	@Autowired
	private Environment environment;

	public void show() {
		System.out.println("userName:" + this.userName);
		System.out.println("password:" + this.environment.getProperty("password"));
	}
}

通过 @Value 获取 userName 配置；通过 environment 获取 password 配置。

修改SpringbootApplication启动类的main方法

ConfigurableApplicationContext context = SpringApplication.run(SpringbootApplication.class, args);
context.getBean(EnvironmentValueConfig.class).show();

2、对象装配

修改下配置

phil.userName=root
phil.password=root

创建需要装配的对象

package com.phil.springboot.config;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

@Component
@ConfigurationProperties(prefix = "phil")
public class EnvironmentValueProperties {

	private String userName;

	private String password;

	public String getUserName() {
		return userName;
	}

	public void setUserName(String userName) {
		this.userName = userName;
	}

	public String getPassword() {
		return password;
	}

	public void setPassword(String password) {
		this.password = password;
	}

	public void show() {
		System.out.println("phil.userName=" + this.userName);
		System.out.println("phil.password=" + this.password);
	}
}

如果此处出现Warnning，在pom.xml加上如下

dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-configuration-processor</artifactId>
	<optional>true</optional>
</dependency>

重新启动