SSH之Spring传统方式接入YAML管理各环境配置方式(从Spring Boot移植)

最新推荐文章于 2024-04-17 08:04:02 发布
最新推荐文章于 2024-04-17 08:04:02 发布
阅读量8k 收藏 1
点赞数 1
分类专栏： 工作记载 文章标签： ssh spring 配置管理
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/littlebrain4solving/article/details/53708058
版权

1. 背景

我们的项目早期是采用Spring Roo进行构建的，但是当业务越来越复杂，后端人员越来越多的时候分工特别不方便；并且大家都不太习惯使用Spring Roo CLI进行项目开发，所以经过了一波去Roo化后回归到了SSH架构；后来由于项目的环境配置管理特别不方便，我们发现Spring Boot对配置文件的管理特别符合我们的需求以及我们后期要把项目进行微服务化发现Spring Cloud同样也是一个不错的选择，但项目业务体系比较庞大需要一步一步去做，要把项目进行调整过渡慢慢的适应于Spring Boot那一套进行开发；所以需要移植Spring Boot已经存在的和我们迫切需要的一些优秀特征。

2. 说明

把配置文件从Properties换成YAML需要导入第三方YAML的核心库，Spring仅仅只是做为一个管理去使用它，但真正的YAML解析还是需要靠这个第三方库；具体Spring是如何使用YAML来进行管理配置文件的可以参考Spring第三方配置文档。

3. 环境版本

Spring 4.2.6.RELEASE、Snakeyaml 1.17

4. SnakeYaml的MAVEN片段

<dependency>
   <groupId>org.yaml</groupId>
   <artifactId>snakeyaml</artifactId>
   <version>1.17</version>
</dependency>

5. 从Spring Boot移植的依赖类(稍修过)

这里所涉及到四个类文件，在自己项目里面新建包名路径为“org.springframework.env”（最好直接使用我这个名称，不需要额外导包之类的），然后把下面四个类拷贝至新建的包中就好了。

5.1 PropertySourceLoader

/*
* Copyright 2012-2015 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*      http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package org.springframework.env;

import java.io.IOException;

import org.springframework.core.env.PropertySource;
import org.springframework.core.io.Resource;
import org.springframework.core.io.support.SpringFactoriesLoader;

/**
* Strategy interface located via {@link SpringFactoriesLoader} and used to load a
* {@link PropertySource}.
*
* @author Dave Syer
* @author Phillip Webb
*/
public interface PropertySourceLoader {

   /**
    * Returns the file extensions that the loader supports (excluding the '.').
    * @return the file extensions
    */
   String[] getFileExtensions();

   /**
    * Load the resource into a property source.
    * @param name the name of the property source
    * @param resource the resource to load
    * @param profile the name of the profile to load or {@code null}. The profile can be
    * used to load multi-document files (such as YAML). Simple property formats should
    * {@code null} when asked to load a profile.
    * @return a property source or {@code null}
    * @throws IOException if the source cannot be loaded
    */
   PropertySource<?> load(String name, Resource resource, String profile)
           throws IOException;

}

5.2 ArrayDocumentMatcher

/*
* Copyright 2012-2015 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*      http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package org.springframework.env;

import java.util.Collections;
import java.util.Properties;
import java.util.Set;

import org.springframework.beans.factory.config.YamlProcessor.DocumentMatcher;
import org.springframework.beans.factory.config.YamlProcessor.MatchStatus;
import org.springframework.util.StringUtils;

/**
* Matches a document containing a given key and where the value of that key is an array
* containing one of the given values, or where one of the values matches one of the given
* values (interpreted as regexes).
*
* @author Dave Syer
*/
public class ArrayDocumentMatcher implements DocumentMatcher {

   private final String key;

   private final String[] patterns;

   public ArrayDocumentMatcher(final String key, final String... patterns) {
       this.key = key;
       this.patterns = patterns;

   }

   @Override
   public MatchStatus matches(Properties properties) {
       if (!properties.containsKey(this.key)) {
           return MatchStatus.ABSTAIN;
       }
       Set<String> values = StringUtils
               .commaDelimitedListToSet(properties.getProperty(this.key));
       if (values.isEmpty()) {
           values = Collections.singleton("");
       }
       for (String pattern : this.patterns) {
           for (String value : values) {
               if (value.matches(pattern)) {
                   return MatchStatus.FOUND;
               }
           }
       }
       return MatchStatus.NOT_FOUND;
   }

}

5.3 SpringProfileDocumentMatcher

/*
* Copyright 2012-2015 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*      http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package org.springframework.env;

import java.util.Arrays;
import java.util.Collections;
import java.util.LinkedHashSet;
import java.util.Properties;

import org.springframework.beans.factory.config.YamlProcessor.DocumentMatcher;
import org.springframework.beans.factory.config.YamlProcessor.MatchStatus;
import org.springframework.core.env.Environment;

/**
* {@link DocumentMatcher} backed by {@link Environment#getActiveProfiles()}. A YAML
* document matches if it contains an element "spring.profiles" (a comma-separated list)
* and one of the profiles is in the active list.
*
* @author Dave Syer
*/
public class SpringProfileDocumentMatcher implements DocumentMatcher {

   private static final String[] DEFAULT_PROFILES = new String[] { "^\\s*$" };

   private String[] activeProfiles = new String[0];

   public SpringProfileDocumentMatcher() {
   }

   public SpringProfileDocumentMatcher(String... profiles) {
       addActiveProfiles(profiles);
   }

   public void addActiveProfiles(String... profiles) {
       LinkedHashSet<String> set = new LinkedHashSet<String>(
               Arrays.asList(this.activeProfiles));
       Collections.addAll(set, profiles);
       this.activeProfiles = set.toArray(new String[set.size()]);
   }

   @Override
   public MatchStatus matches(Properties properties) {
       String[] profiles = this.activeProfiles;
       if (profiles.length == 0) {
           profiles = DEFAULT_PROFILES;
       }
       return new ArrayDocumentMatcher("spring.profiles", profiles).matches(properties);
   }
}

5.4 SpringYamlPropertiesFactoryBean

package org.springframework.env;

import org.springframework.beans.factory.FactoryBean;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.beans.factory.config.YamlProcessor;
import org.springframework.beans.factory.config.YamlPropertiesFactoryBean;
import org.springframework.context.EnvironmentAware;
import org.springframework.core.env.Environment;
import org.springframework.core.io.Resource;
import org.springframework.util.ClassUtils;
import org.yaml.snakeyaml.DumperOptions;
import org.yaml.snakeyaml.Yaml;
import org.yaml.snakeyaml.nodes.Tag;
import org.yaml.snakeyaml.representer.Representer;
import org.yaml.snakeyaml.resolver.Resolver;

import java.util.Map;
import java.util.Properties;
import java.util.regex.Pattern;

/**
* Spring Yaml配置信息处理类
* <p><b>参考SpringBoot内容进行移植</b></p>
* <p>http://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-external-config.html</p>
* <p>具体查看: 24.6.2 Exposing YAML as properties in the Spring Environment</p>
* @author cary
* @date 2016/11/2
*/
public class SpringYamlPropertiesFactoryBean implements FactoryBean<Properties>, InitializingBean, EnvironmentAware {
   private boolean singleton = true;
   private Properties properties;
   private Resource resource;
   private Environment environment;

   @Override
   public Properties getObject() throws Exception {
       return this.properties;
   }

   @Override
   public Class<?> getObjectType() {
       return Properties.class;
   }

   @Override
   public boolean isSingleton() {
       return this.singleton;
   }

   @Override
   public void afterPropertiesSet() throws Exception {
       if (isSingleton()) {
           if (ClassUtils.isPresent("org.yaml.snakeyaml.Yaml", null)) {
               this.properties = new Properties();
               loadDefault();
               for (int i = 0; i < environment.getActiveProfiles().length; i++) {
                   String profile = environment.getActiveProfiles()[i];
                   Processor processor = new Processor(resource, profile);
                   this.properties.putAll(processor.process());
               }
               //让VM参数可以覆盖YAML               
               this.properties.putAll(System.getProperties());
               System.getProperties().putAll(this.properties);
           }
       }
   }

   protected void loadDefault(){
       Processor processor = new Processor(resource, null);
       this.properties.putAll(processor.process());
   }

   public void setResource(Resource resource){
       this.resource = resource;
   }

   @Override
   public void setEnvironment(Environment environment) {
       this.environment = environment;
   }

   /**
    * {@link YamlProcessor} to create a {@link Map} containing the property values.
    * Similar to {@link YamlPropertiesFactoryBean} but retains the order of entries.
    */
   private static class Processor extends YamlProcessor {

       Processor(Resource resource, String profile) {
           if (profile == null) {
               setMatchDefault(true);
               setDocumentMatchers(new SpringProfileDocumentMatcher());
           }
           else {
               setMatchDefault(false);
               setDocumentMatchers(new SpringProfileDocumentMatcher(profile));
           }
           setResources(new Resource[] { resource });
       }

       @Override
       protected Yaml createYaml() {
           return new Yaml(new StrictMapAppenderConstructor(), new Representer(),
                   new DumperOptions(), new Resolver() {
               @Override
               public void addImplicitResolver(Tag tag, Pattern regexp,
                                               String first) {
                   if (tag == Tag.TIMESTAMP) {
                       return;
                   }
                   super.addImplicitResolver(tag, regexp, first);
               }
           });
       }

//        public Map<String, Object> process() {
//            final Map<String, Object> result = new LinkedHashMap<String, Object>();
//            process(new MatchCallback() {
//                @Override
//                public void process(Properties properties, Map<String, Object> map) {
//                    result.putAll(getFlattenedMap(map));
//                }
//            });
//            return result;
//        }

       public Properties process() {
           final Properties result = new Properties();
           process(new MatchCallback() {
               @Override
               public void process(Properties properties, Map<String, Object> map) {
                   result.putAll(properties);
               }
           });
           return result;
       }

   }
}

6. 配置applicationContext.xml

<!--
   如果需要针对不同环境设置,VM参数设置参考: -Dspring.profiles.active=production
-->
<bean id="yamlPropertiesFactoryBean" class="org.springframework.env.SpringYamlPropertiesFactoryBean"
     p:resource="classpath:META-INF/spring/application.yml"/>
<context:property-placeholder properties-ref="yamlPropertiesFactoryBean" />

7. 简易各环境配置示例

新建一个文件“application.yml”存放到项目的“resources/META-INF/spring”中（目录位置其实可以随意，只要在第6点中把位置配置对就好了），加入以下内容到文件中，启动的时候设置JVM参数“-Dspring.profiles.active=development”即可看到效果。

application:
 name: '默认名称'

---

spring:
 profiles: development
application:
 name: '测试名称'

---

spring:
 profiles: production
application:
 name: '生产名称'

---

8. 最后注意

在项目中具体怎么去使用Spring配置属性的相关的代码我就不贴出来了（和原始的使用方式一样）；如果项目启动JVM中没有设置“-Dspring.profiles.active”变量参数的就会使用默认的信息。

littlebrain4solving
关注
  • 1
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
专栏目录
Spring Boot中的yaml文件配置
zhouym_的博客
08-06 1276
在spring boot项目中用的最多的配置文件就是properties和yaml了，这两者是可以互用的，但是 YAML 配置是有序的，properties 配置是无序的 ，而且自定义的 YAML 目前暂时不支持使用注解直接注入到 Spring Boot 项目中 ，下面我们来看看怎么配置yaml文件 yaml文件的存放路径 1、项目根目录下的config目录中 2、项目根目录下 3、classpa...
homestead.yaml配置详解
Quan的博客
09-09 2866
homestead.yaml中主要字段及其意义 --- ip: "192.168.10.10" #虚拟机的地址 memory: 2048 cpus: 1 provider: virtualbox #虚拟机平台，用virtualbox装的一定要确认这里是virtualbox authorize: ~/.ssh/id_rsa.pub #ssh的公钥 keys: - ~...
SpringBoot之配置文件(1)
最新发布
2401_84046695的博客
04-17 710
大型分布式系统犹如一个生命，系统中各个服务犹如骨骼，其中的数据犹如血液，而Kafka犹如经络，串联整个系统。这份Kafka源码笔记通过大量的设计图展示、代码分析、示例分享，把Kafka的实现脉络展示在读者面前，帮助读者更好地研读Kafka代码。麻烦帮忙转发一下这篇文章+关注我《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！Kafka源码笔记通过大量的设计图展示、代码分析、示例分享，把Kafka的实现脉络展示在读者面前，帮助读者更好地研读Kafka代码。
SpringBoot学习：yaml配置
weixin_51624761的博客
04-24 4895
1、前言 在之前的ssm框架的学习中，我们一般使用xml以及properties进行配置，可以很方便的配置资源。在SpringBoot的学习中，我们还将会学习到另外一种配置方式，那就是使用yaml进行配置。 2、几种配置方式的区别 xml配置 xml的配置方式使用相当广泛。在原生的JavaWeb阶段，我们用来配置web.xml，在ssm框架的学习中，我们用来配置mybatis-config.xml，Mapper.xml，applicationContext.xml，在Maven，Tomcat…我们随处可
SpringBoot yaml配置文件
chy1984的博客
03-07 1106
在创建springboot项目时，可以勾选 Developer Tools -> Spring Configuration Processor，或手动添加依赖
SpringBoot03：yaml配置注入
weixin_44740328的博客
06-28 2255
YAML是 "YAML Ain't a Markup Language" （YAML不是一种标记语言）的递归缩写。在开发这种语言时，YAML的意思其实是："Yet Another Markup Language"（仍是一种标记语言）。这种语言以数据作为中心，而不是以标记语言为重点！以前的配置文件，大多数都是使用xml来配置；比如一个简单的端口配置，我们来对比下yaml和xml<server></server>server：prot: 8080。
spring boot2 (27)-yaml配置
JAVA博客
04-21 1729
除了properties文件，spring boot同时支持用yaml文件来进行参数配置，其配置结构更加清晰优雅。基本格式上一篇在application.properties中数据源配置如下spring.datasource.url=jdbc:mysql://localhost:3306/test spring.datasource.username=root spring.datasource....
spring+apollo动态获取yaml格式的配置方式
08-19
"spring+apollo动态获取yaml格式的配置方式" spring框架中，默认情况下都是使用.properties格式的配置文件，...spring+apollo动态获取yaml格式的配置方式可以帮助我们更好地管理配置文件，并提供了很好的参考价值。
详解Spring Boot配置文件之多环境配置
08-29
Spring Boot配置文件之多环境配置详解 Spring Boot是一款非常流行的Java框架，用于快速构建 Production-Ready 的应用程序。其中，配置文件是一個非常重要的组成部分，用于存储应用程序的各种配置信息。在实际开发...
Spring Boot读取配置文件常用方式
10-21
在Spring Boot应用中，配置文件的管理是至关重要的，它允许开发者灵活地配置应用程序的行为，而无需修改代码。Spring Boot提供了多种方式来读取和使用这些配置文件，使其更加便捷和高效。以下将详细介绍Spring Boot...
Spring Boot环境配置
12-22
**Spring Boot环境配置详解** Spring Boot是Java开发领域中的一款热门框架，它简化了Spring应用程序的初始设置和配置，使得开发者能够快速构建可运行的应用程序。在深入学习和使用Spring Boot之前，首先需要确保...
基于Spring Boot不同的环境使用不同的配置方法
08-28
Spring Boot框架提供了多种方式来实现不同环境下的配置管理。在实际开发中，我们经常需要在不同的环境中使用不同的配置，例如开发环境、测试环境和生产环境。今天，我们将讨论基于Spring Boot的多环境配置方法。 一...
spring自定义加载属性文件-{续}(yml、yaml、properties)
岳宇樊
11-07 148
spring自定义加载属性文件(yml、yaml、properties) 上面的文章在容器初始化时不会对@Conditional起作用，所以要彻底重载属性文件，要进行以下处理： import org.springframework.context.ApplicationContextInitializer; import org.springframework.context.Configurab...
springboot ssh通道配置_springboot实践1
weixin_30531997的博客
12-31 677
环境安装 安装jdk 推荐安装jkd1.8+,我使用的是mac，假设已经安装好homebrew,则jdk的安装指令是：brew install java 在 ~/zshrc ,添加两行 export JAVA_HOME=你的jdkPath export PATH=$PATH:$JAVA_HOME; 然后保存； 输入 echo ${JAV...
17、YML配置文件 及让springboot启动时加载我们自定义的yml配置文件的几种方式
Java 领域技术分享
08-03 8640
YML配置文件及让springboot启动时加载我们自定义的yml配置文件的几种方式
【SpringBoot】18张图，详解SpringBoot解析yml全流程
阿Q的小窝
07-30 7988
前几天的时候，项目里有一个需求，需要一个开关控制代码中是否执行一段逻辑，于是理所当然的在 yml 文件中配置了一个属性作为开关，再配合 nacos 就可以随时改变这个值达到我们的目的，yml文件中是这样写的
docker-compose.yaml centos7容器 安装ssh服务
虫二的专栏~~在路上~~~
08-16 865
1、创建文件夹centos7.9_ssh，在该文件夹下创建Dockerfile文件，文件内容如下。好了，到这里就可以通过5001端口访问容器内部了。世界瞬间方便了很多。3、好了，可以创建docker-compose.yml文件了。简单的说，就是一个配置文件的问题。2、执行命令，创建直接的容器。......
SpringBoot 使用yaml文件实现多配置【spring.profiles.active】与@Profile注解——自定义注解
tao911110的博客
09-11 2084
https://www.cnblogs.com/zhengxl5566/p/12268615.html https://blog.csdn.net/uniquewonderq/article/details/79963719 https://blog.csdn.net/loongkingwhat/article/details/105745303 https://blog.csdn.net/wsm890325/article/details/93868894
org/springframework/beans/factory/config/YamlProcessor$StrictMapAppenderConstructor 错误记录
Gj1999的博客
10-09 1764
记录一下 maven包倒入的有问题： <dependency> <groupId>com.github.pagehelper</groupId> <artifactId>pagehelper-spring-boot-starter</artifactId> <version>1.2.10</version> </dependency> 版本号改成1.3.0就可以了 ...
Springboot课件学习讲义
08-31
- 在 `resources` 目录下，传统上会放置 XML 配置文件，但在 Spring Boot 中，我们通常不再需要这个，因为 Java Config 或其他方式（如 YAML 或属性文件）会被优先考虑。 2. **Spring Boot的约定优于配置原则** ...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值