2024 年 Clojure 状况调查中分享您的想法!

欢迎!请查看 关于 页面以获取有关该功能更多信息。

0
IO

我在 clojure.java.io/copy 函数的实现中发现了奇怪的行为

https://github.com/clojure/clojure/blob/ee1b606ad066ac8df2efd4a6b8d0d365c206f5bf/src/clj/clojure/java/io.clj#L391

(defn copy
  "Copies input to output.  Returns nil or throws IOException.
  Input may be an InputStream, Reader, File, byte[], char[], or String.
  Output may be an OutputStream, Writer, or File.
  Options are key/value pairs and may be one of
    :buffer-size  buffer size to use, default is 1024.
    :encoding     encoding to use if converting between
                  byte and char streams.   
  Does not close any streams except those it opens itself 
  (on a File)."
  {:added "1.2"}
  [input output & opts]
  (do-copy input output (when opts (apply hash-map opts))))

实际复制是在这里实现的,当从一个 InputStream 复制到 OutputStream 时。

https://github.com/clojure/clojure/blob/ee1b606ad066ac8df2efd4a6b8d0d365c206f5bf/src/clj/clojure/java/io.clj#L306

(defmethod do-copy [InputStream OutputStream] [^InputStream input ^OutputStream output opts]
  (let [buffer (make-array Byte/TYPE (buffer-size opts))]
    (loop []
      (let [size (.read input buffer)]  ;;; XXX point 1
        (when (pos? size)               ;;; XXX point 2
          (do (.write output buffer 0 size)
              (recur)))))))

这里点1处的 .read 函数为 https://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html#read(byte[])

JavaDoc 说明如下

从输入流中读取一些字节并将其存储到缓冲区数组 b 中。实际读取的字节数作为整数返回。此方法会阻塞直到输入数据可用,检测到文件末尾或抛出异常。
如果 b 的长度为零,则不读取字节并返回 0;否则,将尝试读取至少一个字节。如果没有字节可供读取,因为流已到达文件末尾,则返回 -1;否则,至少读取一个字节并存储到 b 中。

这意味着返回值 -1 表示流结束,返回值 0 并不表示流结束。然而,上述代码点2处的条件,当 .read 返回的值小于1时,停止递归。

现在考虑这样一个情况,.read 在连续调用中返回以下序列值

1024, 0, 1024, 201, -1

clojure.java/io 只复制了前 1024 字节,而整个流有 2249 字节。这是预期行为吗?点1处的条件应该是 (not (neg? size)) 吗?

我把这个问题也发到了 google groups: https://groups.google.com/forum/#!topic/clojure/XzpPPXXhgM4

2 答案

+1

我同意这是错误,并将为此创建Jira。

添加了https://clojure.atlassian.net/browse/CLJ-2533并附带了补丁。谢谢...
我认为这没有错误。

关键点在于这部分java-doc中的描述:"如果b的长度为零,则读取字节并返回0"

只有当缓冲区b的长度为零时,才不会读取字节。在我看来,除非您明确想要无限循环,否则实现不应被修改。
javadoc表示应该不返回0,除非输入缓冲区的长度为0。

但是
1. 有些InputStream实现实际上返回0,违反JavaDoc。例如,当从某些特定的ZIP文件中提取文件时,Apache Commons Compress就是这样做的。这可能是错误,但这类事情确实存在。
2. 其他InputStream->OutputStream复制实现会读取流,直到接收到-1为止。例如
     -  https://github.com/apache/commons-io/blob/master/src/main/java/org/apache/commons/io/IOUtils.java#L1083
     - https://github.com/eclipse/jetty.project/blob/9706d70484863a014d3604e5e7cb4af40aa4cb1e/jetty-util/src/main/java/org/eclipse/jetty/util/IO.java#L161
clojure.java.io/copy必须以某种方式处理`0`,这是一个灰色区域,两种方式均不是规范意义上的更好选择。
查看我的回答。文档非常清晰地指出:a) 该方法会阻塞,直到输入数据可用(或EOF或发生异常);b) 至少会读取一个字节并将其存储到b中(除非EOF、异常或缓冲区大小为零)。

Apollo copyLarge() 函数对于大小为零的缓冲区无法正确工作。Jetty的复制很好,因为它明确使用非零大小的缓冲区,从而确保该条件永远不会发生。
0

我认为你可能误解了文档。关键部分是这里

该方法会阻塞,直到输入数据可用,…… …;否则,
至少会读取一个字节并存储到b中。

因此,它永远不会读取零字节,**除非缓冲区大小为零**。

当前的代码在读取到零时停止是正确的——(仅)当传入的缓冲区大小为零时才会发生这种情况。

我在使用1024个字节的缓冲区运行代码时观察到了以下读值序列。因此,这里的Clojure的copy函数在读取到零时停止复制,而IOUtils ja Jetty复制了整个流。InputStream来自apache.commons-compress。因此,这里的InputStream并没有按照JavaDoc说明的情况工作。

      ...,1024,0,1024, ..., -1
正如我所说的:Apollo的代码是有问题的。
by
https://issues.apache.org/jira/browse/COMPRESS-491 这里是apache库中的问题。
...