Як налаштувати кодування в Maven?

Коли я працюю maven installнад своїм багатомодульним проектом Maven, я завжди отримую такий результат:

[WARNING] File encoding has not been set, using platform encoding UTF-8, i.e. build is platform dependent!

Отже, я трохи погуглився, але все, що я можу знайти, це те, що я повинен додати:

<properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>

... на мій pom.xml. Але це вже є (у батьків pom.xml).

Настроювання <encoding>для плагіна maven-resources або maven-компілятора також не виправляє.

То в чому проблема?

Гаразд, я знайшов проблему.

Я використовую деякі додатки для звітування. У документації про модуль failsafe-maven ( http://maven.apache.org/plugins/maven-failsafe-plugin/integration-test-mojo.html ) я виявив, що <encoding>конфігурація - звичайно, використовується ${project.reporting.outputEncoding}за замовчуванням . Тому я додав властивість як дочірній елемент projectелемента і зараз все добре:

<properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
</properties>

Дивись також http://maven.apache.org/general.html#encoding-warning

Це було б на додаток до попереднього, якщо хтось стикається з проблемою зі скандальними літерами, яка не вирішена з рішенням вище.

Якщо у вихідних файлах Java містяться скандичні букви, їх потрібно правильно інтерпретувати Java, яка використовується для компіляції . (наприклад, скандальні букви, які використовуються в константах)

Навіть якщо файли зберігаються в UTF-8 і Maven налаштований на використання UTF-8, системна Java, що використовується Maven, все одно використовуватиме системний замовник (наприклад, в Windows: cp1252).

Це буде видно лише при виконанні тестів через maven (можливо, надрукування значень цих констант у тестах. Надруковані скандичні букви відображатимуться як <<>>) Якщо не перевіряються належним чином, це пошкодить файли класу як результат компіляції та буде залишився непоміченим.

Щоб цього не допустити, потрібно встановити Java, яка використовується для компіляції, щоб використовувати кодування UTF-8. Мало встановити параметри кодування в maven pom.xml, потрібно встановити змінну середовища: JAVA_TOOL_OPTIONS = -Dfile.encoding = UTF8

Крім того, якщо ви використовуєте Eclipse в Windows, вам може знадобитися встановити кодування, яке використовується додатково до цього (якщо ви запускаєте індивідуальний тест через eclipse).

Якщо ви комбінуєте відповіді вище, нарешті, таким чином повинен виглядати пом.xml, налаштований на UTF-8.

пом.хмл

<?xml version="1.0" encoding="UTF-8"?>
<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">

    <modelVersion>4.0.0</modelVersion>

    <groupId>YOUR_COMPANY</groupId>
    <artifactId>YOUR_APP</artifactId>
    <version>1.0.0-SNAPSHOT</version>

    <properties>
        <project.java.version>1.8</project.java.version>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    </properties>

    <dependencies>
        <!-- Your dependencies -->
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.7.0</version>
                <configuration>
                    <source>${project.java.version}</source>
                    <target>${project.java.version}</target>
                    <encoding>${project.build.sourceEncoding}</encoding>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-resources-plugin</artifactId>
                <version>3.0.2</version>
                <configuration>
                    <encoding>${project.build.sourceEncoding}</encoding>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

Здається, люди змішують кодування вмісту із вбудованим кодуванням файлів / ресурсів. Мати лише властивості Maven недостатньо. Не маючи -Dfile.encoding=UTF8ефективності. Щоб уникнути проблем із кодуванням, слід дотримуватися наступних простих правил

1. Встановіть кодування Maven, як описано вище:

<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>

2. Завжди встановлюйте чітко кодування під час роботи з файлами, рядками, IO у своєму коді. Якщо ви не дотримуєтесь цього правила, ваша програма залежить від середовища. -Dfile.encoding=UTF8Точно відповідає за настройки середовища часу виконання, але ми не повинні залежати від нього. Якщо у вас є тисячі клієнтів, для налаштування систем та пошуку проблем потрібно більше зусиль. У вас просто є додаткова залежність від неї, якої ви можете уникнути, встановивши її чітко. Більшість методів на Java, які використовують кодування за замовчуванням, позначені як застарілі через нього.

3. Переконайтеся, що вміст, з яким ви працюєте, також знаходиться в тому ж кодуванні, яке ви очікуєте. Якщо це не так, попередні кроки не мають значення! Наприклад, файл не буде оброблений правильно, якщо його кодування не UTF8, але ви очікуєте його. Щоб перевірити кодування файлів в Linux:

$ file --ime F_PRDAUFT.dsv

4. Примушуйте клієнтів / серверних кодувань явно в запитах / відповідях, ось приклади:

@Produces("application/json; charset=UTF-8")
@Consumes("application/json; charset=UTF-8")

Сподіваюся, це комусь стане в нагоді.

Спробуйте це:

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

У моєму випадку я використовував maven-dependency-pluginтак, щоб вирішити проблему, мені довелося додати таке властивість:

  <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

Див. Модуль Apache Maven Resources Plugin / Вказання схеми кодування символів