为什么要使用位运算表示线程池状态?
共 7926字，需浏览 16分钟
·
2021-03-07 04:30
我们阅读ThreadPoolExecutor源码时在开篇就会发现很多位运算代码：
public class ThreadPoolExecutor extends AbstractExecutorService {
private final AtomicInteger ctl = new AtomicInteger(ctlOf(RUNNING, 0));
private static final int COUNT_BITS = Integer.SIZE - 3;
private static final int CAPACITY = (1 << COUNT_BITS) - 1;
private static final int RUNNING = -1 << COUNT_BITS;
private static final int SHUTDOWN = 0 << COUNT_BITS;
private static final int STOP = 1 << COUNT_BITS;
private static final int TIDYING = 2 << COUNT_BITS;
private static final int TERMINATED = 3 << COUNT_BITS;
private static int runStateOf(int c) { return c & ~CAPACITY; }
private static int workerCountOf(int c) { return c & CAPACITY; }
private static int ctlOf(int rs, int wc) { return rs | wc; }
}
不难发现线程状态都用位运算表示，但是为什么要这样做呢？为什么不定义为直观的数字呢？下面我们进行分析。虽然代码量不多，但是想要理解线程池就必须要理解为什么使用位运算。
ThreadPoolExecutor在设计时就是用一个int数值表示了两个业务含义：线程池状态和线程数量。其中高3位表示线程池状态，低29位表示线程数量，这个设计思想体现在以下三句代码：
// 代码1
private final AtomicInteger ctl = new AtomicInteger(ctlOf(RUNNING, 0));
// 代码2
private static final int COUNT_BITS = Integer.SIZE - 3;
// 代码3
private static final int CAPACITY = (1 << COUNT_BITS) - 1;
代码1表示用一个int保存线程池信息，代码2表示一共有(32-3)=29位可以表示线程数量，代码3表示理论上最大线程数量为536870911，这个理论值足以支撑线程池使用。
1 线程池状态
我们明白了线程池上述设计思想，下面就来分析线程池状态值：
private static final int RUNNING = -1 << COUNT_BITS;
private static final int SHUTDOWN = 0 << COUNT_BITS;
private static final int STOP = 1 << COUNT_BITS;
private static final int TIDYING = 2 << COUNT_BITS;
private static final int TERMINATED = 3 << COUNT_BITS;
我们知道COUNT_BITS=29则上述代码等价于：
private static final int RUNNING = -1 << 29;
private static final int SHUTDOWN = 0 << 29;
private static final int STOP = 1 << 29;
private static final int TIDYING = 2 << 29;
private static final int TERMINATED = 3 << 29;
现在我们算一算这些状态等于多少，在这里我们从后往前算，因为RUNNING状态是负数左移运算，计算步骤稍微多一些。
(1) TERMINATED = 3 << 29
初始值：00000000 00000000 00000000 00000011
左移后：01100000 00000000 00000000 00000000
(2) TIDYING = 2 << 29
初始值：00000000 00000000 00000000 00000010
左移后：01000000 00000000 00000000 00000000
(3) STOP = 1 << 29
初始值：00000000 00000000 00000000 00000001
左移后：00100000 00000000 00000000 00000000
(4) SHUTDOWN = 0 << 29
初始值：00000000 00000000 00000000 00000000
左移后：00000000 00000000 00000000 00000000
(5) RUNNING = -1 << 29
原码：10000000 00000000 00000000 00000001
反码：11111111 11111111 11111111 11111110（原码符号位不变、数值位取反）
补码：11111111 11111111 11111111 11111111（反码+1）
左移：11100000 00000000 00000000 00000000
2 位运算应用
runStateOf方法用来获取线程池状态信息，workerCountOf方法用来获取线程池线程数，ctlOf方法用来设置当前线程池状态和线程数量信息，我们分别进行计算。
private static int runStateOf(int c) { return c & ~CAPACITY; }
private static int workerCountOf(int c) { return c & CAPACITY; }
private static int ctlOf(int rs, int wc) { return rs | wc; }
(1) CAPACITY = (1 << 29) - 1
先左移：00100000 00000000 00000000 00000000
再减一：00011111 11111111 11111111 11111111
(2) ~CAPACITY
原始值：00011111 11111111 11111111 11111111
取反后：11100000 00000000 00000000 00000000
(3) runStateOf
现在一个线程池状态是RUNNING并且线程数量等于3用二进制表示如下：
11100000 00000000 00000000 00000011
执行runStateOf方法就可以得到线程池状态：
11100000 00000000 00000000 00000011
&
11100000 00000000 00000000 00000000
=
11100000 00000000 00000000 00000000
(4) workerCountOf
现在一个线程池状态是RUNNING并且线程数量等于4用二进制表示如下：
11100000 00000000 00000000 00000100
执行workerCountOf方法就可以得到线程数量：
11100000 00000000 00000000 00000100
&
00011111 11111111 11111111 11111111
=
00000000 00000000 00000000 00000100
(5) ctlOf
现在我们要设置一个状态是RUNNING且线程数量等于4的线程池ctl值：
private final AtomicInteger ctl = new AtomicInteger(ctlOf(RUNNING, 4));
11100000 00000000 00000000 00000000
|
00000000 00000000 00000000 00000100
=
11100000 00000000 00000000 00000100
这个方法真正体现了高3位表示线程池状态，低29位表示线程数量这个设计思想优点，原本需要两步设置动作现在只需要一步，从而实现了操作原子性，这样就可以满足线程池的很多CAS操作，例如线程池在调用addWorker新增工作线程数时会调用compareAndIncrementWorkerCount方法增加线程数量。
但是假设同一时刻shutdownNow方法导致线程池状态发生改变，那么新增工作线程数方法就不会调用成功，需要继续执行自旋进行尝试，这体现了线程状态和线程数量维护的原子性。
3 位图法应用
3.1 需求背景
我们看看位运算怎样应用在实际开发场景。假设在系统中用户一共有三种角色：普通用户、管理员、超级管理员，现在需要设计一张用户角色表记录这类信息。我们不难设计出如下方案：
| id | name | super | admin | normal |
|---|---|---|---|---|
| 101 | 用户一 | 1 | 0 | 0 |
| 102 | 用户二 | 0 | 1 | 0 |
| 103 | 用户三 | 0 | 0 | 1 |
| 104 | 用户四 | 1 | 1 | 1 |
我们使用1表示是，0表示否，那么观察上表不难得出，用户一有用超级管理员角色，用户二具有管理员角色，用户三具有普通用户角色，用户四同时具有三种角色。如果此时新增加一种角色呢？那么新增一个字段即可。
3.2 发现问题
按照上述一个字段表示一种角色进行表设计功能上是没有问题的，优点是容易理解结构清晰，但是我们想一想有没有什么问题？笔者遇到过如下问题：在复杂业务环境一份数据可能会使用在不同的场景，例如上述数据存储在MySQL数据库，这一份数据还会被用在如下场景：
检索数据需要同步一份到ES
业务方使用此表通过Flink计算业务指标
业务方订阅此表Binlog消息进行业务处理
如果表结构发生变化，数据源之间就要重新进行对接，业务方也要进行代码修改，这样开发成本比较非常高。有没有办法避免此类问题？
3.3 解决方案
我们可以使用位图法，这样同一个字段可以表示多个业务含义。首先设计如下数据表，userFlag字段暂时不填。
| id | name | user_flag |
|---|---|---|
| 101 | 用户一 | 暂时不填 |
| 102 | 用户二 | 暂时不填 |
| 103 | 用户三 | 暂时不填 |
| 104 | 用户四 | 暂时不填 |
我们设计位图每一个bit表示一种角色：
我们使用位图法表示如下数据表：
| id | name | super | admin | normal |
|---|---|---|---|---|
| 101 | 用户一 | 1 | 0 | 0 |
| 102 | 用户二 | 0 | 1 | 0 |
| 103 | 用户三 | 0 | 0 | 1 |
| 104 | 用户四 | 1 | 1 | 1 |
用户一位图如下十进制数值等于4：
用户二位图如下十进制数值等于2：
用户三位图如下十进制数值等于1：
用户四位图如下十进制数值等于7：
现在我们可以填写数据表第三列：
| id | name | user_flag |
|---|---|---|
| 101 | 用户一 | 4 |
| 102 | 用户二 | 2 |
| 103 | 用户三 | 1 |
| 104 | 用户四 | 7 |
3.4 代码实例
(1) 枚举定义
定义枚举时不要直接定义为1、2、4这类数字，而是采用位移方式进行定义，这样使用者可以明白设计者的意图。
/**
* 用户角色枚举
*
* @author 微信公众号「JAVA前线」
*
*/
public enum UserRoleEnum {
// 1 -> 00000001
NORMAL(1, "普通用户"),
// 2 -> 00000010
MANAGER(1 << 1, "管理员"),
// 4 -> 00000100
SUPER(1 << 2, "超级管理员")
;
private int code;
private String description;
private UserRoleEnum(Integer code, String description) {
this.code = code;
this.description = description;
}
public String getDescription() {
return description;
}
public int getCode() {
return this.code;
}
}
假设用户已经具有普通用户角色，我们需要为其增加管理员角色，这就是新增角色，与之对应还有删除角色和查询角色，这些操作需要用到为位运算，详见代码注释。
/**
* 用户角色枚举
*
* @author 微信公众号「JAVA前线」
*
*/
public enum UserRoleEnum {
// 1 -> 00000001
NORMAL(1, "普通用户"),
// 2 -> 00000010
MANAGER(1 << 1, "管理员"),
// 4 -> 00000100
SUPER(1 << 2, "超级管理员")
;
// 新增角色 -> 位或操作
// oldRole -> 00000001 -> 普通用户
// addRole -> 00000010 -> 新增管理员
// newRole -> 00000011 -> 普通用户和管理员
public static Integer addRole(Integer oldRole, Integer addRole) {
return oldRole | addRole;
}
// 删除角色 -> 位异或操作
// oldRole -> 00000011 -> 普通用户和管理员
// delRole -> 00000010 -> 删除管理员
// newRole -> 00000001 -> 普通用户
public static Integer removeRole(Integer oldRole, Integer delRole) {
return oldRole ^ delRole;
}
// 是否有某种角色 -> 位与操作
// allRole -> 00000011 -> 普通用户和管理员
// qryRole -> 00000001 -> 是否有管理员角色
// resRole -> 00000001 -> 有普通用户角色
public static boolean hasRole(Integer allRole, Integer qryRole) {
return qryRole == (role & qryRole);
}
private int code;
private String description;
private UserRoleEnum(Integer code, String description) {
this.code = code;
this.description = description;
}
public String getDescription() {
return description;
}
public int getCode() {
return this.code;
}
public static void main(String[] args) {
System.out.println(addRole(1, 2));
System.out.println(removeRole(3, 1));
System.out.println(hasRole(3, 1));
}
}
(2) 数据查询
假设在运营后台查询界面中，需要查询具有普通用户角色的用户数据，可以使用如下SQL语句：
select * from user_role where (user_flag & 1) = user_flag;
select * from user_role where (user_flag & b'0001') = user_flag;
我们也可以使用如下MyBatis语句：
<select id="selectByUserRole" resultMap="BaseResultMap" parameterType="java.util.Map">
select * from user_role
where user_flag & #{userFlag} = #{userFlag}
</select>
<select id="selectByUserIdAndRole" resultMap="BaseResultMap" parameterType="java.util.Map">
select * from user_role
where id = #{userId} and user_flag & #{userFlag} = #{userFlag}
</select>
4 文章总结
本文首先分析了位运算在Java线程池源码的应用，然后我们又介绍了位图法，这样一个字段就可以表示多个含义，从而减少了字段冗余，节省了对接和开发的成本。当然位图法也有缺点，例如数据库字段含义不直观需要进行转义，增加了代码理解成本，大家可以根据需求场景选择使用，希望本文对大家有所帮助。
-- End --
———————
1.原创不易，你的「在看」是我创作的动力。
2.欢迎关注公众号 牧小码农，「带你一起学Java」！
3.疫情期间，勤洗手，戴口罩，做好个人防护。
“在看转发”是最大的支持