SpringBoot读取properties中文乱码解决方案

 更新时间:2024年12月24日 09:40:12   作者:大饼酥  
本文主要介绍了在Spring Boot中读取带有中文字符串的application.properties文件时遇到乱码问题的解决方案,具有一定的参考价值,感兴趣的可以了解一下

一、问题描述

由于业务需求需要在application.properties中配置一个带有中文字符串的参数,注入到业务类中,但是发现注入的中文是乱码的。大概情况如下所示:

package com.cnstar.test;

import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

/**
 * cnstar单元测试
 * @author cnstar
 **/
@SpringBootTest(classes = TestApplication.class)
@RunWith(SpringRunner.class)
public class CnstarTest {

    @Value("${name}")
    private String name;

    @Test
    public void test1() {
        System.out.println("中文内容:" + name);
    }
}

打印输出结果:

二、解决方案

2.1、网络上的解决办法

遇到问题首先想到网络上找解决方案,网络上的解决办法基本一致,概括为以下三种。 

2.1.1、修改IDEA编码 

在IDEA中将所有的编码设置为UTF-8,同时勾上Transparent native-to-ascii conversion的选项,然后重新创建application.properties的文件。

运行结果:

但是这个配置文件用记事本打开编辑时,发现内容被修改成了unicode编码,在线上修改时变得很困难,所以此方式我不做推荐。 

2.1.2、改为yml配置

就是将application.properties的文件修改为application.yml的结构,重启项目。

运行效果

证明是可行的。这种方式可以根据自己需求选择,但是当配置文件的内容层级较深时也不推荐,容易看错行配置。

2.1.3、读取时设置编码

package com.cnstar.test.property;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;

import javax.annotation.PostConstruct;

@Configuration
@PropertySource(value = "classpath:application.properties", encoding = "utf-8")
public class CnstarProperty {
    @Value("${name}")
    private String name;

    @PostConstruct
    public void init() {
        System.out.println("name is :" + name);
    }
}

 亲测发现这种方式针对application.properties是不行的。

但是针对其他名称的properties文件是可以的

package com.cnstar.test.property;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;

import javax.annotation.PostConstruct;

@Configuration
@PropertySource(value = "classpath:test.properties", encoding = "utf-8")
public class CnstarProperty {
    @Value("${name2}")
    private String name;

    @PostConstruct
    public void init() {
        System.out.println("name is :" + name);
    }
}

运行结果:

2.2、重写资源加载类(个人推荐)

 1、创建一个类继承PropertiesPropertySourceLoader,因SpringBoot版本不同PropertiesPropertySourceLoader类会有差别,本文采用的SpringBoot版本是2.3.12.RELEASE。

package com.cnstar.utils;

import org.springframework.core.io.*;
import org.springframework.core.env.*;
import org.springframework.boot.env.*;
import java.util.*;
import java.io.*;

/**
 * 解快springBoot读取properties配置文件中文乱码的问题
 * @author cnstar
 **/
public class SelfPropertySourceLoader extends PropertiesPropertySourceLoader {

    @Override
    public List<PropertySource<?>> load(String name, Resource resource) throws IOException {
        Map<String, ?> properties = this.loadUseUtf8(resource);
        if (properties.isEmpty()) {
            return Collections.emptyList();
        }
        return Collections.singletonList(new OriginTrackedMapPropertySource(name, Collections.unmodifiableMap((Map<?, ?>)properties), true));
    }

    private Map<String, ?> loadUseUtf8(Resource resource) throws IOException {
        Properties props = new Properties();
        InputStream is = resource.getInputStream();
        try {
            String filename = resource.getFilename();
            if (filename != null && filename.endsWith(".xml")) {
                props.loadFromXML(is);
            }
            else {
                props.load(new InputStreamReader(is, "utf-8"));
            }
        } finally {
            is.close();
        }
        return (Map)props;
    }
}

2.在resource目录下创建目录META-INF,在META-INF目录下创建文件spring.factories

内容如下:

org.springframework.boot.env.PropertySourceLoader=com.cnstar.utils.SelfPropertySourceLoader

 重新运行:

到此这篇关于SpringBoot读取properties中文乱码解决方案的文章就介绍到这了,更多相关SpringBoot读取properties中文乱码内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • springboot如何为web层添加统一请求前缀

    springboot如何为web层添加统一请求前缀

    这篇文章主要介绍了springboot如何为web层添加统一请求前缀,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-02-02
  • SpringBoot中统一同步与异步执行模型的示例详解

    SpringBoot中统一同步与异步执行模型的示例详解

    这篇文章主要为大家详细介绍了SpringBoot中如何统一同步与异步执行模型,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下
    2025-12-12
  • idea中VM options配置方式

    idea中VM options配置方式

    文章介绍了JVM的多个配置参数,如堆内存设置、线程栈大小、年轻代与年老代的配置等,其中包括标准参数和各种非标准参数(-X和-XX),并提到了它们对JVM性能和垃圾回收机制的影响,还区分了Client和Server模式
    2025-10-10
  • Java运算符与流程控制之全类型运算符用法及分支 / 循环语句实战指南

    Java运算符与流程控制之全类型运算符用法及分支 / 循环语句实战指南

    这篇文章主要介绍了Java运算符与流程控制之全类型运算符用法及分支/循环语句实战的相关资料,运算符包括算术、关系、逻辑、赋值和三元运算符,重点讲解了它们的用法、优先级和结合性,以及强制类型转换的注意事项,需要的朋友可以参考下
    2026-01-01
  • 使用java实现http多线程断点下载文件(一)

    使用java实现http多线程断点下载文件(一)

    Java 多线程断点下载文件基本原理:利用URLConnection获取要下载文件的长度、头部等相关信息,并设置响应的头部信息,本文将详细介绍,需要了解更多的朋友可以参考下
    2012-12-12
  • Java中的instanceof关键字在Android中的用法实例详解

    Java中的instanceof关键字在Android中的用法实例详解

    instanceof是Java的一个二元操作符,和==,>,<是同一类东西。接下来通过本文给大家介绍Java中的instanceof关键字在Android中的用法,非常不错,具有参考借鉴价值,感兴趣的朋友一起学习吧
    2016-07-07
  • Java实现银行ATM系统

    Java实现银行ATM系统

    这篇文章主要为大家详细介绍了Java实现银行ATM系统,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2020-04-04
  • ResultSet如何动态获取列名和值

    ResultSet如何动态获取列名和值

    这篇文章主要介绍了ResultSet如何动态获取列名和值问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-12-12
  • SpringData如何通过@Query注解支持JPA语句和原生SQL语句

    SpringData如何通过@Query注解支持JPA语句和原生SQL语句

    这篇文章主要介绍了SpringData如何通过@Query注解支持JPA语句和原生SQL语句,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-11-11
  • 关于Java中的 JSP 详解

    关于Java中的 JSP 详解

    JSP 代表 Java 服务器页面。它是一种在应用服务器端使用的编程工具。JSP 基本上用于支持平台–独立和动态的方法来构建 Web 依赖的应用程序。JSP 页面类似于 ASP 页面,因为它们是在服务器上编译的,而不是在用户的 Web 浏览器上进行编译。下面来看看文章的详细介绍内容
    2021-11-11

最新评论