com.centit.framework.jdbc.dao

类 BaseDaoImpl<T extends Serializable,PK extends Serializable>

java.lang.Object

com.centit.framework.jdbc.dao.BaseDaoImpl<T,PK>

public abstract class BaseDaoImpl<T extends Serializable,PK extends Serializable>
extends Object

字段概要

字段

限定符和类型	字段和说明
protected Map<String,String>	filterField
protected org.springframework.jdbc.core.JdbcTemplate	jdbcTemplate
protected static org.slf4j.Logger	logger

构造器概要

构造器

构造器和说明
BaseDaoImpl()

方法概要

限定符和类型	方法和说明
String	buildDefaultFieldFilterSql()
String	buildFieldFilterSql(String alias, boolean useDefaultFilter) 每个dao都需要重载这个函数已获得自定义的查询条件，否则listObjects、pageQuery就等价与listObjectsByProperties 根据 getFilterField 中的内容初始化
void	deleteObject(T o)
void	deleteObjectById(Object id)
void	deleteObjectForce(T o)
void	deleteObjectForceById(Object id)
void	deleteObjectsByProperties(Map<String,Object> filterMap)
void	deleteObjectsForceByProperties(Map<String,Object> filterMap)
boolean	enableDefaultFilter() 是否为每一个没有配置 filterField 配置过滤条件的属性自动配置一个 equal 类型的过滤条件
String	encapsulateFilterToSql(String filterQuery)
T	fetchObjectLazyColumn(T o, String columnName)
T	fetchObjectLazyColumns(T o)
T	fetchObjectReference(T object, String columnName)
T	fetchObjectReferences(T o)
static String	fetchSelfOrderSql(String querySql, Map<String,Object> filterMap) querySql 用户检查order by 中的字段属性 对应的查询标识 比如， select a+b as ab from table 在 filterMap 中的 CodeBook.TABLE_SORT_FIELD (sort) 为 ab 字段 返回的排序语句为 a+b
Connection	getConnection() Get a JDBC Connection, either from the current transaction or a new one.
DataSource	getDataSource() 获取数据源 这个一般不要使用
String	getExtendFilterQuerySql() 可以在外部注入查询语句来屏蔽内部标量getFilterField中定义的查询语句
abstract Map<String,String>	getFilterField() 每个dao都要初始化filterField这个对象，在 getFilterField 初始化，并且返回
static Map<String,org.apache.commons.lang3.tuple.Pair<String,String>>	getFilterFieldWithPretreatment(Map<String,String> fieldMap)
String	getFilterQuerySql()
org.springframework.jdbc.core.JdbcTemplate	getJdbcTemplate() 获取spring jdbc 的 jdbcTemplate
T	getObjectById(Object id)
T	getObjectByProperties(Map<String,Object> properties)
T	getObjectIncludeLazyById(Object id)
T	getObjectWithReferences(Object id)
Class<?>	getPkClass()
Class<?>	getPoClass()
List<T>	listObjects() 查询所有数据
List<T>	listObjects(Map<String,Object> filterMap) 根据设定的条件查询数据对象
com.alibaba.fastjson.JSONArray	listObjectsAsJson(Map<String,Object> filterMap, Collection<String> filters, com.centit.support.database.utils.PageDesc pageDesc) 根据 前端传入的参数 驱动查询
com.alibaba.fastjson.JSONArray	listObjectsAsJson(Map<String,Object> filterMap, com.centit.support.database.utils.PageDesc pageDesc)
List<T>	listObjectsByFilter(String whereSql, Map<String,Object> namedParams) 根据条件查询对象
List<T>	listObjectsByFilter(String whereSql, Map<String,Object> namedParams, com.centit.support.database.utils.PageDesc pageDesc) 已过时。
List<T>	listObjectsByFilter(String whereSql, Object[] params) 根据条件查询对象
List<T>	listObjectsByFilter(String whereSql, Object[] params, com.centit.support.database.utils.PageDesc pageDesc) 已过时。
com.alibaba.fastjson.JSONArray	listObjectsByFilterAsJson(String whereSql, Map<String,Object> namedParams, com.centit.support.database.utils.PageDesc pageDesc)
com.alibaba.fastjson.JSONArray	listObjectsByFilterAsJson(String whereSql, Object[] params, com.centit.support.database.utils.PageDesc pageDesc)
List<T>	listObjectsByProperties(Map<String,Object> propertiesMap)
List<T>	listObjectsByProperties(Map<String,Object> filterMap, com.centit.support.database.utils.PageDesc pageDesc)
List<T>	listObjectsByProperty(String propertyName, Object propertyValue)
List<T>	listObjectsBySql(String querySql, Map<String,Object> namedParams)
void	mergeObject(T o)
int	pageCount(Map<String,Object> filterMap) 已过时。
List<T>	pageQuery(Map<String,Object> filterMap) 已过时。
protected static org.apache.commons.lang3.tuple.ImmutablePair<String,String>	parseParameter(String sParameter) 分析参数，这个主要用于解释，分析参数前面括号中的预处理标识
void	releaseConnection(Connection con) Close the given JDBC Connection, created via this DAO's DataSource, if it isn't bound to the thread.
void	saveNewObject(T o)
Integer	saveObjectReference(T object, String columnName)
Integer	saveObjectReferences(T o)
void	setDataSource(DataSource dataSource) Set the JDBC DataSource to obtain connections from.
static String	translatePropertyNameToColumnName(com.centit.support.database.orm.TableMapInfo mapInfo, String sql, String alias)
void	updateObject(Collection<String> fields, T object) 只更改对象的部分属性
void	updateObject(String[] fields, T object) 只更改对象的部分属性
void	updateObject(T o)

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

logger

protected static org.slf4j.Logger logger

filterField

protected Map<String,String> filterField

jdbcTemplate

protected org.springframework.jdbc.core.JdbcTemplate jdbcTemplate

构造器详细资料

BaseDaoImpl

public BaseDaoImpl()

方法详细资料

setDataSource

public void setDataSource(DataSource dataSource)

Set the JDBC DataSource to obtain connections from.

参数:

dataSource - 数据源

getJdbcTemplate

public org.springframework.jdbc.core.JdbcTemplate getJdbcTemplate()

获取spring jdbc 的 jdbcTemplate

返回:

JdbcTemplate

getDataSource

public DataSource getDataSource()

获取数据源 这个一般不要使用

返回:

DataSource

getConnection

public Connection getConnection()
                         throws org.springframework.jdbc.CannotGetJdbcConnectionException

Get a JDBC Connection, either from the current transaction or a new one. 请不要使用这个方法，我们一般获取jdbcTemplate来操作数据库

返回:

the JDBC Connection

抛出:

org.springframework.jdbc.CannotGetJdbcConnectionException - if the attempt to get a Connection failed

另请参阅:

DataSourceUtils.getConnection(javax.sql.DataSource)

releaseConnection

public void releaseConnection(Connection con)

Close the given JDBC Connection, created via this DAO's DataSource, if it isn't bound to the thread.

参数:

con - Connection to close

另请参阅:

DataSourceUtils.releaseConnection(java.sql.Connection, javax.sql.DataSource)

getPoClass

public Class<?> getPoClass()

getPkClass

public Class<?> getPkClass()

encapsulateFilterToSql

public String encapsulateFilterToSql(String filterQuery)

getExtendFilterQuerySql

public String getExtendFilterQuerySql()

可以在外部注入查询语句来屏蔽内部标量getFilterField中定义的查询语句

返回:

外部语句

parseParameter

protected static org.apache.commons.lang3.tuple.ImmutablePair<String,String> parseParameter(String sParameter)

分析参数，这个主要用于解释，分析参数前面括号中的预处理标识

参数:

sParameter - 传入的参数

返回:

ImmutablePair < String, String >

getFilterFieldWithPretreatment

public static Map<String,org.apache.commons.lang3.tuple.Pair<String,String>> getFilterFieldWithPretreatment(Map<String,String> fieldMap)

translatePropertyNameToColumnName

public static String translatePropertyNameToColumnName(com.centit.support.database.orm.TableMapInfo mapInfo,
                                                       String sql,
                                                       String alias)

buildFieldFilterSql

public String buildFieldFilterSql(String alias,
                                  boolean useDefaultFilter)

每个dao都需要重载这个函数已获得自定义的查询条件，否则listObjects、pageQuery就等价与listObjectsByProperties 根据 getFilterField 中的内容初始化

参数:

alias - 数据库表别名

useDefaultFilter - 使用默认过滤器

返回:

FilterQuery

getFilterField

public abstract Map<String,String> getFilterField()

每个dao都要初始化filterField这个对象，在 getFilterField 初始化，并且返回

返回:

返回 getFilterField 属性

enableDefaultFilter

public boolean enableDefaultFilter()

是否为每一个没有配置 filterField 配置过滤条件的属性自动配置一个 equal 类型的过滤条件

返回:

默认值为false

buildDefaultFieldFilterSql

public String buildDefaultFieldFilterSql()

getFilterQuerySql

public String getFilterQuerySql()

saveNewObject

public void saveNewObject(T o)

deleteObjectForce

public void deleteObjectForce(T o)

deleteObjectForceById

public void deleteObjectForceById(Object id)

deleteObjectsForceByProperties

public void deleteObjectsForceByProperties(Map<String,Object> filterMap)

deleteObject

public void deleteObject(T o)

deleteObjectById

public void deleteObjectById(Object id)

deleteObjectsByProperties

public void deleteObjectsByProperties(Map<String,Object> filterMap)

updateObject

public void updateObject(T o)

updateObject

public void updateObject(Collection<String> fields,
                         T object)
                  throws com.centit.support.database.utils.PersistenceException

只更改对象的部分属性

参数:

fields - 需要修改的部分属性

object - 除了对应修改的属性 需要有相应的值，主键对应的属性也必须要值

抛出:

com.centit.support.database.utils.PersistenceException - 运行时异常

updateObject

public void updateObject(String[] fields,
                         T object)
                  throws com.centit.support.database.utils.PersistenceException

只更改对象的部分属性

参数:

fields - 需要修改的部分属性

object - 除了对应修改的属性 需要有相应的值，主键对应的属性也必须要值

抛出:

com.centit.support.database.utils.PersistenceException - 运行时异常

mergeObject

public void mergeObject(T o)

getObjectById

public T getObjectById(Object id)

getObjectIncludeLazyById

public T getObjectIncludeLazyById(Object id)

getObjectWithReferences

public T getObjectWithReferences(Object id)

fetchObjectLazyColumn

public T fetchObjectLazyColumn(T o,
                               String columnName)

fetchObjectLazyColumns

public T fetchObjectLazyColumns(T o)

fetchObjectReference

public T fetchObjectReference(T object,
                              String columnName)

fetchObjectReferences

public T fetchObjectReferences(T o)

saveObjectReference

public Integer saveObjectReference(T object,
                                   String columnName)

saveObjectReferences

public Integer saveObjectReferences(T o)

getObjectByProperties

public T getObjectByProperties(Map<String,Object> properties)

listObjectsByProperty

public List<T> listObjectsByProperty(String propertyName,
                                     Object propertyValue)

listObjectsByProperties

public List<T> listObjectsByProperties(Map<String,Object> propertiesMap)

listObjectsByProperties

public List<T> listObjectsByProperties(Map<String,Object> filterMap,
                                       com.centit.support.database.utils.PageDesc pageDesc)

pageCount

@Deprecated
public int pageCount(Map<String,Object> filterMap)

已过时。

这个函数仅仅是为了兼容mybatis版本中的查询

参数:

filterMap - 过滤条件

返回:

总行数 在 JDBC 版本中 请用 listObjectsAsJSON

pageQuery

@Deprecated
public List<T> pageQuery(Map<String,Object> filterMap)

已过时。

这个函数仅仅是为了兼容mybatis版本中的查询

参数:

filterMap - 过滤条件

返回:

分页数据 在 JDBC 版本中 请用 listObjectsAsJSON

listObjects

public List<T> listObjects()

查询所有数据

返回:

返回所有数据 listAllObjects

listObjects

public List<T> listObjects(Map<String,Object> filterMap)

根据设定的条件查询数据对象

参数:

filterMap - 过滤条件

返回:

返回符合条件的对象

listObjectsByFilter

public List<T> listObjectsByFilter(String whereSql,
                                   Object[] params)

根据条件查询对象

参数:

whereSql - 只有 where 部分， 不能有from部分 这个式hibernate的区别

params - 参数

返回:

符合条件的对象

listObjectsByFilter

public List<T> listObjectsByFilter(String whereSql,
                                   Map<String,Object> namedParams)

根据条件查询对象

参数:

whereSql - 只有 where 部分， 不能有from部分 这个式hibernate的区别

namedParams - 命名参数

返回:

符合条件的对象

listObjectsByFilter

@Deprecated
public List<T> listObjectsByFilter(String whereSql,
                                               Object[] params,
                                               com.centit.support.database.utils.PageDesc pageDesc)

已过时。

由于性能问题，不推荐使用这个方法，分页查询一般都是用于前端展示的，建议使用 listObjectsByFilterAsJson

参数:

whereSql - 查询po 所以只有套写 where 以后部分

params - 查询参数

pageDesc - 分页信息

返回:

返回对象

listObjectsByFilter

@Deprecated
public List<T> listObjectsByFilter(String whereSql,
                                               Map<String,Object> namedParams,
                                               com.centit.support.database.utils.PageDesc pageDesc)

已过时。

由于性能问题，不推荐使用这个方法，分页查询一般都是用于前端展示的，建议使用 listObjectsByFilterAsJson

参数:

whereSql - 查询po 所以只有套写 where 以后部分

namedParams - 查询参数

pageDesc - 分页信息

返回:

返回对象

listObjectsBySql

public List<T> listObjectsBySql(String querySql,
                                Map<String,Object> namedParams)

fetchSelfOrderSql

public static String fetchSelfOrderSql(String querySql,
                                       Map<String,Object> filterMap)

querySql 用户检查order by 中的字段属性 对应的查询标识 比如， select a+b as ab from table 在 filterMap 中的 CodeBook.TABLE_SORT_FIELD (sort) 为 ab 字段 返回的排序语句为 a+b

参数:

querySql - SQL语句 用来检查字段对应的查询语句 片段

filterMap - 查询条件map其中包含排序属性

返回:

order by 字句

listObjectsAsJson

public com.alibaba.fastjson.JSONArray listObjectsAsJson(Map<String,Object> filterMap,
                                                        Collection<String> filters,
                                                        com.centit.support.database.utils.PageDesc pageDesc)

根据 前端传入的参数 驱动查询

参数:

filterMap - 前端输入的过滤条件，包括用户的基本信息（这个小service注入，主要用于数据权限的过滤）

filters - 数据权限顾虑语句

pageDesc - 分页信息

返回:

返回的对象列表

listObjectsAsJson

public com.alibaba.fastjson.JSONArray listObjectsAsJson(Map<String,Object> filterMap,
                                                        com.centit.support.database.utils.PageDesc pageDesc)

listObjectsByFilterAsJson

public com.alibaba.fastjson.JSONArray listObjectsByFilterAsJson(String whereSql,
                                                                Map<String,Object> namedParams,
                                                                com.centit.support.database.utils.PageDesc pageDesc)

参数:

whereSql - 查询po 所以只有套写 where 以后部分

namedParams - 查询参数

pageDesc - 分页信息

返回:

返回JSONArray

listObjectsByFilterAsJson

public com.alibaba.fastjson.JSONArray listObjectsByFilterAsJson(String whereSql,
                                                                Object[] params,
                                                                com.centit.support.database.utils.PageDesc pageDesc)

参数:

whereSql - 查询po 所以只有套写 where 以后部分

params - 查询参数

pageDesc - 分页信息

返回:

返回JSONArray