java中Writer的线程安全性

 

以前负责一个项目，我负责从一个超大的文本文件中读取信息存入数据库再进一步分析。而文本文件内容是每行一个json串。我在解析的过程中发现，有很小的概率json串的结构会破坏，比如前一个json串只写了半行，后面就被另一个json串覆盖掉了。

与产生日志的部门沟通，他们说是多线程使用log4j写入，可能偶尔会有串行。

具体他们是否使用log4j的AsyncAppender我不太了解，暂时也没去看log4j的源码，当时只是简单的忽略异常的行了事儿。

现在比较闲，想测试一下jdk里面各种输出方式，例如Writer，在多线程交替写入文件一行时是否会出现串行的情况，于是便出现了本文。

 

测试分两部分：

1，多个线程各自开启一个FileWriter写入同一个文件。

2，多个线程共用一个FileWriter写入同一个文件。

--------------------------------------------------

首先来看FileWriter的JDK说明：

“某些平台一次只允许一个 FileWriter（或其他文件写入对象）打开文件进行写入”——如果是这样，那么第1个测试便不用做了，可事实上至少在windows下并非如此。

 

上代码(别嫌丑，咱是在IO，不是在测多线程，您说是吧？)：

1，多个线程各自开启一个FileWriter写入同一个文件。

 

	//在100毫秒的时间内，10个线程各自开一个FileWriter，
	//同时向同一个文件写入字符串，每个线程每次写一行。
	//测试结果：文件内容出现混乱，串行
	private void multiThreadWriteFile() throws IOException{
		File file=new File(basePath+jumpPath+fileName);
		file.createNewFile();
		
		//创建10个线程
		int totalThreads=10;
		WriteFileThread[] threads=new WriteFileThread[totalThreads];
		for(int i=0;i<totalThreads;i++){
			WriteFileThread thread=new WriteFileThread(file,i);
			threads[i]=thread;
		}
		
		//启动10个线程
		for(Thread thread: threads){
			thread.start();
		}
		
		//主线程休眠100毫秒
		try {
			Thread.sleep(100);
		} catch (InterruptedException e) {
			e.printStackTrace();
		}
		
		//所有线程停止
		for(WriteFileThread thread: threads){
			thread.setToStop();
		}
		System.out.println("还楞着干什么，去看一下文件结构正确与否啊！");
	}

 

 

	class WriteFileThread extends Thread{
		private boolean toStop=false;
		private FileWriter writer;
		private int threadNum;
		private String lineSeparator;
		
		WriteFileThread(File file,int threadNum) throws IOException{
			lineSeparator=System.getProperty("line.separator");
			writer=new FileWriter(file,true);
			this.threadNum=threadNum;
		}
		
		@Override
		public void run() {
			while(!toStop){
				try {
					writer.append("线程"+threadNum+"正在写入文件，" +
							"妈妈说名字要很长才能够测试出这几个线程有没有冲突啊，" +
							"不过还是没有论坛里帖子的名字长，怎么办呢？" +
							"哎呀，后面是换行符了"+lineSeparator);
					
				} catch (IOException e) {
					e.printStackTrace();
				}
			}
			System.out.println("---------线程"+threadNum+"停止执行了");
		}

		public void setToStop() {
			this.toStop = true;
		}
	}

 

 

测试结果：

产生5MB左右的文本文件，里面出现大约5%的文本串行现象。

--------------------------------------------------

接下来我们看多个线程共用一个FileWriter写入同一个文件的情况：

在Writer抽象类里面有一个protected类型的lock属性，是一个简单Object对象。

JDK里对这个lock属性的描述如下：“用于同步针对此流的操作的对象。为了提高效率，字符流对象可以使用其自身以外的对象来保护关键部分。因此，子类应使用此字段中的对象，而不是 this 或者同步的方法。 ”——看来，多线程共用同一个writer的方案有戏。

 

继续看下源代码，从FileWriter的writer方法开始看起，调用过程如下：

FileWriter->OutputStreamWriter.write->StreamEncoder.write

其中StreamEncoder.write的源码如下：

(JDK自带源码不包括StreamExcoder，可以在这里查看 http://www.docjar.com/html/api/sun/nio/cs/StreamEncoder.java.html)

 

public void write(char cbuf[], int off, int len) throws IOException {
	synchronized (lock) {
		ensureOpen();
		if ((off < 0) || (off > cbuf.length) || (len < 0) ||
				((off + len) > cbuf.length) || ((off + len) < 0)) 
			{
				throw new IndexOutOfBoundsException();
			} else if (len == 0) {
				return;
			}
		implWrite(cbuf, off, len);
	}
}

 

可以看到FileWriter在写入时，同步在了对应的FileOutputStream对象上——依此分析，多个线程共用一个FileWriter写入同一个文件，一次一行的情况下，不会出现串行。

写代码测试一下：

 

	//多线程争抢写入同一个文件的测试，一次一行
	//多个线程公用一个FileWriter
	//测试结果：
	private void multiThreadWriteFile2() throws IOException{
		File file=new File(basePath+jumpPath+fileName);
		file.createNewFile();
		FileWriter fw=new FileWriter(file);
		
		//创建10个线程
		int totalThreads=10;
		WriteFileThread2[] threads=new WriteFileThread2[totalThreads];
		for(int i=0;i<totalThreads;i++){
			WriteFileThread2 thread=new WriteFileThread2(fw,i);
			threads[i]=thread;
		}
		
		//启动10个线程
		for(Thread thread: threads){
			thread.start();
		}
		
		//主线程休眠100毫秒
		try {
			Thread.sleep(100);
		} catch (InterruptedException e) {
			e.printStackTrace();
		}
		
		//所有线程停止
		for(WriteFileThread2 thread: threads){
			thread.setToStop();
		}
		System.out.println("还楞着干什么，去看一下文件结构正确与否啊！");
	}

 

 

	class WriteFileThread2 extends Thread{
		private boolean toStop=false;
		private FileWriter writer;
		private int threadNum;
		private String lineSeparator;
		
		WriteFileThread2(FileWriter writer,int threadNum){
			lineSeparator=System.getProperty("line.separator");
			this.writer=writer;
			this.threadNum=threadNum;
		}
		
		@Override
		public void run() {
			while(!toStop){
				try {
					writer.append("线程"+threadNum+"正在写入文件，" +
							"妈妈说名字要很长才能够测试出这几个线程有没有冲突啊，" +
							"不过还是没有论坛里帖子的名字长，怎么办呢？" +
							"哎呀，后面是换行符了"+lineSeparator);
				} catch (IOException e) {
					e.printStackTrace();
				}
			}
			System.out.println("---------线程"+threadNum+"停止执行了");
		}

		public void setToStop() {
			this.toStop = true;
		}
	}

 

 

测试结果：

产生2.2MB左右的文本文件，里面没有出现任何串行现象。

--------------------------------------------------

那么BufferedWriter又如何呢？

按道理BufferedWriter只是把别的Writer装饰了一下，在底层写的时候也是同步的。

看源码：

 

    void flushBuffer() throws IOException {
        synchronized (lock) {
            ensureOpen();
            if (nextChar == 0)
                return;
            out.write(cb, 0, nextChar);
            nextChar = 0;
        }
    }

 

BufferedWriter.write和BufferedWriter.flushBuffer的方法同步在了被包装的Writer这个对象上。

也就是说，BufferedWriter.write和BufferedWriter.flushBuffer都有同步块包围，说明按上述环境测试时，是不会出现串行现象的。

--------------------------------------------------

最终结果：

1，windows下，可以开多个线程操作多个FileWriter写入同一个文件，多个FileWriter切换时，会导致相互交错，破坏字符串结构的完整性。

2，多个线程操作FileWriter或者BufferedWriter时，每一次写入操作都是可以保证原子性的，也即：FileWriter或者BufferedWriter是线程安全的——呃，这个结论貌似好简单啊，JDK文档里有说明吗？没看到啊。

3，由于第2条中的线程安全，写入速度下降超过一半。