SpringBoot基础教程1-1-2 配置文件介绍

1. 概述

SpringBoot极大的简化了配置，常用配置都可以application.yml或者application.properties文件中设置。

1.1. 特色

介绍项目的同时，推荐相关IntelliJ IDEA快捷键，熟能生巧，无需死记硬背。

2. 本节重点

• SpringBoot常用配置介绍
• 多环境如何配置
• 自定义配置文件

2. 工具

• IntelliJ IDEA，直接官网下载，Ultimate版本，傻瓜式安装
• Maven，IntelliJ IDEA自带无需安装
• Springboot ，版本2.0.3.RELEASE
• Postman，测试工具，下载地址（密码：sc1e），解压无需安装

3. SpringBoot常用配置介绍

点击resources -> New -> File，或者快捷键ALT+Insert，命名application.yml或者application.properties，推荐使用application.yml更加简洁

server:port:设置服务端口，server:servlet:context-path:设置服务根路径

# 服务相关配置
server:
  # 服务端口配置
  port: 8080
  # 服务根路径配置
  servlet:
    context-path: /dev

启动服务，快捷键Shift+F10

debug:开启debug模式，开启后可以看到服务启动详细过程，SpringBoot加载了哪些配置和class，适合新手了解SpringBoot内部机制

# 开启debug模式
debug: true

4. 多环境如何配置

一般开发过程会分多套环境，简单来说，开发环境一套配置，生产环境一套配置，不同环境配置不同，如何处理？

点击resources -> New -> File，新建配置文件application-dev.yml

# 服务相关配置
server:
  # 服务端口配置
  port: 8888
  # 服务根路径配置
  servlet:
    context-path: /dev

# 开启debug模式
debug: true

点击resources -> New -> File，新建配置文件application-pro.yml

# 服务相关配置
server:
  # 服务端口配置
  port: 8080
  # 服务根路径配置
  servlet:
    context-path: /

# 开启debug模式
debug: false

修改application.yml，配置激活配置

## 多环境配置，激活哪套配置
spring:
  profiles:
    active: dev

启动服务，快捷键Shift+F10

测试

spring:profiles:active: pro 生产环境配置，请自己动手体验，看看是否生效，切记：无它，熟能生巧

5. 如何解析自定义配置文件（properties文件）

SpringBoot解析配置生成元数据，建议添加依赖

<!--该依赖只会在编译时调用-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <optional>true</optional>
</dependency>

点击resources -> New -> File，新建配置文件user.properties，写下如下内容

company.user.name=Mkeeper
company.user.age=28

新建UserProperties.java用来保存user.properties中的内容，方便通过对象访问

@Configuration
//指定配置文件，如果不指定，默认解析“application.yml”
@PropertySource("classpath:user.properties")
//前缀
@ConfigurationProperties(prefix = "company.user")
public class UserProperties {
    private String name;
    private Integer age;

    // 省略 get set

    @Override
    public String toString() {
        return "UserProperties {" +
                "name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
}

如果删除@PropertySource("classpath:user.properties")，SpringBoot将默认解析application.yml中的配置

新建UserController.java，注入UserProperties

@RestController
public class UserController {

    private static final Logger log = LoggerFactory.getLogger(UserController.class);
    @Autowired
    private UserProperties userProperties;
    @GetMapping("/user")
    public String user() {
        log.info("info:");
        return userProperties.toString();
    }
}

快捷键Ctrl+E可以快速查看最近阅读过的文件

测试

6. 工程目录

7. 结束语

无他，熟能生巧，与大家共勉，有任何建议，欢迎留言探讨，本文源码。

---

欢迎关注博主公众号：Java十分钟