重构完成，完善文档

Author: PatternDirClean

README.md

@@ -8,14 +8,12 @@
 ![Gradle 8.10.2](https://img.shields.io/badge/Gradle-8.10.2-04303b.svg "tool")
 ![Apache 2](https://img.shields.io/badge/license-Apache%202-blue.svg "License")
 
--- [Java Doc](https://apidoc.gitee.com/fybug/PDConcurrent) --
+[//]: # (-- [Java Doc](https://apidoc.gitee.com/fybug/PDConcurrent) --)
 
--- [项目主页](https://fybug.gitee.io/projectsby/PDConcurrent.html) --
+[//]: # (-- [项目主页](https://fybug.gitee.io/projectsby/PDConcurrent.html) --)
 
 -------------------------------------------------------------------------------
 
-**专注于单个功能，无附加bug**
-
 ## 简介
 
 轻量级，高可靠，易学习的并发管理工具。
@@ -24,12 +22,15 @@
 
 如果你已经熟悉 java 的多线程管理，尤其是 ReentrantReadWriteLock 读写锁的话你会更容易学会本工具。
 
-本工具采用读写锁标准，无论内部实现如何，外部接口均提供 **read, **write 方法区分读锁并发域和写锁并发域
+无论内部实现如何，外部接口均提供 **read, **write 方法区分读锁并发域和写锁并发域
 
 ### 基础使用示例
+
 ```java
-public static void main(String[] args) {
-  var lock = SyLock.newObjLock();
+public final SyLock lock = SyLock.newObjLock();
+
+public static
+void main(String[] args) {
   lock.read(() -> {
     // 并发域代码内容
     [return null;]? // 可选择是否返回
@@ -46,10 +47,13 @@ public static void main(String[] args) {
 可通过接口的工厂方法实例化内部采用不同实现的锁。
 
 ### synchronized 锁
+
 ```java
-public static void main(String[] args) {
+public final SyLock lock = SyLock.newObjLock();
+
+public static
+void main(String[] args) {
   // 使用
-  var lock = SyLock.newObjLock();
   lock.read(() -> {
     // 并发域代码内容
   });
@@ -63,10 +67,16 @@ public static void main(String[] args) {
 ```
 
 ### ReentrantLock 锁
+
+支持使用`newCondition()`获取`Condition`对象
+
+支持通过`isLocked()`检查是否被占用
+
 ```java
-public static void main(String[] args) {
+public static
+void main(String[] args) {
   // 使用
-  var lock = SyLock.newReLock();
+  SyLock lock = SyLock.newReLock();
   lock.read(() -> {
     // 并发域代码内容
   });
@@ -83,10 +93,18 @@ public static void main(String[] args) {
 ```
 
 ### ReadWriteLock 锁
+
+支持通过`toread()`进行写锁 => 读锁降级
+
+支持使用`newReadCondition()` `newWriteCondition()`获取`Condition`对象
+
+支持通过`isLocked()` `isWriteLocked()` `isReadLocked()`检查是否被占用
+
 ```java
-public static void main(String[] args) {
+public static
+void main(String[] args) {
   // 使用
-  var lock = SyLock.newRWLock();
+  SyLock lock = SyLock.newRWLock();
   lock.read(() -> {
     // 并发域代码内容
   });
@@ -103,17 +121,19 @@ public static void main(String[] args) {
 ```
 
 ## 使用方法
+
 请导入其 `jar` 文件,文件在 **发行版** 或项目的 **jar** 文件夹下可以找到
 
-> PDConcurrent.jar 为不包含源码的包
+> PDConcurrent_bin.jar 为编译包
 >
-> PDConcurrent_sources.jar 为仅包含源码的包
+> PDConcurrent_sources.jar 为源码包
 
 **发行版中可以看到全部版本<br/>项目下的 jar 文件夹是当前最新的每夜版**
 
 可通过 **WIKI** 或者 **doc文档** 深入学习本工具
 
 ## 分支说明
+
 **dev-master**：当前的开发分支，可以拿到最新的每夜版 jar
 
 **releases**：当前发布分支，稳定版的源码

build.gradle

@@ -1,116 +1,113 @@
 plugins {
-	id 'java'
-	id 'idea'
+  id 'java'
+  id 'idea'
 }
 
 tasks.withType(JavaCompile).configureEach {
-	options.encoding = "UTF-8"
+  options.encoding = "UTF-8"
 }
 
 group 'fybug.nulll'
 version = '0.1.0'
 
 java {
-	toolchain {
-		languageVersion = JavaLanguageVersion.of(23)
-	}
+  toolchain {
+    languageVersion = JavaLanguageVersion.of(23)
+  }
 }
 
 repositories {
-	mavenLocal()
-	mavenCentral()
-	google()
-	maven { url 'https://maven.aliyun.com/repository/releases' }
-	maven { url "https://maven.aliyun.com/repository/jcenter" }
-	maven { url "https://maven.aliyun.com/repository/mapr-public" }
-	maven { url "https://maven.aliyun.com/repository/staging-alpha" }
-	maven { url "https://maven.aliyun.com/repository/central" }
-	maven { url "https://maven.aliyun.com/repository/public/" }
-	maven { url "https://maven.aliyun.com/repository/google" }
-	maven { url "https://maven.aliyun.com/repository/gradle-plugin" }
-	maven { url "https://maven.aliyun.com/repository/spring" }
-	maven { url "https://maven.aliyun.com/repository/spring-plugin" }
-	maven { url "https://maven.aliyun.com/repository/grails-core" }
-	maven { url "https://maven.aliyun.com/repository/snapshots" }
-	maven { url "https://maven.aliyun.com/repository/apache-snapshots" }
-	maven { url "https://maven.aliyun.com/repository/staging-alpha-group" }
+  mavenLocal()
+  mavenCentral()
+  google()
+  maven { url 'https://maven.aliyun.com/repository/releases' }
+  maven { url "https://maven.aliyun.com/repository/jcenter" }
+  maven { url "https://maven.aliyun.com/repository/mapr-public" }
+  maven { url "https://maven.aliyun.com/repository/staging-alpha" }
+  maven { url "https://maven.aliyun.com/repository/central" }
+  maven { url "https://maven.aliyun.com/repository/public/" }
+  maven { url "https://maven.aliyun.com/repository/google" }
+  maven { url "https://maven.aliyun.com/repository/gradle-plugin" }
+  maven { url "https://maven.aliyun.com/repository/spring" }
+  maven { url "https://maven.aliyun.com/repository/spring-plugin" }
+  maven { url "https://maven.aliyun.com/repository/grails-core" }
+  maven { url "https://maven.aliyun.com/repository/snapshots" }
+  maven { url "https://maven.aliyun.com/repository/apache-snapshots" }
+  maven { url "https://maven.aliyun.com/repository/staging-alpha-group" }
 }
 
 dependencies {
-	// 本地依赖
-	implementation fileTree(dir: 'lib', includes: ['*.jar'])
+  // 本地依赖
+  implementation fileTree(dir: 'lib', includes: ['*.jar'])
 
-	// 注释包
-	compileOnly "jakarta.validation:jakarta.validation-api:+"
-	compileOnly "jakarta.annotation:jakarta.annotation-api:+"
-	// lombok
-	compileOnly 'org.projectlombok:lombok:+'
-	annotationProcessor 'org.projectlombok:lombok:+'
+  // 注释包
+  compileOnly "jakarta.validation:jakarta.validation-api:+"
+  compileOnly "jakarta.annotation:jakarta.annotation-api:+"
+  // lombok
+  compileOnly 'org.projectlombok:lombok:+'
+  annotationProcessor 'org.projectlombok:lombok:+'
 
-	// 注释包
-	testCompileOnly "jakarta.validation:jakarta.validation-api:+"
-	testCompileOnly "jakarta.annotation:jakarta.annotation-api:+"
-	// lombok
-	testCompileOnly "org.projectlombok:lombok:+"
-	testAnnotationProcessor "org.projectlombok:lombok:+"
-	//	testImplementation "junit:junit"
+  // 注释包
+  testCompileOnly "jakarta.validation:jakarta.validation-api:+"
+  testCompileOnly "jakarta.annotation:jakarta.annotation-api:+"
+  // lombok
+  testCompileOnly "org.projectlombok:lombok:+"
+  testAnnotationProcessor "org.projectlombok:lombok:+"
+  testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
 }
 
 test {
-	useJUnitPlatform()
+  dependencies {
+    testImplementation "org.junit.platform:junit-platform-launcher"
+  }
+  useJUnitPlatform()
 }
 
 /** 清单文件内容 */
 tasks.withType(Jar).configureEach {
-	manifest {
-		attributes('Manifest-Version': '1.0',
-							 'Built-By': 'fybug/风雨bu改',
-							 'Build-Jdk-Spec': 23,
-							 'Bundle-Description': 'java并发控制工具',
-							 'Bundle-Name': 'PDConcurrent',
-							 //							 'Bundle-DocURL': 'https://apidoc.gitee.com/fybug/PDConcurrent/',
-							 'Bundle-Vendor': 'IntelliJ IDEA',
-							 'Bundle-Version': version,
-							 'Bundle-License': 'https://www.apache.org/licenses/LICENSE-2.0',
-							 'Created-By': 'Gradle 8.10.2')
-	}
+  destinationDirectory = file('jar')
+  manifest {
+    attributes('Manifest-Version': '1.0',
+               'Built-By': 'fybug/风雨bu改',
+               'Build-Jdk-Spec': 23,
+               'Bundle-Description': 'java并发控制工具',
+               'Bundle-Name': 'PDConcurrent',
+               //							 'Bundle-DocURL': 'https://apidoc.gitee.com/fybug/PDConcurrent/',
+               'Bundle-Vendor': 'IntelliJ IDEA',
+               'Bundle-Version': version,
+               'Bundle-License': 'https://www.apache.org/licenses/LICENSE-2.0',
+               'Created-By': 'Gradle 8.10.2')
+  }
 }
 
 /** 编译包 */
 tasks.register('PDConcurrent_bin', Jar) {
-	dependsOn classes
-	destinationDirectory = file('jar')
-	archiveFileName = 'PDConcurrent_bin.jar'
-	archiveClassifier = ''
-	// 打包编译输出
-	from sourceSets.main.output
+  archiveFileName = 'PDConcurrent_bin.jar'
+  archiveClassifier = ''
+  // 打包编译输出
+  from sourceSets.main.output
 }
 
 /** 源码包 */
 tasks.register('PDConcurrent_sources', Jar) {
-	dependsOn classes
-	destinationDirectory = file('jar')
-	archiveFileName = 'PDConcurrent_sources.jar'
-	archiveClassifier = 'sources'
-	// 打包源码
-	from sourceSets.main.allSource
+  archiveFileName = 'PDConcurrent_sources.jar'
+  archiveClassifier = 'sources'
+  // 打包源码
+  from sourceSets.main.allSource
 }
 
-tasks.register('PDConcurrent_all', Jar) {
-	dependsOn classes
-	destinationDirectory = file('jar')
-	archiveFileName = 'PDConcurrent_all.jar'
-	archiveClassifier = 'all'
-	// 打包编译输出
-	from sourceSets.main.output
-	from {
-		// implementation 相关的引入解压并打包入新的jar中
-		configurations.runtimeClasspath.collect { it.isDirectory() ? it : zipTree(it) }
-	}
-}
+//tasks.register('PDConcurrent_all', Jar) {
+//  archiveFileName = 'PDConcurrent_all.jar'
+//  archiveClassifier = 'all'
+//  // 打包编译输出
+//  from sourceSets.main.output
+//  from {
+//    // implementation 相关的引入解压并打包入新的jar中
+//    configurations.runtimeClasspath.collect { it.isDirectory() ? it : zipTree(it) }
+//  }
+//}
 
 tasks.register('release') {
-	dependsOn clean
-	dependsOn PDConcurrent_bin
-	dependsOn PDConcurrent_sources
+  dependsOn PDConcurrent_bin
+  dependsOn PDConcurrent_sources
 }

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,7 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.10.2-bin.zip
+distributionUrl=https\://mirrors.cloud.tencent.com/gradle/gradle-8.10.2-bin.zip
+#distributionUrl=https\://services.gradle.org/distributions/gradle-8.10.2-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME