Add saving parameterName prefix feature (#50)

IAM20 · mhyeon-lee · commit 8dd9cbbb3177 · 2021-06-28T10:58:52.000+09:00
(cherry picked from commit d99fe71)
diff --git a/spring-data-jdbc-plus-sql/src/main/java/com/navercorp/spring/data/jdbc/plus/sql/provider/EntityJdbcProvider.java b/spring-data-jdbc-plus-sql/src/main/java/com/navercorp/spring/data/jdbc/plus/sql/provider/EntityJdbcProvider.java
@@ -34,6 +34,7 @@
 import com.navercorp.spring.data.jdbc.plus.sql.convert.SqlProvider;
 import com.navercorp.spring.data.jdbc.plus.sql.parametersource.SqlParameterSourceFactory;
 import com.navercorp.spring.jdbc.plus.support.parametersource.CompositeSqlParameterSource;
+import com.navercorp.spring.jdbc.plus.support.parametersource.ConvertibleParameterSourceFactory;
 
 /**
  * The type Entity jdbc provider.
@@ -198,6 +199,21 @@ public BeanPropertySqlParameterSource beanParameterSource(Object bean) {
 		return this.sqlParameterSourceFactory.beanParameterSource(bean);
 	}
 
+	/**
+	 * Bean parameter source bean property sql parameter source.
+	 *
+	 * @param prefix the prefix
+	 * @param bean   the bean
+	 * @return the bean property sql parameter source
+	 */
+	public BeanPropertySqlParameterSource beanParameterSource(String prefix, Object bean) {
+		if (this.sqlParameterSourceFactory instanceof ConvertibleParameterSourceFactory) {
+			return ((ConvertibleParameterSourceFactory) this.sqlParameterSourceFactory).beanParameterSource(prefix, bean);
+		} else {
+			throw new UnsupportedOperationException("Prefix saving is not supported as default.");
+		}
+	}
+
 	/**
 	 * Map parameter source map sql parameter source.
 	 *
diff --git a/spring-data-jdbc-plus-sql/src/main/java/com/navercorp/spring/data/jdbc/plus/sql/support/JdbcDaoSupport.java b/spring-data-jdbc-plus-sql/src/main/java/com/navercorp/spring/data/jdbc/plus/sql/support/JdbcDaoSupport.java
@@ -125,6 +125,17 @@ protected BeanPropertySqlParameterSource beanParameterSource(Object bean) {
 		return this.entityJdbcProvider.beanParameterSource(bean);
 	}
 
+	/**
+	 * Bean parameter source bean property sql parameter source.
+	 *
+	 * @param prefix the prefix
+	 * @param bean   the bean
+	 * @return the bean property sql parameter source
+	 */
+	protected BeanPropertySqlParameterSource beanParameterSource(String prefix, Object bean) {
+		return this.entityJdbcProvider.beanParameterSource(prefix, bean);
+	}
+
 	/**
 	 * Map parameter source map sql parameter source.
 	 *
diff --git a/spring-data-jdbc-plus-sql/src/main/java/com/navercorp/spring/data/jdbc/plus/sql/support/JdbcRepositorySupport.java b/spring-data-jdbc-plus-sql/src/main/java/com/navercorp/spring/data/jdbc/plus/sql/support/JdbcRepositorySupport.java
@@ -178,6 +178,18 @@ protected BeanPropertySqlParameterSource beanParameterSource(Object bean) {
 		return this.entityJdbcProvider.beanParameterSource(bean);
 	}
 
+
+	/**
+	 * Bean parameter source bean property sql parameter source.
+	 *
+	 * @param prefix the prefix
+	 * @param bean   the bean
+	 * @return the bean property sql parameter source
+	 */
+	protected BeanPropertySqlParameterSource beanParameterSource(String prefix, Object bean) {
+		return this.entityJdbcProvider.beanParameterSource(prefix, bean);
+	}
+
 	/**
 	 * Map parameter source map sql parameter source.
 	 *
diff --git a/spring-jdbc-plus-support/src/main/java/com/navercorp/spring/jdbc/plus/support/parametersource/ConvertibleBeanPropertySqlParameterSource.java b/spring-jdbc-plus-support/src/main/java/com/navercorp/spring/jdbc/plus/support/parametersource/ConvertibleBeanPropertySqlParameterSource.java
@@ -22,6 +22,7 @@
 
 import org.springframework.jdbc.core.namedparam.BeanPropertySqlParameterSource;
 import org.springframework.lang.Nullable;
+import org.springframework.util.StringUtils;
 
 import com.navercorp.spring.jdbc.plus.support.parametersource.converter.IterableExpandPadding;
 import com.navercorp.spring.jdbc.plus.support.parametersource.converter.JdbcParameterSourceConverter;
@@ -31,10 +32,12 @@
  * The type Convertible bean property sql parameter source.
  *
  * @author Myeonghyeon Lee
+ * @author IAM20
  */
 public class ConvertibleBeanPropertySqlParameterSource extends BeanPropertySqlParameterSource {
 	private final JdbcParameterSourceConverter converter;
 	private final FallbackParameterSource fallbackParameterSource;
+	private final String prefix;
 
 	private boolean paddingIterableParams = false;
 	private int[] paddingIterableBoundaries = null;
@@ -61,28 +64,65 @@ public ConvertibleBeanPropertySqlParameterSource(
 		JdbcParameterSourceConverter converter,
 		FallbackParameterSource fallbackParameterSource) {
 
+		this(null, bean, converter, fallbackParameterSource);
+	}
+
+	/**
+	 * Instantiates a new Convertible bean property sql parameter source.
+	 *
+	 * @param prefix                  the prefix
+	 * @param bean                    the bean
+	 * @param converter               the converter
+	 */
+	public ConvertibleBeanPropertySqlParameterSource(
+		String prefix,
+		Object bean,
+		JdbcParameterSourceConverter converter
+	) {
+		this(prefix, bean, converter, null);
+	}
+
+	/**
+	 * Instantiates a new Convertible bean property sql parameter source.
+	 *
+	 * @param prefix                  the prefix
+	 * @param bean                    the bean
+	 * @param converter               the converter
+	 * @param fallbackParameterSource the fallback parameter source
+	 */
+	public ConvertibleBeanPropertySqlParameterSource(
+		String prefix,
+		Object bean,
+		JdbcParameterSourceConverter converter,
+		FallbackParameterSource fallbackParameterSource
+	) {
+
 		super(bean);
+		this.prefix = prefix != null ? prefix.trim() : null;
 		this.converter = Objects.requireNonNull(converter, "Converter must not be null.");
 		this.fallbackParameterSource = fallbackParameterSource;
 	}
 
 	@Nullable
 	@Override
 	public Object getValue(String paramName) {
+		String patchedParamName = paramName;
 		Object value = null;
+
 		try {
-			value = super.getValue(paramName);
+			patchedParamName = this.patchParamName(paramName);
+			value = super.getValue(patchedParamName);
 		} catch (IllegalArgumentException e) {
-			if (!this.isFallback(paramName)) {
+			if (!this.isFallback(patchedParamName)) {
 				throw e;
 			}
 		}
 
-		if (value == null && this.isFallback(paramName)) {
-			value = this.fallbackParameterSource.fallback(paramName);
+		if (value == null && this.isFallback(patchedParamName)) {
+			value = this.fallbackParameterSource.fallback(patchedParamName);
 		}
 
-		value = this.converter.convert(paramName, value);
+		value = this.converter.convert(patchedParamName, value);
 		if (this.paddingIterableParams) {
 			value = IterableExpandPadding.expandIfIterable(value, this.paddingIterableBoundaries);
 		}
@@ -111,4 +151,16 @@ public void setPaddingIterableParam(boolean padding) {
 	private boolean isFallback(String paramName) {
 		return this.fallbackParameterSource != null && this.fallbackParameterSource.isFallback(paramName);
 	}
+
+	private String patchParamName(String paramName) {
+		if (!StringUtils.hasText(prefix)) {
+			return paramName;
+		}
+
+		if (!paramName.startsWith(prefix)) {
+			throw new IllegalArgumentException("Param name does not starts with " + this.prefix);
+		}
+
+		return paramName.substring(prefix.length());
+	}
 }
diff --git a/spring-jdbc-plus-support/src/main/java/com/navercorp/spring/jdbc/plus/support/parametersource/ConvertibleParameterSourceFactory.java b/spring-jdbc-plus-support/src/main/java/com/navercorp/spring/jdbc/plus/support/parametersource/ConvertibleParameterSourceFactory.java
@@ -30,6 +30,7 @@
  * The type Convertible parameter source factory.
  *
  * @author Myeonghyeon Lee
+ * @author IAM20
  */
 public class ConvertibleParameterSourceFactory {
 	private final JdbcParameterSourceConverter converter;
@@ -73,6 +74,22 @@ public BeanPropertySqlParameterSource beanParameterSource(Object bean) {
 		return paramSource;
 	}
 
+	/**
+	 * Bean parameter source bean property sql parameter source.
+	 *
+	 * @param prefix the prefix
+	 * @param bean   the bean
+	 * @return the bean property sql parameter source
+	 */
+	public BeanPropertySqlParameterSource beanParameterSource(String prefix, Object bean) {
+		ConvertibleBeanPropertySqlParameterSource paramSource =
+			new ConvertibleBeanPropertySqlParameterSource(
+				prefix, bean, this.converter, this.fallbackParameterSource);
+		paramSource.setPaddingIterableParam(this.paddingIterableParams);
+		paramSource.setPaddingIterableBoundaries(this.paddingIterableBoundaries);
+		return paramSource;
+	}
+
 	/**
 	 * Map parameter source map sql parameter source.
 	 *
diff --git a/spring-jdbc-plus-support/src/test/java/com/navercorp/spring/jdbc/plus/support/parametersource/ConvertibleBeanPropertySqlParameterSourceTest.java b/spring-jdbc-plus-support/src/test/java/com/navercorp/spring/jdbc/plus/support/parametersource/ConvertibleBeanPropertySqlParameterSourceTest.java
@@ -39,6 +39,7 @@
 
 /**
  * @author Myeonghyeon Lee
+ * @author IAM20
  */
 class ConvertibleBeanPropertySqlParameterSourceTest {
 	private final JdbcParameterSourceConverter converter = new DefaultJdbcParameterSourceConverter(
@@ -132,6 +133,82 @@ void getValueNoParamButFallback() {
 		assertThat(actual).isEqualTo("fallback");
 	}
 
+	@Test
+	void getPrefixValue() {
+		// given
+		Instant now = Instant.now();
+		String paramName = "test.occurrenceTime";
+		Criteria criteria = Criteria.of("sample", now);
+		ConvertibleBeanPropertySqlParameterSource sut = new ConvertibleBeanPropertySqlParameterSource(
+			"test.", criteria, this.converter);
+
+		// when
+		Object actual = sut.getValue(paramName);
+
+		// then
+		assertThat(actual).isEqualTo(Date.from(now));
+	}
+
+	@Test
+	void getWhitespaceIncludedPrefixValue() {
+		// given
+		Instant now = Instant.now();
+		String paramName = "t e s t .occurrenceTime";
+		Criteria criteria = Criteria.of("sample", now);
+		ConvertibleBeanPropertySqlParameterSource sut = new ConvertibleBeanPropertySqlParameterSource(
+			"    t e s t .    ", criteria, this.converter);
+
+		// when
+		Object actual = sut.getValue(paramName);
+
+		// then
+		assertThat(actual).isEqualTo(Date.from(now));
+	}
+
+	@Test
+	void getValuePrefixNotMathced() {
+		String paramName = "occurrenceTime";
+		Criteria criteria = Criteria.of("sample", Instant.now());
+		ConvertibleBeanPropertySqlParameterSource sut = new ConvertibleBeanPropertySqlParameterSource(
+			"test.", criteria, this.converter);
+
+		assertThatThrownBy(() -> sut.getValue(paramName))
+			.isExactlyInstanceOf(IllegalArgumentException.class)
+			.hasMessage("Param name does not starts with test.");
+	}
+
+	@DisplayName("Prefix 가 없지만 fallback parameter 라면 Exception 이 발생하지 않습니다.")
+	@Test
+	void getValuePrefixNotMatchedButFallback() {
+		// given
+		String paramName = "none";
+		Criteria criteria = Criteria.of(null, Instant.now());
+		ConvertibleBeanPropertySqlParameterSource sut = new ConvertibleBeanPropertySqlParameterSource(
+			"test.", criteria, this.converter, new TestFallbackParamSource());
+
+		// when
+		Object actual = sut.getValue(paramName);
+
+		// then
+		assertThat(actual).isEqualTo("fallback");
+	}
+
+	@DisplayName("Object의 Field 가 존재하지 않지만, Prefix 가 있는 fallback parameter 라면 Exception 이 발생하지 않습니다.")
+	@Test
+	void getValueNoParamButFallbackInPrefixSource() {
+		// given
+		String paramName = "test.none";
+		Criteria criteria = Criteria.of(null, Instant.now());
+		ConvertibleBeanPropertySqlParameterSource sut = new ConvertibleBeanPropertySqlParameterSource(
+			"test.", criteria, this.converter, new TestFallbackParamSource());
+
+		// when
+		Object actual = sut.getValue(paramName);
+
+		// then
+		assertThat(actual).isEqualTo("fallback");
+	}
+
 	@DisplayName("Iterable 한 값은, element 를 컨버팅한 후 expand padding 을 수행한다.")
 	@ParameterizedTest
 	@AutoSource
