This commit is contained in:
Looly 2024-10-02 17:06:23 +08:00
parent 463a8308e0
commit 3f23326788
16 changed files with 200 additions and 29 deletions

View File

@ -34,8 +34,6 @@
<properties>
<Automatic-Module-Name>org.dromara.hutool.crypto</Automatic-Module-Name>
<!-- versions -->
<bouncycastle.version>1.78.1</bouncycastle.version>
</properties>
<dependencies>

80
hutool-jmh/README.md Normal file
View File

@ -0,0 +1,80 @@
<p align="center">
<a href="https://hutool.cn/"><img src="https://plus.hutool.cn/images/hutool.svg" width="45%"></a>
</p>
<p align="center">
<strong>🍬Make Java Sweet Again.</strong>
</p>
<p align="center">
👉 <a href="https://hutool.cn">https://hutool.cn/</a> 👈
</p>
## 📚Hutool-jmh 模块介绍
`Hutool-jmh`提供性能对比测试
## 安装
### 引入依赖
```xml
<!-- 基准性能测试 -->
<dependency>
<groupId>org.openjdk.jmh</groupId>
<artifactId>jmh-core</artifactId>
<version>${jmh.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.openjdk.jmh</groupId>
<artifactId>jmh-generator-annprocess</artifactId>
<version>${jmh.version}</version>
<scope>test</scope>
</dependency>
```
### 安装插件
IDEA安装`JMH Java Microbenchmark Harness`插件主页见https://plugins.jetbrains.com/plugin/7529-jmh-java-microbenchmark-harness
## 注解说明
### @BenchmarkMode
使用哪种模式测试JMH 提供了4种不同的模式
- `Mode.Throughput` 吞吐量, ops/time。单位时间内执行操作的平均次数例如“1秒内可以执行多少次调用”
- `Mode.AverageTime` 平均时间, time/op。 执行每次操作所需的平均时间例如“每次调用平均耗时xxx毫秒”
- `Mode.SampleTime` 采样时间, time/op。 同 AverageTime。区别在于会统计取样分布例如“99%的调用在xxx毫秒以内99.99%的调用在xxx毫秒以内”
- `Mode.SingleShotTime` 单次时间, time。 同 AverageTime。区别在于只执行一次操作。这种模式的结果存在较大随机性往往同时把 warmup 次数设为0用于测试冷启动时的性能。
### @Warmup和 @Measurement
@Warmup@Measurement分别用于配置预热迭代和测试迭代。其中:
- iterations 用于指定迭代次数。
- time 和 timeUnit 用于每个迭代的时间。
- batchSize 表示执行多少次 Benchmark为一个invocation。
### @State
类注解JMH 测试类必须使用 @State 注解,它定义了一个类实例的生命周期,有三种类型:
- `Scope.Thread`:每个线程一个实例,适合不共享数据的测试。
- `Scope.Benchmark`:所有测试线程共享一个实例,用于测试有状态实例在多线程共享下的性能;
- `Scope.Group`:每个线程组共享一个实例;
### @Fork
进行 fork 的次数。如果 fork 数是2的话则 JMH 会 fork 出两个进程来进行测试。
### @Setup@TearDown
方法注解。
- `@Setup`会在执行 benchmark 之前被执行,主要用于初始化。
- `@TearDown`会在执行 benchmark 之后被执行,主要用于资源的回收等。
### @Benchmark
方法注解,表示该方法是需要进行 benchmark 的对象。
### @OutputTimeUnit
输出的时间单位。
### @Param
成员注解,可以用来指定某项参数的多种情况。特别适合用来测试一个函数在不同的参数输入的情况下的性能。@Param 注解接收一个String数组@Setup 方法执行前转化为为对应的数据类型。
多个 @Param 注解的成员之间是乘积关系,譬如有两个用 @Param 注解的字段第一个有5个值第二个字段有2个值那么每个测试方法会跑5*2=10次。
## 参考:
[如何在 Java 中使用 JMH 进行基准测试](https://segmentfault.com/a/1190000039902797)

101
hutool-jmh/pom.xml Normal file
View File

@ -0,0 +1,101 @@
<?xml version='1.0' encoding='utf-8'?>
<!--
~ Copyright (c) 2024 Hutool Team and hutool.cn
~
~ Licensed under the Apache License, Version 2.0 (the "License");
~ you may not use this file except in compliance with the License.
~ You may obtain a copy of the License at
~
~ http://www.apache.org/licenses/LICENSE-2.0
~
~ Unless required by applicable law or agreed to in writing, software
~ distributed under the License is distributed on an "AS IS" BASIS,
~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
~ See the License for the specific language governing permissions and
~ limitations under the License.
-->
<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/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<packaging>jar</packaging>
<parent>
<groupId>org.dromara.hutool</groupId>
<artifactId>hutool-parent</artifactId>
<version>6.0.0-M17</version>
</parent>
<artifactId>hutool-jmh</artifactId>
<name>${project.artifactId}</name>
<description>Hutool 性能测试</description>
<properties>
<Automatic-Module-Name>org.dromara.hutool.jmh</Automatic-Module-Name>
<!-- 此模块不部署 -->
<maven.deploy.skip>true</maven.deploy.skip>
<jmh.version>1.37</jmh.version>
<jackson.version>2.17.2</jackson.version>
<gson.version>2.11.0</gson.version>
<fastjson2.version>2.0.41</fastjson2.version>
<moshi.version>1.15.1</moshi.version>
</properties>
<dependencies>
<dependency>
<groupId>org.dromara.hutool</groupId>
<artifactId>hutool-bom</artifactId>
<version>${project.parent.version}</version>
<type>pom</type>
<scope>test</scope>
</dependency>
<!-- 基准性能测试 -->
<dependency>
<groupId>org.openjdk.jmh</groupId>
<artifactId>jmh-core</artifactId>
<version>${jmh.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.openjdk.jmh</groupId>
<artifactId>jmh-generator-annprocess</artifactId>
<version>${jmh.version}</version>
<scope>test</scope>
</dependency>
<!-- JSON 引擎实现 -->
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>${jackson.version}</version>
<optional>true</optional>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.datatype</groupId>
<artifactId>jackson-datatype-jsr310</artifactId>
<version>${jackson.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>com.google.code.gson</groupId>
<artifactId>gson</artifactId>
<version>${gson.version}</version>
<optional>true</optional>
</dependency>
<dependency>
<groupId>com.alibaba.fastjson2</groupId>
<artifactId>fastjson2</artifactId>
<version>${fastjson2.version}</version>
<optional>true</optional>
</dependency>
<dependency>
<groupId>com.squareup.moshi</groupId>
<artifactId>moshi</artifactId>
<version>1.15.1</version>
<optional>true</optional>
</dependency>
</dependencies>
</project>

View File

@ -1,5 +1,6 @@
package org.dromara.hutool.core.io.buffer;
package org.dromara.hutool.jmh.core;
import org.dromara.hutool.core.io.buffer.FastCharBuffer;
import org.openjdk.jmh.annotations.*;
import java.util.concurrent.TimeUnit;

View File

@ -0,0 +1,4 @@
/**
* 核心包性能测试
*/
package org.dromara.hutool.jmh.core;

View File

@ -14,7 +14,7 @@
* limitations under the License.
*/
package org.dromara.hutool.json.jmh;
package org.dromara.hutool.jmh.json;
import lombok.AllArgsConstructor;
import lombok.Data;

View File

@ -14,7 +14,7 @@
* limitations under the License.
*/
package org.dromara.hutool.json.jmh;
package org.dromara.hutool.jmh.json;
import com.fasterxml.jackson.databind.JsonNode;
import com.google.gson.JsonElement;

View File

@ -1,4 +1,4 @@
package org.dromara.hutool.json.jmh;
package org.dromara.hutool.jmh.json;
import com.fasterxml.jackson.databind.node.ArrayNode;
import com.fasterxml.jackson.databind.node.JsonNodeFactory;

View File

@ -1,4 +1,4 @@
package org.dromara.hutool.json.jmh;
package org.dromara.hutool.jmh.json;
import com.fasterxml.jackson.databind.node.JsonNodeFactory;
import com.fasterxml.jackson.databind.node.ObjectNode;

View File

@ -1,4 +1,4 @@
package org.dromara.hutool.json.jmh;
package org.dromara.hutool.jmh.json;
import com.alibaba.fastjson2.JSON;
import com.google.gson.JsonElement;

View File

@ -1,4 +1,4 @@
package org.dromara.hutool.json.jmh;
package org.dromara.hutool.jmh.json;
import com.alibaba.fastjson2.JSON;
import com.fasterxml.jackson.core.JsonProcessingException;

View File

@ -0,0 +1,4 @@
/**
* JSON性能测试
*/
package org.dromara.hutool.jmh.json;

View File

@ -35,7 +35,6 @@
<properties>
<Automatic-Module-Name>org.dromara.hutool.json</Automatic-Module-Name>
<!-- versions -->
<bouncycastle.version>1.78.1</bouncycastle.version>
<jjwt.version>0.12.6</jjwt.version>
<jackson.version>2.17.2</jackson.version>
<gson.version>2.11.0</gson.version>

View File

@ -434,7 +434,7 @@ public class JSONUtil {
* 转换对象为JSON如果用户不配置JSONConfig则JSON的有序与否与传入对象有关<br>
* 支持的对象
* <ul>
* <li>booleanNumberString: 转换为{@link JSONPrimitive}/li>
* <li>booleanNumberString: 转换为{@link JSONPrimitive}</li>
* <li>ArrayIterableIterator转换为{@link JSONArray}</li>
* <li>Bean对象转为{@link JSONObject}</li>
* </ul>

View File

@ -1,4 +0,0 @@
/**
* 测试包用于JMH基准测试
*/
package org.dromara.hutool.json.jmh;

16
pom.xml
View File

@ -46,6 +46,7 @@
<module>hutool-poi</module>
<module>hutool-socket</module>
<module>hutool-swing</module>
<module>hutool-jmh</module>
</modules>
<properties>
@ -58,7 +59,7 @@
<junit.version>5.10.3</junit.version>
<lombok.version>1.18.34</lombok.version>
<kotlin-version>1.9.25</kotlin-version>
<jmh.version>1.37</jmh.version>
<bouncycastle.version>1.78.1</bouncycastle.version>
</properties>
<dependencies>
@ -82,19 +83,6 @@
<version>${lombok.version}</version>
<scope>test</scope>
</dependency>
<!-- 基准性能测试 -->
<dependency>
<groupId>org.openjdk.jmh</groupId>
<artifactId>jmh-core</artifactId>
<version>${jmh.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.openjdk.jmh</groupId>
<artifactId>jmh-generator-annprocess</artifactId>
<version>${jmh.version}</version>
<scope>test</scope>
</dependency>
</dependencies>
<issueManagement>