Prevent double registration of commands

This commit is contained in:
Eric Bottard
2017-08-07 12:06:36 +02:00
parent 6497df181d
commit c8e4752119
11 changed files with 182 additions and 41 deletions

View File

@@ -35,8 +35,8 @@ import org.springframework.shell.converters.SimpleFileConverter;
public class LegacyAdapterAutoConfiguration {
@Bean
public LegacyMethodTargetResolver legacyMethodTargetResolver() {
return new LegacyMethodTargetResolver();
public LegacyMethodTargetRegistrar legacyMethodTargetResolver() {
return new LegacyMethodTargetRegistrar();
}
@Bean

View File

@@ -20,18 +20,20 @@ import static org.springframework.util.StringUtils.collectionToDelimitedString;
import java.util.HashMap;
import java.util.Map;
import java.util.TreeMap;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.shell.ConfigurableCommandRegistry;
import org.springframework.shell.core.CommandMarker;
import org.springframework.shell.core.annotation.CliCommand;
import org.springframework.shell.MethodTarget;
import org.springframework.shell.MethodTargetResolver;
import org.springframework.shell.MethodTargetRegistrar;
import org.springframework.stereotype.Component;
import org.springframework.util.ReflectionUtils;
/**
* A {@link MethodTargetResolver} that discovers methods annotated with {@link CliCommand} on beans
* A {@link MethodTargetRegistrar} that discovers methods annotated with {@link CliCommand} on beans
* implementing the {@link CommandMarker} marker interface.
*
* @author Eric Bottard
@@ -39,31 +41,33 @@ import org.springframework.util.ReflectionUtils;
* @author Camilo Gonzalez
*/
@Component
public class LegacyMethodTargetResolver implements MethodTargetResolver {
public class LegacyMethodTargetRegistrar implements MethodTargetRegistrar {
@Autowired
private ApplicationContext applicationContext;
private Map<String, MethodTarget> commands = new TreeMap<>();
@Override
public Map<String, MethodTarget> resolve() {
Map<String, MethodTarget> methodTargets = new HashMap<>();
public void register(ConfigurableCommandRegistry registry) {
Map<String, CommandMarker> beans = applicationContext.getBeansOfType(CommandMarker.class);
for (Object bean : beans.values()) {
Class<?> clazz = bean.getClass();
ReflectionUtils.doWithMethods(clazz, method -> {
CliCommand cliCommand = method.getAnnotation(CliCommand.class);
for (String key : cliCommand.value()) {
methodTargets.put(key, new MethodTarget(method, bean, cliCommand.help()));
MethodTarget target = new MethodTarget(method, bean, cliCommand.help());
registry.register(key, target);
commands.put(key, target);
}
}, method -> method.getAnnotation(CliCommand.class) != null);
}
return methodTargets;
}
@Override
public String toString() {
return getClass().getSimpleName() + " contributing "
+ collectionToDelimitedString(resolve().keySet(), ", ", "[", "]");
+ collectionToDelimitedString(commands.keySet(), ", ", "[", "]");
}
}

View File

@@ -27,27 +27,32 @@ import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.shell.ConfigurableCommandRegistry;
import org.springframework.shell.MethodTarget;
import org.springframework.shell.MethodTargetResolver;
import org.springframework.shell.MethodTargetRegistrar;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
/**
* Created by ericbottard on 09/12/15.
* Unit tests for {@link LegacyMethodTargetRegistrar}.
*
* @author Eric Bottard
*/
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes = LegacyMethodTargetResolverTest.Config.class)
public class LegacyMethodTargetResolverTest {
@ContextConfiguration(classes = LegacyMethodTargetRegistrarTest.Config.class)
public class LegacyMethodTargetRegistrarTest {
@Autowired
private LegacyCommands legacyCommands;
@Autowired
private MethodTargetResolver resolver;
private MethodTargetRegistrar resolver;
@Test
public void findsMethodsAnnotatedWithCliCommand() throws Exception {
Map<String, MethodTarget> targets = resolver.resolve();
ConfigurableCommandRegistry registry = new ConfigurableCommandRegistry();
resolver.register(registry);
Map<String, MethodTarget> targets = registry.listCommands();
assertThat(targets).contains(entry(
"register module",
@@ -64,8 +69,8 @@ public class LegacyMethodTargetResolverTest {
}
@Bean
public MethodTargetResolver methodTargetResolver() {
return new LegacyMethodTargetResolver();
public MethodTargetRegistrar methodTargetResolver() {
return new LegacyMethodTargetRegistrar();
}
}