Skip to content

Commit

Permalink
Add maxVibrationOffset to LeafSnowflakeKeyGenerator (#3636)
Browse files Browse the repository at this point in the history
  • Loading branch information
@haetao @terrymanu
haetao authored and terrymanu committed Dec 3, 2019
1 parent 353fae2 commit 2e230c3
Show file tree
Hide file tree
Showing 2 changed files with 82 additions and 5 deletions.
15 changes: 13 additions & 2 deletions ...va/org/apache/shardingsphere/orchestration/internal/keygen/LeafSnowflakeKeyGenerator.java
View file
Expand Up @@ -53,6 +53,8 @@ public final class LeafSnowflakeKeyGenerator implements ShardingKeyGenerator {
private static final long TIMESTAMP_LEFT_SHIFT_BITS = WORKER_ID_LEFT_SHIFT_BITS + WORKER_ID_BITS;

private static final int MAX_TOLERATE_TIME_DIFFERENCE_MILLISECONDS = 10000;

private static final int DEFAULT_VIBRATION_VALUE = 1;

private static final String SERVICE_ID_REGULAR_PATTERN = "^((?!/).)*$";

Expand Down Expand Up @@ -80,7 +82,7 @@ public final class LeafSnowflakeKeyGenerator implements ShardingKeyGenerator {

private RegistryCenter leafRegistryCenter;

private byte sequenceOffset;
private int sequenceOffset = -1;

private long sequence;

Expand All @@ -91,6 +93,8 @@ public final class LeafSnowflakeKeyGenerator implements ShardingKeyGenerator {
private long lastUpdateTime;

private long maxTolerateTimeDifference;

private int maxVibrationOffset;

static {
Calendar calendar = Calendar.getInstance();
Expand All @@ -117,6 +121,7 @@ public synchronized Comparable<?> generateKey() {
private void initializeLeafSnowflakeKeyGeneratorIfNeed() {
if (needToBeInitialized()) {
maxTolerateTimeDifference = initializeMaxTolerateTimeDifference();
maxVibrationOffset = initializeMaxVibrationOffset();
leafRegistryCenter = initializeRegistryCenter();
initializeTimeNodeIfNeed(maxTolerateTimeDifference, leafRegistryCenter);
initializeCurrentMaxWorkIdNodeIfNeed(leafRegistryCenter);
Expand Down Expand Up @@ -273,7 +278,7 @@ private void updateNewData(final RegistryCenter leafRegistryCenter, final String
}

private void vibrateSequenceOffset() {
sequenceOffset = (byte) (~sequenceOffset & 1);
sequenceOffset = sequenceOffset >= maxVibrationOffset ? 0 : sequenceOffset + 1;
}

private long initializeMaxTolerateTimeDifference() {
Expand All @@ -282,6 +287,12 @@ private long initializeMaxTolerateTimeDifference() {
Preconditions.checkArgument(result >= 0L && result < Long.MAX_VALUE);
return result;
}

private int initializeMaxVibrationOffset() {
int result = Integer.parseInt(properties.getProperty("maxVibrationOffset", String.valueOf(DEFAULT_VIBRATION_VALUE)));
Preconditions.checkArgument(result >= 0 && result <= SEQUENCE_MASK, "Illegal max vibration offset");
return result;
}

private RegistryCenterConfiguration getRegistryCenterConfiguration() {
RegistryCenterConfiguration result = new RegistryCenterConfiguration(getRegistryCenterType(), properties);
Expand Down
72 changes: 69 additions & 3 deletions ...rg/apache/shardingsphere/orchestration/internal/keygen/LeafSnowflakeKeyGeneratorTest.java
View file
Expand Up @@ -62,13 +62,63 @@ public void assertGenerateKeyWithSingleThread() {
properties.setProperty("registryCenterType", "ForthTestRegistryCenter");
leafSnowflakeKeyGenerator.setProperties(properties);
FieldUtil.setStaticFinalField(leafSnowflakeKeyGenerator, "timeService", new FixedTimeService(1));
List<Comparable<?>> expected = Arrays.<Comparable<?>>asList(4198401L, 4198402L, 8392704L, 8392705L, 12587009L, 12587010L, 16781312L, 16781313L, 20975617L, 20975618L);
List<Comparable<?>> expected = Arrays.<Comparable<?>>asList(4198400L, 4198401L, 8392705L, 8392706L, 12587008L, 12587009L, 16781313L, 16781314L, 20975616L, 20975617L);
List<Comparable<?>> actual = new ArrayList<>();
for (int i = 0; i < 10; i++) {
actual.add(leafSnowflakeKeyGenerator.generateKey());
}
assertThat(actual, is(expected));
}

@Test
public void assertLastDigitalOfGenerateKeySameMillisecond() {
Properties properties = new Properties();
properties.setProperty("serverList", "127.0.0.1:2181");
properties.setProperty("serviceId", "testService1");
properties.setProperty("digest", "name:123456");
properties.setProperty("maxTimeDifference", "5000");
properties.setProperty("registryCenterType", "ForthTestRegistryCenter");
properties.setProperty("maxVibrationOffset", String.valueOf(3));
FieldUtil.setStaticFinalField(leafSnowflakeKeyGenerator, "timeService", new FixedTimeService(6));
leafSnowflakeKeyGenerator.setProperties(properties);
String actualGenerateKeyBinaryString0 = Long.toBinaryString(Long.parseLong(leafSnowflakeKeyGenerator.generateKey().toString()));
assertThat(Integer.parseInt(actualGenerateKeyBinaryString0.substring(actualGenerateKeyBinaryString0.length() - 3), 2), is(0));
String actualGenerateKeyBinaryString1 = Long.toBinaryString(Long.parseLong(leafSnowflakeKeyGenerator.generateKey().toString()));
assertThat(Integer.parseInt(actualGenerateKeyBinaryString1.substring(actualGenerateKeyBinaryString1.length() - 3), 2), is(1));
String actualGenerateKeyBinaryString2 = Long.toBinaryString(Long.parseLong(leafSnowflakeKeyGenerator.generateKey().toString()));
assertThat(Integer.parseInt(actualGenerateKeyBinaryString2.substring(actualGenerateKeyBinaryString2.length() - 3), 2), is(2));
String actualGenerateKeyBinaryString3 = Long.toBinaryString(Long.parseLong(leafSnowflakeKeyGenerator.generateKey().toString()));
assertThat(Integer.parseInt(actualGenerateKeyBinaryString3.substring(actualGenerateKeyBinaryString3.length() - 3), 2), is(3));
String actualGenerateKeyBinaryString4 = Long.toBinaryString(Long.parseLong(leafSnowflakeKeyGenerator.generateKey().toString()));
assertThat(Integer.parseInt(actualGenerateKeyBinaryString4.substring(actualGenerateKeyBinaryString4.length() - 3), 2), is(4));
}

@Test
public void assertLastDigitalOfGenerateKeyDifferentMillisecond() throws InterruptedException {
Properties properties = new Properties();
properties.setProperty("serverList", "127.0.0.1:2181");
properties.setProperty("serviceId", "testService1");
properties.setProperty("digest", "name:123456");
properties.setProperty("maxTimeDifference", "5000");
properties.setProperty("registryCenterType", "ForthTestRegistryCenter");
properties.setProperty("maxVibrationOffset", String.valueOf(3));
FieldUtil.setStaticFinalField(leafSnowflakeKeyGenerator, "timeService", new TimeService());
leafSnowflakeKeyGenerator.setProperties(properties);
String actualGenerateKeyBinaryString0 = Long.toBinaryString(Long.parseLong(leafSnowflakeKeyGenerator.generateKey().toString()));
assertThat(Integer.parseInt(actualGenerateKeyBinaryString0.substring(actualGenerateKeyBinaryString0.length() - 3), 2), is(0));
Thread.sleep(2L);
String actualGenerateKeyBinaryString1 = Long.toBinaryString(Long.parseLong(leafSnowflakeKeyGenerator.generateKey().toString()));
assertThat(Integer.parseInt(actualGenerateKeyBinaryString1.substring(actualGenerateKeyBinaryString1.length() - 3), 2), is(1));
Thread.sleep(2L);
String actualGenerateKeyBinaryString2 = Long.toBinaryString(Long.parseLong(leafSnowflakeKeyGenerator.generateKey().toString()));
assertThat(Integer.parseInt(actualGenerateKeyBinaryString2.substring(actualGenerateKeyBinaryString2.length() - 3), 2), is(2));
Thread.sleep(2L);
String actualGenerateKeyBinaryString3 = Long.toBinaryString(Long.parseLong(leafSnowflakeKeyGenerator.generateKey().toString()));
assertThat(Integer.parseInt(actualGenerateKeyBinaryString3.substring(actualGenerateKeyBinaryString3.length() - 3), 2), is(3));
Thread.sleep(2L);
String actualGenerateKeyBinaryString4 = Long.toBinaryString(Long.parseLong(leafSnowflakeKeyGenerator.generateKey().toString()));
assertThat(Integer.parseInt(actualGenerateKeyBinaryString4.substring(actualGenerateKeyBinaryString4.length() - 3), 2), is(0));
}

@Test
public void assertGenerateKeyWithDigest() {
Expand All @@ -80,7 +130,7 @@ public void assertGenerateKeyWithDigest() {
properties.setProperty("registryCenterType", "ForthTestRegistryCenter");
leafSnowflakeKeyGenerator.setProperties(properties);
FieldUtil.setStaticFinalField(leafSnowflakeKeyGenerator, "timeService", new FixedTimeService(1));
List<Comparable<?>> expected = Arrays.<Comparable<?>>asList(4198401L, 4198402L, 8392704L, 8392705L, 12587009L, 12587010L, 16781312L, 16781313L, 20975617L, 20975618L);
List<Comparable<?>> expected = Arrays.<Comparable<?>>asList(4198400L, 4198401L, 8392705L, 8392706L, 12587008L, 12587009L, 16781313L, 16781314L, 20975616L, 20975617L);
List<Comparable<?>> actual = new ArrayList<>();
for (int i = 0; i < 10; i++) {
actual.add(leafSnowflakeKeyGenerator.generateKey());
Expand All @@ -97,7 +147,7 @@ public void assertGenerateKeyWithFixedWorkId() {
properties.setProperty("registryCenterType", "ForthTestRegistryCenter");
leafSnowflakeKeyGenerator.setProperties(properties);
FieldUtil.setStaticFinalField(leafSnowflakeKeyGenerator, "timeService", new FixedTimeService(1));
List<Comparable<?>> expected = Collections.<Comparable<?>>singletonList(4198401L);
List<Comparable<?>> expected = Collections.<Comparable<?>>singletonList(4198400L);
List<Comparable<?>> actual = new ArrayList<>();
actual.add(leafSnowflakeKeyGenerator.generateKey());
assertThat(actual, is(expected));
Expand Down Expand Up @@ -269,4 +319,20 @@ public void assertSetRegistryCenterTypeFailureWhenArgumentWrong() {
leafSnowflakeKeyGenerator.setProperties(properties);
leafSnowflakeKeyGenerator.generateKey();
}

@Test(expected = IllegalArgumentException.class)
public void assertSetMaxVibrationOffsetFailureWhenNegative() {
Properties properties = new Properties();
properties.setProperty("maxVibrationOffset", String.valueOf(-1));
leafSnowflakeKeyGenerator.setProperties(properties);
leafSnowflakeKeyGenerator.generateKey();
}

@Test(expected = IllegalArgumentException.class)
public void assertSetMaxVibrationOffsetFailureWhenOutOfRange() {
Properties properties = new Properties();
properties.setProperty("max.vibration.offset", String.valueOf(4096));
leafSnowflakeKeyGenerator.setProperties(properties);
leafSnowflakeKeyGenerator.generateKey();
}
}

0 comments on commit 2e230c3

Please sign in to comment.