首页 > 开发 > Java > 正文

Java 中的Printstream介绍_动力节点Java学院整理

2024-07-13 10:07:56
字体:
来源:转载
供稿:网友

PrintStream 介绍

PrintStream 是打印输出流,它继承于FilterOutputStream。

PrintStream 是用来装饰其它输出流。它能为其他输出流添加了功能,使它们能够方便地打印各种数据值表示形式。

与其他输出流不同,PrintStream 永远不会抛出 IOException;它产生的IOException会被自身的函数所捕获并设置错误标记, 用户可以通过 checkError() 返回错误标记,从而查看PrintStream内部是否产生了IOException。
另外,PrintStream 提供了自动flush 和 字符集设置功能。所谓自动flush,就是往PrintStream写入的数据会立刻调用flush()函数。

PrintStream 函数列表 

/*  * 构造函数 */// 将“输出流out”作为PrintStream的输出流,不会自动flush,并且采用默认字符集// 所谓“自动flush”,就是每次执行print(), println(), write()函数,都会调用flush()函数;// 而“不自动flush”,则需要我们手动调用flush()接口。PrintStream(OutputStream out)// 将“输出流out”作为PrintStream的输出流,自动flush,并且采用默认字符集。PrintStream(OutputStream out, boolean autoFlush)// 将“输出流out”作为PrintStream的输出流,自动flush,采用charsetName字符集。PrintStream(OutputStream out, boolean autoFlush, String charsetName)// 创建file对应的FileOutputStream,然后将该FileOutputStream作为PrintStream的输出流,不自动flush,采用默认字符集。PrintStream(File file)// 创建file对应的FileOutputStream,然后将该FileOutputStream作为PrintStream的输出流,不自动flush,采用charsetName字符集。PrintStream(File file, String charsetName)// 创建fileName对应的FileOutputStream,然后将该FileOutputStream作为PrintStream的输出流,不自动flush,采用默认字符集。PrintStream(String fileName)// 创建fileName对应的FileOutputStream,然后将该FileOutputStream作为PrintStream的输出流,不自动flush,采用charsetName字符集。PrintStream(String fileName, String charsetName)// 将“字符c”追加到“PrintStream输出流中”PrintStream  append(char c)// 将“字符序列从start(包括)到end(不包括)的全部字符”追加到“PrintStream输出流中”PrintStream  append(CharSequence charSequence, int start, int end)// 将“字符序列的全部字符”追加到“PrintStream输出流中”PrintStream  append(CharSequence charSequence)// flush“PrintStream输出流缓冲中的数据”,并检查错误boolean  checkError()// 关闭“PrintStream输出流”synchronized void  close()// flush“PrintStream输出流缓冲中的数据”。// 例如,PrintStream装饰的是FileOutputStream,则调用flush时会将数据写入到文件中synchronized void  flush()// 根据“Locale值(区域属性)”来格式化数据PrintStream  format(Locale l, String format, Object... args)// 根据“默认的Locale值(区域属性)”来格式化数据PrintStream  format(String format, Object... args)// 将“float数据f对应的字符串”写入到“PrintStream输出流”中,print实际调用的是write函数void  print(float f)// 将“double数据d对应的字符串”写入到“PrintStream输出流”中,print实际调用的是write函数void  print(double d)// 将“字符串数据str”写入到“PrintStream输出流”中,print实际调用的是write函数synchronized void  print(String str)// 将“对象o对应的字符串”写入到“PrintStream输出流”中,print实际调用的是write函数void  print(Object o)// 将“字符c对应的字符串”写入到“PrintStream输出流”中,print实际调用的是write函数void  print(char c)// 将“字符数组chars对应的字符串”写入到“PrintStream输出流”中,print实际调用的是write函数void  print(char[] chars)// 将“long型数据l对应的字符串”写入到“PrintStream输出流”中,print实际调用的是write函数void  print(long l)// 将“int数据i对应的字符串”写入到“PrintStream输出流”中,print实际调用的是write函数void  print(int i)// 将“boolean数据b对应的字符串”写入到“PrintStream输出流”中,print实际调用的是write函数void  print(boolean b)// 将“数据args”根据“Locale值(区域属性)”按照format格式化,并写入到“PrintStream输出流”中PrintStream  printf(Locale l, String format, Object... args)// 将“数据args”根据“默认Locale值(区域属性)”按照format格式化,并写入到“PrintStream输出流”中PrintStream  printf(String format, Object... args)// 将“换行符”写入到“PrintStream输出流”中,println实际调用的是write函数void  println()// 将“float数据对应的字符串+换行符”写入到“PrintStream输出流”中,println实际调用的是write函数void  println(float f)// 将“int数据对应的字符串+换行符”写入到“PrintStream输出流”中,println实际调用的是write函数void  println(int i)// 将“long数据对应的字符串+换行符”写入到“PrintStream输出流”中,println实际调用的是write函数void  println(long l)// 将“对象o对应的字符串+换行符”写入到“PrintStream输出流”中,println实际调用的是write函数void  println(Object o)// 将“字符数组chars对应的字符串+换行符”写入到“PrintStream输出流”中,println实际调用的是write函数void  println(char[] chars)// 将“字符串str+换行符”写入到“PrintStream输出流”中,println实际调用的是write函数synchronized void  println(String str)// 将“字符c对应的字符串+换行符”写入到“PrintStream输出流”中,println实际调用的是write函数void  println(char c)// 将“double数据对应的字符串+换行符”写入到“PrintStream输出流”中,println实际调用的是write函数void  println(double d)// 将“boolean数据对应的字符串+换行符”写入到“PrintStream输出流”中,println实际调用的是write函数void  println(boolean b)// 将数据oneByte写入到“PrintStream输出流”中。oneByte虽然是int类型,但实际只会写入一个字节synchronized void  write(int oneByte)// 将“buffer中从offset开始的length个字节”写入到“PrintStream输出流”中。void  write(byte[] buffer, int offset, int length)

注意:print()和println()都是将其中参数转换成字符串之后,再写入到输入流。

例如,

print(0x61); 

等价于

write(String.valueOf(0x61));

上面语句是将字符串"97"写入到输出流。0x61对应十进制数是97。

write(0x61)

上面语句是将字符'a'写入到输出流。因为0x61对应的ASCII码的字母'a'。

查看下面的代码,我们能对这些函数有更清晰的认识! 

PrintStream 源码分析(基于jdk1.7.40) 

 package java.io; import java.util.Formatter; import java.util.Locale; import java.nio.charset.Charset; import java.nio.charset.IllegalCharsetNameException; import java.nio.charset.UnsupportedCharsetException; public class PrintStream extends FilterOutputStream  implements Appendable, Closeable {  // 自动flush  // 所谓“自动flush”,就是每次执行print(), println(), write()函数,都会调用flush()函数;  // 而“不自动flush”,则需要我们手动调用flush()接口。  private final boolean autoFlush;  // PrintStream是否右产生异常。当PrintStream有异常产生时,会被本身捕获,并设置trouble为true  private boolean trouble = false;  // 用于格式化的对象  private Formatter formatter;  // BufferedWriter对象,用于实现“PrintStream支持字符集”。  // 因为PrintStream是OutputStream的子类,所以它本身不支持字符串;  // 但是BufferedWriter支持字符集,因此可以通过OutputStreamWriter创建PrintStream对应的BufferedWriter对象,从而支持字符集。  private BufferedWriter textOut;  private OutputStreamWriter charOut;  private static <T> T requireNonNull(T obj, String message) {   if (obj == null)    throw new NullPointerException(message);   return obj;  }  // 返回csn对应的字符集对象  private static Charset toCharset(String csn)   throws UnsupportedEncodingException  {   requireNonNull(csn, "charsetName");   try {    return Charset.forName(csn);   } catch (IllegalCharsetNameException|UnsupportedCharsetException unused) {    // UnsupportedEncodingException should be thrown    throw new UnsupportedEncodingException(csn);   }  }  // 将“输出流out”作为PrintStream的输出流,autoFlush的flush模式,并且采用默认字符集。  private PrintStream(boolean autoFlush, OutputStream out) {   super(out);   this.autoFlush = autoFlush;   this.charOut = new OutputStreamWriter(this);   this.textOut = new BufferedWriter(charOut);  }  // 将“输出流out”作为PrintStream的输出流,自动flush,采用charsetName字符集。  private PrintStream(boolean autoFlush, OutputStream out, Charset charset) {   super(out);   this.autoFlush = autoFlush;   this.charOut = new OutputStreamWriter(this, charset);   this.textOut = new BufferedWriter(charOut);  }  // 将“输出流out”作为PrintStream的输出流,自动flush,采用charsetName字符集。  private PrintStream(boolean autoFlush, Charset charset, OutputStream out)   throws UnsupportedEncodingException  {   this(autoFlush, out, charset);  }  // 将“输出流out”作为PrintStream的输出流,不会自动flush,并且采用默认字符集  public PrintStream(OutputStream out) {   this(out, false);  }  // 将“输出流out”作为PrintStream的输出流,自动flush,并且采用默认字符集。  public PrintStream(OutputStream out, boolean autoFlush) {   this(autoFlush, requireNonNull(out, "Null output stream"));  }  // 将“输出流out”作为PrintStream的输出流,自动flush,采用charsetName字符集。  public PrintStream(OutputStream out, boolean autoFlush, String encoding)   throws UnsupportedEncodingException  {   this(autoFlush,    requireNonNull(out, "Null output stream"),    toCharset(encoding));  }  // 创建fileName对应的FileOutputStream,然后将该FileOutputStream作为PrintStream的输出流,不自动flush,采用默认字符集。  public PrintStream(String fileName) throws FileNotFoundException {   this(false, new FileOutputStream(fileName));  }  // 创建fileName对应的FileOutputStream,然后将该FileOutputStream作为PrintStream的输出流,不自动flush,采用charsetName字符集。  public PrintStream(String fileName, String csn)   throws FileNotFoundException, UnsupportedEncodingException  {   // ensure charset is checked before the file is opened   this(false, toCharset(csn), new FileOutputStream(fileName));  }  // 创建file对应的FileOutputStream,然后将该FileOutputStream作为PrintStream的输出流,不自动flush,采用默认字符集。  public PrintStream(File file) throws FileNotFoundException {   this(false, new FileOutputStream(file));  }  // 创建file对应的FileOutputStream,然后将该FileOutputStream作为PrintStream的输出流,不自动flush,采用csn字符集。  public PrintStream(File file, String csn)   throws FileNotFoundException, UnsupportedEncodingException  {   // ensure charset is checked before the file is opened   this(false, toCharset(csn), new FileOutputStream(file));  }  private void ensureOpen() throws IOException {   if (out == null)    throw new IOException("Stream closed");  }  // flush“PrintStream输出流缓冲中的数据”。  // 例如,PrintStream装饰的是FileOutputStream,则调用flush时会将数据写入到文件中  public void flush() {   synchronized (this) {    try {     ensureOpen();     out.flush();    }    catch (IOException x) {     trouble = true;    }   }  }  private boolean closing = false; /* To avoid recursive closing */  // 关闭PrintStream  public void close() {   synchronized (this) {    if (! closing) {     closing = true;     try {      textOut.close();      out.close();     }     catch (IOException x) {      trouble = true;     }     textOut = null;     charOut = null;     out = null;    }   }  }  // flush“PrintStream输出流缓冲中的数据”,并检查错误  public boolean checkError() {   if (out != null)    flush();   if (out instanceof java.io.PrintStream) {    PrintStream ps = (PrintStream) out;    return ps.checkError();   }   return trouble;  }  protected void setError() {   trouble = true;  }  protected void clearError() {   trouble = false;  }  // 将数据b写入到“PrintStream输出流”中。b虽然是int类型,但实际只会写入一个字节  public void write(int b) {   try {    synchronized (this) {     ensureOpen();     out.write(b);     if ((b == '/n') && autoFlush)      out.flush();    }   }   catch (InterruptedIOException x) {    Thread.currentThread().interrupt();   }   catch (IOException x) {    trouble = true;   }  }  // 将“buf中从off开始的length个字节”写入到“PrintStream输出流”中。  public void write(byte buf[], int off, int len) {   try {    synchronized (this) {     ensureOpen();     out.write(buf, off, len);     if (autoFlush)      out.flush();    }   }   catch (InterruptedIOException x) {    Thread.currentThread().interrupt();   }   catch (IOException x) {    trouble = true;   }  }  // 将“buf中的全部数据”写入到“PrintStream输出流”中。  private void write(char buf[]) {   try {    synchronized (this) {     ensureOpen();     textOut.write(buf);     textOut.flushBuffer();     charOut.flushBuffer();     if (autoFlush) {      for (int i = ; i < buf.length; i++)       if (buf[i] == '/n')        out.flush();     }    }   }   catch (InterruptedIOException x) {    Thread.currentThread().interrupt();   }   catch (IOException x) {    trouble = true;   }  }  // 将“字符串s”写入到“PrintStream输出流”中。  private void write(String s) {   try {    synchronized (this) {     ensureOpen();     textOut.write(s);     textOut.flushBuffer();     charOut.flushBuffer();     if (autoFlush && (s.indexOf('/n') >= ))      out.flush();    }   }   catch (InterruptedIOException x) {    Thread.currentThread().interrupt();   }   catch (IOException x) {    trouble = true;   }  }  // 将“换行符”写入到“PrintStream输出流”中。  private void newLine() {   try {    synchronized (this) {     ensureOpen();     textOut.newLine();     textOut.flushBuffer();     charOut.flushBuffer();     if (autoFlush)      out.flush();    }   }   catch (InterruptedIOException x) {    Thread.currentThread().interrupt();   }   catch (IOException x) {    trouble = true;   }  }  // 将“boolean数据对应的字符串”写入到“PrintStream输出流”中,print实际调用的是write函数  public void print(boolean b) {   write(b ? "true" : "false");  }  // 将“字符c对应的字符串”写入到“PrintStream输出流”中,print实际调用的是write函数  public void print(char c) {   write(String.valueOf(c));  }  // 将“int数据i对应的字符串”写入到“PrintStream输出流”中,print实际调用的是write函数  public void print(int i) {   write(String.valueOf(i));  }  // 将“long型数据l对应的字符串”写入到“PrintStream输出流”中,print实际调用的是write函数  public void print(long l) {   write(String.valueOf(l));  }  // 将“float数据f对应的字符串”写入到“PrintStream输出流”中,print实际调用的是write函数  public void print(float f) {   write(String.valueOf(f));  }  // 将“double数据d对应的字符串”写入到“PrintStream输出流”中,print实际调用的是write函数  public void print(double d) {   write(String.valueOf(d));  }  // 将“字符数组s”写入到“PrintStream输出流”中,print实际调用的是write函数  public void print(char s[]) {   write(s);  }  // 将“字符串数据s”写入到“PrintStream输出流”中,print实际调用的是write函数  public void print(String s) {   if (s == null) {    s = "null";   }   write(s);  }  // 将“对象obj对应的字符串”写入到“PrintStream输出流”中,print实际调用的是write函数  public void print(Object obj) {   write(String.valueOf(obj));  }  // 将“换行符”写入到“PrintStream输出流”中,println实际调用的是write函数  public void println() {   newLine();  }  // 将“boolean数据对应的字符串+换行符”写入到“PrintStream输出流”中,println实际调用的是write函数  public void println(boolean x) {   synchronized (this) {    print(x);    newLine();   }  }  // 将“字符x对应的字符串+换行符”写入到“PrintStream输出流”中,println实际调用的是write函数  public void println(char x) {   synchronized (this) {    print(x);    newLine();   }  }  // 将“int数据对应的字符串+换行符”写入到“PrintStream输出流”中,println实际调用的是write函数  public void println(int x) {   synchronized (this) {    print(x);    newLine();   }  }  // 将“long数据对应的字符串+换行符”写入到“PrintStream输出流”中,println实际调用的是write函数  public void println(long x) {   synchronized (this) {    print(x);    newLine();   }  }  // 将“float数据对应的字符串+换行符”写入到“PrintStream输出流”中,println实际调用的是write函数  public void println(float x) {   synchronized (this) {    print(x);    newLine();   }  }  // 将“double数据对应的字符串+换行符”写入到“PrintStream输出流”中,println实际调用的是write函数  public void println(double x) {   synchronized (this) {    print(x);    newLine();   }  }  // 将“字符数组x+换行符”写入到“PrintStream输出流”中,println实际调用的是write函数  public void println(char x[]) {   synchronized (this) {    print(x);    newLine();   }  }  // 将“字符串x+换行符”写入到“PrintStream输出流”中,println实际调用的是write函数  public void println(String x) {   synchronized (this) {    print(x);    newLine();   }  }  // 将“对象o对应的字符串+换行符”写入到“PrintStream输出流”中,println实际调用的是write函数  public void println(Object x) {   String s = String.valueOf(x);   synchronized (this) {    print(s);    newLine();   }  }  // 将“数据args”根据“默认Locale值(区域属性)”按照format格式化,并写入到“PrintStream输出流”中  public PrintStream printf(String format, Object ... args) {   return format(format, args);  }  // 将“数据args”根据“Locale值(区域属性)”按照format格式化,并写入到“PrintStream输出流”中  public PrintStream printf(Locale l, String format, Object ... args) {   return format(l, format, args);  }  // 根据“默认的Locale值(区域属性)”来格式化数据  public PrintStream format(String format, Object ... args) {   try {    synchronized (this) {     ensureOpen();     if ((formatter == null)      || (formatter.locale() != Locale.getDefault()))      formatter = new Formatter((Appendable) this);     formatter.format(Locale.getDefault(), format, args);    }   } catch (InterruptedIOException x) {    Thread.currentThread().interrupt();   } catch (IOException x) {    trouble = true;   }   return this;  }  // 根据“Locale值(区域属性)”来格式化数据  public PrintStream format(Locale l, String format, Object ... args) {   try {    synchronized (this) {     ensureOpen();     if ((formatter == null)      || (formatter.locale() != l))      formatter = new Formatter(this, l);     formatter.format(l, format, args);    }   } catch (InterruptedIOException x) {    Thread.currentThread().interrupt();   } catch (IOException x) {    trouble = true;   }   return this;  }  // 将“字符序列的全部字符”追加到“PrintStream输出流中”  public PrintStream append(CharSequence csq) {   if (csq == null)    print("null");   else    print(csq.toString());   return this;  }  // 将“字符序列从start(包括)到end(不包括)的全部字符”追加到“PrintStream输出流中”  public PrintStream append(CharSequence csq, int start, int end) {   CharSequence cs = (csq == null ? "null" : csq);   write(cs.subSequence(start, end).toString());   return this;  }  // 将“字符c”追加到“PrintStream输出流中”  public PrintStream append(char c) {   print(c);   return this;  } }

说明:

PrintStream的源码比较简单,请上文的注释进行阅读。若有不明白的地方,建议先看看后面的PrintStream使用示例;待搞清它的作用和用法之后,再来阅读源码。

PrintStream和DataOutputStream异同点

相同点:都是继承与FileOutputStream,用于包装其它输出流。

不同点:

(01) PrintStream和DataOutputStream 都可以将数据格式化输出;但它们在“输出字符串”时的编码不同。

       PrintStream是输出时采用的是用户指定的编码(创建PrintStream时指定的),若没有指定,则采用系统默认的字符编码。而DataOutputStream则采用的是UTF-8。

(02) 它们的写入数据时的异常处理机制不同。

       DataOutputStream在通过write()向“输出流”中写入数据时,若产生IOException,会抛出。

       而PrintStream在通过write()向“输出流”中写入数据时,若产生IOException,则会在write()中进行捕获处理;并设置trouble标记(用于表示产生了异常)为true。用户可以通过checkError()返回trouble值,从而检查输出流中是否产生了异常。

(03) 构造函数不同

       DataOutputStream的构造函数只有一个:DataOutputStream(OutputStream out)。即它只支持以输出流out作为“DataOutputStream的输出流”。

       而PrintStream的构造函数有许多:和DataOutputStream一样,支持以输出流out作为“PrintStream输出流”的构造函数;还支持以“File对象”或者“String类型的文件名对象”的构造函数。
       而且,在PrintStream的构造函数中,能“指定字符集”和“是否支持自动flush()操作”。

(04) 目的不同

       DataOutputStream的作用是装饰其它的输出流,它和DataInputStream配合使用:允许应用程序以与机器无关的方式从底层输入流中读写java数据类型。

       而PrintStream的作用虽然也是装饰其他输出流,但是它的目的不是以与机器无关的方式从底层读写java数据类型;而是为其它输出流提供打印各种数据值表示形式,使其它输出流能方便的通过print(), println()或printf()等输出各种格式的数据。

示例代码

关于PrintStream中API的详细用法,参考示例代码(PrintStreamTest.java):    

import java.io.PrintStream; import java.io.File; import java.io.FileOutputStream; import java.io.IOException; /** * PrintStream 的示例程序 * *  */ public class PrintStreamTest {  public static void main(String[] args) {   // 下面3个函数的作用都是一样:都是将字母“abcde”写入到文件“file.txt”中。   // 任选一个执行即可!   testPrintStreamConstrutor() ;   //testPrintStreamConstrutor2() ;  //testPrintStreamConstrutor3() ;   // 测试write(), print(), println(), printf()等接口。   testPrintStreamAPIS() ;  }  /**  * PrintStream(OutputStream out) 的测试函数  *  * 函数的作用,就是将字母“abcde”写入到文件“file.txt”中  */  private static void testPrintStreamConstrutor() {  // 0x61对应ASCII码的字母'a',0x62对应ASCII码的字母'b', ...  final byte[] arr={0x61, 0x62, 0x63, 0x64, 0x65 }; // abced   try {    // 创建文件“file.txt”的File对象    File file = new File("file.txt");    // 创建文件对应FileOutputStream    PrintStream out = new PrintStream(      new FileOutputStream(file));    // 将“字节数组arr”全部写入到输出流中    out.write(arr);    // 关闭输出流    out.close();   } catch (IOException e) {    e.printStackTrace();   }  }  /**  * PrintStream(File file) 的测试函数  *  * 函数的作用,就是将字母“abcde”写入到文件“file.txt”中  */  private static void testPrintStreamConstrutor2() {  final byte[] arr={0x61, 0x62, 0x63, 0x64, 0x65 };   try {    File file = new File("file.txt");    PrintStream out = new PrintStream(file);    out.write(arr);    out.close();   } catch (IOException e) {    e.printStackTrace();   }  }  /**  * PrintStream(String fileName) 的测试函数  *  * 函数的作用,就是将字母“abcde”写入到文件“file.txt”中  */  private static void testPrintStreamConstrutor3() {  final byte[] arr={0x61, 0x62, 0x63, 0x64, 0x65 };   try {    PrintStream out = new PrintStream("file.txt");    out.write(arr);    out.close();   } catch (IOException e) {    e.printStackTrace();   }  }  /**  * 测试write(), print(), println(), printf()等接口。  */  private static void testPrintStreamAPIS() {   // 0x61对应ASCII码的字母'a',0x62对应ASCII码的字母'b', ...  final byte[] arr={0x61, 0x62, 0x63, 0x64, 0x65 }; // abced   try {    // 创建文件对应FileOutputStream    PrintStream out = new PrintStream("other.txt");    // 将字符串“hello PrintStream”+回车符,写入到输出流中    out.println("hello PrintStream");    // 将x写入到输出流中    // x对应ASCII码的字母'A',也就是写入字符'A'    out.write(0x41);   // 将字符串"65"写入到输出流中。   // out.print(0x41); 等价于 out.write(String.valueOf(0x41));   out.print(0x41);    // 将字符'B'追加到输出流中    out.append('B');   // 将"CDE is 5" + 回车 写入到输出流中    String str = "CDE";   int num = 5;    out.printf("%s is %d/n", str, num);    out.close();   } catch (IOException e) {    e.printStackTrace();   }  } }

运行上面的代码,会在源码所在目录生成两个文件“file.txt”和“other.txt”。

file.txt的内容如下:

abcde

other.txt的内容如下:

hello PrintStreamA65BCDE is 5

以上所述是小编给大家介绍的Java 中的Printstream知识,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对VeVb武林网网站的支持


注:相关教程知识阅读请移步到JAVA教程频道。
发表评论 共有条评论
用户名: 密码:
验证码: 匿名发表