我们介绍新建Spring Boot项目的流程, 主要内容包含
- 创建项目
- 配置日志环境
- 使用配置文件
- 多环境下的配置文件
- 写一个demo服务
- 打包和部署
1. 创建项目
-
打开IntelliJ IDEA, 选择菜单File->New->Project.
-
输入组织名称(Group)和项目名称(Artifact).
-
添加依赖包. 添加Web: Web即可. 我们建议添加一个插件Core: Lombok. 它可以在编译的时候自动生成模版代码(例如Getter和Setter).
-
按照提示一路Next就能完成项目的创建. 项目文件夹的结构如下图所示.
-
打开
DemoSpringBootApplication.java, 然后点击编辑器中的三角形图标即可启动服务. 至此项目创建完毕.
2. 配日志环境
我们使用SLF4j + Log4j2, 其中SLF4j是一个日志框架, 而Log4j2是日志框架的一种实现. 更多信息读者可以自行参考其他教程.
- 在pom.xml文件中添加如下依赖.
<!-- 日志依赖: SLF4j + Log4j2 --> <!-- SLF4j核心包 --> <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-api</artifactId> </dependency> <!-- SLF4j桥接Log4j2 --> <dependency> <groupId>org.apache.logging.log4j</groupId> <artifactId>log4j-slf4j-impl</artifactId> <version>2.11.2</version> </dependency> <!-- Log4j2核心包 --> <dependency> <groupId>org.apache.logging.log4j</groupId> <artifactId>log4j-api</artifactId> <version>2.11.2</version> </dependency> <dependency> <groupId>org.apache.logging.log4j</groupId> <artifactId>log4j-core</artifactId> <version>2.11.2</version> </dependency> - 在指定的位置添加
execlusion, 目的是过滤Springboot自带的日志依赖.<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> <!-- 去掉springboot自带的日志依赖 --> <exclusions> <exclusion> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-logging</artifactId> </exclusion> </exclusions> </dependency> - 添加Log4j2的配置文件
log4j2.xml到resources文件夹下. 关于Log4j2如何配置, 可以自行参考网上教程.
下面的配置文件设置了3个日志输出:- 控制台 日志等级:INFO
- 文件(logs/info.log) 日志等级: INFO
- 文件(logs/error.log) 日志等级: ERROR
<?xml version="1.0" encoding="UTF-8"?> <!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL --> <Configuration> <Appenders> <!-- 控制台的配置 --> <Console name="Console" target="SYSTEM_OUT"> <!--输出日志的格式--> <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%5p] - %l - %m%n"/> </Console> <!-- 输出文件的配置 - INFO --> <RollingFile name="RollingFileInfo" fileName="./logs/info.log" filePattern="./logs/info-%d{yyyyMMdd}.log"> <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%5p] - %l - %m%n" charset="UTF-8"/> <!--输出level及以上级别的信息 --> <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/> <Policies> <!-- 日志文件的滚动时间间隔: 1天(单位取决于filePattern定义的粒度) --> <TimeBasedTriggeringPolicy interval="1" modulate="false"/> <!-- 单个日志文件最大size --> <SizeBasedTriggeringPolicy size="50 MB"/> </Policies> </RollingFile> <!-- 输出文件的配置 - ERROR --> <RollingFile name="RollingFileError" fileName="./logs/error.log" filePattern="./logs/error-%d{yyyyMMdd}.log"> <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%5p] - %l - %m%n" charset="UTF-8"/> <!--输出level及以上级别的信息 --> <ThresholdFilter level="ERROR" onMatch="ACCEPT" onMismatch="DENY"/> <Policies> <!-- 日志文件的滚动时间间隔: 1天(单位取决于filePattern定义的粒度) --> <TimeBasedTriggeringPolicy interval="1" modulate="true"/> <!-- 单个日志文件最大size --> <SizeBasedTriggeringPolicy size="50 MB"/> </Policies> </RollingFile> </Appenders> <Loggers> <!--过滤掉框架的日志信息 --> <Logger name="org.springframework" level="WARN" /> <Logger name="org.hibernate" level="WARN" /> <Root level="INFO"> <AppenderRef ref="Console"/> <AppenderRef ref="RollingFileInfo"/> <AppenderRef ref="RollingFileError"/> </Root> </Loggers> </Configuration> - 测试日志环境: 添加注解
@Slf4j可直接使用log变量.
DemoSpringBootApplicationTests.java
我们能看到如下的日志信息:@Slf4j @RunWith(SpringRunner.class) @SpringBootTest public class DemoSpringBootApplicationTests { @Test public void testLogger() { log.info("Logger is OK"); log.error("Logger is OK"); } }2019-05-10 10:54:18.096 [ INFO] - com.example.demospringboot.DemoSpringBootApplicationTests.testLogger(DemoSpringBootApplicationTests.java:20) - Logger is OK 2019-05-10 10:54:18.097 [ERROR] - com.example.demospringboot.DemoSpringBootApplicationTests.testLogger(DemoSpringBootApplicationTests.java:21) - Logger is OK
3. 使用配置文件
我们可以在application.properties文件中添加自定义配置, 例如
myConfig.foo=foo-foo
myConfig.bar=bar-bar
在代码中读取配置的方法如下. 新建一个配置类(名字任意):
MyConfig.java
@Data
@Component
public class MyConfig {
@Value("${myConfig.foo}")
private String foo;
@Value("${myConfig.bar}")
private String bar;
}
注解说明
- @Data 为类提供读写方法, 此外还提供了 equals(), hashCode(), toString() 方法.
- @Component Spring Boot为类提供管理功能, 可以自动生成对象.
- @Value (lombok) 读取配置文件中定义的字段.
注意 由于我们使用Spring Boot框架来加载配置文件, 因此不能直接通过
new MyConfig()这样的操作来初始化对象, 否则无法读取配置. 正确的使用方式应该是使用注解@Autowired, 由框架来帮助我们初始化对象.
MyConfigTest.java
@RunWith(SpringRunner.class)
@SpringBootTest
public class MyConfigTest {
@Autowired
private MyConfig myConfig;
@Test
public void test() {
System.out.println("myConfig.foo = " + myConfig.getFoo());
System.out.println("myConfig.bar = " + myConfig.getBar());
}
}
运行上面的测试代码, 结果如下.
myConfig.foo = foo-foo
myConfig.bar = bar-bar
4. 多环境下的配置文件
实际的项目开发可能会有多套环境, 分别采用不同的配置. 为了方便打包和部署, 我们可以按照application-[xxx].properties的格式命名, 其中[xxx]代表环境名称. 示例如下:
- 开发环境:
application-dev.properties - 测试环境:
application-test.properties - 线上环境:
application-online.properties
然后在application.properties中设置当前环境的名称.
# 设置当前环境为开发环境
spring.profiles.active=dev
Spring Boot的默认配置可以参考 Common application properties.
5. 写一个demo服务
我们实现如下功能: 当用户访问 http://localhost:8080/config时返回配置文件的内容. 实现代码如下.
Controller.java
@RestController
public class Controller {
// 配置类
private MyConfig myConfig;
@Autowired
public Controller(MyConfig myConfig) {
this.myConfig = myConfig;
}
// 以把配置文件的内容以JSON格式返回
@RequestMapping(value = "/config", method = RequestMethod.GET)
public String getConfig() {
return new Gson().toJson(myConfig);
}
}
说明: Gson类把对象转换成JSON字符串, 可以在pom.xml中添加如下依赖.
<!-- 处理JSON -->
<dependency>
<groupId>com.google.code.gson</groupId>
<artifactId>gson</artifactId>
<version>2.8.5</version>
</dependency>
6. 打包和部署
- 点击工具栏Edit Configurations菜单
- 点"+"(加号)新建Maven配置
- 命令行输入:
clean package, 然后确定
- 运行上一步建立的maven配置, IDE会在
target文件夹下生成demo-spring-boot-0.0.1-SNAPSHOT.jar.
注意 如果想跳过单元测试, 可以在pom.xml的plugins节点中添加如下依赖:<plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-surefire-plugin</artifactId> <configuration> <skip>true</skip> </configuration> </plugin> - 进入target文件夹, 然后运行
java -jar demo-spring-boot-0.0.1-SNAPSHOT.jar即可启动服务. 在浏览器访问http://localhost:8080/config可以测试结果.
7. 完整的示例代码
https://github.com/xianqiu/demo-spring-boot
