Inflater 和 Deflater 解压缩中的坑

使用 Inflater 和 Deflater 解压缩可能会踩到一个死循环的坑。

 

在网上搜索 Inflater 和 Deflater 的 demo 时，往往都会看到类似下面的写法：

注意看 7-10 行的写法，假如我传一个不完整的压缩后的数据去解压（比如 main() 方法里的），那么 7-10 行就会出现一个死循环 

　　public static byte[] uncompress(byte[] input) throws IOException, DataFormatException {
        Inflater inflater = new Inflater();
        inflater.setInput(input);
        ByteArrayOutputStream baos = new ByteArrayOutputStream(input.length);

        byte[] buff = new byte[1024];
　　　　　　 // 注意这里的写法，有死循环的风险
        while (!inflater.finished()) {
            int count = inflater.inflate(buff);
            baos.write(buff, 0, count);
        }

        baos.close();
        inflater.end();
        return baos.toByteArray();
    }

    public static byte[] compress(byte[] data) throws IOException {
        Deflater compress = new Deflater();

        compress.reset();
        compress.setInput(data);
        compress.finish();
        ByteArrayOutputStream bos = new ByteArrayOutputStream(data.length);

        byte[] buf = new byte[1024];
        while (!compress.finished()) {
            int i = compress.deflate(buf);
            bos.write(buf, 0, i);
        }
        bos.close();

        compress.end();
        return bos.toByteArray();
    }

　　　　// 用来复现死循环的例子
    public static void main(String[] args) throws IOException, DataFormatException {
        byte[] after = compress("xxxxxx".getBytes(StandardCharsets.UTF_8));
        int len = after.length - 1;
        byte[] newByte = new byte[len];
        System.arraycopy(after, 0, newByte, 0, len);
        after = uncompress(newByte);
        System.out.println(new String(after));
    }

 

所以 7-10 行的逻辑需要加一些判断，比如增加对返回值的判断，及时跳出循环

看 inflate() 方法的注释可知，当返回值是 0 时，表示需要调用 needsInput() 或者 needsDictionary() 来判断是否需要继续追加数据或者需要字典

继续看 inflate(byte[] b) -> inflate(byte[] b, int off, int len) -> inflateBytes(long addr, byte[] b, int off, int len) 的 JDK 源码注释和内容可知，当解压出现其它异常时也会返回 0，因此这里个人认为， needsInput() 或者 needsDictionary()  均为 false 时，也有概率返回 0。

　　　　while (!inflater.finished()) {
            int count = inflater.inflate(buff);
            if (count == 0) {
                break;
            }
            baos.write(buff, 0, count);
        }

 

综上，虽然网上这两工具类的 demo 都基本一样，但都还是有风险的，需要多加小心

外网有帖子提到过这个问题：Java Inflater will loop infinitely sometimes