JarUtil (common-ds 2100.6.1 API)

java.lang.Object
- com.ideaaedi.commonds.jar.JarUtil

```
public final class JarUtil
extends Object
```
jar/war操作工具类

从以下版本开始:

1.0.0

作者:

JustryDeng

构造器概要

构造器
构造器和说明

JarUtil()

构造器
构造器和说明
`JarUtil()`

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static String`	`doJarWar(String srcDir, String targetJarOrWar)`
`static String`	`doJarWar(String srcDir, String targetJarOrWar, FileOrderSupport fileOrderSupport)` 把目录压缩成jar(or war)
`static byte[]`	`getFileFromZip(File zip, String fileName)` 从(zip/jar/war)压缩文件中获取一个文件的字节注：jar其实也是zip。
`static String`	`getFileFromZip(File zip, String fileName, File targetFile)` 从(zip/jar)压缩文件中获取文件注：jar其实也是zip。
`static String`	`getRootPath(String projectPath)` 获取当前类对应的其所在的classes目录全路径名（或其所在jar包/war包文件全路径名）
`static void`	`guarantyDirExist(File dir)` 保证目录存在
`static boolean`	`isJarOrWar(String originJarOrWar)` 判断originJarOrWar是jar文件还是war文件
`static Map<String,Pair<byte[],byte[]>>`	`rewriteZipEntry(ZipFile zipFile, Map<String,byte[]> replacerMap)` 修改zip文件（.java、.war文件）中的条目
`static <T extends Collection<String>> List<String>`	`unJarWar(String jarWarPath, String targetDir)` 解压jar(or war)至指定的目录
`static <T extends Collection<String>> List<String>`	`unJarWar(String jarWarPath, String targetDir, boolean delOldTargetDirIfAlreadyExist, T entryNamePrefixes)` 解压jar(or war)至指定的目录

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - JarUtil
```
public JarUtil()
```
- 方法详细资料
  - doJarWar
```
public static String doJarWar(String srcDir,
                              String targetJarOrWar)
```
    另请参阅:
    
    doJarWar(String, String, FileOrderSupport)
  - doJarWar
```
public static String doJarWar(String srcDir,
                              String targetJarOrWar,
                              FileOrderSupport fileOrderSupport)
```
    把目录压缩成jar(or war)
    
    参数:
    
    srcDir - 需要打包的目录(如 /tmp/demo-1.0.0/)
    
    targetJarOrWar - 打包出的jar/war文件路径(如 /tmp/abc.jar)
    
    fileOrderSupport - 文件排序序号提供者
    注：部分jar包会对jar包内的条目有顺序要求（如：spring-boot的jar包的lib目录下，lib包的顺序要和pom.xml中的声明顺序保持一致），此时就可以使用此字段来实现排序了。
    
    返回:
    
    打包出的jar/war文件路径
  - unJarWar
```
public static <T extends Collection<String>> List<String> unJarWar(String jarWarPath,
                                                                   String targetDir)
```
    解压jar(or war)至指定的目录
    
    另请参阅:
    
    unJarWar(String, String, boolean, Collection)
  - unJarWar
```
public static <T extends Collection<String>> List<String> unJarWar(String jarWarPath,
                                                                   String targetDir,
                                                                   boolean delOldTargetDirIfAlreadyExist,
                                                                   T entryNamePrefixes)
```
    解压jar(or war)至指定的目录
    
    参数:
    
    jarWarPath - 待解压的jar(or war)文件
    
    targetDir - 解压后文件放置的文件夹
    
    delOldTargetDirIfAlreadyExist - 若targetDir已存在，是否先将原来的targetDir进行删除
    
    entryNamePrefixes - 只有当entryName为指定的前缀时，才对该entry进行解压(若为null或者长度为0，则解压所有文件) 如: ["BOOT-INF/classes/", "BOOT-INF/classes/com/example/ssm/author/JustryDeng.class"]
    注:当entry对应jar或者war中的目录时，那么其值形如 BOOT-INF/classes/
    注:当entry对应jar或者war中的文件时，那么其值形如 BOOT-INF/classes/com/example/ssm/author/JustryDeng.class
    
    返回:
    
    （按压缩文件中条目的顺序）解压出来的（有序的）文件(包含目录)的完整路径
  - guarantyDirExist
```
public static void guarantyDirExist(File dir)
```
    保证目录存在
    
    参数:
    
    dir - 目录
  - getFileFromZip
```
public static String getFileFromZip(File zip,
                                    String fileName,
                                    File targetFile)
```
    从(zip/jar)压缩文件中获取文件
    注：jar其实也是zip。
    
    示例 String path = JarUtil.getFileFromJar("/tmp/demo.jar", "META-INF/services/com.niantou.filter.HttpExtFilter", new File("/root/HttpExtFilter.txt"));
    
    参数:
    
    zip - 压缩文件
    
    fileName - 压缩文件的(相对压缩文件的root的)相对路径文件名
    
    targetFile - 获取出来的目标文件
    
    返回:
    
    获取出来的目标文件的绝对路径
  - getFileFromZip
```
public static byte[] getFileFromZip(File zip,
                                    String fileName)
```
    从(zip/jar/war)压缩文件中获取一个文件的字节
    注：jar其实也是zip。 war虽然不是zip,但是也是可以使用压缩/解压zip的方式来进行压缩解压的。
    
    示例 byte[] bytes = JarUtil.getFileFromJar("/tmp/demo.jar", "META-INF/services/com.niantou.filter.HttpExtFilter");
    
    参数:
    
    zip - 压缩文件
    
    fileName - 压缩文件的(相对压缩文件的root的)相对路径文件名
    
    返回:
    
    文件字节（可能为null）
  - rewriteZipEntry
```
public static Map<String,Pair<byte[],byte[]>> rewriteZipEntry(ZipFile zipFile,
                                                              Map<String,byte[]> replacerMap)
                                                       throws IOException
```
    修改zip文件（.java、.war文件）中的条目
    
    参数:
    
    zipFile - 要修改的zip文件（.java、.war文件）
    
    replacerMap - 替换器(k-ZipFile中，要被替换的ZipEntry的相对路径，如：BOOT-INF/classes/application.yml; V-要替换成的内容)
    
    返回:
    
    被替换了的ZipEntry的相对路径及重写前后的内容信息
    k - ZipEntry的相对路径，如：BOOT-INF/classes/application.yml
    v - 左：重写前的内容，右：重写后的内容
    
    抛出:
    
    IOException
  - isJarOrWar
```
public static boolean isJarOrWar(String originJarOrWar)
                          throws IllegalArgumentException
```
    判断originJarOrWar是jar文件还是war文件
    
    参数:
    
    originJarOrWar - jar或者war的文件名(或全路径文件名)
    
    返回:
    
    true-jar包; false-war包
    
    抛出:
    
    IllegalArgumentException - 当originJarOrWar既不是jar文件又不是war文件时抛出
  - getRootPath
```
public static String getRootPath(String projectPath)
```
    获取当前类对应的其所在的classes目录全路径名（或其所在jar包/war包文件全路径名）
    
    参数:
    
    projectPath - 当前类对应的项目路径
    
    返回:
    
    当前类对应的其所在的classes目录全路径名（或其所在jar包/war包文件全路径名）

类 JarUtil

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

JarUtil

方法详细资料

doJarWar

doJarWar

unJarWar

unJarWar

guarantyDirExist

getFileFromZip

getFileFromZip

rewriteZipEntry

isJarOrWar

getRootPath