开通VIP,畅享免费电子书等14项超值服
首页
好书
留言交流
下载APP
联系客服
2023.07.10广东
你好,我是田哥
手写分布式配置中心一步一个脚印正在进行中。
这年头基本上都是使用SpringBoot开发,然后都知道在项目中会有个application.properties配置文件(也有的是application.yaml,反正就是用来保存我们的一些配置信息),通常我们会把一些配置信息写到properties文件中,比如:数据库连接信息、第三方接口信息(密钥、用户名、密码、地址等),连接池、Redis配置信息、各种第三方组件配置信息等。
单体服务,甚至一些小型的分布式架构中,项目的配置都是依赖一个application.properties配置文件来解决(可能有的项目会搞一个环境区分,比如:application-dev.properties、application-pro.properties等)。不过,可能伴随着业务的发展和架构不断升级,服务的数据以及每个服务涉及到配置信息会越来越多,并且对于配置管理的要求也是越来越高,比如配置信息的实时性、独立性等。
同时,我们在微服务架构下,可能还会涉及到不同环境下的配置管理、灰度发布、动态限流、动态降级等需求,包括对于配置内容的安全与权限,所以传统的配置维护方式很难达到需求。
于是,分布式配置中心就在这样的环境下产生了。
本文我们先搞清楚java中读取properties配置文件,到底有哪些方法。
需求是我们项目中有个jdbc.properties配置文件,内如如下:
jdbc.driver=com.mysql.cj.jdbc.Driverjdbc.url=mysql://localhost:3306/databaseuseUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghaijdbc.username=rootjdbc.password=123456现在是想要在java代码中获取上面配置文件内容。
第一种方式我们采用:this.getClass().getResourceAsStream()+Properties
代码实现:
具体文件和代码的位置是,代码在src/main/java目录下,资源文件在src/main/resources/目录下。
会从当前类的目录下去找,这个文件如果不和该类在一个目录下,就找不到。
会从编译后的整个classes目录下去找,maven也会把资源文件打包进classes文件夹,所以可以找到。
ClassLoader就是从整个classes文件夹找的,所以前面无需再加/
类关系图:
从上面的类图可以看到Properties类继承至Hashtable,相信大家都知道Hashtable是存储key-value数据结构类,也刚好对应我们properties文件内容也是key-value形式。
getProperty(Stringkey):在此属性列表中搜索具有指定键的属性。如果在此属性列表中找不到该键,则会检查默认属性列表及其默认值(递归)。如果未找到该属性,则该方法返回默认值参数。
list(PrintStreamout)将此属性列表打印到指定的输出流。此方法对于调试很有用。
load(InputStreaminStream):从输入字节流中读取属性列表(键和元素对)。输入流采用加载(Reader)中指定的简单的面向行的格式,并假定使用ISO8859-1字符编码;即每个字节是一个Latin1字符。不在Latin1中的字符和某些特殊字符在使用Unicode转义符的键和元素中表示。此方法返回后,指定的流仍保持打开状态。
setProperty(Stringkey,Stringvalue):调用Hashtable的方法put。他通过调用基类的put方法来设置键值对。
store(OutputStreamout,Stringcomments):将此Properties表中的此属性列表(键和元素对)以适合使用load(InputStream)方法加载到Properties表的格式写入输出流。此Properties方法不会写出此Properties表的defaults表中的属性(如果有)。
storeToXML(OutputStreamos,Stringcomment,Stringencoding):使用指定的编码发出表示此表中包含的所有属性的XML文档。
clear():清除此哈希表,使其不包含任何键。
stringPropertyNames():返回此属性列表中的一组键,其中键及其对应的值是字符串,如果尚未从主属性列表中找到相同名称的键,则包括默认属性列表中的不同键。键或键不是String类型的属性将被省略。
publicStringgetProperty(Stringkey){Objectoval=super.get(key);Stringsval=(ovalinstanceofString)(String)oval:null;return((sval==null)&&(defaults!=null))defaults.getProperty(key):sval;}super.get(key);就是调用Hashtable中的get()方法,也就是此时返回value,同时这就对应返回了properties文件中key对应的value。
第二种方式,我们通过当前类的加载器进行读取this.getClass().getClassLoader().getResourceAsStream()获取InputStream。
剩下的部分代码和第一种方式一样,这里就不在赘述了。
接下来我们采用ClassLoader类的static方法getSystemResourceAsStream()。
说白了就是获取InputStream的方式不同罢了,最终还是交给Properties去解析jdbc.properties文件内容。
我们在实际开发中,基本上都是离不开Spring了,所以,接下来我们使用Spring中的ClassPathResource读取配置文件。
org.springframework.core.io.support.PropertiesLoaderUtils。
PropertiesLoaderUtils.loadProperties(resource)源码部分:
publicstaticPropertiesloadProperties(EncodedResourceresource)throwsIOException{//创建一个Properties对象Propertiesprops=newProperties();//处理文件内容并赋值给propsfillProperties(props,resource);returnprops;}fillProperties(props,resource);方法:
publicvoidload(Propertiesprops,InputStreamis)throwsIOException{props.load(is);}这里又回到Properties类中的load()方法里了。
绕了半天也只是获取InputStream的方式不同而已
接下来我们来使用PropertyResourceBundle读取InputStream流,实现配置文件读取。
publicvoidreadProperties5()throwsIOException{InputStreaminputStream=ClassLoader.getSystemResourceAsStream("jdbc.properties");//InputStreaminputStream=ClassLoader.getSystemResourceAsStream("config/jdbc.properties");PropertyResourceBundlebundle=newPropertyResourceBundle(inputStream);System.out.println(bundle.getString("jdbc.driver"));System.out.println(bundle.getString("jdbc.url"));System.out.println(bundle.getString("jdbc.username"));System.out.println(bundle.getString("jdbc.password"));}好像也没什么,
我们来看看newPropertyResourceBundle(inputStream);源码部分:
publicPropertyResourceBundle(InputStreamstream)throwsIOException{Propertiesproperties=newProperties();properties.load(stream);lookup=newHashMap(properties);}这个构造方法里直接new了一个Properties对象。然后调用load方法解析。
所以,这种方式无非就是在Properties基础之上再封装了,也就是让我们使用起来更加方便。
所以,上面代码中的bundle.getString("jdbc.url")其实调用的是父类中方法;
publicfinalStringgetString(Stringkey){return(String)getObject(key);}最终调用到PropertyResourceBundle的handleGetObject()方法:
publicObjecthandleGetObject(Stringkey){if(key==null){thrownewNullPointerException();}returnlookup.get(key);}lookup就是一个HashMap:lookup=newHashMap(properties);
第五种方式中我们看到了ResourceBundle,接下来我们就是用ResourceBundle.getBundle()实现。
//不用输入后缀publicvoidreadProperties6(){ResourceBundlebundle=ResourceBundle.getBundle("jdbc");System.out.println(bundle.getString("jdbc.driver"));System.out.println(bundle.getString("jdbc.url"));System.out.println(bundle.getString("jdbc.username"));System.out.println(bundle.getString("jdbc.password"));}直接使用文件名称就可以了,不需要写文件后缀名。
java.util.ResourceBundle.getBundle(StringbaseName)方法获取使用指定的基本名称,不需要文件后缀名,默认的语言环境和调用者的类加载器获取资源包。