Add EntityListenerProvider auto configuration

Author: backpaper0

doma-spring-boot-autoconfigure/src/main/java/org/seasar/doma/boot/autoconfigure/DomaAutoConfiguration.java

@@ -16,6 +16,7 @@
 package org.seasar.doma.boot.autoconfigure;
 
 import org.seasar.doma.jdbc.Config;
+import org.seasar.doma.jdbc.EntityListenerProvider;
 import org.seasar.doma.jdbc.Naming;
 import org.seasar.doma.jdbc.SqlFileRepository;
 import org.seasar.doma.jdbc.dialect.Dialect;
@@ -27,6 +28,7 @@
 import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.context.ApplicationContext;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.dao.support.PersistenceExceptionTranslator;
@@ -77,6 +79,13 @@ public Naming naming() {
 	}
 
 	@Bean
+	@ConditionalOnMissingBean
+	public EntityListenerProvider entityListenerProvider(
+			ApplicationContext context) {
+		return new TryLookupEntityListenerProvider(context);
+	}
+
+    @Bean
 	@ConditionalOnMissingBean
 	public DomaConfigBuilder domaConfigBuilder() {
 		return new DomaConfigBuilder();
@@ -87,6 +96,7 @@ public DomaConfigBuilder domaConfigBuilder() {
 	@ConfigurationProperties(prefix = DOMA_PREFIX)
 	public DomaConfig config(DataSource dataSource, Dialect dialect,
 			SqlFileRepository sqlFileRepository, Naming naming,
+			EntityListenerProvider entityListenerProvider,
 			DomaConfigBuilder domaConfigBuilder) {
 		if (domaConfigBuilder.dataSource() == null) {
 			domaConfigBuilder.dataSource(dataSource);
@@ -100,6 +110,9 @@ public DomaConfig config(DataSource dataSource, Dialect dialect,
 		if (domaConfigBuilder.naming() == null) {
 			domaConfigBuilder.naming(naming);
 		}
+		if (domaConfigBuilder.entityListenerProvider() == null) {
+			domaConfigBuilder.entityListenerProvider(entityListenerProvider);
+		}
 		return new DomaConfig(domaConfigBuilder);
 	}
 

doma-spring-boot-autoconfigure/src/main/java/org/seasar/doma/boot/autoconfigure/DomaConfigBuilder.java

@@ -48,7 +48,7 @@ public class DomaConfigBuilder {
 	private Naming naming;
 	private MapKeyNaming mapKeyNaming = ConfigSupport.defaultMapKeyNaming;
 	private Commenter commenter = ConfigSupport.defaultCommenter;
-	private EntityListenerProvider entityListenerProvider = ConfigSupport.defaultEntityListenerProvider;
+	private EntityListenerProvider entityListenerProvider;
 
 	public DataSource dataSource() {
 		return dataSource;

doma-spring-boot-autoconfigure/src/main/java/org/seasar/doma/boot/autoconfigure/TryLookupEntityListenerProvider.java

@@ -0,0 +1,47 @@
+/*
+ * Copyright (C) 2004-2016 the Seasar Foundation and the Others.
+ *
+ * Licensed 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.seasar.doma.boot.autoconfigure;
+
+import java.util.Map;
+import java.util.Objects;
+import java.util.function.Supplier;
+
+import org.seasar.doma.jdbc.EntityListenerProvider;
+import org.seasar.doma.jdbc.entity.EntityListener;
+import org.springframework.context.ApplicationContext;
+
+/**
+ * {@link EntityListenerProvider} implementation that
+ * {@link EntityListener} managed by Spring Framework, or else created by Doma.
+ * 
+ * @author backpaper0
+ *
+ */
+public class TryLookupEntityListenerProvider implements EntityListenerProvider {
+
+	private final ApplicationContext context;
+
+	public TryLookupEntityListenerProvider(ApplicationContext context) {
+		this.context = Objects.requireNonNull(context);
+	}
+
+	@Override
+	public <ENTITY, LISTENER extends EntityListener<ENTITY>> LISTENER get(
+			Class<LISTENER> listenerClass, Supplier<LISTENER> listenerSupplier) {
+		Map<String, LISTENER> beans = context.getBeansOfType(listenerClass);
+		return beans.values().stream().findAny().orElseGet(listenerSupplier);
+	}
+}

doma-spring-boot-autoconfigure/src/test/java/org/seasar/doma/boot/autoconfigure/DomaAutoConfigurationTest.java

@@ -67,6 +67,8 @@ public void testAutoRegisteredConfig() {
 				is(instanceOf(GreedyCacheSqlFileRepository.class)));
 		assertThat(config.getNaming(), is(Naming.DEFAULT));
 		assertThat(config.getJdbcLogger(), is(instanceOf(UtilLoggingJdbcLogger.class)));
+		assertThat(config.getEntityListenerProvider(),
+				is(instanceOf(TryLookupEntityListenerProvider.class)));
 		PersistenceExceptionTranslator translator = this.context
 				.getBean(PersistenceExceptionTranslator.class);
 		assertThat(translator, is(instanceOf(DomaPersistenceExceptionTranslator.class)));
@@ -86,6 +88,8 @@ public void testConfigWithDomaConfigBuilder() {
 				is(instanceOf(NoCacheSqlFileRepository.class)));
 		assertThat(config.getNaming(), is(Naming.SNAKE_UPPER_CASE));
 		assertThat(config.getJdbcLogger(), is(instanceOf(UtilLoggingJdbcLogger.class)));
+		assertThat(config.getEntityListenerProvider(),
+				is(instanceOf(TestEntityListenerProvider.class)));
 		PersistenceExceptionTranslator translator = this.context
 				.getBean(PersistenceExceptionTranslator.class);
 		assertThat(translator, is(instanceOf(DomaPersistenceExceptionTranslator.class)));
@@ -105,6 +109,8 @@ public void testConfigWithConfig() {
 				is(instanceOf(NoCacheSqlFileRepository.class)));
 		assertThat(config.getNaming(), is(Naming.SNAKE_LOWER_CASE));
 		assertThat(config.getJdbcLogger(), is(instanceOf(UtilLoggingJdbcLogger.class)));
+		assertThat(config.getEntityListenerProvider(),
+				is(instanceOf(TestEntityListenerProvider.class)));
 		PersistenceExceptionTranslator translator = this.context
 				.getBean(PersistenceExceptionTranslator.class);
 		assertThat(translator, is(instanceOf(DomaPersistenceExceptionTranslator.class)));
@@ -178,7 +184,8 @@ public static class ConfigBuilderConfigure {
 		DomaConfigBuilder myDomaConfigBuilder() {
 			return new DomaConfigBuilder().dialect(new MysqlDialect())
 					.sqlFileRepository(new NoCacheSqlFileRepository())
-					.naming(Naming.SNAKE_UPPER_CASE);
+					.naming(Naming.SNAKE_UPPER_CASE)
+					.entityListenerProvider(new TestEntityListenerProvider());
 		}
 	}
 
@@ -206,8 +213,15 @@ public SqlFileRepository getSqlFileRepository() {
 				public Naming getNaming() {
 					return Naming.SNAKE_LOWER_CASE;
 				}
+
+				@Override
+				public EntityListenerProvider getEntityListenerProvider() {
+					return new TestEntityListenerProvider();
+				}
 			};
 		}
 	}
 
+	static class TestEntityListenerProvider implements EntityListenerProvider {
+	}
 }

doma-spring-boot-autoconfigure/src/test/java/org/seasar/doma/boot/autoconfigure/TryLookupEntityListenerProviderTest.java

@@ -0,0 +1,70 @@
+/*
+ * Copyright (C) 2004-2016 the Seasar Foundation and the Others.
+ *
+ * Licensed 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.seasar.doma.boot.autoconfigure;
+
+import static org.hamcrest.CoreMatchers.*;
+import static org.hamcrest.MatcherAssert.*;
+
+import org.junit.Test;
+import org.seasar.doma.jdbc.entity.EntityListener;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.ApplicationContext;
+import org.springframework.context.annotation.AnnotationConfigApplicationContext;
+import org.springframework.stereotype.Component;
+
+public class TryLookupEntityListenerProviderTest {
+
+	@Test
+	public void testManaged() throws Exception {
+		AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();
+		context.register(FooListener.class);
+		context.refresh();
+		TryLookupEntityListenerProvider provider = new TryLookupEntityListenerProvider(
+				context);
+		FooListener listener = provider
+				.get(FooListener.class, FooListener::new);
+		assertThat(listener.managed, is(true));
+	}
+
+	@Test
+	public void testNotManaged() throws Exception {
+		AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();
+		//context.register(FooListener.class);
+		context.refresh();
+		TryLookupEntityListenerProvider provider = new TryLookupEntityListenerProvider(
+				context);
+		FooListener listener = provider
+				.get(FooListener.class, FooListener::new);
+		assertThat(listener.managed, is(false));
+	}
+
+	@Component
+	public static class FooListener implements EntityListener<Object> {
+
+		final boolean managed;
+
+		//Invoked by Doma
+		public FooListener() {
+			managed = false;
+		}
+
+		//Invoked by Spring
+		@Autowired
+		public FooListener(ApplicationContext context) {
+			managed = true;
+		}
+	}
+}