本文章基于最新稳定版本2.1.1RELEASE。
官方文档
1.Spring Boot是什么
Spring Boot 是由 Pivotal 团队提供的全新框架,其设计目的是用来简化新 Spring 应用的初始搭建以及开发过程。该框架采用“习惯优于配置”的方式开发,可以快速构建Spring应用。
特性
- 能够创建独立的Spring应用
- 本身嵌入了Tomcat、Jetty容器
- 提供可选的
starter
依赖库简化应用构建配置 - 自动配置Spring以及第三方依赖
- 提供生产级的特性,如度量、检查和外部化配置
- 无代码生成并且不需要XML配置
2.准备工作
Build Tool
Version
Maven
3.3+
JDK
1.8+
3.创建应用
应用有两种常用创建方式
第一种: 使用spring官网提供的初始化入口
红色箭头处选择需要的依赖包,这里选择了Web,包含了内嵌Tomcat容器以及Spring MVC相关依赖,如果需要其他可以继续选择。
第二种: 使用可视化开发工具,建议Intellij旗舰版、Eclipse4.6+,这里使用Intellij作为演示工具。
1.New Project
2.根据项目情况修改
3.选择需要依赖的Starter
,这里勾选了Web和Thymeleaf
4.填入工程名称
生成的工程结构如下:
注意: * 过程中一定要联网,否则框架初始化会失败*
3.1Spring Boot目录结构
src/main
目录含义
java
Java源代码目录
resources
资源目录
resources/static
静态资源目录
resources/templates
展现层页面目录
resources/application.properties
Spring Boot配置文件
test
单元测试目录
3.2 pom文件解析
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<!-- spingboot父依赖,里面包含springboot的默认依赖配置和插件配置-->
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.1.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.microservice</groupId>
<artifactId>hello</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>hello</name>
<description>Demo project for Spring Boot</description>
<properties>
<java.version>1.8</java.version>
</properties>
<dependencies>
<!-- 这里使用到Web 所以引入了web starter,版本号由于在上面的parent中已包含 dependency-management,所以不需要指定 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- 测试相关依赖 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<!-- 创建可执行jar -->
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
3.3 Spring Boot启动类
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class HelloApplication {
public static void main(String[] args) {
SpringApplication.run(HelloApplication.class, args);
}
}
@SpringBootApplication
包含了@Configuration
、@EnableAutoConfiguration
、@ComponentScan
以及他们的默认属性。如果你熟悉JavaConfig配置方式,就明白这个启动类其实就是一个AppConfig。
下面我们编写一个Controller类测试下:
@RestController
public class HelloController {
@RequestMapping("/home")
public String home() {
return "Hello Spring Boot!";
}
}
启动SpringBoot项目,并在浏览器中访问路径:
注意@SpringBootApplication
默认扫描启动类所在包及其子包,如果需要扫描其他路径,需要增加@ComponentScan
或者@Import
注解
4.Starters
Starters是一系列可以方便引用到项目中的依赖描述。你可以一站式获取所有Spring相关的技术,而不需要遍历示例代码和复制黏贴依赖描描述。比方说,你想使用JPA作为数据库访问,只需要引入spring-boot-starter-data-jpa
依赖即可。表格中是我们上面示例代码中用到相关依赖:
Name
Description
spring-boot-starter
核心starter,包含自动配置、日志、YAML等
spring-boot-starter-web
提供web支持,包含RESTful,Spring MVC ,Tomcat内嵌容器等
spring-boot-starter-thymeleaf
提供thymeleaf模板引擎的支持
其他请参考官网 Starter
5.常用配置
Spring Boot的配置文件是appication.properties,表格中列出了web相关的常用配置项。
web常用配置项
默认值
说明
debug
false
开启/关闭调试模式
server.port
8080
服务器访问端口号
server.servlet.content-path
/
应用上下文
spring.http.encoding.charset
utf-8
默认字符集编码
spring.thymeleaf.cache
开启关闭页面缓存
spring.mvc.date-format
日期输入格式
spring.jackson.date-format
json输出的日期格式
spring.jackson.time-zone
设置GMT时区
application.properties示例
# 端口号
server.port=8080
# true开启调试模式,日志模式降为debug级别 默认false不开启
debug=true
# 应用上下文
server.servlet.context-path=/SpringBootDemo
# 默认字符集编码
spring.http.encoding.charset=UTF-8
6.日志配置
Spring引导对所有内部日志使用公共日志记录,但是底层日志实现是开放的。为Java Util Logging,Log4j2,and LogBack提供了默认配置。在每种情况下,日志记录器都预先配置为使用控制台输出和可选的文件输出。如果项目中引用了spring-boot-starter
,默认使用Logback作为日志记录器。
日志常用配置项:
日志常用配置项
默认值
备注
logging.file
日志输出文件地址
logging.level.root
info
设置根目录的日志输出级别
loggin.level.*
info
定义指定包的输出级别
loggin.config
logback-spring.xml
指定日志的配置文件
生产环境项目中一般都有自己的日志组件以及对应的配置文件,如何与这些配置组件配合使用呢?
根据依赖的日志系统,将会自动加载根目录下的日志配置文件,比如:
Loggin System
Customization
Logback
logback-spring.xml or logbabck.xml
Log4j2
log4j2-spring.xml or log4j2.xml
JDK(Java Util Logging)
logging.properties
为了springboot能够控制日志的初始化过程,官方建议使用包含-spring
的配置文件名称。
6.1 配置Logback作为日志记录器
因为spring-boot-starter-web
中包含了spring-boot-starter-logging
,而spring-boot-starter-logging
的默认实现是Logback,所以直接将logback.xml或者logback-spring.xml放到根目录下即可。
6.2 配置Log4j作为日志记录器
将log4j2.xml或者log4j2-spring.xml放到项目根目录下,pom文件修改如下:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</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>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>
备注: 如果日志文件放在别的地方,需要在配置文件中使用logging.config
指定。
7.YML配置
Spring Boot支持两种格式的配置文件:
- 属性文件:application.properties
- YAML:application.yml
YAML是json的超集,提供了方便的格式用于层次化配置数据。YAML由spring-boot-starter
自动提供。
YAML语法格式:
标准格式:key:(空格)value,使用空格代表层级关系,以“:”结束
将上面的properties文件转换为yml:
server:
port: 8080
servlet:
context-path: /SpringBootDemo
debug: false
spring:
http:
encoding:
charset: UTF-8
备注: yml和properties同时存在时,以properties为主。YAML一定要按格式来存放,否则会出现难以发现的问题,这点比较坑,使用时要注意。
------------本文结束感谢您的阅读------------