字节流与字符流在properties上混用的神奇反应

前介

最近在项目中遇到了一个非常神奇的问题,该问题的根本原因是因为字节流字符流在项目中被混用在了properties文件上,从而导致了后续一系列的问题,所以在此记录下。

前段时间有人反映项目运行变得越来越卡,起初我认为这个项目比较老就没怎么管,直到有个周末项目连登录都登不了,这是一个CS架构的项目,问题出在客户端上。排查问题的时候发现客户端上的一个properties格式的配载文件居然足足有45m这么大,大到用记事本打开都要等很久,正是因为这个配置文件大的离谱,加载时间长,从而导致的客户端上出现的一系列问题,以至于差点对这项目差点造成了毁灭性的打击。经过两天的问题问题排查,最终发现了这个当字节流字符流被混用在properties上的神奇化学反应。

前置知识

properties是一种配置文件,常用于java项目中,并且java.util包中有对应的集合类Properties,通过Properties类提供的api我们可以很方便的操作properties文件。在Properties类中有两个用来读取properties文件到内存中的方法,以及两个保存数据到properties文件中的方法,如下所示:

// 两个load方法
public synchronized void load(Reader reader) throws IOException {
    ...... //方法体省略
}

public synchronized void load(InputStream inStream) throws IOException {
    ...... //方法体省略
}

// 两个store方法
public void store(Writer writer, String comments){
    ...... //方法体省略
}

public void store(OutputStream out, String comments){
    ...... //方法体省略
}

这两个load文件都能将磁盘中的properties文件里的数据读到内存中的Properties集合对象,两个store方法都能将内存中的Properties集合数据存放到磁盘上的properties文件中,在只有英文字符的情况下混用这些方法并不会有什么问题,但是如果有中文字符就完全不一样了。

字节流:InputStream和OutputStream,不能输入和输出中文字符

字符流:Reader和Writer,可以输入和输出中文字符

记住这二者在面对中文字符时的不同,因为后续的问题就出在这里。

测试代码

测试properties文件test.properties,其中test2为test1的中文对应的ascii码

test1=今天的天气真好

test2=\u4eca\u5929\u7684\u5929\u6c14\u771f\u597d

测代码

使用字节流

private static void useByteStream(){
    String testFile = "D:\\test.properties";
    Properties prop = new Properties();

    try {
        InputStream fis = new FileInputStream(testFile);
        prop.load(fis);
        fis.close();

        OutputStream fos = new FileOutputStream(testFile);
        prop.store(fos, "");
        fos.flush();
        fos.close();
    } catch (IOException e) {
        e.printStackTrace();
    }
}

使用字符流

private static void useCharacterStream(){
    String testFile = "D:\\test.properties";
    Properties prop = new Properties();
    try {
        prop.load(new FileReader(testFile));

        prop.store(new FileWriter(testFile), "");
    } catch (Exception e) {
        e.printStackTrace();
    }
}    

这里的两个方法的逻辑都是将磁盘中的test.properties文件读到内存中,然后再将读到内存中的Properties对象存到磁盘中去,useByteStream()使用的是字节流来进行输入输出,而useCharacterStream()中用的字符流来进行输入输出。

效果演示

首先单独调用useByteStream()方法,调用结果如下:

test1=\u00E4\u00BB\u008A\u00E5\u00A4\u00A9\u00E7\u009A\u0084\u00E5\u00A4\u00A9\u00E6\u00B0\u0094\u00E7\u009C\u009F\u00E5\u00A5\u00BD
test2=\u4ECA\u5929\u7684\u5929\u6C14\u771F\u597D

其中原本是中文的test1变成了乱码,而test2则没有变化,原因是字节流不能读取完整的中文字符,所以导致test1成了乱码,而test2本来就是ascii码格式的字节流可以读取。

单独调用useCharacterStream()方法,调用结果如下:

test1=今天的天气真好
test2=今天的天气真好

test1和test2都变成了中文,其原因是字符流能读取和输出完整的中文字符。

一旦我们把这两个方法放在一起调用,就会发生一个非常可怕的事情。

public static void main(String[] args) {
    useCharacterStream();
    useByteStream();
}

调用一次

test1=�天�天��好
test2=今天的天气真好

调用两次

test1=�天�天��好
test2=�天�天��好

调用三次

test1=�¤�»���¥�¤�©�§�����¥�¤�©�¦�°���§�����¥�¥�½
test2=�天�天��好

从上面的三次调用我们可以发现,原本正常的中文和ascii码变成了乱码,并且数量越来越多,最终会多到程序都无法读取的地步。因为字符流可以将完整的读取中文字符,不论是中文字符还是中文字符的ascii格式都能被完整的读入内存,并以中文字符的形式写出。而字节流则无法读取完整的中文字符,会使得中文乱码,并以ascii码格式将这乱码的内容写出到properties文件中。后续这乱码的内容又被字符流完整的读取,并以中文字符的形式写出到properties文件中,字节流再读取这已经乱码的中文字符,再次形成乱码,并且乱码字符量成指数增长,再以ascii码的形式写出......如此一直循环往复,最终使得一个properties文件的大小达到了令人震惊的45m。

建议

在properties文件中一般是建议不使用中文字符来作为值,如果要用的话请使用中文的ascii码格式,并用字节流来操作properties文件,或是用字符流来读取properties文件用字节流来写出文件,这样就不会出现上面的问题。ascii码格式中文的确不适合阅读,毕竟这东西是给机器看的,我们可以根据自己用的ide来设置将properties中的ascii格式中文显示成中文(具体怎么做请自行百度)。最后,希望大家写代码的时候多留意下字节流字符流的使用,这两个东西用的不好真的很容易引发大问题。

©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容