Spring-Boot 中 application.properties 属性的 UTF-8 编码

Question

在我的application.properties 中，我添加了一些自定义属性。

custom.mail.property.subject-message=This is a ä ö ü ß problem

在这个类中，我有自定义属性的表示。

@Component
@ConfigurationProperties(prefix="custom.mail.property")
public class MailProperties {
    private String subjectMessage;
    public String getSubjectMessage() {
        return subjectMessage;
    }
    public void setSubjectMessage(String subjectMessage) {
        this.subjectMessage = subjectMessage;
    }

我在这里使用我的MailProperties：

@Service
public class SimpleUnknownResponseMessage extends MailProperties implements UnknownResponseMessage{

    private JavaMailSender javaMailSender;

    @Autowired
    public SimpleUnknownResponseMessage(JavaMailSender javaMailSender) {
        this.javaMailSender = javaMailSender;
    }

    @Override
    public void placeUnknownResponse(BookResponse bookResponse) {
        MimeMessage message = javaMailSender.createMimeMessage();
        try {
            MimeMessageHelper helper = new MimeMessageHelper(message, "UTF-8");
            helper.setSubject(this.getSubjectMessage());            
            javaMailSender.send(message);

        } catch (MessagingException e) {
            e.printStackTrace();
        }
    }

调试时我可以看到我的this.getSubjectMessage() 变量内部有这个值：This is a ä ö ü à problem。所以在发送邮件之前，我已经遇到了 UTF-8 编码问题。

我已经检查了application.properties 文件的编码及其 UTF-8。

我的 IDE(STS/Eclipse) 和项目属性也设置为 UTF-8。

如何为 application.properties 文件中的自定义属性的文本设置 UTF-8 编码？

Answer 1

正如 cmets 中已经提到的，.properties 文件预计将使用 ISO 8859-1 进行编码。可以使用 unicode 转义符来指定其他字符。还有一个tool 可用于进行转换。例如，这可以在自动构建中使用，以便您仍然可以在源代码中使用您喜欢的编码。

Answer 2

请尝试将带有编码参数的PropertySource注释添加到您的配置文件中：

@PropertySource(value = "classpath:application-${env}.properties", encoding = "UTF-8")

希望对您有所帮助。

Answer 3

我也遇到过同样的问题。 在 Spring Boot 中有 2 个 PropertySourceLoader 用于在应用程序中加载属性：

• PropertiesPropertySourceLoader - 仅在从 XML 加载时支持 UTF-8
• YamlPropertySourceLoader - 支持 UTF-8，但您必须更改配置格式才能使用它

它们在文件https://github.com/spring-projects/spring-boot/blob/master/spring-boot/src/main/resources/META-INF/spring.factories中列出

所以我们决定编写自己的 PropertySourceLoader 实现，它能够正确地从 UTF-8 文件加载属性。这个想法来自答案@BalusC - How to use UTF-8 in resource properties with ResourceBundle

我们的 PropertySourceLoader 实现：

public class UnicodePropertiesPropertySourceLoader implements PropertySourceLoader {

@Override
public String[] getFileExtensions() {
    return new String[]{"properties"};
}

@Override
public PropertySource<?> load(String name, Resource resource, String profile) throws IOException {
    if (profile == null) {
        Properties properties = new Properties();
        PropertyResourceBundle bundle = new PropertyResourceBundle(new InputStreamReader(resource.getInputStream(), "UTF-8"));
        Enumeration<String> keys = bundle.getKeys();
        while (keys.hasMoreElements()) {
            String key = keys.nextElement();
            properties.setProperty(key, bundle.getString(key));
        }
        if (!properties.isEmpty()) {
            return new PropertiesPropertySource(name, properties);
        }
    }
    return null;
}

}

然后我们创建了文件 resources/META-INF/spring.factories，其内容为：

# Custom PropertySource Loaders
org.springframework.boot.env.PropertySourceLoader=\
your.own.package.UnicodePropertiesPropertySourceLoader

现在我们的应用程序中有 3 个 PropertySourceLoader，顺序如下：

• UnicodePropertiesPropertySourceLoader
• PropertiesPropertySourceLoader
• YamlPropertySourceLoader

注意！

1. 我不确定是否正确使用 PropertyResourceBundle
2. 如果您创建一个专用库以在其他项目中重用它，我不确定 Spring Boot 中 PropertySourceLoaders 的顺序是否相同。

在我们的项目中，这个解决方案运行良好。

更新！

最好在没有PropertyResourceBundle的情况下实现UnicodePropertiesPropertySourceLoader的加载方法：

@Override
public PropertySource<?> load(String name, Resource resource, String profile) throws IOException {
    if (profile == null) {
        Properties properties = new Properties();
        properties.load(new InputStreamReader(resource.getInputStream(), "UTF-8"));
        if (!properties.isEmpty()) {
            return new PropertiesPropertySource(name, properties);
        }
    }
    return null;
}

Answer 4

要为 application.properties（以及任何其他 Java 属性以及环境变量）中的文本设置 UTF-8 编码，请将 -Dfile.encoding=UTF-8 添加到 java 命令行 agrs。

Answer 5

刚刚用https://native2ascii.net/ 转换了带有特殊字符的文本