จะกำหนดค่าการเข้ารหัสใน Maven ได้อย่างไร

เมื่อฉันทำงานmaven installในโครงการ maven โมดูลของฉันฉันมักจะได้รับผลลัพธ์ต่อไปนี้:

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

ดังนั้นฉัน googled รอบเล็กน้อย แต่สิ่งที่ฉันสามารถหาได้คือฉันต้องเพิ่ม:

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

... ถึง pom.xml ของฉัน แต่มันมีอยู่แล้ว (ในแม่pom.xml)

การกำหนดค่า<encoding>สำหรับ maven-resources-plugin หรือ maven-compiler-plugin ยังไม่สามารถแก้ไขได้

แล้วปัญหาคืออะไร

ตกลงฉันพบปัญหา

ฉันใช้ปลั๊กอินรายงานบางตัว ในเอกสารของ Failafe-maven-plugin ( 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 ประกอบด้วยตัวอักษร Scandic พวกเขาจะต้องตีความอย่างถูกต้องโดยJava ใช้สำหรับการรวบรวม (เช่นตัวอักษรสแกนดิชที่ใช้ในค่าคงที่)

แม้ไฟล์จะถูกเก็บไว้ใน UTF-8 และ Maven ก็ถูกกำหนดค่าให้ใช้ UTF-8 แต่ System Java ที่ใช้โดย Maven จะยังคงใช้ค่าเริ่มต้นของระบบ (เช่นใน Windows: cp1252)

สิ่งนี้จะปรากฏให้เห็นเฉพาะการรันการทดสอบผ่านทาง Maven (อาจจะพิมพ์ค่าของค่าคงที่เหล่านี้ในการทดสอบตัวอักษร scandic ที่พิมพ์ออกมาจะแสดงเป็น '<?>') หากไม่ได้ทดสอบอย่างถูกต้อง ไม่มีใครสังเกตเห็น

เพื่อป้องกันสิ่งนี้คุณต้องตั้งค่าJava ที่ใช้สำหรับการคอมไพล์เพื่อใช้การเข้ารหัส UTF-8 ไม่เพียงพอที่จะมีการตั้งค่าการเข้ารหัสใน maven pom.xml คุณต้องตั้งค่าตัวแปรสภาพแวดล้อม: JAVA_TOOL_OPTIONS = -Dfile.encoding = UTF8

นอกจากนี้หากใช้ Eclipse ใน Windows คุณอาจต้องตั้งค่าการเข้ารหัสที่ใช้เพิ่มเติมนอกเหนือจากนี้

หากคุณรวมคำตอบข้างต้นสุดท้าย pom.xml ที่กำหนดค่าสำหรับ UTF-8 ควรดูเหมือนว่า

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>

ดูเหมือนว่าคนผสมการเข้ารหัสเนื้อหากับการเข้ารหัสไฟล์ / ทรัพยากรที่สร้างขึ้น มีคุณสมบัติ 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 --mime 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 / การระบุรูปแบบการเข้ารหัสอักขระ