AI专业者开发社区 1 号成员
  •  0 回帖  •  2 浏览  •  4 个月前
   

Spring Boot 系列（三）属性配置&自定义属性配置

在使用 spring boot 过程中，可以发现项目中只需要极少的配置就能完成相应的功能，这归功于 spring boot 中的模块化配置，在 pom.xml 中依赖的每个 Starter 都有默认配置，而这些默认配置足以满足正常的功能开发。

如果需要修改自定义修改默认配置，spring boot 提供了很简便的方法，只需要在 application.properties 中添加修改相应的配置。（spring boot 启动的时候会读取 application.properties 这份默认配置）

一、修改默认配置

例 1、spring boot 开发 web 应用的时候，默认 tomcat 的启动端口为 8080，如果需要修改默认的端口，则需要在 application.properties 添加以下记录：

server.port=8888
重启项目，启动日志可以看到：Tomcat started on port(s): 8888 (http) 启动端口为 8888，浏览器中访问 http://localhost:8888 能正常访问。

例 2、spring boot 开发中的数据库连接信息配置（这里使用 com.alibaba 的 druid）, 在 application.properties 添加以下记录：

druid.url=jdbc:mysql://192.168.0.20:3306/test
druid.driver-class=com.mysql.jdbc.Driver
druid.username=root
druid.password=123456
druid.initial-size=1
druid.min-idle=1
druid.max-active=20
druid.test-on-borrow=true

以上两个例子，说明了如需修改 starter 模块中的默认配置，只需要在在 application.properties 添加需要修改的配置即可。

附： application.properties 全部配置项，点击查看 Spring Boot 所有配置说明

二、自定义属性配置

在 application.properties 中除了可以修改默认配置，我们还可以在这配置自定义的属性，并在实体 bean 中加载出来。

1、在 application.properties 中添加自定义属性配置

com.sam.name=sam
com.sam.age=11
com.sam.desc=magical sam

2、编写 Bean 类，加载属性

Sam 类需要添加 @Component 注解，让 spring 在启动的时候扫描到该类，并添加到 spring 容器中。

第一种：使用 spring 支持的 @Value() 加载

package com.sam.demo.conf;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;


/**


    

  • 

    @author sam
    

    • 

  • 

    @since 2017/7/15
    */
    @Component
    public class Sam {
    

    // 获取 application.properties 的属性
    @Value("${com.sam.name}")
    private String name;
    

    @Value("${com.sam.age}")
    private int age;
    

    @Value("${com.sam.desc}")
    private String desc;
    

    //getter & setter
    }
    

    •

第二种：使用 @ConfigurationProperties(prefix="") 设置前缀，属性上不需要添加注解。

package com.sam.demo.conf;

import org.springframework.stereotype.Component;


/**


    

  • 

    @author sam
    

    • 

  • 

    @since 2017/7/15
    */
    @Component
    @ConfigurationProperties(prefix = "com.sam")
    public class Sam {
    

    private String name;
    

    private int age;
    

    private String desc;
    

    //getter & setter
    }
    

    •

3、在 controller 中注入并使用 Sam 这个 Bean。

package com.sam.demo.controller;

import com.sam.demo.conf.Sam;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;


/**


    

  • 

    @author sam
    

    • 

  • 

    @since 2017/7/14
    */
    @RestController
    public class IndexController {
    

    @Autowired
    private Sam sam;
    

    @RequestMapping("/index")
    public String index() {
    System.out.println(sam.getName() + " " + sam.getAge() + " " + sam.getDesc());
    return "index";
    }
    

    • 



}

浏览器访问：http://localhost:8080/index ，控制台正常打印出 sam 的内容。

三、application.properties 属性配置详解

1、参数引用与 random 随机数方法的使用

在 application.properties 内可以直接通过 ${} 引用其他属性的值，如下：
com.sam.name=sam
com.sam.age=11
com.sam.desc=${name} is ${age} years old.

在 application.properties 中如果需要获取随机数，可以通过 ${random}，如下：
#获取随机字符串
com.sam.randomValue=${random.value}

#获取随机字符串：${random.value}
#获取随机 int：${random.int}
#获取 10 以内的随机数：${random.int(10)}
#获取 10-20 的随机数：${random.int[10,20]}
#获取随机 long：${random.long}
#获取随机 uuid：${random.uuid}

2、多环境配置

实际开发中可能会有不同的环境，有开发环境、测试环境、生成环境。对于每个环境相关配置都可能有所不同，如：数据库信息、端口配置、本地路径配置等。

如果每次切换不同环境都需要修改 application.properties，那么操作是十分繁琐的。在 spring boot 中提供了多环境配置，使得我们切换环境变得简便。

在 application.properties 同目录下新建一下三个文件：

application-dev.properties      // 开发环境的配置文件
application-test.properties     // 测试环境的配置文件
application-prod.properties     // 生产环境的配置文件
上面三个文件分别对应了 开发、测试、生产 的配置内容，接下来就是应该怎么选择性引用这些配置了。

在 application.properties 添加：

spring.profiles.active=dev
#引用测试的配置文件
#spring.profiles.active=test
#引用生产的配置文件
#spring.profiles.active=prod
添加 spring.profiles.active=dev 后启动应用，会发现引用了 dev 的这份配置信息。
可以看出上面三个配置文件符合 application-{profile}.properties 格式，而在 application.properties 添加的 spring.profiles.active=dev 中的 dev 正是上面配置文件中的 profile。根据具体环境进行切换即刻。

用命令运行 jar 包启动应用的时候，可以指定相应的配置.

java -jar demo-0.0.1-SNAPSHOT.jar --spring.profiles.active=dev

附：配置方式和优先级

这些方式优先级如下：
a. 命令行参数
b. 来自java:comp/env 的 JNDI 属性
c. Java 系统属性（System.getProperties()）
d. 操作系统环境变量
e. RandomValuePropertySource配置的random.*属性值
f. jar 外部的 application-{profile}.properties 或 application.yml(带 spring.profile) 配置文件
g. jar 内部的 application-{profile}.properties 或 application.yml(带 spring.profile) 配置文件
h. jar 外部的 application.properties 或 application.yml(不带 spring.profile) 配置文件
i. jar 内部的 application.properties 或 application.yml(不带 spring.profile) 配置文件
j. @Configuration注解类上的@PropertySource
k. 通过SpringApplication.setDefaultProperties指定的默认属性

注：命令行参数这种 jar 包指定参数启动应用的方式，可能是不安全的，我们可以设置禁止这种方式启动应用，如下：

springApplication.setAddCommandLineProperties(false);

package com.sam.demo;

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


@SpringBootApplication
public class DemoApplication {


<span class="hljs-keyword">public</span> <span class="hljs-keyword">static</span> <span class="hljs-keyword">void</span> <span class="hljs-title function_">main</span><span class="hljs-params">(String[] args)</span> {



//        SpringApplication.run(DemoApplication.class, args);
SpringApplication springApplication = new SpringApplication(DemoApplication.class);
// 禁止命令行设置参数
springApplication.setAddCommandLineProperties(false);
springApplication.run(args);
}
}

补充：

在 spring boot 中配置除了支持 application.properties，还支持 application.yml 的配置方式，如下：
新建 application.yml 代替 application.properties
server:
  port: 9999

com:
sam:
name: sam
age: 11
desc: magical sam

注意：port: 9999 中间是有空格的，yml 语法请参考：yml 配置文件用法

版权声明：本文为博主原创文章，转载请注明出处。