spring boot 学习--07---配置文件处理

springboot减少了项目的配置文件，但是在项目中我们依然会使用自定配置文件，这里介绍几种springboot读取配置方式

下面我们开始来开始我们处理配置的旅程
（1）新建一个maven项目，这里我使用的是eclipse
1. 创建项目 maven project

2. 选择NEXT
3. new maven project

- 这里建议选择我用红框标注的选择（create a simple project）,因为这样就可以创建一个模板项目，意思就是maven标准工程
4. NEXT
5. 配置项目基本信息

6. finish，到此一个maven项目就创建完成。

（2）配置项目
1. 检查jdk配置，一般来说创建好的项目JDK都是默认配置，有时候需要改下

（3）增加依赖，修改pom.xml
- pom.xml

<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>
    <groupId>com.study</groupId>
    <artifactId>boot-study-properties</artifactId>
    <version>1.0.0</version>

    <!-- springboot 父类，版本控制 -->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.4.0.RELEASE</version>
    </parent>
    <!-- 自定义配置 -->
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    </properties>

    <dependencies>
        <!--web应用配置 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>


        <!--spring-boot-configuration:spring boot 配置处理器; -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>



    </dependencies>
    <build>
        <plugins>
            <!-- 可执行jar配置 -->
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>

        </plugins>

    </build>
</project>

（4）新增application.properties配置文件
1. 在src/main/resources/目录下添加application.properties
2. 在application.properties中添加我们需要的配置
- 自定义配置
xml
test.name=test
test.gender=male

（5）增加主类

package com.springboot.study;

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

/**
 * 启动主类
 * @author like
 *
 */
@SpringBootApplication
public class ConfigApp {
    public static void main(String[] args) {
        SpringApplication.run(ConfigApp.class, args);
    }
}

（6）写一个restful 方式的controller 来展示我们读取的配置文件

package com.springboot.study.controller;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * 自定义配置文件读取控制类
 * @author like
 *
 */
@RestController
public class ConfigController {
    @Value(value="${test.name}")
    private String test_Name;
    @Value(value="${test.gender}")
    private String test_gender;

    @RequestMapping(value="/readApplicationConfigByValue")
    public String readApplicationConfigByValue(){

        return test_Name + " : " + test_gender; 
    }

}

这里涉及到第一种处理自定义配置的方式，利用spring注解@Value 来注入application中自定义属性

（7）启动项目

（8）访问项目，spingboot项目默认端口是8080,所以我们访问：http://localhost:8080/readApplicationConfigByValue
（9）结果

（10） @Value使用补充
一般我们@value的时候，如果配置文件中没有值，我们可以给一个默认，如下面：

    package com.springboot.study.controller;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * 自定义配置文件读取控制类
 * @author like
 *
 */
@RestController
public class ConfigController {
    @Value(value="${test.name}")
    private String test_Name;
    @Value(value="${test.gender}")
    private String test_gender;
    @Value(value="${test.default:defaultValue}")
    private String test_dafault;

    @RequestMapping(value="/readApplicationConfigByValue")
    public String readApplicationConfigByValue(){

        return test_Name + " : " + test_gender; 
    }
    @RequestMapping(value= "readDefaultValue")
    public String readDefaultValue(){
        return test_dafault;
    }

}

结果：

下面我们来说第二种读取配置文件的方式，利用java 配置类的方式来读取配置文件
（1）新建一个配置类，这个类需要根据我们定义的配置文件来定义，如下：

package com.springboot.study.config;

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

/**
 * 自定义配置
 * @author like
 *
 */
@Component
@ConfigurationProperties(prefix="test")
public class Config {
    private String name;
    private String gender;
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public String getGender() {
        return gender;
    }
    public void setGender(String gender) {
        this.gender = gender;
    }
    @Override
    public String toString() {
        return "Config [name=" + name + ", gender=" + gender + "]";
    }


}

注:
@Component 声明这个类需要spring管理
@ConfigurationProperties 配置文件注解，prefix 这个属性是前缀的意思

（2）在controller中新增方法来测试我们是否能读取这个配置文件

package com.springboot.study.controller;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import com.springboot.study.config.Config;

/**
 * 自定义配置文件读取控制类
 * @author like
 *
 */
@RestController
public class ConfigController {
    @Value(value="${test.name}")
    private String test_Name;
    @Value(value="${test.gender}")
    private String test_gender;
    @Value(value="${test.default:defaultValue}")
    private String test_dafault;
    @Autowired
    private Config config;

    @RequestMapping(value="/readApplicationConfigByValue")
    public String readApplicationConfigByValue(){

        return test_Name + " : " + test_gender; 
    }
    @RequestMapping(value= "readDefaultValue")
    public String readDefaultValue(){
        return test_dafault;
    }
    @RequestMapping("/readConfigByBean")
    public String readConfigByBean(){
        return config.toString();
    }

}

（3）访问：http://localhost:8080/readConfigByBean
（4）结果