add ThreadPool Utils

Author: liubr1491

.gitignore

@@ -21,3 +21,18 @@
 
 # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
 hs_err_pid*
+
+# Eclipse
+.classpath
+.project
+target
+.settings
+
+# Idea
+.idea
+*.iml
+
+# git
+*.orig
+
+*.zip

README.md

@@ -1,4 +1,4 @@
-# java-lib
+# baishi-common
 Java通用代码仓库
 
 ## 目标

pom.xml

@@ -0,0 +1,44 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<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.baishi</groupId>
+    <artifactId>baishi-common</artifactId>
+    <version>1.0.0</version>
+
+    <properties>
+        <maven.compiler.source>11</maven.compiler.source>
+        <maven.compiler.target>11</maven.compiler.target>
+    </properties>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-api</artifactId>
+            <version>1.7.36</version>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.httpcomponents</groupId>
+            <artifactId>httpclient</artifactId>
+            <version>4.5.13</version>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.httpcomponents</groupId>
+            <artifactId>httpcore</artifactId>
+            <version>4.4.15</version>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.commons</groupId>
+            <artifactId>commons-lang3</artifactId>
+            <version>3.12.0</version>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.commons</groupId>
+            <artifactId>commons-collections4</artifactId>
+            <version>4.4</version>
+        </dependency>
+    </dependencies>
+
+</project>

src/main/java/io/baishi/common/PropertiesUtils.java

@@ -0,0 +1,57 @@
+package io.baishi.common;
+
+import java.io.IOException;
+import java.io.InputStreamReader;
+import java.util.Objects;
+import java.util.Properties;
+
+/**
+ * @author baishi
+ * @date 2022/6/10 09:34
+ */
+public class PropertiesUtils {
+
+    /**
+     * 根据clazz的物理路径，获取propertyFileName名称的属性文件的Properties对象
+     *
+     * @param clazz
+     * @param propertyFileName
+     * @return
+     */
+    public static Properties getPropertyFile(Class clazz, String propertyFileName) throws IOException {
+        InputStreamReader reader = new InputStreamReader(
+                Objects.requireNonNull(
+                        clazz.getClassLoader().getResourceAsStream(propertyFileName)));
+
+        Properties p = new Properties();
+        p.load(reader);
+
+        return p;
+    }
+
+    /**
+     * 默认路径
+     *
+     * @param key
+     * @return
+     */
+    public static String getValue(String key) {
+        return getValue("classpath:META-INF/config.properties", key);
+    }
+
+    /**
+     * 指定路径
+     *
+     * @param fileName
+     * @param key
+     * @return
+     */
+    public static String getValue(String fileName, String key) {
+        try {
+            Properties prop = getPropertyFile(PropertiesUtils.class, fileName);
+            return prop.getProperty(key);
+        } catch (IOException e) {
+            return null;
+        }
+    }
+}

CustomHttpException.java …shi/common/http/CustomHttpException.javaCustomHttpException.java renamed to src/main/java/io/baishi/common/http/CustomHttpException.java CustomHttpException.java renamed to src/main/java/io/baishi/common/http/CustomHttpException.java

@@ -1,4 +1,4 @@
-package com.nick.common.exception;
+package io.baishi.common.http;
 
 /**
  * 自定义HTTP访问异常

HttpClient.java …/baishi/common/http/HttpClientUtils.javaHttpClient.java renamed to src/main/java/io/baishi/common/http/HttpClientUtils.java HttpClient.java renamed to src/main/java/io/baishi/common/http/HttpClientUtils.java

@@ -1,6 +1,5 @@
-package com.nick.common.http;
+package io.baishi.common.http;
 
-import com.nick.common.exception.CustomHttpException;
 import org.apache.commons.lang3.StringUtils;
 import org.apache.http.HttpEntity;
 import org.apache.http.client.config.RequestConfig;
@@ -19,11 +18,11 @@
  * @author nick
  * @date 2018/2/24
  */
-public class HttpClient {
+public class HttpClientUtils {
 
     private static final int HTTP_STATUS_CODE_SUCCESS = 200;
 
-    private static CloseableHttpClient closeableHttpClient = HttpClients.createDefault();
+    private static final CloseableHttpClient CLOSEABLE_HTTP_CLIENT = HttpClients.createDefault();
 
     private static final int CONNECTION_REQUEST_TIMEOUT = 1000;
     private static final int SOCKET_TIMEOUT = 1000;
@@ -121,7 +120,7 @@ public static byte[] sendPost(String url,
                 .setConnectTimeout(connectTimeout)
                 .build();
         httpPost.setConfig(requestConfig);
-        try (CloseableHttpResponse httpResponse = closeableHttpClient.execute(httpPost)) {
+        try (CloseableHttpResponse httpResponse = CLOSEABLE_HTTP_CLIENT.execute(httpPost)) {
             if (httpResponse.getStatusLine().getStatusCode() != HTTP_STATUS_CODE_SUCCESS) {
                 throw new CustomHttpException(httpResponse.getStatusLine() + ". url is " + url);
             }

src/main/java/io/baishi/common/thread/threadpool/AbstractThreadPoolBuilder.java

@@ -0,0 +1,71 @@
+package io.baishi.common.thread.threadpool;
+
+import java.util.concurrent.*;
+
+/**
+ * 线程池构造参数有8个，但是最核心的是3个：corePoolSize、maximumPoolSize，workQueue，
+ * 它们最大程度地决定了线程池的任务分配和线程分配策略。
+ * <p>
+ * <p>1. 并行执行子任务，提高响应速度。</p>
+ * <p>>>>>这种情况下，应该使用同步队列，没有什么任务应该被缓存下来，而是应该立即执行。</p>
+ * <p>2. 并行执行大批次任务，提升吞吐量。</p>
+ * <p>>>>>这种情况下，应该使用有界队列，使用队列去缓冲大批量的任务，队列容量必须声明，防止任务无限制堆积。</p>
+ *
+ * @author baishi
+ * @date 2022/1/18 15:08
+ */
+public abstract class AbstractThreadPoolBuilder {
+
+    /**
+     * 默认拒绝策略
+     */
+    protected static final RejectedExecutionHandler DEFAULT_REJECT_HANDLER = new ThreadPoolExecutor.AbortPolicy();
+
+    /**
+     * CPU 核心数量
+     */
+    protected static final int CPU_COUNT = MachineUtils.getCpuCount();
+
+    protected ThreadFactory threadFactory;
+
+    protected RejectedExecutionHandler rejectedExecutionHandler;
+
+    /**
+     * 任务队列大小
+     * <p>
+     * 默认为-1，表示不限制大小，使用{@link LinkedBlockingDeque}存储
+     */
+    protected int queueSize = -1;
+
+    protected int maximumPoolSize = CPU_COUNT;
+
+    protected int keepAliveTimeMilliSeconds = 1000;
+
+    protected boolean daemon = false;
+
+    protected String threadNamePrefix;
+
+    /**
+     * 最大线程数
+     *
+     * @return
+     */
+    protected int getMaximumPoolSize(int coreSize) {
+        return Math.max(coreSize, maximumPoolSize);
+    }
+
+    protected BlockingQueue<Runnable> getBlockingQueue() {
+        return queueSize < 1 ?
+                new LinkedBlockingDeque<>() :
+                new ArrayBlockingQueue<>(queueSize);
+    }
+
+    protected RejectedExecutionHandler getRejectedExecutionHandler() {
+
+        if (rejectedExecutionHandler == null) {
+            rejectedExecutionHandler = DEFAULT_REJECT_HANDLER;
+        }
+
+        return rejectedExecutionHandler;
+    }
+}

src/main/java/io/baishi/common/thread/threadpool/CpuThreadPoolBuilder.java

@@ -0,0 +1,76 @@
+package io.baishi.common.thread.threadpool;
+
+import io.baishi.common.thread.threadpool.dynamic.DynamicThreadPoolExecutor;
+
+import java.util.concurrent.RejectedExecutionHandler;
+import java.util.concurrent.ThreadFactory;
+import java.util.concurrent.TimeUnit;
+
+/**
+ * 处理CPU密集的线程池
+ * <p>
+ * 最佳线程数 = CPU核数 + 1
+ *
+ * @author baishi
+ * @date 2022/1/17 14:48
+ */
+public class CpuThreadPoolBuilder extends AbstractThreadPoolBuilder {
+
+    /**
+     * 计算核心线程数量
+     *
+     * @return
+     */
+    public int getCorePoolSize() {
+        return CPU_COUNT + 1;
+    }
+
+    public CpuThreadPoolBuilder setThreadFactory(ThreadFactory threadFactory) {
+        this.threadFactory = threadFactory;
+        return this;
+    }
+
+    public CpuThreadPoolBuilder setRejectedExecutionHandler(RejectedExecutionHandler rejectedExecutionHandler) {
+        this.rejectedExecutionHandler = rejectedExecutionHandler;
+        return this;
+    }
+
+    public CpuThreadPoolBuilder setQueueSize(int queueSize) {
+        this.queueSize = queueSize;
+        return this;
+    }
+
+    public CpuThreadPoolBuilder setMaximumPoolSize(int maximumPoolSize) {
+        this.maximumPoolSize = maximumPoolSize;
+        return this;
+    }
+
+    public CpuThreadPoolBuilder setKeepAliveTimeMilliSeconds(int keepAliveTimeMilliSeconds) {
+        this.keepAliveTimeMilliSeconds = keepAliveTimeMilliSeconds;
+        return this;
+    }
+
+    public CpuThreadPoolBuilder setDaemon(boolean daemon) {
+        this.daemon = daemon;
+        return this;
+    }
+
+    public CpuThreadPoolBuilder setThreadNamePrefix(String threadNamePrefix) {
+        this.threadNamePrefix = threadNamePrefix;
+        return this;
+    }
+
+    public DynamicThreadPoolExecutor builder() {
+
+        threadFactory = ThreadPoolUtils.createThreadFactory(this.threadNamePrefix, this.daemon);
+
+        return new DynamicThreadPoolExecutor(
+                getCorePoolSize(),
+                getMaximumPoolSize(getCorePoolSize()),
+                keepAliveTimeMilliSeconds,
+                TimeUnit.MILLISECONDS,
+                getBlockingQueue(),
+                threadFactory,
+                getRejectedExecutionHandler());
+    }
+}

src/main/java/io/baishi/common/thread/threadpool/IoThreadPoolBuilder.java

@@ -0,0 +1,78 @@
+package io.baishi.common.thread.threadpool;
+
+import io.baishi.common.thread.threadpool.dynamic.DynamicThreadPoolExecutor;
+
+import java.util.concurrent.RejectedExecutionHandler;
+import java.util.concurrent.ThreadFactory;
+import java.util.concurrent.TimeUnit;
+
+/**
+ * 处理IO密集的线程池
+ * <p>
+ * 最佳线程数 = CPU核数 * [ 1 +（I/O 耗时 / CPU 耗时）]
+ *
+ * @author baishi
+ * @date 2022/1/17 14:50
+ */
+public class IoThreadPoolBuilder extends AbstractThreadPoolBuilder {
+
+    /**
+     * 计算核心线程数量
+     *
+     * @param ioTime
+     * @param cpuTime
+     * @return
+     */
+    public int getCorePoolSize(int ioTime, int cpuTime) {
+        return CPU_COUNT + (1 + (ioTime / cpuTime));
+    }
+
+    public IoThreadPoolBuilder setThreadFactory(ThreadFactory threadFactory) {
+        this.threadFactory = threadFactory;
+        return this;
+    }
+
+    public IoThreadPoolBuilder setRejectedExecutionHandler(RejectedExecutionHandler rejectedExecutionHandler) {
+        this.rejectedExecutionHandler = rejectedExecutionHandler;
+        return this;
+    }
+
+    public IoThreadPoolBuilder setQueueSize(int queueSize) {
+        this.queueSize = queueSize;
+        return this;
+    }
+
+    public IoThreadPoolBuilder setMaximumPoolSize(int maximumPoolSize) {
+        this.maximumPoolSize = maximumPoolSize;
+        return this;
+    }
+
+    public IoThreadPoolBuilder setKeepAliveTimeMilliSeconds(int keepAliveTimeMilliSeconds) {
+        this.keepAliveTimeMilliSeconds = keepAliveTimeMilliSeconds;
+        return this;
+    }
+
+    public IoThreadPoolBuilder setDaemon(boolean daemon) {
+        this.daemon = daemon;
+        return this;
+    }
+
+    public IoThreadPoolBuilder setThreadNamePrefix(String threadNamePrefix) {
+        this.threadNamePrefix = threadNamePrefix;
+        return this;
+    }
+
+    public DynamicThreadPoolExecutor builder(int ioTime, int cpuTime) {
+
+        threadFactory = ThreadPoolUtils.createThreadFactory(this.threadNamePrefix, this.daemon);
+
+        return new DynamicThreadPoolExecutor(
+                getCorePoolSize(ioTime, cpuTime),
+                getMaximumPoolSize(getCorePoolSize(ioTime, cpuTime)),
+                keepAliveTimeMilliSeconds,
+                TimeUnit.MILLISECONDS,
+                getBlockingQueue(),
+                threadFactory,
+                getRejectedExecutionHandler());
+    }
+}