spring boot 教程（三）配置详解

痛定思痛。 2022-06-11 09:47 235阅读 0赞

在大部分情况下，我们不需要做太多的配置就能够让spring boot正常运行。在一些特殊的情况下，我们需要做修改一些配置，或者需要有自己的配置属性。

Spring Boot 支持多种外部配置方式

这些方式优先级如下：

1.  命令行参数
2.  来自`java:comp/env`的JNDI属性
3.  Java系统属性（`System.getProperties()`）
4.  操作系统环境变量
5.  `RandomValuePropertySource`配置的`random.*`属性值
6.  `jar`包外部的`application-{profile}.properties`或`application.yml`(带`spring.profile`)配置文件
7.  `jar`包内部的`application-{profile}.properties`或`application.yml`(带`spring.profile`)配置文件
8.  `jar`包外部的`application.properties`或`application.yml`(不带`spring.profile`)配置文件
9.  `jar`包内部的`application.properties`或`application.yml`(不带`spring.profile`)配置文件
10. `@Configuration`注解类上的`@PropertySource`
11. 通过`SpringApplication.setDefaultProperties`指定的默认属性

# 命令行参数 #

与类C语言一样，main函数都可以传入参数，这被称为命令行参数。

比如配置文件配置服务端口好是：  
server.port=8081  
那么对应的命令行就是：  
mvn spring-boot:run -Drun.arguments="--server.port=8081"

# 系统参数 #

系统参数也分为很多种的，首先如果是使用main方法的话。点击run as选择run config然后配置系统参数

![Center][]

可以使用的参数可以是我们自己定义的，也可以是Spring Boot中默认的参数。

很多人可能会关心如web端口如何配置这样的问题，这些都是Spring Boot中提供的参数，部分可用参数如下：

# LOGGING
    logging.path=/var/logs
    logging.file=myapp.log
    logging.config= # location of config file (default classpath:logback.xml for logback)
    logging.level.*= # levels for loggers, e.g. "logging.level.org.springframework=DEBUG" (TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF)
    
    # EMBEDDED SERVER CONFIGURATION (ServerProperties)
    server.port=8080
    server.address= # bind to a specific NIC
    server.session-timeout= # session timeout in seconds
    server.context-parameters.*= # Servlet context init parameters, e.g. server.context-parameters.a=alpha
    server.context-path= # the context path, defaults to '/'
    server.servlet-path= # the servlet path, defaults to '/'

如果我们是用mvn打包的话， 系统参数就配置在我们的mvaen里面。如果是用tomcat打包的话， 系统参数就配置在我们

的tomcat里面。

# 操作系统环境变量 #

配置过JAVA\_HOME的应该都了解这一个。

这里需要注意的地方，有些OS可以不支持使用`.`这种名字，如`server.port`，这种情况可以使用`SERVER_PORT`来配置。

具体名字如何匹配，看本文后面。

### RandomValuePropertySource ###

系统中用到随机数的地方，例如：

操作系统环境变量
    
    配置过JAVA_HOME的应该都了解这一个。
    
    这里需要注意的地方，有些OS可以不支持使用.这种名字，如server.port，这种情况可以使用SERVER_PORT来配置。
    
    具体名字如何匹配，看本文后面。
    
    RandomValuePropertySource
    
    系统中用到随机数的地方，例如：
    
    my.secret=${random.value}
    my.number=${random.int}
    my.bignumber=${random.long}
    my.number.less.than.ten=${random.int(10)}
    my.number.in.range=${random.int[1024,65536]}
    random.int*支持value参数和,max参数，当提供max参数的时候，value就是最小值。

`random.int*`支持`value`参数和`,max`参数，当提供`max`参数的时候，`value`就是最小值。

# 应用配置文件（.properties或.yml） #

当我们创建一个springboot项目的时候，系统默认会为我们在src/main/ [Java][] /resources目录下创建一个application.properties。

或者application.yml。yml的语法比properties简单，而且优先级要比proper高。建议使用yml；

先创建一个配置文件。

name: java core
    price: 35.4

如果你需要读取配置文件的值只需要加@Value(“$\{属性名\}”)

@RestController
    public class BookController {
    
        @Value("${name}")
        private String name;
        @Value("${price}")
        private Double price;
    
        @RequestMapping(value = "/book")
        public String bookToString(){
            return "图书名称："+name+",图书价格:"+":"+price;
        }
    
    }

这里直接访问会出现

![Center 1][]

# 将配置文件的属性赋给实体类 #

当我们有很多配置属性的时候，这时我们会把这些属性作为字段来创建一个javabean，并将属性值赋予给他们。

book.name: javacore
    book.price: '35.4'

@ConfigurationProperties(prefix = "book")
    @Component
    public class Book {
       
        private String name;
      
        private Double price;
    	public String getName() {
    		return name;
    	}
    	public void setName(String name) {
    		this.name = name;
    	}
    	public Double getPrice() {
    		return price;
    	}
    	public void setPrice(Double price) {
    		this.price = price;
    	}
    	@Override
    	public String toString() {
    		return "Book [name=" + name + ", price=" + price + "]";
    	}
        
        
    }

@Controller
    @EnableConfigurationProperties({Book.class})
    public class BookController {
    	@Autowired
    	private Book book;
        @RequestMapping("book")
        public String framework(ModelMap map) {
        	map.addAttribute("book",book);
            return "freeMarker/book";  
        }
     
        
    }

<!DOCTYPE html>
    <html>
    <head lang="en">
        <meta charset="UTF-8" />
        <title></title>
    </head>
    <body>
    <h1>图书名称：${book.name}</h1>
    <h1>图书价格：${book.price}</h1>
    </body>
    </html>

最终结果图：

![Center 2][]  
  
这个只是最简单的注入 Spring Boot 会自动转换类型，当使用`List`的时候需要注意在配置中对`List`进行初始化！

Spring Boot 还支持嵌套属性注入

book.name: javacore
    book.price: '35.4'
    book.address: 
    - '上海图书馆'
    - '上海张江高科图书馆'
    book.manage.name: '张三'
    book.manage.age: 23

这里我们添加了一个地址集合，和一个嵌套类，管理员对象。

@ConfigurationProperties(prefix = "book")
    public class Book {
       
        private String name;
      
        private Double price;
        
        private List<String> address=new ArrayList<>();
        
        public  Manage manage=new Manage();
        class Manage{
        	private String name;
        	private Integer age;
    		public String getName() {
    			return name;
    		}
    		public void setName(String name) {
    			this.name = name;
    		}
    		public Integer getAge() {
    			return age;
    		}
    		public void setAge(Integer age) {
    			this.age = age;
    		}
    		@Override
    		public String toString() {
    			return "Manage [name=" + name + ", age=" + age + "]";
    		}
    		
        	
        }
    	public String getName() {
    		return name;
    	}
    	public void setName(String name) {
    		this.name = name;
    	}
    	public Double getPrice() {
    		return price;
    	}
    	public void setPrice(Double price) {
    		this.price = price;
    	}
    	@Override
    	public String toString() {
    		return "Book [name=" + name + ", price=" + price + "]";
    	}
    	public List<String> getAddress() {
    		return address;
    	}
    	public void setAddress(List<String> address) {
    		this.address = address;
    	}
    	public Manage getManage() {
    		return manage;
    	}
    	public void setManage(Manage manage) {
    		this.manage = manage;
    	}
        
        
    }

记住，集合和对象一定要初始化，不然会报错。Controller基本不变。

<!DOCTYPE html>
    <html xmlns="http://www.w3.org/1999/xhtml" xmlns:th="http://www.thymeleaf.org"
          xmlns:sec="http://www.thymeleaf.org/thymeleaf-extras-springsecurity3">
    <head lang="en">
        <meta charset="UTF-8" />
        <title></title>
    </head>
    <body>
    <h1>图书名称：${book.name}</h1>
    <h1>图书价格：${book.price}</h1>
    <#list book.address as address>  
    图书所在地址 : ${address}<br/>   
    </#list> 
    <h2>管理员属性:${book.manage}<h2>
    </body>
    </html>

![Center 3][]

# 属性占位符 #

app.name=MyApp
    app.description=${app.name} is a Spring Boot application

可以在配置文件中引用前面配置过的属性（优先级前面配置过的这里都能用）。

通过如`${app.name:默认名称}`方法还可以设置默认值，当找不到引用的属性时，会使用默认的属性。

由于方式会被Maven处理。如果你pom继承的‘‘‘spring−boot−starter−parent‘‘‘，SpringBoot已经将maven−resources−plugins默认的\{\}方式改为了@ @方式，例如@name@。

如果你是引入的Spring Boot，你可以修改[使用其他的分隔符][Link 1]

#### 通过属性占位符还能缩短命令参数 ####

server.port=${port:7001}

# 属性名匹配规则 #

例如有如下配置对象：

@Component
    @ConfigurationProperties(prefix="person")
    public class ConnectionSettings {
    
        private String firstName;
    
    }

firstName可以使用的属性名如下：

`person.firstName`，标准的驼峰式命名

`person.first-name`，虚线（-）分割方式，推荐在.properties和.yml配置文件中使用

`PERSON_FIRST_NAME`，大写下划线形式，建议在系统环境变量中使用

[Center]: /images/20220611/4650953595ea42c1bbf4f1aa7c36232c.png
[Java]: http://lib.csdn.net/base/java
[Center 1]: /images/20220611/2134714168c74cfa80d0cd22a869f56e.png
[Center 2]: /images/20220611/bf2cd36e8c4f4f5f85a21c8346c4f5a2.png
[Center 3]: /images/20220611/1dcc1f576ca044e1b80d4e062f5922f1.png
[Link 1]: http://maven.apache.org/plugins/maven-resources-plugin/resources-mojo.html#delimiters