并发测试工具_JUC整理笔记三之测试工具jcstress

并发测试工具Jcstress使用教程

Jcstress 全称 Java Concurrency Stress&＃xff0c;是一种并发压力测试工具&＃xff0c;可以帮助研究JVM、java类库和硬件中并发的正确性。

Wiki地址&＃xff1a;https://wiki.openjdk.java.net/display/CodeTools/jcstress

Wiki中有一个Jcstress的example&＃xff0c;可以根据example很方便入门使用jcstress。当然&＃xff0c;我们也可以手动创建自己的Jcstress测试工程。

Maven例子

添加maven依赖

org.openjdk.jcstress jcstress-core 0.5org.openjdk.jcstress jcstress-samples 0.5

pom.xml 可以如下:

4.0.0jfound jcstress-test 1.0.0-SNAPSHOTUTF-8org.openjdk.jcstress jcstress-core 0.5org.openjdk.jcstress jcstress-samples 0.5org.apache.maven.plugins maven-compiler-plugin 3.8.11111

新增一个测试类&＃xff0c;这次以测试变量加 volatile 和不加 volatile 的区别。代码如下&＃xff1a;

package jfound;import org.openjdk.jcstress.annotations.*;public class VolatileTest { &＃64;JCStressTest(Mode.Termination) &＃64;Outcome(id &＃61; "TERMINATED", expect &＃61; Expect.ACCEPTABLE) &＃64;Outcome(id &＃61; "STALE", expect &＃61; Expect.ACCEPTABLE_INTERESTING) &＃64;State public static class NoVolatile { private int i &＃61; 0; &＃64;Actor public void actor() { while (i &＃61;&＃61; 0) { //nothing } } &＃64;Signal public void single() { i &＃61; 1; } } &＃64;JCStressTest(Mode.Termination) &＃64;Outcome(id &＃61; "TERMINATED", expect &＃61; Expect.ACCEPTABLE) &＃64;Outcome(id &＃61; "STALE", expect &＃61; Expect.FORBIDDEN) &＃64;State public static class AddVolatile { private volatile int i &＃61; 0; &＃64;Actor public void actor() { while (i &＃61;&＃61; 0) { //nothing } } &＃64;Signal public void single() { i &＃61; 1; } }}

VolatileTest 类里面有两个静态内部类&＃xff0c;其中 NoVolatile 的 i 是没有加 volatile 关键字的&＃xff0c;AddVolatile 类中的 i 是有加 volatile 关键字的。

测试注解说明

• org.openjdk.jcstress.annotations.JCStressTest

该注解标记一个类为一个并发测试的类&＃xff0c;有一个属性 value 为 org.openjdk.jcstress.annotations.Mode。mode 有Continuous 和 Termination 两种模式。Continuous 模式是运行几个 org.openjdk.jcstress.annotations.Actor 、org.openjdk.jcstress.annotations.Ariter 线程&＃xff0c;并收集结果。Termination 模式运行具有阻塞/循环操作的单个 Actor 和 Singal 的测试。

• org.openjdk.jcstress.annotations.Outcome

Outcome 是描述测试结果&＃xff0c;并处理这个结果&＃xff0c;该注解有 id、expect、desc 这三个属性。

其中 id 接收结果&＃xff0c;如上面的 TERMINATED 、 STALE 就是结果&＃xff0c;id 还支持正则表达式&＃xff1b;expect 是期望处理结果&＃xff0c;类型为 org.openjdk.jcstress.annotationsExpect &＃xff0c;有 ACCEPTABLE、ACCEPTABLE_INTERESTING 、FORBIDDEN、UNKNOWN 四种类型&＃xff0c;ACCEPTABLE 表示接受当前结果&＃xff0c;ACCEPTABLE 结果不一定会存在&＃xff1b;ACCEPTABLE_INTERESTING 和 ACCEPTABLE 差不多&＃xff0c;唯一不一样的是&＃xff0c;这个结果会在生成的报告中高亮&＃xff1b;FORBIDDEN 表示永远不应该出现的结果&＃xff0c;若测试过程中有该结果&＃xff0c;意味着测试失败&＃xff1b; UNKNOWN 没有评分&＃xff0c;不使用。

如上面例子所示&＃xff0c;一个测试类 (JCStressTest) 中可以有一个或多个 Outcome 。

• org.openjdk.jcstress.annotations.State

标记这个类是有状态的&＃xff0c;有状态的意识是拥有数据&＃xff0c;而且数据是可以被修改的&＃xff0c;如上面测试例子中的 i , 其中 i 就是拥有的数据。为了方便理解&＃xff0c;可以拿 Stateless 来做对比&＃xff1b;如一些实体类是有状态(State)的&＃xff0c;Service理应设置为无状态的 Sateless &＃xff0c;尽管service有属性&＃xff0c;但是属性也是不能被修改的。

State 修饰的类必须是 public 的&＃xff0c;不能是内部类&＃xff0c;但是可以是静态内部类&＃xff0c;如上面例子。

State 修饰的类必须有一个默认构造函数

• org.openjdk.jcstress.annotations.Actor

该注解标记的方法会被线程调用&＃xff0c;被 Actor 修饰方法所在的类必须有 State 或者 Result注解&＃xff0c;被其修饰的方法可以抛出异常&＃xff0c;但是抛出异常的话&＃xff0c;会引起测试失败。注意的是&＃xff0c;Actor 标记的每个方法仅由一个特定线程调用&＃xff0c;而且每个被 State 标记的实例仅调用每一个方法 。Actor 修饰的方法之间是没有顺序的&＃xff0c;调用是并发执行的。

与之相对的还有 org.openjdk.jcstress.annotations.Arbiter 注解&＃xff0c;Arbiter 注解和 Actor 注解差不多&＃xff0c;不一样的是 Arbiter 注解声明的方法访问是在所有 State 之后&＃xff0c;而且 Actor 所有的内存都对 Arbiter 可见&＃xff0c;这就使得 Arbiter 在确认最终状态信息上有很大的作用。

• org.openjdk.jcstress.annotations.Singal

改注解在 Termination 模式下是比较有用的&＃xff0c;它标记的方法执行是在 Actor 标记方法执行之后。

• org.openjdk.jcstress.annotations.Result

用该注解标记的类是测试结果的类&＃xff0c;如 org.openjdk.jcstress.infra.results 下的类&＃xff0c;该注解标记的类所有 field 都必须是原生数据类似或者是 String 类型&＃xff0c;所有 field 都应该是 public。可以参考 org.openjdk.jcstress.infra.results 下的类。用法如下

&＃64;Actorpublic void actor1(I_Result r) { r.r1 &＃61; 1;}

把测试结果用 Result 修饰的类接收&＃xff0c;通常是配合 toString 打印出来。

• org.openjdk.jcstress.annotations.Description

与测试无关&＃xff0c;可以定义一些描述&＃xff0c;方便查看

• org.openjdk.jcstress.annotations.Ref

与测试无关&＃xff0c;提供一些引用&＃xff0c;如地址&＃xff0c;ISBN等等。

• org.openjdk.jcstress.annotations.JCStressMeta

Description 、Outcome、Ref 这些注解是可以放到一个公共类&＃xff0c;然后由 JCStressMeta 注解引进来&＃xff0c;以达到重复使用的目的。

运行及结果说明

在idea下执行如下

其中 Main class 填写 org.org.openjdk.jcstress.Main , 参数中的 -t 是指指定测试包名&＃xff0c;不指定的话是默认扫描项目所有包。

在执行完成后&＃xff0c;会在项目所在的目录下生成 results 文件夹&＃xff0c;里面有个 index.html &＃xff0c;用浏览器打开即可查看报告。

总结

本文以一个例子展开来编写 Jcstress 并发测试工具的使用说明&＃xff0c;并描述了 Jcstress 的所有核心注解&＃xff0c;方便初学者去了解并借助该工具来学习并发编程。

本文使用 mdnice 排版