SpringBoot从小白到精通（三）系统配置及自定义配置

2021-11-03 04:11:49

前面介绍了Spring的@Controller和@RestController控制器，他们是如何响应客户端请求，如何返回json数据。

今天来说一说SpringBoot的application.properities的相关配置属性和如何自定义配置文件。

这个系列课程的完整源码，也会提供给大家。大家关注我的微信公众号（架构师精进），回复：springboot源码获取这个系列课程的完整源码。或者点此链接直接下载完整源码

一、系统配置application.properities

创建spring-boot项目后，会在resources目录下生成一个空的application.properties配置文件，springboot启动时加载该配置文件。

application.properties(或者application.yml)中包含系统属性、环境变量、命令参数这类信息。

下面简要说一部分spring-boot项目中application.properties内的一些常用配置，更多参照官方文档。

############################################################
#
# Server 服务器相关配置
#
############################################################
# 配置端口号
server.port=8080
# 配置context-path,一般这个配置在正式发布的时候不需要配置。 
#server.context-path=
# 错误页，指定发生错误时，跳转的URL --> BasicErrorController
#server.error.path=/error
# session最大超市时间（分钟），默认30分钟
server.session-timeout=60
# 服务绑定的IP地址，启动服务器时，如本机不是该IP地址则抛出异常启动失败，
# 所以此配置只有在特殊情况下才配置，具体更具各自的业务来设置。
#server.address=192.168.1.9
############################################################
# Server - tomcat 相关配置
############################################################
# tomcat最大线程数，默认200
#server.tomcat.max-threads=250
# tomcat的URI编码格式
server.tomcat.uri-encoding=UTF-8
# 存放Tomcat的日志，Dump等文件的零食文件夹，默认为系统但是tmp文件夹
# （如：C:\\Users\Zhang\AppData\Local\Temp）
#server.tomcat.basedir=D:/springboot-tomcat-tmp
# 打开Tomcat的Access日志，并可以设置日志格式的方法，
#server.tomcat.access-log-enabled=true
#server.tomcat.access-log-pattern=
# accesslog目录，默认在basedir/logs
#server.tomcat.accesslog.directory=
# 日志文件目录
#logging.path=H:/springboot-tomcat-tmp
# 日志文件名称，默认为spring.log
#logging.file=myapp.log

这些参数配置不一定要写在application.properties里面，可以在application.properties里面配置指定自定义配置文件名称和位置：（但是无论怎么配置，spring-boot都会读取加载application.properties文件）

二、@Value

在实际项目中，经常需要在配置文件中定义一些简单的配置项，Spring Boot提供@Value注解来设置简单的配置项，系统默认读取的是application.properties配置文件。下面通过示例来演示使用@Value注解添加自定义配置项。

首先，在application.properties配置文件中添加自定义配置项：

com.weiz.costum.firstname=Zhang 
com.weiz.costum.secondname=Weiz

在上面的示例中，我们添加了firstname和secondname两个自定义配置项。

然后，在使用的位置调用@Value注解来获取配置项的值：

@Value("${com.weiz.costum.firstname}")
private String firstName;
 
@Value("${com.weiz.costum.secondname}")
private String secondName;

在上面的示例中，通过@Value注解获取了配置文件中对应的配置项的值。

需要注意的是：

（1）使用@Value注解时，所在类必须被Spring容器管理，也就是使用@Component、@Controller、@Service等注解定义的类。

（2）@Value需要配置完整的key路径。

（3）@Value注解默认读取application.properties配置文件，如果需要自定义的配置文件，则需要通过@PropertySource注解指定对应的自定义配置文件。

三、@ConfigurationProperties

系统相关的配置，我们一般放在application.properties中，但是其他的和业务相关的配置怎么定义呢，下面就来介绍下如何自定义配置：

1、增加自定义的resource.properties 文件

com.weiz.resource.name=weiz
com.weiz.resource.website=www.weiz.com
com.weiz.resource.language=java

2、增加Resource.java 类

package com.weiz.pojo;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;
@Configuration
@ConfigurationProperties(prefix = "com.weiz.resource")
@PropertySource(value = "classpath:resource.properties")
public class Resource {
    private String name;
    private String website;
    private String language;
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public String getWebsite() {
        return website;
    }
    public void setWebsite(String website) {
        this.website = website;
    }
    public String getLanguage() {
        return language;
    }
    public void setLanguage(String language) {
        this.language = language;
    }
}

代码说明：

（1）@ConfigurationProperties 配置的属性，prefix定义这些属性的前缀。

（2）@PropertySource 资源配置文件的地址。

3、使用自定义配置

@Autowired
    private Resource resource;
    
    @RequestMapping("/index")
    public String index(ModelMap map) {
        map.addAttribute("name", resource.getName());
        return "freemarker/index";
    }

四、Environment

Environment是Spring为运行环境提供的高度抽象接口，项目运行中的所有相关配置都基于此接口。Environment类会自动获取系统加载的全部配置文件中的配置项，使用时无须其他的额外配置，只要在使用的类中注入Environment即可。下面通过示例演示Environment读取系统自定义的配置项。

首先，在application.properties配置文件中增加如下的配置项：

com.weiz.costum.firstname=Zhang 
com.weiz.costum.secondname=Weiz

在上面的示例中，我们在application.properties中配置了firstname和secondname两个自定义配置项。Environment读取的是系统中所有的配置。我们既可以在application.properties中设置自定义的配置项，又可以在自定义配置文件中添加配置项。

然后，创建单元测试方法，并注入Environment读取系统配置。示例代码如下：

@Autowired
private Environment env;
 
@Test
void getEnv() {
   System.out.println(env.getProperty("com.weiz.costum.firstname"));
   System.out.println(env.getProperty("com.weiz.costum.secondname"));
}

上面就是Environment使用的示例代码，非常简单。不过，使用Environment时还需要注意以下两点：

（1）使用Environment无须指定配置文件，其获取的是系统加载的全部配置文件中的配置项。

（2）需要注意配置文件的编码格式，默认为ISO8859-1。

最后

以上，就把Spring Boot如何资源文件属性配置介绍完了。

推荐阅读：

SpringBoot从小白到精通（二）如何返回统一的数据格式

SpringBoot从小白到精通（一）如何快速创建SpringBoot项目

码农公寓

一、系统配置application.properities

二、@Value

三、@ConfigurationProperties

四、Environment

最后

相关文章