T - the result typepublic class NestedBeanPropertyRowMapper<T>
extends java.lang.Object
implements org.springframework.jdbc.core.RowMapper<T>
RowMapper implementation that converts a row into a new instance of
the specified mapped target class. The mapped target class must be a
top-level class and it must have a default or no-arg constructor.
Column values are mapped based on matching the column name as obtained from result set meta-data to public setters for the corresponding properties. The names are matched either directly or by transforming a name separating the parts with underscores to the same name using "camel" case.
Mapping is provided for fields in the target class for many common types,
e.g.: String, boolean, Boolean, byte, Byte, short, Short, int, Integer, long,
Long, float, Float, double, Double, BigDecimal, java.util.Date, etc.
To facilitate mapping between columns and fields that don't have matching names, try using column aliases in the SQL statement like "select fname as first_name from customer".
For 'null' values read from the database, we will attempt to call the setter, but in the case of Java primitives, this causes a TypeMismatchException. This class can be configured (using the primitivesDefaultedForNullValue property) to trap this exception and use the primitives default value. Be aware that if you use the values from the generated bean to update the database the primitive value will have been set to the primitive's default value instead of null.
Please note that this class is designed to provide convenience rather than
high performance. For best performance, consider using a custom
RowMapper implementation.
| 限定符和类型 | 字段和说明 |
|---|---|
protected org.slf4j.Logger |
logger
Logger available to subclasses.
|
| 构造器和说明 |
|---|
NestedBeanPropertyRowMapper()
Create a new
BeanPropertyRowMapper for bean-style configuration. |
NestedBeanPropertyRowMapper(java.lang.Class<T> mappedClass)
Create a new
BeanPropertyRowMapper, accepting unpopulated
properties in the target bean. |
NestedBeanPropertyRowMapper(java.lang.Class<T> mappedClass,
boolean checkFullyPopulated)
Create a new
BeanPropertyRowMapper. |
| 限定符和类型 | 方法和说明 |
|---|---|
protected java.lang.Object |
getColumnValue(java.sql.ResultSet rs,
int index,
java.beans.PropertyDescriptor pd)
Retrieve a JDBC object value for the specified column.
|
org.springframework.core.convert.ConversionService |
getConversionService()
Return a
ConversionService for binding JDBC values to bean
properties, or null if none. |
java.lang.Class<T> |
getMappedClass()
Get the class that we are mapping to.
|
protected void |
initBeanWrapper(org.springframework.beans.BeanWrapper bw)
Initialize the given BeanWrapper to be used for row mapping.
|
protected void |
initialize(java.lang.Class<T> mappedClass)
Initialize the mapping meta-data for the given class.
|
boolean |
isCheckFullyPopulated()
Return whether we're strictly validating that all bean properties have
been mapped from corresponding database fields.
|
boolean |
isPrimitivesDefaultedForNullValue()
Return whether we're defaulting Java primitives in the case of mapping a
null value from corresponding database fields.
|
protected java.lang.String |
lowerCaseName(java.lang.String name)
Convert the given name to lower case.
|
T |
mapRow(java.sql.ResultSet rs,
int rowNumber)
Extract the values for all columns in the current row.
|
static <T> NestedBeanPropertyRowMapper<T> |
newInstance(java.lang.Class<T> mappedClass)
Static factory method to create a new
BeanPropertyRowMapper (with
the mapped class specified only once). |
void |
setCheckFullyPopulated(boolean checkFullyPopulated)
Set whether we're strictly validating that all bean properties have been
mapped from corresponding database fields.
|
void |
setConversionService(org.springframework.core.convert.ConversionService conversionService)
Set a
ConversionService for binding JDBC values to bean
properties, or null for none. |
void |
setMappedClass(java.lang.Class<T> mappedClass)
Set the class that each row should be mapped to.
|
void |
setPrimitivesDefaultedForNullValue(boolean primitivesDefaultedForNullValue)
Set whether we're defaulting Java primitives in the case of mapping a
null value from corresponding database fields.
|
protected java.lang.String |
underscoreName(java.lang.String name)
Convert a name in camelCase to an underscored name in lower case.
|
public NestedBeanPropertyRowMapper()
BeanPropertyRowMapper for bean-style configuration.public NestedBeanPropertyRowMapper(java.lang.Class<T> mappedClass)
BeanPropertyRowMapper, accepting unpopulated
properties in the target bean.
Consider using the newInstance(java.lang.Class<T>) factory method instead, which
allows for specifying the mapped type once only.
mappedClass - the class that each row should be mapped topublic NestedBeanPropertyRowMapper(java.lang.Class<T> mappedClass, boolean checkFullyPopulated)
BeanPropertyRowMapper.mappedClass - the class that each row should be mapped tocheckFullyPopulated - whether we're strictly validating that all
bean properties have been mapped from
corresponding database fieldspublic void setMappedClass(java.lang.Class<T> mappedClass)
mappedClass - the new mapped class@Nullable public final java.lang.Class<T> getMappedClass()
public void setCheckFullyPopulated(boolean checkFullyPopulated)
Default is false, accepting unpopulated properties in the target
bean.
checkFullyPopulated - the new check fully populatedpublic boolean isCheckFullyPopulated()
public void setPrimitivesDefaultedForNullValue(boolean primitivesDefaultedForNullValue)
Default is false, throwing an exception when nulls are mapped to
Java primitives.
primitivesDefaultedForNullValue - the new primitives defaulted for
null valuepublic boolean isPrimitivesDefaultedForNullValue()
public void setConversionService(@Nullable
org.springframework.core.convert.ConversionService conversionService)
ConversionService for binding JDBC values to bean
properties, or null for none.
Default is a DefaultConversionService, as of Spring 4.3. This
provides support for java.time conversion and other special
types.
conversionService - the new conversion serviceinitBeanWrapper(BeanWrapper)@Nullable public org.springframework.core.convert.ConversionService getConversionService()
ConversionService for binding JDBC values to bean
properties, or null if none.protected void initialize(java.lang.Class<T> mappedClass)
mappedClass - the mapped classprotected java.lang.String underscoreName(java.lang.String name)
name - the original namelowerCaseName(java.lang.String)protected java.lang.String lowerCaseName(java.lang.String name)
name - the original namepublic T mapRow(java.sql.ResultSet rs, int rowNumber) throws java.sql.SQLException
Utilizes public setters and result set meta-data.
mapRow 在接口中 org.springframework.jdbc.core.RowMapper<T>java.sql.SQLExceptionResultSetMetaDataprotected void initBeanWrapper(org.springframework.beans.BeanWrapper bw)
The default implementation applies the configured
ConversionService, if any. Can be overridden in subclasses.
bw - the BeanWrapper to initializegetConversionService(),
ConfigurablePropertyAccessor.setConversionService(org.springframework.core.convert.ConversionService)@Nullable
protected java.lang.Object getColumnValue(java.sql.ResultSet rs,
int index,
java.beans.PropertyDescriptor pd)
throws java.sql.SQLException
The default implementation calls
JdbcUtils.getResultSetValue(java.sql.ResultSet, int, Class).
Subclasses may override this to check specific value types upfront, or to
post-process values return from getResultSetValue.
rs - is the ResultSet holding the dataindex - is the column indexpd - the bean property that each result object is expected to
matchjava.sql.SQLException - in case of extraction failureJdbcUtils.getResultSetValue(java.sql.ResultSet,
int, Class)public static <T> NestedBeanPropertyRowMapper<T> newInstance(java.lang.Class<T> mappedClass)
BeanPropertyRowMapper (with
the mapped class specified only once).T - the generic typemappedClass - the class that each row should be mapped to