初始代码

aping-source · aping-source · commit be10ac20c7ac · 2021-11-14T11:17:27.000+08:00
diff --git a/README.md b/README.md
@@ -1,14 +1,14 @@
 # async-file
 
 #### 介绍
-框架提供Java异步读写文件功能，除依赖slf4j日志包，不依赖其他第三方包。Java应用程序引入框架可以简单的，异步和非阻塞的读写文件。框架包含三个工具类：
+框架提供Java异步读写文件工具，使用Java NIO 文件读写库。Java应用程序引入框架可以简单的，异步和非阻塞的读写文件。框架包含三个工具类：
 
 
-[`AIOFileReader`](src/main/java/io/github/kavahub/file/reader/AIOFileReader.java) 异步读取文件，使用Java NIO库 [`AsynchronousFileChannel`](https://docs.oracle.com/javase/10/docs/api/java/nio/channels/AsynchronousFileChannel.html) 和 [`CompletionHandler`](https://docs.oracle.com/javase/10/docs/api/java/nio/channels/CompletionHandler.html) 实现。
+- [`AIOFileReader`](src/main/java/io/github/kavahub/file/reader/AIOFileReader.java) 异步读取文件，使用Java NIO库 [`AsynchronousFileChannel`](https://docs.oracle.com/javase/10/docs/api/java/nio/channels/AsynchronousFileChannel.html) 和 [`CompletionHandler`](https://docs.oracle.com/javase/10/docs/api/java/nio/channels/CompletionHandler.html) 实现。
 
-[`AIOFileWriter`](src/main/java/io/github/kavahub/file/writer/AIOFileWriter.java) 异步写入文件，使用Java NIO库 [`AsynchronousFileChannel`](https://docs.oracle.com/javase/10/docs/api/java/nio/channels/AsynchronousFileChannel.html) 和 [`CompletionHandler`](https://docs.oracle.com/javase/10/docs/api/java/nio/channels/CompletionHandler.html) 实现。
+- [`AIOFileWriter`](src/main/java/io/github/kavahub/file/writer/AIOFileWriter.java) 异步写入文件，使用Java NIO库 [`AsynchronousFileChannel`](https://docs.oracle.com/javase/10/docs/api/java/nio/channels/AsynchronousFileChannel.html) 和 [`CompletionHandler`](https://docs.oracle.com/javase/10/docs/api/java/nio/channels/CompletionHandler.html) 实现。
 
-[`NIOFileLineReader`](src/main/java/io/github/kavahub/file/reader/NIOFileLineReader.java) 非阻塞读取文件，使用 [`ForkJoinPool`](https://docs.oracle.com/javase/10/docs/api/java/util/concurrent/ForkJoinPool.html) 和 [`BufferedReader`](https://docs.oracle.com/javase/10/docs/api/java/io/BufferedReader.html) 实现
+- [`NIOFileLineReader`](src/main/java/io/github/kavahub/file/reader/NIOFileLineReader.java) 非阻塞读取文件，使用 [`ForkJoinPool`](https://docs.oracle.com/javase/10/docs/api/java/util/concurrent/ForkJoinPool.html) 和 [`BufferedReader`](https://docs.oracle.com/javase/10/docs/api/java/io/BufferedReader.html) 实现
 
 Java提供的 [`Files`](https://docs.oracle.com/javase/10/docs/api/java/nio/file/Files.html) 文件读取功能是阻塞的。
 
@@ -302,7 +302,7 @@ Thread-7
 
 关于使用的建议：
 
-- 文件的异步读写，并不是未了提高文件的读取性能，而是提高文件读取的吞吐量（读取更多的文件，并保持性能，使JVM可以稳定运行）。
+- 文件的异步读写，并不是为了提高文件的读取性能，而是提高文件读取的吞吐量（读取更多的文件，并保持性能，使JVM可以稳定运行）。
 - 在大多数情况下，使用Jdk提供的[`Files`](https://docs.oracle.com/javase/10/docs/api/java/nio/file/Files.html)或许更合适。
 - 不要为了异步而异步，找到问题所在，也许解决问题的关键不是异步。
 
@@ -311,9 +311,13 @@ Thread-7
 
 建议使用优先级： `Java NIO Files` > `NIOFileLineReader` > `AIOFileReader`
 
+#### 如何参与开发
+
+
+
 #### 其他开源项目
 
-- [RxIo](https://github.com/javasync/RxIo) 
+- [RxIo](https://github.com/javasync/RxIo) : Asynchronous non-blocking File Reader and Writer library for Java
 
 #### 参考文档
 
diff --git a/pom.xml b/pom.xml
@@ -2,9 +2,9 @@
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
   <groupId>io.github.kavahub</groupId>
-  <artifactId>async-file</artifactId>
+  <artifactId>kavahub-async-file</artifactId>
   <version>1.0.0-SNA</version>
-  <name>async-file</name>
+  <name>kavahub-async-file</name>
   <packaging>jar</packaging>
 
   <description>
@@ -14,10 +14,10 @@
   <url>https://gitee.com/yangyunjiao/async-file</url>
   <licenses>
     <license>
-        <name>MIT license</name>
-        <url>https://opensource.org/licenses/MIT</url>
+      <name>MIT license</name>
+      <url>https://opensource.org/licenses/MIT</url>
     </license>
-</licenses>
+  </licenses>
   <developers>
     <developer>
       <name>PinWei Wan</name>
@@ -50,66 +50,72 @@
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
     <argLine>-Dfile.encoding=UTF-8</argLine>
-  </properties>
 
-  <dependencyManagement>
-    <dependencies>
-      <dependency>
-        <groupId>org.junit</groupId>
-        <artifactId>junit-bom</artifactId>
-        <version>5.8.1</version>
-        <type>pom</type>
-        <scope>import</scope>
-      </dependency>
-    </dependencies>
-  </dependencyManagement>
+    <!-- maven plugin -->
+    <maven-surefire-plugin.version>3.0.0-M5</maven-surefire-plugin.version>
+    <maven-release-plugin.veriosn>3.0.0-M4</maven-release-plugin.veriosn>
+    <maven-gpg-plugin.version>3.0.1</maven-gpg-plugin.version>
+    <maven-source-plugin.version>3.2.1</maven-source-plugin.version>
+    <maven-javadoc-plugin.version>3.3.1</maven-javadoc-plugin.version>
+    <maven-compiler-plugin.version>3.8.1</maven-compiler-plugin.version>
+
+    <!-- thrid lib -->
+    <junit-jupiter.version>5.8.1</junit-jupiter.version>
+    <slf4j-api.version>1.7.32</slf4j-api.version>
+    <jmh-generator-annprocess.version>1.33</jmh-generator-annprocess.version>
+    <testng.version>7.4.0</testng.version>
+    <assertj-core.version>3.21.0</assertj-core.version>
+    <logback-classic.version>1.2.7</logback-classic.version>
+    <lombok.version>1.18.20</lombok.version>
+  </properties>
 
   <dependencies>
     <dependency>
       <groupId>org.slf4j</groupId>
       <artifactId>slf4j-api</artifactId>
-      <version>2.0.0-alpha4</version>
+      <version>${slf4j-api.version}</version>
     </dependency>
 
     <dependency>
       <groupId>org.openjdk.jmh</groupId>
       <artifactId>jmh-generator-annprocess</artifactId>
-      <version>1.33</version>
+      <version>${jmh-generator-annprocess.version}</version>
       <scope>provided</scope>
     </dependency>
 
     <!-- test -->
     <dependency>
       <groupId>org.junit.jupiter</groupId>
       <artifactId>junit-jupiter</artifactId>
-      <scope>test</scope>
-    </dependency>
-
-    <dependency>
-      <groupId>org.testng</groupId>
-      <artifactId>testng</artifactId>
-      <version>7.4.0</version>
+      <version>${junit-jupiter.version}</version>
       <scope>test</scope>
     </dependency>
 
     <dependency>
       <groupId>org.assertj</groupId>
       <artifactId>assertj-core</artifactId>
-      <version>3.21.0</version>
+      <version>${assertj-core.version}</version>
       <scope>test</scope>
     </dependency>
 
     <dependency>
       <groupId>ch.qos.logback</groupId>
       <artifactId>logback-classic</artifactId>
-      <version>1.3.0-alpha10</version>
+      <version>${logback-classic.version}</version>
+      <scope>test</scope>
+    </dependency>
+
+    <dependency>
+      <groupId>org.testng</groupId>
+      <artifactId>testng</artifactId>
+      <version>${testng.version}</version>
       <scope>test</scope>
     </dependency>
 
     <dependency>
       <groupId>org.projectlombok</groupId>
       <artifactId>lombok</artifactId>
-      <version>1.18.20</version>
+      <version>${lombok.version}</version>
       <scope>provided</scope>
     </dependency>
   </dependencies>
@@ -130,7 +136,7 @@
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-surefire-plugin</artifactId>
-        <version>3.0.0-M5</version>
+        <version>${maven-surefire-plugin.version}</version>
         <configuration>
           <parallel>methods</parallel>
           <threadCount>10</threadCount>
@@ -139,67 +145,100 @@
           </suiteXmlFiles>
         </configuration>
       </plugin>
-
-      <plugin>
-        <groupId>org.apache.maven.plugins</groupId>
-        <artifactId>maven-release-plugin</artifactId>
-        <version>3.0.0-M4</version>
-        <configuration>
-          <autoVersionSubmodules>true</autoVersionSubmodules>
-          <useReleaseProfile>false</useReleaseProfile>
-          <releaseProfiles>release</releaseProfiles>
-          <goals>deploy</goals>
-          <pushChanges>false</pushChanges>
-        </configuration>
-      </plugin>
-
-      <plugin>
-        <groupId>org.apache.maven.plugins</groupId>
-        <artifactId>maven-gpg-plugin</artifactId>
-        <version>3.0.1</version>
-        <executions>
-          <execution>
-            <id>sign-artifacts</id>
-            <phase>verify</phase>
-            <goals>
-              <goal>sign</goal>
-            </goals>
-          </execution>
-        </executions>
-      </plugin>
-
-      <plugin>
-        <groupId>org.apache.maven.plugins</groupId>
-        <artifactId>maven-source-plugin</artifactId>
-        <version>3.2.1</version>
-        <executions>
-          <execution>
-            <id>attach-sources</id>
-            <goals>
-              <goal>jar-no-fork</goal>
-            </goals>
-          </execution>
-        </executions>
-      </plugin>
-
-      <plugin>
-        <groupId>org.apache.maven.plugins</groupId>
-        <artifactId>maven-javadoc-plugin</artifactId>
-        <version>3.3.1</version>
-        <executions>
-          <execution>
-            <id>attach-javadocs</id>
-            <goals>
-              <goal>jar</goal>
-            </goals>
-          </execution>
-        </executions>
-      </plugin>
+      
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-compiler-plugin</artifactId>
-        <version>3.8.1</version>
+        <version>${maven-compiler-plugin.version}</version>
       </plugin>
     </plugins>
   </build>
+
+  <profiles>
+    <profile>
+      <id>release</id>
+
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-surefire-plugin</artifactId>
+            <version>${maven-surefire-plugin.version}</version>
+            <configuration>
+              <parallel>methods</parallel>
+              <threadCount>10</threadCount>
+              <suiteXmlFiles>
+                <file>testng.xml</file>
+              </suiteXmlFiles>
+            </configuration>
+          </plugin>
+
+          <plugin>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-release-plugin</artifactId>
+            <version>${maven-release-plugin.version}</version>
+            <configuration>
+              <autoVersionSubmodules>true</autoVersionSubmodules>
+              <useReleaseProfile>false</useReleaseProfile>
+              <releaseProfiles>release</releaseProfiles>
+              <goals>deploy</goals>
+              <pushChanges>false</pushChanges>
+            </configuration>
+          </plugin>
+
+          <plugin>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-gpg-plugin</artifactId>
+            <version>${maven-gpg-plugin.version}</version>
+            <executions>
+              <execution>
+                <id>sign-artifacts</id>
+                <phase>verify</phase>
+                <goals>
+                  <goal>sign</goal>
+                </goals>
+              </execution>
+            </executions>
+          </plugin>
+
+          <plugin>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-source-plugin</artifactId>
+            <version>${maven-source-plugin.version}</version>
+            <executions>
+              <execution>
+                <id>attach-sources</id>
+                <goals>
+                  <goal>jar-no-fork</goal>
+                </goals>
+              </execution>
+            </executions>
+          </plugin>
+
+          <plugin>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-javadoc-plugin</artifactId>
+            <version>${maven-javadoc-plugin.version}</version>
+            <executions>
+              <execution>
+                <id>attach-javadocs</id>
+                <goals>
+                  <goal>jar</goal>
+                </goals>
+              </execution>
+            </executions>
+          </plugin>
+          <plugin>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-compiler-plugin</artifactId>
+            <version>${maven-compiler-plugin.version}</version>
+            <configuration>
+              <source>1.8</source>
+              <target>1.8</target>
+            </configuration>
+          </plugin>
+        </plugins>
+      </build>
+    </profile>
+  </profiles>
 </project>
diff --git a/src/test/java/io/github/kavahub/file/AIOFileWriterExample.java b/src/test/java/io/github/kavahub/file/AIOFileWriterExample.java
@@ -13,31 +13,31 @@
 import io.github.kavahub.file.writer.AIOFileWriter;
 
 public class AIOFileWriterExample {
-    private static final String FILE_TO_WRITE = "fileToWrite.txt";
+    private static final Path FILE_TO_WRITE = Paths.get("target", "fileToWrite.txt");
 
     @BeforeEach
     public void clearUp() throws IOException {
-        Files.deleteIfExists(Paths.get(FILE_TO_WRITE));
+        Files.deleteIfExists(FILE_TO_WRITE);
     }
 
     @Test
     public void whenWriteWithString() throws IOException {
-        AIOFileWriter.write(Paths.get(FILE_TO_WRITE), "This is file content：你好").join();
+        AIOFileWriter.write(FILE_TO_WRITE, "This is file content：你好").join();
     }
 
     @Test
     public void whenWriteWithStringSplit() throws IOException {
         final String content = "This is file content：你好";
 
-        AIOFileWriter.write(Paths.get(FILE_TO_WRITE), String.join(System.lineSeparator(), content.split(" "))).join();
+        AIOFileWriter.write(FILE_TO_WRITE, String.join(System.lineSeparator(), content.split(" "))).join();
     }
 
     @Test
     public void whenWriteWithQueryFlatMapMerge() throws IOException {
         Query<String>  data = Query.of("This is file content：你好")
             .flatMapMerge(line -> Query.of(line.split(" ")))
             .map((line) -> line + System.lineSeparator());
-        AIOFileWriter.write(Paths.get(FILE_TO_WRITE), data).join();
+        AIOFileWriter.write(FILE_TO_WRITE, data).join();
     }
 
     @Test
@@ -53,6 +53,6 @@ public void whenWriteWithQueryFilter() throws IOException {
             .map(String::toUpperCase)
             // 加入换行符
             .map((line) -> line + System.lineSeparator());
-        AIOFileWriter.write(Paths.get(FILE_TO_WRITE), reader).join();
+        AIOFileWriter.write(FILE_TO_WRITE, reader).join();
     }
 }
diff --git a/src/test/java/io/github/kavahub/file/AIOFileWriterTest.java b/src/test/java/io/github/kavahub/file/AIOFileWriterTest.java
