Browse Source
* Add spi priority factory * Add doc * Add override log * Use lombok * Add comment3.1.0-release
Wenjun Ruan
2 years ago
committed by
GitHub
20 changed files with 314 additions and 65 deletions
@ -0,0 +1,34 @@ |
|||||||
|
/* |
||||||
|
* Licensed to the Apache Software Foundation (ASF) under one or more |
||||||
|
* contributor license agreements. See the NOTICE file distributed with |
||||||
|
* this work for additional information regarding copyright ownership. |
||||||
|
* The ASF licenses this file to You 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. |
||||||
|
*/ |
||||||
|
|
||||||
|
package org.apache.dolphinscheduler.spi.plugin; |
||||||
|
|
||||||
|
public interface PrioritySPI extends Comparable<Integer> { |
||||||
|
|
||||||
|
/** |
||||||
|
* The SPI identify, if the two plugin has the same name, will load the high priority. |
||||||
|
* If the priority and name is all same, will throw <code>IllegalArgumentException</code> |
||||||
|
* @return |
||||||
|
*/ |
||||||
|
SPIIdentify getIdentify(); |
||||||
|
|
||||||
|
@Override |
||||||
|
default int compareTo(Integer o) { |
||||||
|
return Integer.compare(getIdentify().getPriority(), o); |
||||||
|
} |
||||||
|
|
||||||
|
} |
||||||
@ -0,0 +1,60 @@ |
|||||||
|
/* |
||||||
|
* Licensed to the Apache Software Foundation (ASF) under one or more |
||||||
|
* contributor license agreements. See the NOTICE file distributed with |
||||||
|
* this work for additional information regarding copyright ownership. |
||||||
|
* The ASF licenses this file to You 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. |
||||||
|
*/ |
||||||
|
|
||||||
|
package org.apache.dolphinscheduler.spi.plugin; |
||||||
|
|
||||||
|
import lombok.extern.slf4j.Slf4j; |
||||||
|
|
||||||
|
import java.util.Collections; |
||||||
|
import java.util.HashMap; |
||||||
|
import java.util.Map; |
||||||
|
import java.util.ServiceLoader; |
||||||
|
|
||||||
|
@Slf4j |
||||||
|
public class PrioritySPIFactory<T extends PrioritySPI> { |
||||||
|
|
||||||
|
private final Map<String, T> map = new HashMap<>(); |
||||||
|
|
||||||
|
public PrioritySPIFactory(Class<T> spiClass) { |
||||||
|
for (T t : ServiceLoader.load(spiClass)) { |
||||||
|
if (map.containsKey(t.getIdentify().getName())) { |
||||||
|
resolveConflict(t); |
||||||
|
} else { |
||||||
|
map.put(t.getIdentify().getName(), t); |
||||||
|
} |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
public Map<String, T> getSPIMap() { |
||||||
|
return Collections.unmodifiableMap(map); |
||||||
|
} |
||||||
|
|
||||||
|
private void resolveConflict(T newSPI) { |
||||||
|
SPIIdentify identify = newSPI.getIdentify(); |
||||||
|
T oldSPI = map.get(identify.getName()); |
||||||
|
|
||||||
|
if (newSPI.compareTo(oldSPI.getIdentify().getPriority()) == 0) { |
||||||
|
throw new IllegalArgumentException(String.format("These two spi plugins has conflict identify name with the same priority: %s, %s", |
||||||
|
oldSPI.getIdentify(), newSPI.getIdentify())); |
||||||
|
} else if (newSPI.compareTo(oldSPI.getIdentify().getPriority()) > 0) { |
||||||
|
log.info("The {} plugin has high priority, will override {}", newSPI.getIdentify(), oldSPI); |
||||||
|
map.put(identify.getName(), newSPI); |
||||||
|
} else { |
||||||
|
log.info("The low plugin {} will be skipped", newSPI); |
||||||
|
} |
||||||
|
} |
||||||
|
} |
||||||
@ -0,0 +1,36 @@ |
|||||||
|
/* |
||||||
|
* Licensed to the Apache Software Foundation (ASF) under one or more |
||||||
|
* contributor license agreements. See the NOTICE file distributed with |
||||||
|
* this work for additional information regarding copyright ownership. |
||||||
|
* The ASF licenses this file to You 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. |
||||||
|
*/ |
||||||
|
|
||||||
|
package org.apache.dolphinscheduler.spi.plugin; |
||||||
|
|
||||||
|
import lombok.AllArgsConstructor; |
||||||
|
import lombok.Builder; |
||||||
|
import lombok.Data; |
||||||
|
|
||||||
|
@Data |
||||||
|
@Builder |
||||||
|
@AllArgsConstructor |
||||||
|
public class SPIIdentify { |
||||||
|
|
||||||
|
private static final int DEFAULT_PRIORITY = 0; |
||||||
|
|
||||||
|
private String name; |
||||||
|
|
||||||
|
@Builder.Default |
||||||
|
private int priority = DEFAULT_PRIORITY; |
||||||
|
|
||||||
|
} |
||||||
@ -0,0 +1,88 @@ |
|||||||
|
/* |
||||||
|
* Licensed to the Apache Software Foundation (ASF) under one or more |
||||||
|
* contributor license agreements. See the NOTICE file distributed with |
||||||
|
* this work for additional information regarding copyright ownership. |
||||||
|
* The ASF licenses this file to You 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. |
||||||
|
*/ |
||||||
|
|
||||||
|
package org.apache.dolphinscheduler.spi.plugin; |
||||||
|
|
||||||
|
import com.google.auto.service.AutoService; |
||||||
|
import org.junit.Assert; |
||||||
|
import org.junit.Test; |
||||||
|
|
||||||
|
import java.util.Map; |
||||||
|
|
||||||
|
public class PrioritySPIFactoryTest { |
||||||
|
|
||||||
|
@Test |
||||||
|
public void loadHighPriority() { |
||||||
|
PrioritySPIFactory<LoadHighPriorityConflictTestSPI> factory = new PrioritySPIFactory<>(LoadHighPriorityConflictTestSPI.class); |
||||||
|
Map<String, LoadHighPriorityConflictTestSPI> spiMap = factory.getSPIMap(); |
||||||
|
Assert.assertEquals(1, spiMap.get("A").getIdentify().getPriority()); |
||||||
|
} |
||||||
|
|
||||||
|
@Test(expected = IllegalArgumentException.class) |
||||||
|
public void throwExceptionWhenPriorityIsSame() { |
||||||
|
PrioritySPIFactory<ThrowExceptionConflictTestSPI> factory = new PrioritySPIFactory<>(ThrowExceptionConflictTestSPI.class); |
||||||
|
Map<String, ThrowExceptionConflictTestSPI> spiMap = factory.getSPIMap(); |
||||||
|
Assert.assertEquals(0, spiMap.get("B").getIdentify().getPriority()); |
||||||
|
} |
||||||
|
|
||||||
|
|
||||||
|
public interface LoadHighPriorityConflictTestSPI extends PrioritySPI { |
||||||
|
|
||||||
|
} |
||||||
|
|
||||||
|
@AutoService(LoadHighPriorityConflictTestSPI.class) |
||||||
|
public static class SPIA implements LoadHighPriorityConflictTestSPI { |
||||||
|
|
||||||
|
@Override |
||||||
|
public SPIIdentify getIdentify() { |
||||||
|
return SPIIdentify.builder().name("A").priority(0).build(); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
@AutoService(LoadHighPriorityConflictTestSPI.class) |
||||||
|
public static class SPIAA implements LoadHighPriorityConflictTestSPI { |
||||||
|
|
||||||
|
@Override |
||||||
|
public SPIIdentify getIdentify() { |
||||||
|
return SPIIdentify.builder().name("A").priority(1).build(); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
public interface ThrowExceptionConflictTestSPI extends PrioritySPI { |
||||||
|
|
||||||
|
} |
||||||
|
|
||||||
|
@AutoService(ThrowExceptionConflictTestSPI.class) |
||||||
|
public static class SPIB implements ThrowExceptionConflictTestSPI { |
||||||
|
|
||||||
|
@Override |
||||||
|
public SPIIdentify getIdentify() { |
||||||
|
return SPIIdentify.builder().name("B").priority(0).build(); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
@AutoService(ThrowExceptionConflictTestSPI.class) |
||||||
|
public static class SPIBB implements ThrowExceptionConflictTestSPI { |
||||||
|
|
||||||
|
@Override |
||||||
|
public SPIIdentify getIdentify() { |
||||||
|
return SPIIdentify.builder().name("B").priority(0).build(); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
|
||||||
|
} |
||||||
Loading…
Reference in new issue