springboot转调外部服务

转载

编程小达人 2024-12-03 13:27:56

文章标签 springboot转调外部服务 spring boot 后端 java spring 文章分类 架构后端开发

============================================================================

属性文件配置这一部分是我们比较熟悉的了，我们在快速创建SpringBoot项目的时候，默认会在resources目录下生成一个application.properties文件。SpringApplication都会从配置文件加载配置的属性，并最终加入到Spring的Environment中。除了resources目录下，还有其他路径，SpringBoot默认是支持存放配置文件的。

/config

以上四个，优先级从上往下依次降低，也就是说，如果同时出现，上面配置的属性将会覆盖下面的。

关于配置文件，properties和yaml文件都能够满足配置的需求。

当然，这些配置都是灵活的，如果你不喜欢默认的配置文件命名或者默认的路径，你都可以进行配置：

$ java -jar myproject.jar --spring.config.name=myproject
$ java -jar myproject.jar --spring.config.location=classpath:/default.properties,classpath:/override.properties

4、指定profile属性

=================================================================================

通常情况下，我们开发的应用程序需要部署到不同的环境下，属性的配置自然也需要不同。如果每次在发布的时候替换配置文件，过于麻烦。SpringBoot的多环境配置为此提供了便利。具体做法如下：

我们之前在介绍各种配置的优先级的时候说过， application-{profile}.properties或者application-{profile}.yml文件的优先级高于 application.properties或application.yml 配置，这里的profile就是我们定义的环境标识：

我们在resource目录下创建三个文件：

application.properties：默认的配置，default。
application-dev.properties：开发环境，dev。
application-prod.properties：生产环境，prod。

我们可以通过指定 spring.profiles.active 属性来激活对应的配置环境：

spring.profiles.active=dev

或使用命令行参数的配置形式：

$ java -jar hyh.jar --spring.profiles.active=dev

如果没有profile指定的文件于profile指定的文件的配置属性同时定义，那么指定profile的配置优先。

5、使用占位符

===========================================================================

在使用application.properties中的值的时候，他们会从Environment中获取值，那就意味着，可以引用之前定义过的值，比如引用系统属性。具体做法如下：

name=天乔巴夏

description=${name} is my name

6、加密属性

==========================================================================

Spring Boot不提供对加密属性值的任何内置支持，但是，它提供了 修改Spring环境中的值所必需的挂钩点。我们可以通过实现EnvironmentPostProcessor接口在应用程序启动之前操纵Environment。

可以参考 howto.html ，查看具体使用方法。

7、使用YAML代替properties

========================================================================================

YAML是JSON的超集，是一种 指定层次结构配置数据的便捷格式 ，我们以properties文件对比一下就知道了：

#properties
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/test?serverTimezone=GMT%2B8
spring.datasource.username=root
spring.datasource.password=123456
my.servers[0]=www.hyh.com
my.servers[1]=www.yhy.com

yml

spring:
datasource:
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://localhost:3306/test?serverTimezone=GMT%2B8
username: root
password: 123456
my:
server:
• www.hyh.com
• www.yhy.com

只要在类路径上具有SnakeYAML库，SpringApplication类就会自动支持YAML作为属性配置的方式。SpringBoot项目中的 spring-boot-starter 已经提供了相关类库： org.yaml.snakeyaml，因此SpringBoot天然支持这种方式配置。

关于yaml文件的格式，可以参考官方文档： Using YAML Instead of Properties

8、类型安全的属性配置

===============================================================================

上面说到通过 @Value(“${property}”) 注解来注入配置有时会比较麻烦，特别是当多个属性本质上具有层次结构的时候。SpringBoot提供了一种解决方案： 让强类型的bean管理和验证你的配置 。

直接来看具体的使用叭：

@ConfigurationPropertie定义一个绑定配置的JavaBean

============================================================================================================

使用默认构造器+getter和setter注入

@ConfigurationProperties(“acme”)
public class AcmeProperties {
private boolean enabled; //acme.enabled 默认为false
private InetAddress remoteAddress;// acme.remote-address 可以从String转换而来的类型
private final Security security = new Security();
//… 省略getter和setter方法
public static class Security {
private String username; // acme.security.username
private String password; // acme.security.password
private List roles = new ArrayList<>(Collections.singleton(“USER”));// acme.security.roles
//… 省略getter setter方法
}
}

这种方式依赖于默认的空构造函数，通过getter和setter方法赋值，因此getter和setter方法是必要的，且不支持静态属性的绑定。

如果嵌套pojo属性已经被初始化值： private final Security security = new Security(); 可以不需要setter方法。如果希望绑定器使用其默认构造函数动态创建实例，则需要setter。

通过@ContructorBinding注解使用构造器绑定的方式：

@ConstructorBinding //标注使用构造器绑定
@ConfigurationProperties(“acme”)
public class AcmeProperties {
private final Security security;
private final boolean enabled;
private final InetAddress remoteAddress;
public AcmeProperties(boolean enabled, InetAddress remoteAddress, Security security) {
this.enabled = enabled;
this.remoteAddress = remoteAddress;
this.security = security;
}
//…省略getter方法
@ToString
public static class Security {
private final String username;
private final String password;
private final List roles;
public Security(String username, String password,
@DefaultValue(“USER”) List roles) {
this.username = username;
this.password = password;
this.roles = roles;
}
}
//…省略getter方法
}

如果没有配置Security实例属性，那么最后结果：Security=null。如果我们想让Security={username=null,password=null,roles=[USER]}，可以在Security上加上@DefaultValue。public AcmeProperties(boolean enabled, InetAddress remoteAddress, @DefaultValue Security security)

通过@EnableConfigurationProperties注册

======================================================================================================

已经定义好了JavaBean，并与配置属性绑定完成，接着需要注册这些bean。我们通常用的@Component或@Bean，@Import加载bean的方式在这里是不可取的，SpringBoot提供了解决方案： 使用@EnableConfigurationProperties ，我们既可以一一指定配置的类，也可以按照组件扫描的方式进行配置。

@SpringBootApplication
@EnableConfigurationProperties({HyhConfigurationProperties.class, MyProperties.class,AcmeProperties.class})
public class SpringBootProfileApplication {
}
@SpringBootApplication
@ConfigurationPropertiesScan({“com.hyh.config”})
public class SpringBootProfileApplication {
}

配置yaml文件

============================================================================

acme:
remote-address: 192.168.1.1
security:
username: admin
roles:
• USER
• ADMIN
注入properties，测试
===================================================================================
@Configuration
public class Application implements CommandLineRunner {
@Autowired
private AcmeProperties acmeProperties;
@Override
public void run(String… args) throws Exception {
System.out.println(acmeProperties);
}
}
//输出：
AcmeProperties(security=AcmeProperties.Security(username=admin, password=null, roles=[USER, ADMIN]), enabled=false, remoteAddress=/192.168.1.1)
宽松绑定
========================================================================
SpringBoot采用宽松的规则进行Environment和@ConfigurationProperties标注bean的匹配。如：
@ConfigurationProperties(prefix=“acme.my-project.person”)
public class OwnerProperties {
private String firstName;
public String getFirstName() {
return this.firstName;
}
public void setFirstName(String firstName) {
this.firstName = firstName;
}
}

下面表格中的属性名都可以匹配：

springboot转调外部服务_java

@ConfigurationProperties注解中的prefix值必须是kebab case形式的，以 - 为分割符。

Spring官方建议，属性尽可能以lower-case kebab的形式：my.property-name=acme

Map如何绑定

===========================================================================

绑定到Map属性时，如果key包含 小写字母数字字符或-以外的任何其他字符 ，则需要使用方括号包围key，以便保留原始值。如果键没有被 [] 包围，则所有非字母数字或-的字符都将被删除。如下：

hyh:

username: 天乔巴夏
password: 123456
map:
“[/key1]”: value1 #用引号包围[]，用[]包围key
/key3: value3
key-4: value4
key/5: value5

结果：“map”:{/key1=value1,key5=value5, key-4=value4, key3=value3}

环境变量如何绑定

============================================================================

遵循三条原则：

把 . 换成下划线 _ 。
移除 - 。
小写转大写。

如： spring.main.log-startup-info 转为： SPRING_MAIN_LOGSTARTUPINFO ， my.acme[0].other 转为 MY_ACME_0_OTHER 。

9、复杂类型

==========================================================================

之前介绍yml文件，介绍了单纯的数组形式或值的绑定，SpringBoot还支持复杂类型的绑定。

merge:
list:
• name: 天乔巴夏
desc: 帅啊
• name: tqbx
desc: 很帅啊
map:
key1:
name: summerday
desc: handsome!
key2:
name: summer
@ToString
@ConfigurationProperties(prefix = “merge”)
public class MergeProperties {
private final List list = new ArrayList<>();
private final Map<String,User> map = new HashMap<>();
public List getList() {
return list;
}
public Map<String, User> getMap() {
return map;
}
}
最后输出：
MergeProperties(

本文章为转载内容，我们尊重原作者对文章享有的著作权。如有内容错误或侵权问题，欢迎原作者联系我们进行内容更正或删除文章。