Spring/spring-data-jpa
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

DATAJPA-681 - Adhoc stored procedures now automatically adapt output parameter binding based on input parameters.

Browse Source 
If input parameters are named we now also bind the synthetic output parameter by name for adhoc stored procedures.
This commit is contained in:
Oliver Gierke
2015-02-27 19:13:32 +01:00
parent d1b21f4239
commit 386c2a5ecd
4 changed files with 96 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
src/main/java/org/springframework/data/jpa/repository/query/StoredProcedureAttributes.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2014 the original author or authors.
* Copyright 2014-2015 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.
@@ -18,6 +18,7 @@ package org.springframework.data.jpa.repository.query;
import javax.persistence.StoredProcedureQuery;
import org.springframework.util.Assert;
import org.springframework.util.StringUtils;
/**
* Stored procedure configuration for JPA 2.1 {@link StoredProcedureQuery}s.
@@ -28,6 +29,9 @@ import org.springframework.util.Assert;
*/
class StoredProcedureAttributes {
// A syntheic output parameter name to be used in case of derived stored procedures and named parameters
static final String SYNTHETIC_OUTPUT_PARAMETER_NAME = "out";
private final boolean namedStoredProcedure;
private final String procedureName;
private final String outputParameterName;
@@ -48,7 +52,8 @@ class StoredProcedureAttributes {
Assert.notNull(outputParameterType, "OutputParameterType must not be null!");
this.procedureName = procedureName;
this.outputParameterName = outputParameterName;
this.outputParameterName = !namedStoredProcedure && !StringUtils.hasText(outputParameterName) ? SYNTHETIC_OUTPUT_PARAMETER_NAME
: outputParameterName;
this.outputParameterType = outputParameterType;
this.namedStoredProcedure = namedStoredProcedure;
}

59
src/main/java/org/springframework/data/jpa/repository/query/StoredProcedureJpaQuery.java
View File

@@ -22,6 +22,8 @@ import javax.persistence.StoredProcedureQuery;
import javax.persistence.TypedQuery;
import org.springframework.data.jpa.repository.query.JpaParameters.JpaParameter;
import org.springframework.data.repository.query.Parameter;
import org.springframework.data.repository.query.QueryMethod;
import org.springframework.util.Assert;
import org.springframework.util.StringUtils;
@@ -36,6 +38,7 @@ import org.springframework.util.StringUtils;
class StoredProcedureJpaQuery extends AbstractJpaQuery {
private final StoredProcedureAttributes procedureAttributes;
private final boolean useNamedParameters;
/**
* Creates a new {@link StoredProcedureJpaQuery}.
@@ -47,6 +50,25 @@ class StoredProcedureJpaQuery extends AbstractJpaQuery {
super(method, em);
this.procedureAttributes = method.getProcedureAttributes();
this.useNamedParameters = useNamedParameters(method);
}
/**
* Determine whether to used named parameters for the given query method.
*
* @param method must not be {@literal null}.
* @return
*/
private static boolean useNamedParameters(QueryMethod method) {
for (Parameter parameter : method.getParameters()) {
if (parameter.isNamedParameter()) {
return true;
}
}
return false;
}
/*
@@ -64,10 +86,7 @@ class StoredProcedureJpaQuery extends AbstractJpaQuery {
*/
@Override
protected StoredProcedureQuery doCreateQuery(Object[] values) {
StoredProcedureQuery proc = createStoredProcedure();
return createBinder(values).bind(proc);
return createBinder(values).bind(createStoredProcedure());
}
/*
@@ -93,11 +112,12 @@ class StoredProcedureJpaQuery extends AbstractJpaQuery {
return null;
}
if (StringUtils.hasText(procedureAttributes.getOutputParameterName())) {
return storedProcedureQuery.getOutputParameterValue(procedureAttributes.getOutputParameterName());
}
String outputParameterName = procedureAttributes.getOutputParameterName();
JpaParameters parameters = getQueryMethod().getParameters();
return storedProcedureQuery.getOutputParameterValue(getQueryMethod().getParameters().getNumberOfParameters() + 1);
return useNamedParameters && StringUtils.hasText(outputParameterName) ? //
storedProcedureQuery.getOutputParameterValue(outputParameterName)
: storedProcedureQuery.getOutputParameterValue(parameters.getNumberOfParameters() + 1);
}
/**
@@ -126,17 +146,18 @@ class StoredProcedureJpaQuery extends AbstractJpaQuery {
*/
private StoredProcedureQuery newAdhocStoredProcedureQuery() {
StoredProcedureQuery procedureQuery = getEntityManager().createStoredProcedureQuery(
procedureAttributes.getProcedureName());
JpaParameters params = getQueryMethod().getParameters();
String procedureName = procedureAttributes.getProcedureName();
StoredProcedureQuery procedureQuery = getEntityManager().createStoredProcedureQuery(procedureName);
for (JpaParameter param : params) {
if (!param.isBindable()) {
continue;
}
if (param.isNamedParameter()) {
if (useNamedParameters) {
procedureQuery.registerStoredProcedureParameter(param.getName(), param.getType(), ParameterMode.IN);
} else {
procedureQuery.registerStoredProcedureParameter(param.getIndex() + 1, param.getType(), ParameterMode.IN);
@@ -144,8 +165,18 @@ class StoredProcedureJpaQuery extends AbstractJpaQuery {
}
if (procedureAttributes.hasReturnValue()) {
procedureQuery.registerStoredProcedureParameter(params.getNumberOfParameters() + 1,
procedureAttributes.getOutputParameterType(), ParameterMode.OUT);
Class<?> outputParameterType = procedureAttributes.getOutputParameterType();
ParameterMode mode = ParameterMode.OUT;
if (useNamedParameters) {
String outputParameterName = procedureAttributes.getOutputParameterName();
procedureQuery.registerStoredProcedureParameter(outputParameterName, outputParameterType, mode);
} else {
procedureQuery.registerStoredProcedureParameter(params.getNumberOfParameters() + 1, outputParameterType, mode);
}
}
return procedureQuery;

8
src/test/java/org/springframework/data/jpa/repository/query/StoredProcedureAttributeSourceUnitTests.java
View File

@@ -65,7 +65,7 @@ public class StoredProcedureAttributeSourceUnitTests {
assertThat(attr.getProcedureName(), is("plus1inout"));
assertThat(attr.getOutputParameterType(), is(typeCompatibleWith(Integer.class)));
assertThat(attr.getOutputParameterName(), is(nullValue()));
assertThat(attr.getOutputParameterName(), is(StoredProcedureAttributes.SYNTHETIC_OUTPUT_PARAMETER_NAME));
}
/**
@@ -79,7 +79,7 @@ public class StoredProcedureAttributeSourceUnitTests {
assertThat(attr.getProcedureName(), is("plus1inout"));
assertThat(attr.getOutputParameterType(), is(typeCompatibleWith(Integer.class)));
assertThat(attr.getOutputParameterName(), is(nullValue()));
assertThat(attr.getOutputParameterName(), is(StoredProcedureAttributes.SYNTHETIC_OUTPUT_PARAMETER_NAME));
}
/**
@@ -93,7 +93,7 @@ public class StoredProcedureAttributeSourceUnitTests {
assertThat(attr.getProcedureName(), is("plus1inout"));
assertThat(attr.getOutputParameterType(), is(typeCompatibleWith(Integer.class)));
assertThat(attr.getOutputParameterName(), is(nullValue()));
assertThat(attr.getOutputParameterName(), is(StoredProcedureAttributes.SYNTHETIC_OUTPUT_PARAMETER_NAME));
}
/**
@@ -107,7 +107,7 @@ public class StoredProcedureAttributeSourceUnitTests {
assertThat(attr.getProcedureName(), is("plus1inout"));
assertThat(attr.getOutputParameterType(), is(typeCompatibleWith(Integer.class)));
assertThat(attr.getOutputParameterName(), is(nullValue()));
assertThat(attr.getOutputParameterName(), is(StoredProcedureAttributes.SYNTHETIC_OUTPUT_PARAMETER_NAME));
}
/**

40
src/test/java/org/springframework/data/jpa/repository/query/StoredProcedureAttributesUnitTests.java Normal file
View File

@@ -0,0 +1,40 @@
/*
* Copyright 2015 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.
* 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.springframework.data.jpa.repository.query;
import static org.hamcrest.CoreMatchers.*;
import static org.junit.Assert.*;
import static org.springframework.data.jpa.repository.query.StoredProcedureAttributes.*;
import org.junit.Test;
/**
* Unit tests for {@link StoredProcedureAttributes}.
*
* @author Oliver Gierke
*/
public class StoredProcedureAttributesUnitTests {
/**
* @see DATAJPA-681
*/
@Test
public void usesSyntheticOutputParameterNameForAdhocProcedureWithoutOutputName() {
StoredProcedureAttributes attributes = new StoredProcedureAttributes("procedure", null, Long.class, false);
assertThat(attributes.getOutputParameterName(), is(SYNTHETIC_OUTPUT_PARAMETER_NAME));
}
}