Maven 常用技巧总结

1. 设置 Java JDK 的版本为「JDK 1.8」

可以修改 pom.xml 添加如下语句实现使用 Java 8 语言特性，共有两种方式，可任选其一：

1.1 添加 property

  [...]
  
    1.8
    1.8
  
  [...]

1.2 直接配置插件

  [...]
  
    [...]
    
      
        org.apache.maven.plugins
        maven-compiler-plugin
        3.6.1
        
          1.8
          1.8
        
      
    
    [...]
  
  [...]

2. Maven 构建生成可执行的 Jar

2.1 简单构建可执行的 Jar

  [...]
  
    [...]
    
      
        maven-assembly-plugin
        3.0.0
        
          [...]
          
            
              org.sample.App
            
          
        
        [...]
      
      [...]

此时可使用如下命令构建可执行 Jar

mvn assembly:single

2.2 将 Assembly 的 single 目标绑定到项目的构建生命周期中

可在 pom.xml 文件中添加如下内容：

    
  [...]              
          
    [...]                            
    
        
          maven-assembly-plugin
          3.0.0
          
            
            true
            
            
              
                cc.bitky.fx.Main
              
            
            
            
              jar-with-dependencies
            
          
          
            
              make-assembly
              
              package
              
              
                single
              
            
          
        
      
    [...]  
  

之后，为了生成项目的 Jar 文件，可以简单地执行如下生命周期阶段命令：

mvn package

构建完毕后，可以看到已经生成了类似于以下名字的文件：

target / sample-1.0-SNAPSHOT-jar-with-dependencies.jar

target / sample-1.0.jar

appendAssemblyId: 控制是否在已生成的文件的文件名中包含「ssembly id」。

execution: 用于将 maven-assembly-plugin 集成至标准的 Maven 构建生命周期中，此时执行 maven package 时就会执行指定的操作，从而实现自定义打包。

2.3 Assembly 插件的 Maven Goals

• assembly:assembly: 「已弃用」会自动执行 package 生命周期。
• assembly:single: 仅会装配成 jar-with-dependencies，我们不想让 package 阶段运行两次 package，所以配置为这个。

3. 可执行 Jar 文件执行时出现乱码

使用 Maven 生成的可执行 Jar 文件，在 cmd 中执行时出现乱码，项目编码统一为 UTF-8，日志使用 SLF4J 框架。

3.1 方法 1：windows 默认使用 GBK 编码，执行 Jar 时动态指定编码

运行 java -jar 命令时添加参数

-Dfile.encoding=UTF-8 

格式如下：

java -jar -Dfile.encoding=UTF-8 simpler.jar 

或添加环境变量：

JAVA_TOOL_OPTIONS = -Dfile.encoding=UTF-8

3.2 使用临时的活动代码页运行

在控制台执行命令：

chcp 65001

可将当前 cmd 的编码临时变为 UTF-8，执行 chcp 命令可显示当前 cmd 的编码。

4. Maven 中读取资源文件

在 Maven 项目的根目录下，有如下必要的目录结构:

• src
  • main
    • resources「存放一些资源文件」
    • java
  • test
    • resources「存放一些资源文件」
    • java
• pom.xml

在项目的 compile 时期，所有的资源文件和 .class 文件均被复制到 target/classes/ 目录中，获取资源文件，可参考如下语句：

1. this.getClass().getResource（""）
   //得到的是当前类 class 文件所在的目录 URL。

2. this.getClass().getResource（"/"）
3. this.getClass().getClassLoader().getResource（""）
4. ClassLoader.getSystemResource（""）
5. Thread.currentThread().getContextClassLoader().getResource（""）
   //得到的是当前 ClassPath 的绝对 URI 路径。

所以，如若想要获取 resources 文件夹中的资源文件 ky.xml，可使用如下语句之一：

getClass().getClassLoader().getResource("ky.xml")
getClass().getResource("/ky.xml")

5. 参考资料

1. Setting the -source and -target of the Java Compiler
2. 关于 Apache Maven 您不知道的 5 件事
3. Maven 打包可执行 Jar 的方法
4. 关于创建可执行的 Jar 文件
5. 初学 Maven - 使用 Assembly Plugin 实现自定义打包
6. JavaFX and maven: NullPointerException: Location is required
7. Java 获取文件的路径
8. Maven 项目打包成 Jar 后执行日志乱码
9. Console 输出 UTF-8