All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.jchanghong.db.AbstractDb Maven / Gradle / Ivy

The newest version!
package com.jchanghong.db;

import com.jchanghong.core.collection.CollUtil;
import com.jchanghong.db.dialect.Dialect;
import com.jchanghong.db.handler.BeanListHandler;
import com.jchanghong.db.handler.EntityHandler;
import com.jchanghong.db.handler.EntityListHandler;
import com.jchanghong.db.handler.NumberHandler;
import com.jchanghong.db.handler.RsHandler;
import com.jchanghong.db.handler.StringHandler;
import com.jchanghong.db.sql.Condition;
import com.jchanghong.db.sql.Condition.LikeType;
import com.jchanghong.db.sql.Query;
import com.jchanghong.db.sql.SqlExecutor;
import com.jchanghong.db.sql.SqlUtil;
import com.jchanghong.db.sql.Wrapper;

import javax.sql.DataSource;
import java.io.Serializable;
import java.sql.Connection;
import java.sql.SQLException;
import java.util.Collection;
import java.util.List;
import java.util.Map;

/**
 * 抽象数据库操作类
* 通过给定的数据源执行给定SQL或者给定数据源和方言,执行相应的CRUD操作
* 提供抽象方法getConnection和closeConnection,用于自定义数据库连接的打开和关闭 * * @author Luxiaolei */ public abstract class AbstractDb implements Serializable { private static final long serialVersionUID = 3858951941916349062L; protected final DataSource ds; /** * 是否支持事务 */ protected Boolean isSupportTransaction = null; /** * 是否大小写不敏感(默认大小写不敏感) */ protected boolean caseInsensitive = DbUtil.caseInsensitiveGlobal; protected SqlConnRunner runner; // ------------------------------------------------------- Constructor start /** * 构造 * * @param ds 数据源 * @param dialect 数据库方言 */ public AbstractDb(DataSource ds, Dialect dialect) { this.ds = ds; this.runner = new SqlConnRunner(dialect); } // ------------------------------------------------------- Constructor end /** * 获得链接。根据实现不同,可以自定义获取连接的方式 * * @return {@link Connection} * @throws SQLException 连接获取异常 */ public abstract Connection getConnection() throws SQLException; /** * 关闭连接
* 自定义关闭连接有利于自定义回收连接机制,或者不关闭 * * @param conn 连接 {@link Connection} */ public abstract void closeConnection(Connection conn); /** * 查询 * * @param sql 查询语句 * @param params 参数 * @return 结果对象 * @throws SQLException SQL执行异常 * @since 3.1.1 */ public List query(String sql, Map params) throws SQLException { return query(sql, new EntityListHandler(this.caseInsensitive), params); } /** * 查询 * * @param sql 查询语句 * @param params 参数 * @return 结果对象 * @throws SQLException SQL执行异常 * @since 3.1.1 */ public List query(String sql, Object... params) throws SQLException { return query(sql, new EntityListHandler(this.caseInsensitive), params); } /** * 查询 * * @param 结果集需要处理的对象类型 * @param sql 查询语句 * @param beanClass 元素Bean类型 * @param params 参数 * @return 结果对象 * @throws SQLException SQL执行异常 * @since 3.2.2 */ public List query(String sql, Class beanClass, Object... params) throws SQLException { return query(sql, new BeanListHandler<>(beanClass), params); } /** * 查询单条记录 * * @param sql 查询语句 * @param params 参数 * @return 结果对象 * @throws SQLException SQL执行异常 */ public Entity queryOne(String sql, Object... params) throws SQLException { return query(sql, new EntityHandler(this.caseInsensitive), params); } /** * 查询单条单个字段记录,并将其转换为Number * * @param sql 查询语句 * @param params 参数 * @return 结果对象 * @throws SQLException SQL执行异常 */ public Number queryNumber(String sql, Object... params) throws SQLException { return query(sql, new NumberHandler(), params); } /** * 查询单条单个字段记录,并将其转换为String * * @param sql 查询语句 * @param params 参数 * @return 结果对象 * @throws SQLException SQL执行异常 */ public String queryString(String sql, Object... params) throws SQLException { return query(sql, new StringHandler(), params); } /** * 查询 * * @param 结果集需要处理的对象类型 * @param sql 查询语句 * @param rsh 结果集处理对象 * @param params 参数 * @return 结果对象 * @throws SQLException SQL执行异常 */ public T query(String sql, RsHandler rsh, Object... params) throws SQLException { Connection conn = null; try { conn = this.getConnection(); return SqlExecutor.query(conn, sql, rsh, params); } finally { this.closeConnection(conn); } } /** * 支持占位符的查询,例如:select * from table where field1=:name1 * * @param 结果集需要处理的对象类型 * @param sql 查询语句,使用参数名占位符,例如:name * @param rsh 结果集处理对象 * @param paramMap 参数 * @return 结果对象 * @throws SQLException SQL执行异常 * @since 5.2.2 */ public T query(String sql, RsHandler rsh, Map paramMap) throws SQLException { Connection conn = null; try { conn = this.getConnection(); return SqlExecutor.query(conn, sql, rsh, paramMap); } finally { this.closeConnection(conn); } } /** * 执行非查询语句
* 语句包括 插入、更新、删除 * * @param sql SQL * @param params 参数 * @return 影响行数 * @throws SQLException SQL执行异常 */ public int execute(String sql, Object... params) throws SQLException { Connection conn = null; try { conn = this.getConnection(); return SqlExecutor.execute(conn, sql, params); } finally { this.closeConnection(conn); } } /** * 执行非查询语句
* 语句包括 插入、更新、删除 * * @param sql SQL * @param params 参数 * @return 主键 * @throws SQLException SQL执行异常 */ public Long executeForGeneratedKey(String sql, Object... params) throws SQLException { Connection conn = null; try { conn = this.getConnection(); return SqlExecutor.executeForGeneratedKey(conn, sql, params); } finally { this.closeConnection(conn); } } /** * 批量执行非查询语句 * * @param sql SQL * @param paramsBatch 批量的参数 * @return 每个SQL执行影响的行数 * @throws SQLException SQL执行异常 */ public int[] executeBatch(String sql, Object[]... paramsBatch) throws SQLException { Connection conn = null; try { conn = this.getConnection(); return SqlExecutor.executeBatch(conn, sql, paramsBatch); } finally { this.closeConnection(conn); } } /** * 批量执行非查询语句 * * @param sqls SQL列表 * @return 每个SQL执行影响的行数 * @throws SQLException SQL执行异常 * @since 4.5.6 */ public int[] executeBatch(String... sqls) throws SQLException { Connection conn = null; try { conn = this.getConnection(); return SqlExecutor.executeBatch(conn, sqls); } finally { this.closeConnection(conn); } } // ---------------------------------------------------------------------------- CRUD start /** * 插入数据 * * @param record 记录 * @return 插入行数 * @throws SQLException SQL执行异常 */ public int insert(Entity record) throws SQLException { Connection conn = null; try { conn = this.getConnection(); return runner.insert(conn, record); } finally { this.closeConnection(conn); } } /** * 插入或更新数据
* 根据给定的字段名查询数据,如果存在则更新这些数据,否则执行插入 * * @param record 记录 * @param keys 需要检查唯一性的字段 * @return 插入行数 * @throws SQLException SQL执行异常 * @since 4.0.10 */ public int insertOrUpdate(Entity record, String... keys) throws SQLException { Connection conn = null; try { conn = this.getConnection(); return runner.insertOrUpdate(conn, record, keys); } finally { this.closeConnection(conn); } } /** * 批量插入数据
* 需要注意的是,批量插入每一条数据结构必须一致。批量插入数据时会获取第一条数据的字段结构,之后的数据会按照这个格式插入。
* 也就是说假如第一条数据只有2个字段,后边数据多于这两个字段的部分将被抛弃。 * * @param records 记录列表 * @return 插入行数 * @throws SQLException SQL执行异常 */ public int[] insert(Collection records) throws SQLException { Connection conn = null; try { conn = this.getConnection(); return runner.insert(conn, records); } finally { this.closeConnection(conn); } } /** * 插入数据 * * @param record 记录 * @return 主键列表 * @throws SQLException SQL执行异常 */ public List insertForGeneratedKeys(Entity record) throws SQLException { Connection conn = null; try { conn = this.getConnection(); return runner.insertForGeneratedKeys(conn, record); } finally { this.closeConnection(conn); } } /** * 插入数据 * * @param record 记录 * @return 主键 * @throws SQLException SQL执行异常 */ public Long insertForGeneratedKey(Entity record) throws SQLException { Connection conn = null; try { conn = this.getConnection(); return runner.insertForGeneratedKey(conn, record); } finally { this.closeConnection(conn); } } /** * 删除数据 * * @param tableName 表名 * @param field 字段名,最好是主键 * @param value 值,值可以是列表或数组,被当作IN查询处理 * @return 删除行数 * @throws SQLException SQL执行异常 */ public int del(String tableName, String field, Object value) throws SQLException { return del(Entity.create(tableName).set(field, value)); } /** * 删除数据 * * @param where 条件 * @return 影响行数 * @throws SQLException SQL执行异常 */ public int del(Entity where) throws SQLException { Connection conn = null; try { conn = this.getConnection(); return runner.del(conn, where); } finally { this.closeConnection(conn); } } /** * 更新数据
* 更新条件为多个key value对表示,默认key = value,如果使用其它条件可以使用:where.put("key", " > 1"),value也可以传Condition对象,key被忽略 * * @param record 记录 * @param where 条件 * @return 影响行数 * @throws SQLException SQL执行异常 */ public int update(Entity record, Entity where) throws SQLException { Connection conn = null; try { conn = this.getConnection(); return runner.update(conn, record, where); } finally { this.closeConnection(conn); } } // ------------------------------------------------------------- Get start /** * 根据某个字段(最好是唯一字段)查询单个记录
* 当有多条返回时,只显示查询到的第一条 * * @param 字段值类型 * @param tableName 表名 * @param field 字段名 * @param value 字段值 * @return 记录 * @throws SQLException SQL执行异常 */ public Entity get(String tableName, String field, T value) throws SQLException { return this.get(Entity.create(tableName).set(field, value)); } /** * 根据条件实体查询单个记录,当有多条返回时,只显示查询到的第一条 * * @param where 条件 * @return 记录 * @throws SQLException SQL执行异常 */ public Entity get(Entity where) throws SQLException { return find(where.getFieldNames(), where, new EntityHandler(this.caseInsensitive)); } // ------------------------------------------------------------- Get end /** * 查询
* 查询条件为多个key value对表示,默认key = value,如果使用其它条件可以使用:where.put("key", " > 1"),value也可以传Condition对象,key被忽略 * * @param 需要处理成的结果对象类型 * @param fields 返回的字段列表,null则返回所有字段 * @param where 条件实体类(包含表名) * @param rsh 结果集处理对象 * @return 结果对象 * @throws SQLException SQL执行异常 */ public T find(Collection fields, Entity where, RsHandler rsh) throws SQLException { Connection conn = null; try { conn = this.getConnection(); return runner.find(conn, fields, where, rsh); } finally { this.closeConnection(conn); } } /** * 查询
* 查询条件为多个key value对表示,默认key = value,如果使用其它条件可以使用:where.put("key", " > 1"),value也可以传Condition对象,key被忽略 * * @param fields 返回的字段列表,null则返回所有字段 * @param where 条件实体类(包含表名) * @return 结果Entity列表 * @throws SQLException SQL执行异常 * @since 4.5.16 */ public List find(Collection fields, Entity where) throws SQLException { return find(fields, where, new EntityListHandler(this.caseInsensitive)); } /** * 查询
* Query为查询所需数据的一个实体类,此对象中可以定义返回字段、查询条件,查询的表、分页等信息 * * @param 需要处理成的结果对象类型 * @param query {@link Query}对象,此对象中可以定义返回字段、查询条件,查询的表、分页等信息 * @param rsh 结果集处理对象 * @return 结果对象 * @throws SQLException SQL执行异常 * @since 4.0.0 */ public T find(Query query, RsHandler rsh) throws SQLException { Connection conn = null; try { conn = this.getConnection(); return runner.find(conn, query, rsh); } finally { this.closeConnection(conn); } } /** * 查询,返回所有字段
* 查询条件为多个key value对表示,默认key = value,如果使用其它条件可以使用:where.put("key", " > 1"),value也可以传Condition对象,key被忽略 * * @param 需要处理成的结果对象类型 * @param where 条件实体类(包含表名) * @param rsh 结果集处理对象 * @param fields 字段列表,可变长参数如果无值表示查询全部字段 * @return 结果对象 * @throws SQLException SQL执行异常 */ public T find(Entity where, RsHandler rsh, String... fields) throws SQLException { return find(CollUtil.newArrayList(fields), where, rsh); } /** * 查询数据列表,返回字段由where参数指定
* 查询条件为多个key value对表示,默认key = value,如果使用其它条件可以使用:where.put("key", " > 1"),value也可以传Condition对象,key被忽略 * * @param where 条件实体类(包含表名) * @return 数据对象列表 * @throws SQLException SQL执行异常 * @since 3.2.1 */ public List find(Entity where) throws SQLException { return find(where.getFieldNames(), where, new EntityListHandler(this.caseInsensitive)); } /** * 查询数据列表,返回字段由where参数指定
* 查询条件为多个key value对表示,默认key = value,如果使用其它条件可以使用:where.put("key", " > 1"),value也可以传Condition对象,key被忽略 * * @param Bean类型 * @param where 条件实体类(包含表名) * @param beanClass Bean类 * @return 数据对象列表 * @throws SQLException SQL执行异常 * @since 3.2.2 */ public List find(Entity where, Class beanClass) throws SQLException { return find(where.getFieldNames(), where, BeanListHandler.create(beanClass)); } /** * 查询数据列表,返回所有字段
* 查询条件为多个key value对表示,默认key = value,如果使用其它条件可以使用:where.put("key", " > 1"),value也可以传Condition对象,key被忽略 * * @param where 条件实体类(包含表名) * @return 数据对象列表 * @throws SQLException SQL执行异常 */ public List findAll(Entity where) throws SQLException { return find(where, EntityListHandler.create()); } /** * 查询数据列表,返回所有字段
* 查询条件为多个key value对表示,默认key = value,如果使用其它条件可以使用:where.put("key", " > 1"),value也可以传Condition对象,key被忽略 * * @param Bean类型 * @param where 条件实体类(包含表名) * @param beanClass 返回的对象类型 * @return 数据对象列表 * @throws SQLException SQL执行异常 * @since 3.2.2 */ public List findAll(Entity where, Class beanClass) throws SQLException { return find(where, BeanListHandler.create(beanClass)); } /** * 查询数据列表,返回所有字段 * * @param tableName 表名 * @return 数据对象列表 * @throws SQLException SQL执行异常 */ public List findAll(String tableName) throws SQLException { return findAll(Entity.create(tableName)); } /** * 根据某个字段名条件查询数据列表,返回所有字段 * * @param tableName 表名 * @param field 字段名 * @param value 字段值 * @return 数据对象列表 * @throws SQLException SQL执行异常 */ public List findBy(String tableName, String field, Object value) throws SQLException { return findAll(Entity.create(tableName).set(field, value)); } /** * 根据多个条件查询数据列表,返回所有字段 * * @param tableName 表名 * @param wheres 字段名 * @return 数据对象列表 * @throws SQLException SQL执行异常 * @since 4.0.0 */ public List findBy(String tableName, Condition... wheres) throws SQLException { final Query query = new Query(wheres, tableName); return find(query, new EntityListHandler(this.caseInsensitive)); } /** * 根据某个字段名条件查询数据列表,返回所有字段 * * @param tableName 表名 * @param field 字段名 * @param value 字段值 * @param likeType {@link LikeType} * @return 数据对象列表 * @throws SQLException SQL执行异常 */ public List findLike(String tableName, String field, String value, LikeType likeType) throws SQLException { return findAll(Entity.create(tableName).set(field, SqlUtil.buildLikeValue(value, likeType, true))); } /** * 结果的条目数 * * @param where 查询条件 * @return 复合条件的结果数 * @throws SQLException SQL执行异常 */ public int count(Entity where) throws SQLException { Connection conn = null; try { conn = this.getConnection(); return runner.count(conn, where); } finally { this.closeConnection(conn); } } /** * 分页查询
* 查询条件为多个key value对表示,默认key = value,如果使用其它条件可以使用:where.put("key", " > 1"),value也可以传Condition对象,key被忽略 * * @param 结果对象类型 * @param fields 返回的字段列表,null则返回所有字段 * @param where 条件实体类(包含表名) * @param page 页码,0表示第一页 * @param numPerPage 每页条目数 * @param rsh 结果集处理对象 * @return 结果对象 * @throws SQLException SQL执行异常 */ public T page(Collection fields, Entity where, int page, int numPerPage, RsHandler rsh) throws SQLException { Connection conn = null; try { conn = this.getConnection(); return runner.page(conn, fields, where, page, numPerPage, rsh); } finally { this.closeConnection(conn); } } /** * 分页查询
* 查询条件为多个key value对表示,默认key = value,如果使用其它条件可以使用:where.put("key", " > 1"),value也可以传Condition对象,key被忽略 * * @param 结果对象类型 * @param where 条件实体类(包含表名) * @param page 页码,0表示第一页 * @param numPerPage 每页条目数 * @param rsh 结果集处理对象 * @return 结果对象 * @throws SQLException SQL执行异常 * @since 3.2.2 */ public T page(Entity where, int page, int numPerPage, RsHandler rsh) throws SQLException { return page(where, new Page(page, numPerPage), rsh); } /** * 分页查询,结果为Entity列表,不计算总数
* 查询条件为多个key value对表示,默认key = value,如果使用其它条件可以使用:where.put("key", " > 1"),value也可以传Condition对象,key被忽略 * * @param where 条件实体类(包含表名) * @param page 页码,0表示第一页 * @param numPerPage 每页条目数 * @return 结果对象 * @throws SQLException SQL执行异常 * @since 3.2.2 */ public List pageForEntityList(Entity where, int page, int numPerPage) throws SQLException { return pageForEntityList(where, new Page(page, numPerPage)); } /** * 分页查询,结果为Entity列表,不计算总数
* 查询条件为多个key value对表示,默认key = value,如果使用其它条件可以使用:where.put("key", " > 1"),value也可以传Condition对象,key被忽略 * * @param where 条件实体类(包含表名) * @param page 分页对象 * @return 结果对象 * @throws SQLException SQL执行异常 * @since 3.2.2 */ public List pageForEntityList(Entity where, Page page) throws SQLException { return page(where, page, new EntityListHandler(this.caseInsensitive)); } /** * 分页查询
* 查询条件为多个key value对表示,默认key = value,如果使用其它条件可以使用:where.put("key", " > 1"),value也可以传Condition对象,key被忽略 * * @param 结果对象类型 * @param where 条件实体类(包含表名) * @param page 分页对象 * @param rsh 结果集处理对象 * @return 结果对象 * @throws SQLException SQL执行异常 * @since 3.2.2 */ public T page(Entity where, Page page, RsHandler rsh) throws SQLException { return page(where.getFieldNames(), where, page, rsh); } /** * 分页查询
* 查询条件为多个key value对表示,默认key = value,如果使用其它条件可以使用:where.put("key", " > 1"),value也可以传Condition对象,key被忽略 * * @param 结果对象类型 * @param fields 返回的字段列表,null则返回所有字段 * @param where 条件实体类(包含表名) * @param page 分页对象 * @param rsh 结果集处理对象 * @return 结果对象 * @throws SQLException SQL执行异常 */ public T page(Collection fields, Entity where, Page page, RsHandler rsh) throws SQLException { Connection conn = null; try { conn = this.getConnection(); return runner.page(conn, fields, where, page, rsh); } finally { this.closeConnection(conn); } } /** * 分页查询
* 查询条件为多个key value对表示,默认key = value,如果使用其它条件可以使用:where.put("key", " > 1"),value也可以传Condition对象,key被忽略 * * @param fields 返回的字段列表,null则返回所有字段 * @param where 条件实体类(包含表名) * @param page 分页对象 * @param numPerPage 每页条目数 * @return 结果对象 * @throws SQLException SQL执行异常 */ public PageResult page(Collection fields, Entity where, int page, int numPerPage) throws SQLException { Connection conn = null; try { conn = this.getConnection(); return runner.page(conn, fields, where, page, numPerPage); } finally { this.closeConnection(conn); } } /** * 分页查询
* 查询条件为多个key value对表示,默认key = value,如果使用其它条件可以使用:where.put("key", " > 1"),value也可以传Condition对象,key被忽略 * * @param fields 返回的字段列表,null则返回所有字段 * @param where 条件实体类(包含表名) * @param page 分页对象 * @return 结果对象 * @throws SQLException SQL执行异常 */ public PageResult page(Collection fields, Entity where, Page page) throws SQLException { Connection conn = null; try { conn = this.getConnection(); return runner.page(conn, fields, where, page); } finally { this.closeConnection(conn); } } /** * 分页查询
* 查询条件为多个key value对表示,默认key = value,如果使用其它条件可以使用:where.put("key", " > 1"),value也可以传Condition对象,key被忽略 * * @param where 条件实体类(包含表名) * @param page 页码 * @param numPerPage 每页条目数 * @return 分页结果集 * @throws SQLException SQL执行异常 * @since 3.2.2 */ public PageResult page(Entity where, int page, int numPerPage) throws SQLException { return this.page(where, new Page(page, numPerPage)); } /** * 分页查询
* 查询条件为多个key value对表示,默认key = value,如果使用其它条件可以使用:where.put("key", " > 1"),value也可以传Condition对象,key被忽略 * * @param where 条件实体类(包含表名) * @param page 分页对象 * @return 分页结果集 * @throws SQLException SQL执行异常 */ public PageResult page(Entity where, Page page) throws SQLException { return this.page(where.getFieldNames(), where, page); } // ---------------------------------------------------------------------------- CRUD end // ---------------------------------------------------------------------------- Getters and Setters start /** * 设置是否在结果中忽略大小写
* 如果忽略,则在Entity中调用getXXX时,字段值忽略大小写,默认忽略 * * @param caseInsensitive 否在结果中忽略大小写 * @since 5.2.4 */ public void setCaseInsensitive(boolean caseInsensitive) { this.caseInsensitive = caseInsensitive; } /** * 获取{@link SqlConnRunner} * * @return {@link SqlConnRunner} */ public SqlConnRunner getRunner() { return runner; } /** * 设置 {@link SqlConnRunner} * * @param runner {@link SqlConnRunner} */ public void setRunner(SqlConnRunner runner) { this.runner = runner; } /** * 设置包装器,包装器用于对表名、字段名进行符号包装(例如双引号),防止关键字与这些表名或字段冲突 * * @param wrapperChar 包装字符,字符会在SQL生成时位于表名和字段名两边,null时表示取消包装 * @return this * @since 4.0.0 */ public AbstractDb setWrapper(Character wrapperChar) { return setWrapper(new Wrapper(wrapperChar)); } /** * 设置包装器,包装器用于对表名、字段名进行符号包装(例如双引号),防止关键字与这些表名或字段冲突 * * @param wrapper 包装器,null表示取消包装 * @return this * @since 4.0.0 */ public AbstractDb setWrapper(Wrapper wrapper) { this.runner.setWrapper(wrapper); return this; } /** * 取消包装器
* 取消自动添加到字段名、表名上的包装符(例如双引号) * * @return this * @since 4.5.7 */ public AbstractDb disableWrapper() { return setWrapper((Wrapper) null); } // ---------------------------------------------------------------------------- Getters and Setters end // ---------------------------------------------------------------------------- protected method start /** * 检查数据库是否支持事务,此项检查同一个数据源只检查一次,如果不支持抛出DbRuntimeException异常 * * @param conn Connection * @throws SQLException 获取元数据信息失败 * @throws DbRuntimeException 不支持事务 */ protected void checkTransactionSupported(Connection conn) throws SQLException, DbRuntimeException { if (null == isSupportTransaction) { isSupportTransaction = conn.getMetaData().supportsTransactions(); } if (false == isSupportTransaction) { throw new DbRuntimeException("Transaction not supported for current database!"); } } // ---------------------------------------------------------------------------- protected method end }