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

我同意这是一个bug,并将为此创建一个jira。

已添加https://clojure.atlassian.net/browse/CLJ-2533 并附上补丁。谢谢...
我认为这并不是一个bug。

关键在于java-doc中的这一点:"如果b的长度为零,则不读取任何字节,并返回0"

只有当缓冲区b的长度为零时,才不会读取字节。除非你明确想要在传递长度为0的缓冲区时产生无限循环,否则我认为实现不应该更改。
Javadoc表示如果不输入缓冲区的长度为0,则不应返回0

然而
1. 一些InputStream实现确实返回0违反了JavaDoc。例如Apache commons-compress在从某些特定的ZIP文件中提取文件时会这样做。这可能是一个bug,但这样的东西确实存在。
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、异常或缓冲区大小为零)。

Apache的copyLarge()函数在缓冲区大小为零的情况下将不能正常工作。Jetty的copy没有问题,因为它明确使用了一个非零大小的缓冲区,因此该条件不会发生。
0

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

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

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

当前的代码在遇到零时正确地停止,这将仅在传入的缓冲区大小为零时发生。

我在使用1024字节的缓冲区大小运行代码时观察到了这种读取返回值序列。因此,clojure的copy函数在读取到零时停止复制,而IOUtils和Jetty复制了整个流。InputStream来自apache的commons-compress库。因此,这里的InputStream不按照JavaDoc中的说明工作。

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