Làm cách nào để định cấu hình mã hóa trong Maven?

Khi tôi chạy maven installtrên dự án maven đa mô-đun, tôi luôn nhận được đầu ra sau:

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

Vì vậy, tôi đã đi vòng quanh một chút, nhưng tất cả những gì tôi có thể tìm thấy là tôi phải thêm:

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

... đến tệp pom.xml của tôi. Nhưng nó đã ở đó (trong cha mẹ pom.xml).

Cấu hình <encoding>cho plugin maven-resource-plugin hoặc maven-Trình biên dịch-plugin cũng không khắc phục được.

Vậy vấn đề là gì?

OK, tôi tìm thấy vấn đề.

Tôi sử dụng một số plugin báo cáo. Trong tài liệu về failafe-maven-plugin ( http://maven.apache.org/plugins/maven-failsafe-plugin/integration-test-mojo.html ) tôi thấy rằng <encoding>cấu hình - tất nhiên - sử dụng ${project.reporting.outputEncoding}theo mặc định . Vì vậy, tôi đã thêm thuộc tính như là một phần tử con của projectphần tử và bây giờ mọi thứ đều ổn:

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

Xem thêm http://maven.apache.org/general.html#encoding-warning

Điều này sẽ được bổ sung vào trước đó, nếu ai đó gặp vấn đề với các chữ cái scandic không được giải quyết với giải pháp ở trên.

Nếu các tệp nguồn java chứa các chữ cái scandic, chúng cần được giải thích chính xác bởi Java được sử dụng để biên dịch . (ví dụ: các chữ cái scandic được sử dụng trong các hằng số)

Ngay cả khi các tệp được lưu trữ trong UTF-8 và Maven được định cấu hình để sử dụng UTF-8, Java hệ thống được sử dụng bởi Maven vẫn sẽ sử dụng mặc định hệ thống (ví dụ: trong Windows: cp1252).

Điều này sẽ chỉ hiển thị khi chạy thử nghiệm thông qua maven (có thể in các giá trị của các hằng số này trong các thử nghiệm. Các chữ cái scandic được in sẽ hiển thị là '<?>') Nếu không được kiểm tra đúng cách, điều này sẽ làm hỏng các tệp lớp dưới dạng kết quả biên dịch và bị không để ý

Để ngăn chặn điều này, bạn phải đặt Java được sử dụng để biên dịch để sử dụng mã hóa UTF-8. Không đủ để có các cài đặt mã hóa trong maven pom.xml, bạn cần đặt biến môi trường: JAVA_TOOL_OPTIONS = -Dfile.encoding = UTF8

Ngoài ra, nếu sử dụng Eclipse trong Windows, bạn có thể cần phải thiết lập mã hóa được sử dụng bổ sung cho điều này (nếu bạn chạy thử nghiệm riêng lẻ qua nhật thực).

Nếu bạn kết hợp các câu trả lời ở trên, cuối cùng, một tệp pom.xml được định cấu hình cho UTF-8 sẽ giống như vậy.

pom.xml

<?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>

Dường như mọi người trộn mã hóa nội dung với mã hóa tệp / tài nguyên được xây dựng. Chỉ có thuộc tính maven là không đủ. Có -Dfile.encoding=UTF8hiệu quả. Để tránh gặp sự cố với mã hóa, bạn nên tuân theo các quy tắc đơn giản sau

1. Đặt mã hóa maven, như được mô tả ở trên:

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

2. Luôn đặt mã hóa rõ ràng, khi làm việc với các tệp, chuỗi, IO trong mã của bạn. Nếu bạn không tuân theo quy tắc này, ứng dụng của bạn phụ thuộc vào môi trường. Chính -Dfile.encoding=UTF8xác chịu trách nhiệm cho cấu hình môi trường thời gian chạy, nhưng chúng ta không nên phụ thuộc vào nó. Nếu bạn có hàng ngàn khách hàng, phải mất nhiều nỗ lực hơn để định cấu hình hệ thống và tìm sự cố vì nó. Bạn chỉ cần có một sự phụ thuộc bổ sung vào nó mà bạn có thể tránh bằng cách đặt nó rõ ràng. Hầu hết các phương thức trong Java sử dụng mã hóa mặc định được đánh dấu là không dùng nữa vì nó.

3. Hãy chắc chắn rằng nội dung mà bạn đang làm việc cũng nằm trong cùng một mã hóa mà bạn mong đợi. Nếu không, các bước trước không thành vấn đề! Ví dụ, một tệp sẽ không được xử lý chính xác, nếu mã hóa của nó không phải là UTF8 nhưng bạn mong đợi nó. Để kiểm tra mã hóa tệp trên Linux:

$ tập tin --mime F_PRDAUFT.dsv

4. Buộc khách hàng / máy chủ thiết lập mã hóa rõ ràng trong các yêu cầu / phản hồi, đây là các ví dụ:

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

Hy vọng điều này sẽ hữu ích cho một ai đó.

Thử cái này:

<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>

Trong trường hợp của tôi, tôi đã sử dụng maven-dependency-pluginnhư vậy để giải quyết vấn đề, tôi đã phải thêm thuộc tính sau:

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

Xem Plugin Tài nguyên Maven của Apache / Chỉ định sơ đồ mã hóa ký tự