处理目录和文件时处理 IO 异常的最佳实践?
Best practice to handle IO Exceptions while coping directory(s) and file(s)?
示例代码如下。它将目标文件和目录从一个位置复制到另一个位置。在跨网络处理文件时处理 IO 异常的最佳实践是什么?
我使用了 printStackTrace() 但感觉这只是更好解决方案的占位符。是否正在记录答案,除了记录实际 "handle" 错误之外还应该有其他步骤吗?
感谢您的反馈。
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
/**
This is a test program to copy a directory(s) & file(s) from one location to another.
*/
public class CopyTest{
public static void main(String[] args) {
//Declarations
String sourcePath = "I:\MB\PO";
String destPath = "C:\testPO\";
System.out.println("Source path: " + sourcePath);
System.out.println("Destination path: " + destPath);
File source = new File(sourcePath);
File dest = new File(destPath);
//Process
//Call to method copyUsingStream
long start = System.nanoTime(); //start recording how much time the copy takes.
copyUsingStream(source, dest); //method to copy the directory/files.
System.out.println("Time taken to copy the file: "+(System.nanoTime() -start) + " nanoseconds");
} //end main method
/**
The copyUsingStream method is a recursive method to copy folders and files from one location to another.
*/
private static void copyUsingStream(File source, File dest) {
if (!source.isDirectory()){
// If source is a file -> copy it to the new folder
InputStream inStream = null;
OutputStream outStream = null;
try {
inStream = new FileInputStream(source);
outStream = new FileOutputStream(dest);
byte[] buffer = new byte[1024];
int length;
while ((length = inStream.read(buffer)) > 0) {
outStream.write(buffer, 0, length);
}
} catch(IOException ioe) {
ioe.printStackTrace();
} finally {
try{
inStream.close();
outStream.close();
System.out.println("File copied from " + source + " to " + dest + "successfully");
} catch(IOException ioe2) {
ioe2.printStackTrace();
}
}
} else {
//If a directory -> create the directory inside the new destination
//List all contents
if (!dest.exists()) {
dest.mkdir();
System.out.println("Directory copied from " + source + " to " + dest + "successfully");
}
String folder_contents[] = source.list();
for (String file : folder_contents) {
File srcFile = new File(source, file);
File destFile = new File(dest, file);
copyUsingStream(srcFile, destFile);
}
}
} //end method copyUsingStream
} //end class CopyTest
没有捕获的方法:
private static void copyUsingStream(File source, File dest) throws IOException {
if (!source.isDirectory()){
// If source is a file -> copy it to the new folder
InputStream inStream = null;
OutputStream outStream = null;
try {
inStream = new FileInputStream(source);
outStream = new FileOutputStream(dest);
byte[] buffer = new byte[1024];
int length;
while ((length = inStream.read(buffer)) > 0) {
outStream.write(buffer, 0, length);
}
} finally {
inStream.close();
outStream.close();
System.out.println("File copied from " + source + " to " + dest + "successfully");
}
} else {
//If a directory -> create the directory inside the new destination
//List all contents
if (!dest.exists()) {
dest.mkdir();
System.out.println("Directory copied from " + source + " to " + dest + "successfully");
}
String folder_contents[] = source.list();
for (String file : folder_contents) {
File srcFile = new File(source, file);
File destFile = new File(dest, file);
copyUsingStream(srcFile, destFile);
}
}
} //end method copyUsingStream
这在很大程度上取决于您的应用程序。
无论如何都会继续 运行 的应用程序(例如 Web 服务器、守护程序和批处理程序)通常会在文件中记录此类错误以及时间戳、线程 ID 和可能的其他有用信息。
我对两个日志文件的组合有很好的经验。
myapp.log
只接收重要消息,通常是警告和错误。该文件供普通用户和系统操作员使用。
debug.log
是给开发者的。它提供错误发生前的调试消息,但只要一切正常,它就不会提供任何消息。要启用此功能,需要一个内存缓冲区。
如果您对该缓冲区感兴趣,可以看看 http://stefanfrings.de/bfUtilities/index.html 。该网站是德文的,但图书馆及其文档是英文的。
在桌面 GUI 应用程序上,当错误中止请求的操作时,在弹出窗口中显示简短的错误消息可能会很好 window,并在可扩展框中隐藏详细信息(堆栈跟踪) .不要忘记清楚地告诉用户什么操作失败了。异常本身对您的开发人员来说可能足够清楚,但普通用户希望使用较少的技术文本。例如:"Loading weather info from service weather.com failed: Connection failed",后跟堆栈跟踪。
对于立即停止的控制台应用程序,我更喜欢直接在屏幕上查看堆栈跟踪,如 printStackTrace()
所写。
正如 Stefan 所说,这取决于应用程序。
一个好的经验法则是:不要捕获异常,除非您准备好执行特定操作(除了打印或记录它之外),或者没有可以将其传播给的调用者。
如果您有复制文件的通用方法,则该方法不应假设调用它的原因。它的工作是复制一个文件。它应该 return 仅当它成功完成该任务时。如果不成功,它应该抛出异常而不是 returning.
因此对于一般的复制方法,您需要将 throws IOException
添加到方法签名中,并且在方法本身中有零个 try/catch 块。这让调用者决定如何处理失败。 GUI 应用程序可能会显示一个错误对话框。服务可能只是记录异常并稍后重试。
您自己应该只捕获并记录尽可能高级别的异常。 GUI 应用程序会在显示错误对话框之前记录它。 (您可能还想在对话框中包含堆栈跟踪的文本,在可扩展的“显示详细信息”部分中。)服务可能有一个主循环或主执行方法,其中没有异常可以调用的更高层调用者被传播,所以除了记录它别无他法。
示例代码如下。它将目标文件和目录从一个位置复制到另一个位置。在跨网络处理文件时处理 IO 异常的最佳实践是什么?
我使用了 printStackTrace() 但感觉这只是更好解决方案的占位符。是否正在记录答案,除了记录实际 "handle" 错误之外还应该有其他步骤吗?
感谢您的反馈。
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
/**
This is a test program to copy a directory(s) & file(s) from one location to another.
*/
public class CopyTest{
public static void main(String[] args) {
//Declarations
String sourcePath = "I:\MB\PO";
String destPath = "C:\testPO\";
System.out.println("Source path: " + sourcePath);
System.out.println("Destination path: " + destPath);
File source = new File(sourcePath);
File dest = new File(destPath);
//Process
//Call to method copyUsingStream
long start = System.nanoTime(); //start recording how much time the copy takes.
copyUsingStream(source, dest); //method to copy the directory/files.
System.out.println("Time taken to copy the file: "+(System.nanoTime() -start) + " nanoseconds");
} //end main method
/**
The copyUsingStream method is a recursive method to copy folders and files from one location to another.
*/
private static void copyUsingStream(File source, File dest) {
if (!source.isDirectory()){
// If source is a file -> copy it to the new folder
InputStream inStream = null;
OutputStream outStream = null;
try {
inStream = new FileInputStream(source);
outStream = new FileOutputStream(dest);
byte[] buffer = new byte[1024];
int length;
while ((length = inStream.read(buffer)) > 0) {
outStream.write(buffer, 0, length);
}
} catch(IOException ioe) {
ioe.printStackTrace();
} finally {
try{
inStream.close();
outStream.close();
System.out.println("File copied from " + source + " to " + dest + "successfully");
} catch(IOException ioe2) {
ioe2.printStackTrace();
}
}
} else {
//If a directory -> create the directory inside the new destination
//List all contents
if (!dest.exists()) {
dest.mkdir();
System.out.println("Directory copied from " + source + " to " + dest + "successfully");
}
String folder_contents[] = source.list();
for (String file : folder_contents) {
File srcFile = new File(source, file);
File destFile = new File(dest, file);
copyUsingStream(srcFile, destFile);
}
}
} //end method copyUsingStream
} //end class CopyTest
没有捕获的方法:
private static void copyUsingStream(File source, File dest) throws IOException {
if (!source.isDirectory()){
// If source is a file -> copy it to the new folder
InputStream inStream = null;
OutputStream outStream = null;
try {
inStream = new FileInputStream(source);
outStream = new FileOutputStream(dest);
byte[] buffer = new byte[1024];
int length;
while ((length = inStream.read(buffer)) > 0) {
outStream.write(buffer, 0, length);
}
} finally {
inStream.close();
outStream.close();
System.out.println("File copied from " + source + " to " + dest + "successfully");
}
} else {
//If a directory -> create the directory inside the new destination
//List all contents
if (!dest.exists()) {
dest.mkdir();
System.out.println("Directory copied from " + source + " to " + dest + "successfully");
}
String folder_contents[] = source.list();
for (String file : folder_contents) {
File srcFile = new File(source, file);
File destFile = new File(dest, file);
copyUsingStream(srcFile, destFile);
}
}
} //end method copyUsingStream
这在很大程度上取决于您的应用程序。
无论如何都会继续 运行 的应用程序(例如 Web 服务器、守护程序和批处理程序)通常会在文件中记录此类错误以及时间戳、线程 ID 和可能的其他有用信息。
我对两个日志文件的组合有很好的经验。
myapp.log
只接收重要消息,通常是警告和错误。该文件供普通用户和系统操作员使用。debug.log
是给开发者的。它提供错误发生前的调试消息,但只要一切正常,它就不会提供任何消息。要启用此功能,需要一个内存缓冲区。
如果您对该缓冲区感兴趣,可以看看 http://stefanfrings.de/bfUtilities/index.html 。该网站是德文的,但图书馆及其文档是英文的。
在桌面 GUI 应用程序上,当错误中止请求的操作时,在弹出窗口中显示简短的错误消息可能会很好 window,并在可扩展框中隐藏详细信息(堆栈跟踪) .不要忘记清楚地告诉用户什么操作失败了。异常本身对您的开发人员来说可能足够清楚,但普通用户希望使用较少的技术文本。例如:"Loading weather info from service weather.com failed: Connection failed",后跟堆栈跟踪。
对于立即停止的控制台应用程序,我更喜欢直接在屏幕上查看堆栈跟踪,如 printStackTrace()
所写。
正如 Stefan 所说,这取决于应用程序。
一个好的经验法则是:不要捕获异常,除非您准备好执行特定操作(除了打印或记录它之外),或者没有可以将其传播给的调用者。
如果您有复制文件的通用方法,则该方法不应假设调用它的原因。它的工作是复制一个文件。它应该 return 仅当它成功完成该任务时。如果不成功,它应该抛出异常而不是 returning.
因此对于一般的复制方法,您需要将 throws IOException
添加到方法签名中,并且在方法本身中有零个 try/catch 块。这让调用者决定如何处理失败。 GUI 应用程序可能会显示一个错误对话框。服务可能只是记录异常并稍后重试。
您自己应该只捕获并记录尽可能高级别的异常。 GUI 应用程序会在显示错误对话框之前记录它。 (您可能还想在对话框中包含堆栈跟踪的文本,在可扩展的“显示详细信息”部分中。)服务可能有一个主循环或主执行方法,其中没有异常可以调用的更高层调用者被传播,所以除了记录它别无他法。