8

I am developing a maven based web project. In my web module I am using different language specific resource bundles (german, spain, ....). All my sources are based on UTF-8 and erverything works fine. Now it was necessary to acitvate maven resouce filtering to replace some configurations depending on different maven profiles.

my pom.xml:

.....
 <project xmlns="http://maven.apache.org/POM/4.0.0"   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
.....

 <properties>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 </properties>    
 <build>
 <resources>
    <resource>
    <directory>src/main/resources</directory>
        <filtering>true</filtering>             
    </resource>      
 </resources>
 ....

From this moment my war file contains resource bundles with wrong encoding. For example German umlauts are no longer displayed in my web application correctly. When I disable the resource filtering everything is well again.

The only solution I found was to set the property project.build.sourceEncoding to 'ISO-8859-1'

<properties>
  <project.build.sourceEncoding>ISO-8859-1</project.build.sourceEncoding>
</properties>

But I can not understand why this is necessary? All my sources are UTF-8 and also my application is based on UTF-8? What will happen if I need to add a resource bundle with - for example Japanese characters?

I am developing on linux using Eclipse 4.2 and Maven 3

svick
  • 236,525
  • 50
  • 385
  • 514
Ralph
  • 4,500
  • 9
  • 48
  • 87

6 Answers6

4

You can specify the encoding in the resources plugin configuration like so:

<project>
  ...
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-resources-plugin</artifactId>
        <version>2.6</version>
        <configuration>
          ...
          <encoding>UTF-8</encoding>
          ...
        </configuration>
      </plugin>
    </plugins>
    ...
  </build>
  ...
</project>

Link to the Docs

gregwhitaker
  • 13,124
  • 7
  • 69
  • 78
  • I was going to suggest the same! – carlspring Jan 15 '13 at 01:50
  • 2
    I have tested this before but it had no effect. – Ralph Jan 16 '13 at 09:15
  • 1
    -1 The problem is that UTF-8 will break all properties files in your project as they contain non-ASCII characters. – Aaron Digulla Apr 16 '14 at 15:19
  • @Aaron Digulla - I'm not sure I understand what you are saying. If you have different encodings in different properties files why couldn't you just filter those separately? – gregwhitaker Apr 16 '14 at 16:14
  • @GregWhitaker: As per the JavaDoc for [Properties](http://docs.oracle.com/javase/7/docs/api/java/util/Properties.html), `*.property` files are always using ISO-Latin-1 (ISO-8859-1) encoding. So if they contain non-ASCII characters, your solution will corrupt these files during the build. See http://jira.codehaus.org/browse/MRESOURCES-171 – Aaron Digulla Apr 17 '14 at 08:21
  • Thanks for the link Aaron. I appreciate it. – gregwhitaker Apr 17 '14 at 15:08
4

Are you sure your resource bundles (.properties) are using UTF-8?

java.util.Properties assumes ISO-8859-1 for resource bundles encoding, see http://docs.oracle.com/javase/6/docs/api/java/util/Properties.html#load(java.io.Reader), and I think Eclipse (as well as IntelliJ IDEA) honors this default encoding for these files (.properties).

So go and check with a text editor the current encoding for these files in your project source tree, in Windows Notepad 2 can help you with this.

And then configure maven-resources-plugin like indicated here Configure encoding for different filetypes in maven?

Community
  • 1
  • 1
Jaime Hablutzel
  • 6,117
  • 5
  • 40
  • 57
1

I had the same problem today. Setting project.build.sourceEncoding to UTF-8 will not work. All the filtered files will be copied in ISO-8859-1(actually I didn't test but I am sure they are not copied in UTF-8).
My solution is declaring two <resource> sections. One to include all the files you really need to filter. The other one to copy other resources with <filtering> set to false.
It works for me because I don't need to filter I18N files and the file which needs to be set value when build contains only ASCII characters.

grape_mao
  • 1,153
  • 1
  • 8
  • 16
0

Not really an answer to your question (sorry), but I think it is useful information about the property project.build.sourceEncoding

This property is an attempt to simplify the encoding management in maven projects.

The idea is that all plugins use it as default encoding value whenever the encoding is not specified in the plugin configuration it self. Using or not this property as default encoding value is only a recommendation for plugin developers.

I think this is done in all major and recent plugins, but one important exception is the maven-war-plugin before version 2.2

sources :

  • discussion about project.build.sourceEncoding is here.
  • war-plugin encoding details is here.
ben75
  • 29,217
  • 10
  • 88
  • 134
  • Thanks for that information. But it says that the war-plugin in actual version 2.3 respects the property project.build.sourceEncoding when filtering resources. But this seems not to work for me. Only when I set project.build.sourceEncoding to ISO-8859-1 the german umlauts are correctly bundled into my war. – Ralph Jan 16 '13 at 12:45
0

In Windows>Preferences>General>Workspace there is a radio button for "Text file encoding". I had UTF-8 set and it was breaking all my special characters in the code.

as Default in Windows it´s "Cp1252" I think.

Laura Liparulo
  • 2,849
  • 26
  • 27
0

If we assume the file

BundleAppl.properties

is the file I want to filter but all other resources should not:

<build>
        <resources>
            <resource>
                <directory>src/main/resources</directory>
                <filtering>true</filtering>
                <includes>
                    <include>BundleAppl.properties</include>
                </includes>
            </resource>
            <resource>
                <directory>src/main/resources</directory>
                <filtering>false</filtering>
                <excludes>
                    <exclude>BundleAppl.properties</exclude>
                </excludes>
            </resource>
        </resources>
</build>

So I have the possibility to define two bundle files. One with the normal text stuff including Umlauts and so on and a technical bundle file with the build stuff like ....

  • pom.version
  • build.date

.......

bemar
  • 334
  • 5
  • 11