Spring properties文件中文乱码的原因及解决方案

先看看原情况以及效果图

image.png

说到乱码问题,其实目前遇到的乱码问题原因可以归根为读取协议不对等,例如使用GBK文件格式去读取UTF-8文件格式的内容肯定会出现乱码,那么我们解决问题的整体思路也就是使用合适的读取格式去读取文件内容

本篇学习笔记代码地址在simple-spring 的spring-learn模块的bpp文件夹中

在此感谢 antz_H 的指正,此笔记只是本人在学习调试Spring代码时弄的,启动的方法也是ClassPathXmlApplicationContext applicationContext = new ClassPathXmlApplicationContext( new String[]{"spring/spring-bpp.xml"}) 不适用于SpringBoot常规的情况下,SpringBoot已经提供了现成的@PropertySource 注解 解决方案

Properties 文件读取

在之前的学习笔记中Spring Properties属性获取 源码学习,也曾经介绍过如何读取@Value("${XXX}")在属性文件中XXX对应的值。

PropertySourcesPlaceholderConfigurer 类是实现BeanFactoryPostProcessor接口的,在执行postProcessBeanFactory方法的时候,会进行属性文件的读取并且把键值对信息存储到PropertySourcesPlaceholderConfigurer类本身的容器中

在抽象类PropertiesLoaderSupport的protected void loadProperties(Properties props) throws IOException方法去完成属性文件内容的读取

最后来到了PropertiesLoaderUtils工具类中

    static void fillProperties(Properties props, EncodedResource resource, PropertiesPersister persister)
            throws IOException {

        InputStream stream = null;
        Reader reader = null;
        try {
            String filename = resource.getResource().getFilename();
            // 获取文件名称
            if (filename != null && filename.endsWith(XML_FILE_EXTENSION)) {
                  // 1处 文件名不为null,而且是xml结尾
                stream = resource.getInputStream();
                persister.loadFromXml(props, stream);
            }
            else if (resource.requiresReader()) {
                  // 2处 如果resource中的encoding字段或者charset字段不为空
                    // 就会使用encoding内的字符编码或者charset设置的字符编码格式读取属性文件
                reader = resource.getReader();
                persister.load(props, reader);
            }
            else {
                   // 3处 否则就是使用默认的字符编码获取IO流
                stream = resource.getInputStream();
                persister.load(props, stream);
            }
        }

所以现在能够解决当前问题只有2处了,需要设置resource对象的encoding、charset字段值,而此resource生成是使用了new EncodedResource(location, this.fileEncoding)实现的

现在解决方案已经非常明了了,也就是设置PropertySourcesPlaceholderConfigurerbean的fileEncoding字段值即可

fileEncoding 字段值填充

xml配置的方法还是很简单的,直接设置bean的基本参数,然后在bean实例完之后参数填充即可

image

现在讨论的是另一种情况,没有对外直接的file-encoding字段设置能力

上面已经说了,调用postProcessBeanFactory方法,会进行属性文件的读取(也就意味着PropertySourcesPlaceholderConfigurer是一个实现了BeanFactoryPostProcessor和PriorityOrdered接口的特殊BPP类),那么就必须在这个方法调用前完成参数的注入

重点关注BPP处理的核心类PostProcessorRegistrationDelegate

可以提出两种解决方案

  • 实现BeanDefinitionRegistryPostProcessor 接口
  • 实现BeanFactoryPostProcessor、PriorityOrdered 接口(排序超过PropertySourcesPlaceholderConfigurer)

至于为啥是这两种方案,可以看看之前写的Spring 钩子之BeanFactoryPostProcessor和BeanPostProcessor的源码学习再谈Spring BeanPostProcessor

例如如下自定义的BPP(具方法可看github内的代码)

@Component
public class PriorityOrderedBeanFactoryPostProcessor implements BeanFactoryPostProcessor,
        PriorityOrdered {

    @Override
    public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory)
            throws BeansException {
        Map map = beanFactory.getBeansOfType(PropertySourcesPlaceholderConfigurer.class);
        // 可能存在多个PropertySourcesPlaceholderConfigurerbean的情况
        Iterator<Map.Entry<String, PropertySourcesPlaceholderConfigurer>> it = map.entrySet().iterator();

        while (it.hasNext()) {
            Map.Entry<String, PropertySourcesPlaceholderConfigurer> entry = it.next();
            PropertySourcesPlaceholderConfigurer pp = entry.getValue();
            pp.setFileEncoding("UTF-8");
            // 终于获取到了设置文件编码类型的地方了
            // 这也是最关键的地方
        }
    }

    @Override
    public int getOrder() {
        // 排序规则,具体可以看看OrderComparator的排序规则
        // PropertySourcesPlaceholderConfigurer的排序order是最低的,所以设置一个0完全可以满足要求
        return 0;
    }
}

总结

本学习笔记也可以算是又一篇BPP的实践,一方面加深对BPP的了解,另一方面结合当前遇到的具体问题具体解决,其实随着对spring学习的深入会发现越来越多通过BPP扩展的功能,例如监控spring-actuator也是利用BPP添加额外的端点完成相应的功能

如果对BPP有更多兴趣的,PostProcessorRegistrationDelegate类需要来回琢磨,调试

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,826评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,968评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,234评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,562评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,611评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,482评论 1 302
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,271评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,166评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,608评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,814评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,926评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,644评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,249评论 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,866评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,991评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,063评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,871评论 2 354

推荐阅读更多精彩内容