1. @Value("${变量名称}")
使用@Value("${变量名称}")是最简单的一种形式
代码中直接通过该方式引用即可
public class MicroGatewayConfig {
@Value("${config}")
private String config;
}
这种方式简单粗暴，但是不推荐使用，
缺点很多
- idea也给我们报黄色的警告。而且我们不能再配置文件中按住“ctrl”鼠标点击配置变量直接跳到程序中。如果我们的项目中使用大量这样的变量，将会是灾难。
- 最致命的问题是程序中变量获取到的值只能是字符串，不能支持数字，布尔类型。
-
使用这种形式，变量的值只会在SpringBoot启动的时候赋值一次，以后不会改变，如果我们使用了配置中心，随后，我们即使更新了配置中心中配置信息的值，程序也不会同步，除非我们重启项目，配置中心就显得比较尴尬。
2.1 配置类
@Setter
@Getter
@Component
@ConfigurationProperties("spring.cloud.gateway.custom")
public class MicroGatewayConfig {
/**
* config demo
*/
private String config;
}
@ConfigurationProperties注解内容填写的是这个配置变量的前缀
这样配置信息就以类的形成呈现出来，如果我们需要使用配置信息，直接通过@Resource注入即可。在配置文件中，也不会报警告，在编写配置信息的时候，强大的idea也会帮我们联想。
2.2 配置类嵌套
当我们的配置信息越来越多时，需要针对不同的配置进行分类，如果全部编写在同一个配置类中，那么这个配置类会显得十分臃肿。
springBoot支持配置类嵌套的形式。
举个例子
我现在网关通过配置文件中的“开关”决定是否对请求信息进行缓存。
这样，我们可以将关于请求缓存相关的配置信息单独一个类进行保存。
- 缓存配置类
@Data
@Component
@ConfigurationProperties("spring.cloud.gateway.custom.cache-request")
public class CacheRequestConfig {
/**
* 是否缓存body信息
*/
private Boolean body = false;
/**
* 是否缓存表单信息
*/
private Boolean formData = false;
/**
* 是否缓存encodeBody信息
*/
private Boolean encodeFormData = false;
}
- 主配置类
@Setter
@Getter
@Component
@ConfigurationProperties("spring.cloud.gateway.custom")
public class MicroGatewayConfig {
private CacheRequestConfig cacheRequest;
}
-
配置文件
image.png
我们在编写配置类的时候，可以发现一个有趣的事情，就是针对于布尔类型，我们除了使用true/false外，还可以使用on/off进行代替，在程序中springBoot会自动替我们转换成true/false。这样增强了配置的可读性。
2.3 List配置信息
我们在配置信息中有时候可能需要配置一个list，比如配置redis的集群ip信息。之前我们可以使用一个字符串代替，每个ip中间使用特定的符号隔开，然后在程序中自己手动的去分隔。
强大的yml支持List，表达形式是每个元素前面使用“-”+空格
eg:
配置一个redis集群列表
- 配置类
@Data
@Component
@ConfigurationProperties("spring.cloud.gateway.custom")
public class MicroGatewayConfig {
private CacheRequestConfig cacheRequest;
private List<String> redisClusterPortList;
}
- 配置信息
spring:
cloud:
gateway:
custom:
cache-request:
body: true
form-data: true
encode-form-data: on
redisClusterHostList:
- 192.168.1.1
- 196.168.1.0
2.3 Map配置信息
yml使用map的格式为：
map变量名
key: value
key: value
map适用于未知的键值对，听起来可能有点奇怪，举个例子，加入我们想编写一个header校验器，但是我们校验的内容需要具体的场景来定义，但是校验的规则已经制定好了，这里说一下我指定的校验规则。key 即为header的key,value为header的value，如果value的值可以是多个值中的任意一个，那么用“|”隔开，如果header的值可以为任意，但是不能为空，那么value的值不写即可。
eg:
这里有三个header的值，分别是version,固定值为：1.0.0，platform是ios或者android都可以，diviceNo为任意值。那么具体的配置如下：
header:
version: 1.0.0
platform: iso|android
diviceNo:
进阶用法：
1. 为配置添加候选值
需求：
假设我这里有性别这个配置，候选值分别为man和woman
候选值依赖于枚举实现，我们需要编写一个枚举类
public enum Sex {
man,
woman
}
配置类
@Data
@Component
@ConfigurationProperties(prefix = "user")
public class UserConfiguration {
/**
* 用户性别
*/
private Sex sex;
}
2.为配置添加默认值
还是上面的例子，如果我们配置用户性别，默认是man，我们只需要在配置类写默认值即可
@Data
@Component
@ConfigurationProperties(prefix = "user")
public class UserConfiguration {
/**
* 用户性别，默认man
*/
private Sex sex = Sex.man;
}
3. map的高阶用法
用过feign的朋友都知道，feign可以针对每个服务进行配置，而且配置的时候还有提示信息，如下：
feign:
client:
config:
default:
connectTimeout: 1000
readTimeout: 1000
user-servce:
connectTimeout: 5000
readTimeout: 5000
order-service:
connectTimeout: 3000
readTimeout: 3000
feign配置文件部分代码如下：
@ConfigurationProperties("feign.client")
public class FeignClientProperties {
private boolean defaultToProperties = true;
private String defaultConfig = "default";
private Map<String, FeignClientConfiguration> config = new HashMap<>();
可以看出他存储配置类的方式是采用map，我们的服务名即为map的key，配置信息即为map的value
