Improve framework for custom mapping couchbase converter.

mikereiche · mikereiche · commit 8be47bfe366a · 2021-06-08T16:25:33.000-04:00
1) have AbstractCouchbaseConverter.setCustomConversions call afterPropertiesSet() to register converters with conversionService 2) have MappingCouchbaseConverter constructor with mappingContext set its applicationContext from the applicationContext from mappingContext 3) add getApplicationContext() to CouchbaseMappingContext to use in setting applicationContext of MappingCouchbaseConverter 4) change examples in Config to show creating repository mappings using existing MappingCouchbaseConverter (which have customConversions / BeanNames.COUCHBASE_CUSTOM_CONVERSIONS and applicationContext) instead of creating their own and then adding the customConversion and applicationContext. 5) replace @Autowired couchbaseObjectMapper with couchbaseObjectMapper() to avoid the following when using @componentscan : Unsatisfied dependency expressed through field 'couchbaseObjectMapper'; nested exception is org.springframework.beans.factory. BeanCurrentlyInCreationException: Error creating bean with name 'couchbaseObjectMapper': Requested bean is currently in creation: Is there an unresolvable circular reference? 6) remove unused members fro StringBasedN1qlQueryParser Closes #1141.
diff --git a/src/main/java/org/springframework/data/couchbase/config/AbstractCouchbaseConfiguration.java b/src/main/java/org/springframework/data/couchbase/config/AbstractCouchbaseConfiguration.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2020 the original author or authors
+ * Copyright 2012-2021 the original author or authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -49,7 +49,6 @@
 import org.springframework.util.StringUtils;
 
 import com.couchbase.client.core.deps.com.fasterxml.jackson.databind.DeserializationFeature;
-import com.couchbase.client.core.deps.com.fasterxml.jackson.databind.Module;
 import com.couchbase.client.core.encryption.CryptoManager;
 import com.couchbase.client.core.env.Authenticator;
 import com.couchbase.client.core.env.PasswordAuthenticator;
@@ -60,7 +59,6 @@
 import com.couchbase.client.java.env.ClusterEnvironment;
 import com.couchbase.client.java.json.JacksonTransformers;
 import com.couchbase.client.java.json.JsonValueModule;
-import com.couchbase.client.java.json.RepackagedJsonValueModule;
 import com.fasterxml.jackson.databind.ObjectMapper;
 
 /**
@@ -75,8 +73,6 @@
 @Configuration
 public abstract class AbstractCouchbaseConfiguration {
 
-	@Autowired ObjectMapper couchbaseObjectMapper;
-
 	/**
 	 * The connection string which allows the SDK to connect to the cluster.
 	 * <p>
@@ -144,7 +140,7 @@ public ClusterEnvironment couchbaseClusterEnvironment() {
 		if (!nonShadowedJacksonPresent()) {
 			throw new CouchbaseException("non-shadowed Jackson not present");
 		}
-		builder.jsonSerializer(JacksonJsonSerializer.create(couchbaseObjectMapper));
+		builder.jsonSerializer(JacksonJsonSerializer.create(couchbaseObjectMapper()));
 		configureEnvironment(builder);
 		return builder.build();
 	}
diff --git a/src/main/java/org/springframework/data/couchbase/core/convert/AbstractCouchbaseConverter.java b/src/main/java/org/springframework/data/couchbase/core/convert/AbstractCouchbaseConverter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2020 the original author or authors
+ * Copyright 2012-2021 the original author or authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,7 +17,6 @@
 package org.springframework.data.couchbase.core.convert;
 
 import java.util.Collections;
-import java.util.Optional;
 
 import org.springframework.beans.factory.InitializingBean;
 import org.springframework.core.convert.ConversionService;
@@ -74,6 +73,7 @@ public ConversionService getConversionService() {
 	 */
 	public void setCustomConversions(final CustomConversions conversions) {
 		this.conversions = conversions;
+		afterPropertiesSet(); // register the conversions with the conversion service
 	}
 
 	/**
diff --git a/src/main/java/org/springframework/data/couchbase/core/convert/MappingCouchbaseConverter.java b/src/main/java/org/springframework/data/couchbase/core/convert/MappingCouchbaseConverter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2020 the original author or authors
+ * Copyright 2012-2021 the original author or authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -148,6 +148,8 @@ public MappingCouchbaseConverter(
 		this.mappingContext = mappingContext;
 		typeMapper = new DefaultCouchbaseTypeMapper(typeKey != null ? typeKey : TYPEKEY_DEFAULT);
 		spELContext = new SpELContext(CouchbaseDocumentPropertyAccessor.INSTANCE);
+		// ApplicationContext is needed for environment for resolving SPEL expressions.
+		this.setApplicationContext(((CouchbaseMappingContext) mappingContext).getApplicationContext());
 	}
 
 	/**
diff --git a/src/main/java/org/springframework/data/couchbase/core/mapping/CouchbaseMappingContext.java b/src/main/java/org/springframework/data/couchbase/core/mapping/CouchbaseMappingContext.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2020 the original author or authors
+ * Copyright 2012-2021 the original author or authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -112,6 +112,10 @@ public void setApplicationContext(final ApplicationContext applicationContext) t
 		super.setApplicationContext(applicationContext);
 	}
 
+	public ApplicationContext getApplicationContext() {
+		return context;
+	}
+
 	@Override
 	public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher) {
 		eventPublisher = applicationEventPublisher;
diff --git a/src/main/java/org/springframework/data/couchbase/repository/query/StringBasedN1qlQueryParser.java b/src/main/java/org/springframework/data/couchbase/repository/query/StringBasedN1qlQueryParser.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2020 the original author or authors.
+ * Copyright 2017-2021 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -125,9 +125,6 @@ public class StringBasedN1qlQueryParser {
 	private final Collection<String> parameterNames = new HashSet<String>();
 	public final N1QLExpression parsedExpression;
 
-	private GenericConversionService conversionService = new DefaultConversionService();
-	private CustomConversions conversions = new CouchbaseCustomConversions(Collections.emptyList());
-
 	public StringBasedN1qlQueryParser(String statement, CouchbaseQueryMethod queryMethod, String bucketName,
 			CouchbaseConverter couchbaseConverter, String typeField, String typeValue, ParameterAccessor accessor,
 			SpelExpressionParser parser, QueryMethodEvaluationContextProvider evaluationContextProvider) {
diff --git a/src/test/java/org/springframework/data/couchbase/domain/Config.java b/src/test/java/org/springframework/data/couchbase/domain/Config.java
@@ -18,9 +18,12 @@
 
 import java.lang.reflect.InvocationTargetException;
 
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.ApplicationContext;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.data.auditing.DateTimeProvider;
+import org.springframework.data.convert.CustomConversions;
 import org.springframework.data.couchbase.CouchbaseClientFactory;
 import org.springframework.data.couchbase.SimpleCouchbaseClientFactory;
 import org.springframework.data.couchbase.config.AbstractCouchbaseConfiguration;
@@ -33,6 +36,7 @@
 import org.springframework.data.couchbase.core.mapping.CouchbaseMappingContext;
 import org.springframework.data.couchbase.domain.time.AuditingDateTimeProvider;
 import org.springframework.data.couchbase.repository.auditing.EnableCouchbaseAuditing;
+import org.springframework.data.couchbase.repository.auditing.EnableReactiveCouchbaseAuditing;
 import org.springframework.data.couchbase.repository.config.EnableCouchbaseRepositories;
 import org.springframework.data.couchbase.repository.config.ReactiveRepositoryOperationsMapping;
 import org.springframework.data.couchbase.repository.config.RepositoryOperationsMapping;
@@ -48,7 +52,12 @@
  */
 @Configuration
 @EnableCouchbaseRepositories
-@EnableCouchbaseAuditing(auditorAwareRef = "auditorAwareRef", dateTimeProviderRef = "dateTimeProviderRef")
+@EnableCouchbaseAuditing(auditorAwareRef = "auditorAwareRef", dateTimeProviderRef = "dateTimeProviderRef") // this
+																																																						// activates
+																																																						// auditing
+@EnableReactiveCouchbaseAuditing(auditorAwareRef = "reactiveAuditorAwareRef",
+		dateTimeProviderRef = "dateTimeProviderRef") // this activates auditing
+
 public class Config extends AbstractCouchbaseConfiguration {
 	String bucketname = "travel-sample";
 	String username = "Administrator";
@@ -104,6 +113,11 @@ public NaiveAuditorAware testAuditorAware() {
 		return new NaiveAuditorAware();
 	}
 
+	@Bean(name = "reactiveAuditorAwareRef")
+	public ReactiveNaiveAuditorAware testReactiveAuditorAware() {
+		return new ReactiveNaiveAuditorAware();
+	}
+
 	@Bean(name = "dateTimeProviderRef")
 	public DateTimeProvider testDateTimeProvider() {
 		return new AuditingDateTimeProvider();
@@ -113,12 +127,12 @@ public DateTimeProvider testDateTimeProvider() {
 	public void configureReactiveRepositoryOperationsMapping(ReactiveRepositoryOperationsMapping baseMapping) {
 		try {
 			// comment out references to 'protected' and 'mybucket' - they are only to show how multi-bucket would work
-			// ReactiveCouchbaseTemplate personTemplate =
-			// myReactiveCouchbaseTemplate(myCouchbaseClientFactory("protected"),new MappingCouchbaseConverter());
+			// ReactiveCouchbaseTemplate personTemplate = myReactiveCouchbaseTemplate(myCouchbaseClientFactory("protected"),
+			//		(MappingCouchbaseConverter) (baseMapping.getDefault().getConverter()));
 			// baseMapping.mapEntity(Person.class, personTemplate); // Person goes in "protected" bucket
-			// ReactiveCouchbaseTemplate userTemplate = myReactiveCouchbaseTemplate(myCouchbaseClientFactory("mybucket"),new
-			// MappingCouchbaseConverter());
-			// baseMapping.mapEntity(User.class, userTemplate); // User goes in "mybucket"
+			// ReactiveCouchbaseTemplate userTemplate = myReactiveCouchbaseTemplate(myCouchbaseClientFactory("mybucket"),
+			//		(MappingCouchbaseConverter) (baseMapping.getDefault().getConverter()));
+			//baseMapping.mapEntity(User.class, userTemplate); // User goes in "mybucket"
 			// everything else goes in getBucketName() ( which is travel-sample )
 		} catch (Exception e) {
 			throw e;
@@ -129,11 +143,12 @@ public void configureReactiveRepositoryOperationsMapping(ReactiveRepositoryOpera
 	public void configureRepositoryOperationsMapping(RepositoryOperationsMapping baseMapping) {
 		try {
 			// comment out references to 'protected' and 'mybucket' - they are only to show how multi-bucket would work
-			// CouchbaseTemplate personTemplate = myCouchbaseTemplate(myCouchbaseClientFactory("protected"),new
-			// MappingCouchbaseConverter());
+			// CouchbaseTemplate personTemplate = myCouchbaseTemplate(myCouchbaseClientFactory("protected"),
+			// 		(MappingCouchbaseConverter) (baseMapping.getDefault().getConverter()));
 			// baseMapping.mapEntity(Person.class, personTemplate); // Person goes in "protected" bucket
-			// CouchbaseTemplate userTemplate = myCouchbaseTemplate(myCouchbaseClientFactory("mybucket"),new
-			// MappingCouchbaseConverter());
+			// MappingCouchbaseConverter cvtr = (MappingCouchbaseConverter)baseMapping.getDefault().getConverter();
+			// CouchbaseTemplate userTemplate = myCouchbaseTemplate(myCouchbaseClientFactory("mybucket"),
+			// 		(MappingCouchbaseConverter) (baseMapping.getDefault().getConverter()));
 			// baseMapping.mapEntity(User.class, userTemplate); // User goes in "mybucket"
 			// everything else goes in getBucketName() ( which is travel-sample )
 		} catch (Exception e) {
@@ -176,10 +191,11 @@ public MappingCouchbaseConverter mappingCouchbaseConverter() {
 		return converter;
 	}
 
+	/* This uses a CustomMappingCouchbaseConverter instead of MappingCouchbaseConverter */
 	@Override
-	@Bean(name = "couchbaseMappingConverter")
+	@Bean(name = "mappingCouchbaseConverter")
 	public MappingCouchbaseConverter mappingCouchbaseConverter(CouchbaseMappingContext couchbaseMappingContext,
-			CouchbaseCustomConversions couchbaseCustomConversions) {
+			CouchbaseCustomConversions couchbaseCustomConversions /* there is a customConversions() method bean  */) {
 		// MappingCouchbaseConverter relies on a SimpleInformationMapper
 		// that has an getAliasFor(info) that just returns getType().getName().
 		// Our CustomMappingCouchbaseConverter uses a TypeBasedCouchbaseTypeMapper that will

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * Copyright 2012-2020 the original author or authors`
	`2`	`+ * Copyright 2012-2021 the original author or authors`
`3`	`3`	`*`
`4`	`4`	`* Licensed under the Apache License, Version 2.0 (the "License");`
`5`	`5`	`* you may not use this file except in compliance with the License.`
`@@ -148,6 +148,8 @@ public MappingCouchbaseConverter(`
`148`	`148`	`this.mappingContext = mappingContext;`
`149`	`149`	`typeMapper = new DefaultCouchbaseTypeMapper(typeKey != null ? typeKey : TYPEKEY_DEFAULT);`
`150`	`150`	`spELContext = new SpELContext(CouchbaseDocumentPropertyAccessor.INSTANCE);`
	`151`	`+ // ApplicationContext is needed for environment for resolving SPEL expressions.`
	`152`	`+ this.setApplicationContext(((CouchbaseMappingContext) mappingContext).getApplicationContext());`
`151`	`153`	`}`
`152`	`154`
`153`	`155`	`/**`