Java IO 四大附加接口、try-with-resource

Java IO 四大附加接口、try-with-resource

@author ixenos

四大附加接口 Closeable、Flushable、Readable、Appendable

---

Closeable：

　　void close() throws IOException 关闭此流并释放与此流关联的所有系统资源

　　java.io.closeable扩展了java.lang.AutoCloseable，因此，对任何Closeable进行操作时，都可以使用try-with-resources语句

• try-with-resources 可以声明一个或多个资源，资源之间用分号隔开。

• try (
          java.util.zip.ZipFile zf = new java.util.zip.ZipFile(zipFileName);
          java.io.BufferedWriter writer = java.nio.file.Files.newBufferedWriter(outputFilePath, charset)
        ) {
              ...
        }

　　有关 try-with-resource 特性的具体分析请见下文。

Flushable：

　　void flush() 将所有已缓冲输出写入底层流

Readable：

　　int read(CharBuffer cb) 形参中的CharBuffer类拥有按顺序和随机地进行读写访问的方法，它表示一个内存中的缓冲区或者一个内存映像（虚拟内存）的文件

　　

Appendable：

　　Appendable append(char c) 添加的单个字符

　　Appendable append(CharSequence s) 添加字符序列，CharSequence接口描述了一个char值序列的基本属性，String、CharBuffer、StringBuffer、StringBuilder都实现了CharSequence，所以可以传入这些类型的对象

　　以上两个方法，都返回this

四大IO抽象类与附加接口的关系

---

1、InputStream、OutputStream、Reader、Writer都实现了Closeable和AutoCloseable接口，因此，都可以使用 try-with-resources 语句

2、OutputStream、Writer实现了Flushable接口

3、Reader实现了Readable接口

4、Writer实现了Appendable接口

try-with-resource

---

try-with-resource 是Java SE 7 加入AutoCloseable接口后才有的，closeable接口继承了AutoCloseable接口。

　　AutoCloseable接口规定了自动关闭资源：

The close() method of an AutoCloseable object is called automatically when exiting a try-with-resources block for which the object has been declared in the resource specification header.

1、这个所谓的try-with-resources，是个语法糖。实际上就是自动调用资源的close()函数。

public class TryStudy implements AutoCloseable{  
    static void test() throws Exception {  
        try(TryStudy tryStudy = new TryStudy()){  
            System.out.println(tryStudy);  
        }  
    }  
    @Override  
    public void close() throws Exception {  
    }  
}  

2、可以在一个 try-with-resources 语句中声明一个或多个资源(用分号隔开)，但要注意资源的 close 方法调用顺序与它们的创建顺序相反 

try (
        java.util.zip.ZipFile zf = new java.util.zip.ZipFile(zipFileName);
        java.io.BufferedWriter writer = java.nio.file.Files.newBufferedWriter(outputFilePath, charset)
      ) 

　　资源的close方法在JVM中的调用顺序是: writer.close()   zf.close()

3、下面从编绎器生成的字节码来分析下，try-with-resources到底是怎样工作的：

　　TryStudy实现了AutoCloseable接口，下面来看下test函数的字节码：

static test()V throws java/lang/Exception   
  TRYCATCHBLOCK L0 L1 L2   
  TRYCATCHBLOCK L3 L4 L4   
 L5  
  LINENUMBER 21 L5  
  ACONST_NULL  
  ASTORE 0  
  ACONST_NULL  
  ASTORE 1  
 L3  
  NEW TryStudy  
  DUP  
  INVOKESPECIAL TryStudy.<init> ()V  
  ASTORE 2  
 L0  
  LINENUMBER 22 L0  
  GETSTATIC java/lang/System.out : Ljava/io/PrintStream;  
  ALOAD 2  
  INVOKEVIRTUAL java/io/PrintStream.println (Ljava/lang/Object;)V  
 L1  
  LINENUMBER 23 L1  
  ALOAD 2  
  IFNULL L6  
  ALOAD 2  
  INVOKEVIRTUAL TryStudy.close ()V  
  GOTO L6  
 L2  
 FRAME FULL [java/lang/Throwable java/lang/Throwable TryStudy] [java/lang/Throwable]  
  ASTORE 0  
  ALOAD 2  
  IFNULL L7  
  ALOAD 2  
  INVOKEVIRTUAL TryStudy.close ()V  
 L7  
 FRAME CHOP 1  
  ALOAD 0  
  ATHROW  
 L4  
 FRAME SAME1 java/lang/Throwable  
  ASTORE 1  
  ALOAD 0  
  IFNONNULL L8  
  ALOAD 1  
  ASTORE 0  
  GOTO L9  
 L8  
 FRAME SAME  
  ALOAD 0  
  ALOAD 1  
  IF_ACMPEQ L9  
  ALOAD 0  
  ALOAD 1  
  INVOKEVIRTUAL java/lang/Throwable.addSuppressed (Ljava/lang/Throwable;)V  
 L9  
 FRAME SAME  
  ALOAD 0  
  ATHROW  
 L6  
  LINENUMBER 24 L6  
 FRAME CHOP 2  
  RETURN  
  LOCALVARIABLE tryStudy LTryStudy; L0 L7 2  
  MAXSTACK = 2  
  MAXLOCALS = 3  

从字节码里可以看出，的确是有判断tryStudy对象是否为null，如果不是null，则调用close函数进行资源回收。

try-with-resource与异常捕获

---

1、从 被丢弃 到 被抑制 的异常 Suppressed Exceptions

　　再仔细分析，可以发现有一个Throwable.addSuppressed的调用，那么这个调用是什么呢？

　　使用了try-catch语句之后(try-with-resource也算是try-catch)，有可能会出现两种异常，一个是try块里的异常，一个是调用close函数里抛出的异常。

　　a) 在JDK1.7 以前，一旦finally块抛出了close函数里的异常，前面try块catch的异常被丢弃了！

　　b) 而在 try-with-resources 语句中，如果在调用close函数时出现异常（注意这个前提），那么前面的异常就被称为Suppressed Exceptions，因此Throwable还有个addSuppressed函数可以把它们保存起来，当用户捕捉到close里抛出的异常时，就可以调用Throwable.getSuppressed函数来取出close之前的异常了。

2、注意:

　　 一个 try-with-resources 语句可以像普通的 try 语句那样有 catch 和 finally 块。

　　但是在try-with-resources 语句中, 任意的 catch 或者 finally 块都是在声明的资源被关闭以后才运行。

3、catch多种异常，但抛出一种异常时

　　在JDK1.7之前catch多个异常是这样的：

        try{
        //逻辑代码
        }catch (IOException ex) {
             logger.log(ex);
             throw new SpecialException();
        catch (SQLException ex) {
             logger.log(ex);
             throw new SpecialException();
        }

从上述代码中可以看出这样写非常的难看，并且会出现许多重复的代码。

JDK1.7及以后可以这样：

        try{
        //逻辑代码
        }catch (IOException | SQLException ex) {
             logger.log(ex);
             throw new SpecialException();
        }

注：上面例子中的ex是隐式的final不可以在catch块中改变ex。

 4、在JDK1.7以前的版本，在方法声明中声明抛出的异常如果在方法体内没有抛出时不被允许的，如下：

static class FirstException extends Exception { 
    
}

static class SecondException extends Exception {
    
}

public void rethrowException(String exceptionName) throws Exception {
    
  try {
      
    if (exceptionName.equals("First")) {
        //如果异常名称为"First"，则抛出异常一
      throw new FirstException();
      
    } else {
        //否则的话，则抛出异常二
      throw new SecondException();
      
    }
    
  } catch (Exception e) {
      
    throw e;
  }
}

JDK1.7及以后版本：

static class FirstException extends Exception { 
    
}

static class SecondException extends Exception {
    
}

public void rethrowException(String exceptionName) throws Exception, FirstException, SecondException {
    try {
      // 逻辑代码
    }catch (Exception e) {
        
      throw e;
    }
}