开发一个mybatis主键自动生成的插件 默认使用雪花算法生成Id
前言：
最近阅读了mybatis相关的源码 知道了mybatis插件的运行流程 于是自己尝试着开发一个主键自动生成的插件出来 这样在数据库的主键不能自动生成的时候 可以不用每次都给实体类赋值
注：本次开发环境为单纯的mybatis环境
相信阅读过mybatis源码的同学都知道 mybatis四大组件 分别是 Executor ParamHandler ResultSetHandler StatementHandler mybatis 基本就是使用Executor来做我们的数据库交互操作 我们想要在插入数据的时候自动生成主键Id 那么我们需要在插入的时候拦截到实体类 然后给实体类的主键字段赋值 然后继续操作
思路就是这个思路 下面开始撸
1 开发一个注解 标注实体类是否需要我们的主键自增策略
import java.lang.annotation.*;
@Target(value = ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface AutoGenegrateId {
String name();
}其中 name为实体类 主键的字段名称
2 主键生成的策略
先开发一个抽象主键生成策略类 默认实现为 雪花算法
2.1 雪花算法工具类
package com.pps.core.generate;
import java.lang.management.ManagementFactory;
import java.net.InetAddress;
import java.net.NetworkInterface;
/**
* 名称：IdWorker.java
* 描述：分布式自增长ID
*
* Twitter的 Snowflake JAVA实现方案
*
* 核心代码为其IdWorker这个类实现，其原理结构如下，我分别用一个0表示一位，用—分割开部分的作用：
* 1||0---0000000000 0000000000 0000000000 0000000000 0 --- 00000 ---00000 ---000000000000
* 在上面的字符串中，第一位为未使用（实际上也可作为long的符号位），接下来的41位为毫秒级时间，
* 然后5位datacenter标识位，5位机器ID（并不算标识符，实际是为线程标识），
* 然后12位该毫秒内的当前毫秒内的计数，加起来刚好64位，为一个Long型。
* 这样的好处是，整体上按照时间自增排序，并且整个分布式系统内不会产生ID碰撞（由datacenter和机器ID作区分），
* 并且效率较高，经测试，snowflake每秒能够产生26万ID左右，完全满足需要。
*
* 64位ID (42(毫秒)+5(机器ID)+5(业务编码)+12(重复累加))
*
* @author Polim
*/
public class IdWorker {
/**
* 时间起始标记点，作为基准，一般取系统的最近时间（一旦确定不能变动）
*/
private final static long twepoch = 1288834974657L;
/**
* 机器标识位数
*/
private final static long workerIdBits = 5L;
/**
* 数据中心标识位数
*/
private final static long datacenterIdBits = 5L;
/**
* 机器ID最大值
*/
private final static long maxWorkerId = -1L ^ (-1L << workerIdBits);
/**
* 数据中心ID最大值
*/
private final static long maxDatacenterId = -1L ^ (-1L << datacenterIdBits);
/**
* 毫秒内自增位
*/
private final static long sequenceBits = 12L;
/**
* 机器ID偏左移12位
*/
private final static long workerIdShift = sequenceBits;
/**
* 数据中心ID左移17位
*/
private final static long datacenterIdShift = sequenceBits + workerIdBits;
/**
* 时间毫秒左移22位
*/
private final static long timestampLeftShift = sequenceBits + workerIdBits + datacenterIdBits;
private final static long sequenceMask = -1L ^ (-1L << sequenceBits);
/**
* 上次生产id时间戳
*/
private static long lastTimestamp = -1L;
/**
* 并发控制
*/
private long sequence = 0L;
private final long workerId;
/**
* 数据标识id部分
*/
private final long datacenterId;
public IdWorker(){
this.datacenterId = getDatacenterId(maxDatacenterId);
this.workerId = getMaxWorkerId(datacenterId, maxWorkerId);
}
/**
* @param workerId
* 工作机器ID
* @param datacenterId
* 序列号
*/
public IdWorker(long workerId, long datacenterId) {
if (workerId > maxWorkerId || workerId < 0) {
throw new IllegalArgumentException(String.format("worker Id can't be greater than %d or less than 0", maxWorkerId));
}
if (datacenterId > maxDatacenterId || datacenterId < 0) {
throw new IllegalArgumentException(String.format("datacenter Id can't be greater than %d or less than 0", maxDatacenterId));
}
this.workerId = workerId;
this.datacenterId = datacenterId;
}
/**
* 获取下一个ID
*
* @return
*/
public synchronized long nextId() {
long timestamp = timeGen();
if (timestamp < lastTimestamp) {
throw new RuntimeException(String.format("Clock moved backwards. Refusing to generate id for %d milliseconds", lastTimestamp - timestamp));
}
if (lastTimestamp == timestamp) {
// 当前毫秒内，则+1
sequence = (sequence + 1) & sequenceMask;
if (sequence == 0) {
// 当前毫秒内计数满了，则等待下一秒
timestamp = tilNextMillis(lastTimestamp);
}
} else {
sequence = 0L;
}
lastTimestamp = timestamp;
// ID偏移组合生成最终的ID，并返回ID
long nextId = ((timestamp - twepoch) << timestampLeftShift)
| (datacenterId << datacenterIdShift)
| (workerId << workerIdShift) | sequence;
return nextId;
}
private long tilNextMillis(final long lastTimestamp) {
long timestamp = this.timeGen();
while (timestamp <= lastTimestamp) {
timestamp = this.timeGen();
}
return timestamp;
}
private long timeGen() {
return System.currentTimeMillis();
}
/**
*
* 获取 maxWorkerId
*
*/
protected static long getMaxWorkerId(long datacenterId, long maxWorkerId) {
StringBuffer mpid = new StringBuffer();
mpid.append(datacenterId);
String name = ManagementFactory.getRuntimeMXBean().getName();
if (!name.isEmpty()) {
/*
* GET jvmPid
*/
mpid.append(name.split("@")[0]);
}
/*
* MAC + PID 的 hashcode 获取16个低位
*/
return (mpid.toString().hashCode() & 0xffff) % (maxWorkerId + 1);
}
/**
*
* 数据标识id部分
*
*/
protected static long getDatacenterId(long maxDatacenterId) {
long id = 0L;
try {
InetAddress ip = InetAddress.getLocalHost();
NetworkInterface network = NetworkInterface.getByInetAddress(ip);
if (network == null) {
id = 1L;
} else {
byte[] mac = network.getHardwareAddress();
id = ((0x000000FF & (long) mac[mac.length - 1])
| (0x0000FF00 & (((long) mac[mac.length - 2]) << 8))) >> 6;
id = id % (maxDatacenterId + 1);
}
} catch (Exception e) {
System.out.println(" getDatacenterId: " + e.getMessage());
}
return id;
}
}2.2 抽象类
public abstract class IdStrategy {
private final IdWorker idWorker = new IdWorker(1, 1);
/**
* @description: 默认实现 雪花算法
* @params: length 长度限制
* @return: java.lang.Object
* @author:
* @time: 2020/8/20 15:39
*/
public Object product() {
return idWorker.nextId();
}
}2.3 自定义返回数据类型 因为我的实体类为int
/**
* @author
* @discription;
* @time 2020/8/20 15:59
*/
public class MyIdStrategy extends IdStrategy {
@Override
public Object product() {
return ((Long)super.product()).intValue();
}
}
3 开发插件
import com.pps.core.annotion.AutoGenegrateId;
import com.pps.core.generate.IdStrategy;
import com.pps.core.generate.MyIdStrategy;
import org.apache.ibatis.executor.Executor;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.plugin.*;
import java.lang.reflect.Field;
import java.util.Properties;
import java.util.Random;
/**
* @author
* @discription;
* @time 2020/8/18 17:08
*/
@Intercepts({@Signature(
type= Executor.class,
method = "update",
args = {MappedStatement.class,Object.class})})
public class MyInterceptor implements Interceptor {
private IdStrategy idStrategy=new MyIdStrategy();
@Override
public Object intercept(Invocation invocation) throws Throwable {
Object[] args = invocation.getArgs();
if(args.length==2&&args[1]!=null){
Object paramObject = args[1];
Class aClass = paramObject.getClass();
AutoGenegrateId annotation = aClass.getAnnotation(AutoGenegrateId.class);
if(annotation!=null){
String name = annotation.name();
Field declaredField = aClass.getDeclaredField(name);
if(declaredField!=null){
declaredField.setAccessible(true);
declaredField.set(paramObject, idStrategy.product());
args[1]=paramObject;
}else {
throw new RuntimeException("注解["+name+"] 的域在实体类中不存在");
}
}
}
Object proceed = invocation.proceed();
return proceed;
}
@Override
public Object plugin(Object o) {
return Plugin.wrap(o,this);
}
@Override
public void setProperties(Properties properties) {
System.out.println("进入到我的拦截器配置了：----配置如下");
properties.entrySet().forEach(p->{
System.out.println(p.getKey()+":"+p.getValue());
});
}
}ok 搞定了 测试一下
String resource = "SqlMappingConfig.xml";
// 得到配置文件流
InputStream inputStream = Resources.getResourceAsStream(resource);
// 创建会话工厂，传入mybatis的配置文件信息
SqlSession sqlSession = new SqlSessionFactoryBuilder().build(inputStream).openSession();
User user1 = new User();
user1.setName("ttttttt");
int insert = sqlSession.insert("com.pps.mapper.UserMapper.insert", user1);
sqlSession.commit();可以看到我的User 没有给Id赋值 但是数据库
生成了Id
奉上 我的 配置环境
完整项目 体验请上我的github: 记得帮我点星 谢谢！
https://github.com/pupansheng/mybatis-study