com.itranswarp.warpdb.WarpDb Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of warpdb Show documentation
Show all versions of warpdb Show documentation
Simple, DSL-driven RDBMS interface for Java
package com.itranswarp.warpdb;
import java.io.Serializable;
import java.lang.reflect.Constructor;
import java.lang.reflect.InvocationTargetException;
import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.ResultSetMetaData;
import java.sql.SQLException;
import java.sql.Statement;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.OptionalInt;
import java.util.OptionalLong;
import java.util.function.Function;
import javax.annotation.PostConstruct;
import javax.persistence.EntityNotFoundException;
import javax.persistence.NoResultException;
import javax.persistence.NonUniqueResultException;
import javax.persistence.PersistenceException;
import javax.sql.DataSource;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.dao.DataAccessException;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.jdbc.core.PreparedStatementCreator;
import org.springframework.jdbc.core.ResultSetExtractor;
import org.springframework.jdbc.core.RowMapper;
import org.springframework.jdbc.support.GeneratedKeyHolder;
import org.springframework.jdbc.support.KeyHolder;
import com.itranswarp.warpdb.util.ClassUtils;
/**
* A Spring-JdbcTemplate wrapper.
*
* @author Michael
*/
public class WarpDb {
final Log log = LogFactory.getLog(getClass());
JdbcTemplate jdbcTemplate;
List basePackages;
// class -> Mapper:
Map, Mapper> classMapping;
// tableName -> Mapper:
Map> tableMapping;
public void setDataSource(DataSource dataSource) {
this.jdbcTemplate = new JdbcTemplate(dataSource, false);
}
public void setJdbcTemplate(JdbcTemplate jdbcTemplate) {
this.jdbcTemplate = jdbcTemplate;
}
public void setBasePackages(List basePackages) {
this.basePackages = basePackages;
}
@PostConstruct
public void init() {
List> classes = ClassUtils
.scanEntities(this.basePackages.toArray(new String[this.basePackages.size()]));
Map, Mapper> classMapping = new HashMap<>();
Map> tableMapping = new HashMap<>();
for (Class clazz : classes) {
Mapper mapper = new Mapper<>(clazz);
classMapping.put(clazz, mapper);
if (null != tableMapping.put(mapper.tableName.toLowerCase(), mapper)) {
throw new ConfigurationException(
"Duplicate table name: " + mapper.tableName + " defined in class: " + clazz.getName());
}
}
this.classMapping = classMapping;
this.tableMapping = tableMapping;
}
public String getDDL(Class clazz) {
Mapper mapper = this.classMapping.get(clazz);
if (mapper == null) {
throw new PersistenceException("Cannot find entity class: " + clazz.getName());
}
return mapper.ddl();
}
public String exportSchema() {
return String.join("\n\n", this.tableMapping.values().stream().map((mapper) -> {
return mapper.ddl();
}).toArray(String[]::new));
}
/**
* Get a model instance by class type and id. EntityNotFoundException is
* thrown if not found.
*
* @param
* Generic type.
* @param clazz
* Entity class.
* @param id
* Id value.
* @return Entity bean found by id.
*/
public T get(Class clazz, Serializable id) {
T t = fetch(clazz, id);
if (t == null) {
throw new EntityNotFoundException(clazz.getSimpleName());
}
return t;
}
/**
* Get a model instance by class type and id. Return null if not found.
*
* @param
* Generic type.
* @param clazz
* Entity class.
* @param id
* Id value.
* @return Entity bean found by id.
*/
public T fetch(Class clazz, Serializable id) {
Mapper mapper = getMapper(clazz);
log.debug("SQL: " + mapper.selectSQL);
List list = (List) jdbcTemplate.query(mapper.selectSQL, new Object[] { id }, mapper.rowMapper);
if (list.isEmpty()) {
return null;
}
T t = list.get(0);
try {
mapper.postLoad.invoke(t);
} catch (IllegalAccessException | InvocationTargetException e) {
throw new PersistenceException(e);
}
return t;
}
public void remove(@SuppressWarnings("unchecked") T... beans) {
try {
for (Object bean : beans) {
Mapper mapper = getMapper(bean.getClass());
mapper.preRemove.invoke(bean);
log.debug("SQL: " + mapper.deleteSQL);
jdbcTemplate.update(mapper.deleteSQL, mapper.id.convertGetter.get(bean));
mapper.postRemove.invoke(bean);
}
} catch (IllegalAccessException | InvocationTargetException e) {
throw new PersistenceException(e);
}
}
@SuppressWarnings("rawtypes")
public Select select(String... selectFields) {
return new Select(new Criteria(this), selectFields);
}
public From from(Class entityClass) {
Mapper mapper = getMapper(entityClass);
return new From<>(new Criteria<>(this), mapper);
}
/**
* Update entities' updatable properties by id.
*
* @param beans
* Entity objects.
*/
public void update(@SuppressWarnings("unchecked") T... beans) {
try {
for (T bean : beans) {
Mapper mapper = getMapper(bean.getClass());
mapper.preUpdate.invoke(bean);
Object[] args = new Object[mapper.updatableProperties.size() + 1];
int n = 0;
for (AccessibleProperty prop : mapper.updatableProperties) {
args[n] = prop.convertGetter.get(bean);
n++;
}
args[n] = mapper.id.getter.get(bean);
log.debug("SQL: " + mapper.updateSQL);
jdbcTemplate.update(mapper.updateSQL, args);
mapper.postUpdate.invoke(bean);
}
} catch (IllegalAccessException | InvocationTargetException e) {
throw new PersistenceException(e);
}
}
/**
* Update entity's specified properties.
*
* @param bean
* Entity object.
* @param properties
* Properties' names.
*/
public void updateProperties(T bean, String... properties) {
if (properties.length == 0) {
throw new IllegalArgumentException("No properties provided.");
}
Mapper mapper = getMapper(bean.getClass());
try {
mapper.preUpdate.invoke(bean);
Object[] args = new Object[properties.length + 1];
StringBuilder sb = new StringBuilder(150);
sb.append("UPDATE ").append(mapper.tableName).append(" SET ");
int n = 0;
for (String prop : properties) {
AccessibleProperty ap = mapper.updatablePropertiesMap.get(prop.toLowerCase());
if (ap == null) {
throw new IllegalArgumentException("Property " + prop + " not exist or un-updatable.");
}
sb.append(ap.columnName).append(" = ?, ");
args[n] = ap.convertGetter.get(bean);
n++;
}
args[n] = mapper.id.getter.get(bean);
sb.delete(sb.length() - 2, sb.length());
sb.append(" WHERE ").append(mapper.id.columnName).append(" = ?");
String sql = sb.toString();
log.debug("SQL: " + sql);
jdbcTemplate.update(sql, args);
mapper.postUpdate.invoke(bean);
} catch (IllegalAccessException | InvocationTargetException e) {
throw new PersistenceException(e);
}
}
/**
* Persist entity objects.
*
* @param beans
* Entity objects.
*/
public void save(@SuppressWarnings("unchecked") T... beans) {
try {
for (T bean : beans) {
Mapper mapper = getMapper(bean.getClass());
mapper.prePersist.invoke(bean);
Object[] args = new Object[mapper.insertableProperties.size()];
int n = 0;
for (AccessibleProperty prop : mapper.insertableProperties) {
args[n] = prop.convertGetter.get(bean);
n++;
}
log.debug("SQL: " + mapper.insertSQL);
if (mapper.id.isIdentityId()) {
// using identityId:
KeyHolder keyHolder = new GeneratedKeyHolder();
jdbcTemplate.update(new PreparedStatementCreator() {
public PreparedStatement createPreparedStatement(Connection connection) throws SQLException {
PreparedStatement ps = connection.prepareStatement(mapper.insertSQL,
Statement.RETURN_GENERATED_KEYS);
for (int i = 0; i < args.length; i++) {
ps.setObject(i + 1, args[i]);
}
return ps;
}
}, keyHolder);
mapper.id.convertSetter.set(bean, keyHolder.getKey());
} else {
// id is specified:
jdbcTemplate.update(mapper.insertSQL, args);
}
mapper.postPersist.invoke(bean);
}
} catch (IllegalAccessException | InvocationTargetException e) {
throw new PersistenceException(e);
}
}
/**
* Execute update SQL.
*
* @param sql
* The update SQL.
* @param args
* The arguments that match the SQL.
* @return int result of update.
*/
public int update(String sql, Object... args) {
return jdbcTemplate.update(sql, args);
}
/**
* Execute query.
*
* @param sql
* The select SQL.
* @param args
* The arguments that match the SQL.
* @return List of object T.
*/
public List list(String sql, Object... args) {
log.debug("SQL: " + sql);
Mapper mapper = getMapper(sql);
List list = (List) jdbcTemplate.query(sql, args, mapper.rowMapper);
try {
for (T bean : list) {
mapper.postLoad.invoke(bean);
}
} catch (IllegalAccessException | InvocationTargetException e) {
throw new PersistenceException(e);
}
return list;
}
/**
* Get list of entity.
*
* @param clazz
* Entity class.
* @param sql
* Raw SQL.
* @param args
* Arguments.
* @return List of entities.
*/
public List list(Class clazz, String sql, Object... args) {
log.debug("SQL: " + sql);
Mapper mapper = getMapper(clazz);
List list = (List) jdbcTemplate.query(sql, args, mapper.rowMapper);
try {
for (T bean : list) {
mapper.postLoad.invoke(bean);
}
} catch (IllegalAccessException | InvocationTargetException e) {
throw new PersistenceException(e);
}
return list;
}
public Optional queryForNumber(String sql, Object... args) {
log.debug("SQL: " + sql);
Number number = jdbcTemplate.query(sql, args, NUMBER_RESULT_SET);
return Optional.ofNullable(number);
}
public OptionalLong queryForLong(String sql, Object... args) {
log.debug("SQL: " + sql);
Number number = jdbcTemplate.query(sql, args, NUMBER_RESULT_SET);
if (number == null) {
return OptionalLong.empty();
}
return OptionalLong.of(number.longValue());
}
public OptionalInt queryForInt(String sql, Object... args) {
log.debug("SQL: " + sql);
Number number = jdbcTemplate.query(sql, args, NUMBER_RESULT_SET);
if (number == null) {
return OptionalInt.empty();
}
return OptionalInt.of(number.intValue());
}
public T unique(String sql, Object... args) {
if (sql.toLowerCase().indexOf(" limit ") == (-1)) {
sql = sql + " limit 2";
}
List list = list(sql, args);
if (list.isEmpty()) {
throw new NoResultException("Empty result from SQL: " + sql);
}
if (list.size() > 1) {
throw new NonUniqueResultException("Non unique result from SQL: " + sql);
}
return list.get(0);
}
public T fetch(String sql, Object... args) {
if (sql.toLowerCase().indexOf(" limit ") == (-1)) {
sql = sql + " limit 2";
}
List list = list(sql, args);
if (list.isEmpty()) {
return null;
}
if (list.size() > 1) {
throw new NonUniqueResultException("Non unique result returned from SQL: " + sql);
}
return list.get(0);
}
// get mapper by class:
@SuppressWarnings("unchecked")
Mapper getMapper(Class clazz) {
Mapper mapper = (Mapper) this.classMapping.get(clazz);
if (mapper == null) {
throw new RuntimeException("Target class is not a registered entity: " + clazz.getName());
}
return mapper;
}
// get Mapper from SQL like "select * from abc where ..."
@SuppressWarnings("unchecked")
Mapper getMapper(String sql) {
String[] ss = sql.split("\\s+");
for (int i = 0; i < ss.length; i++) {
if (ss[i].toLowerCase().equals("from")) {
if (i < ss.length - 1) {
String table = ss[i + 1];
if (table.length() > 2 && table.startsWith("`") && table.endsWith("`")) {
table = table.substring(1, table.length() - 1);
}
Mapper mapper = (Mapper) this.tableMapping.get(table.toLowerCase());
if (mapper == null) {
throw new RuntimeException("Cannot find mapping for table: " + table);
}
return mapper;
}
}
}
throw new RuntimeException("Cannot parse entity name from SQL: " + sql);
}
static final RowMapper NUMBER_ROW_MAPPER = new RowMapper() {
@Override
public Number mapRow(ResultSet rs, int rowNum) throws SQLException {
return (Number) rs.getObject(1);
}
};
static final ResultSetExtractor NUMBER_RESULT_SET = new ResultSetExtractor() {
@Override
public Number extractData(ResultSet rs) throws SQLException, DataAccessException {
if (rs.next()) {
return (Number) rs.getObject(1);
}
return null;
}
};
}
class BeanRowMapper implements RowMapper {
// columnName -> property:
final Map mapping;
final Function constructor;
BeanRowMapper(Class clazz, List properties) {
Map mapping = new HashMap<>();
for (AccessibleProperty p : properties) {
mapping.put(p.columnName.toLowerCase(), p);
}
this.mapping = mapping;
try {
Constructor constructor = clazz.getDeclaredConstructor();
constructor.setAccessible(true);
this.constructor = (Void) -> {
try {
return constructor.newInstance();
} catch (InstantiationException | IllegalAccessException | InvocationTargetException e) {
throw new RuntimeException(e);
}
};
} catch (NoSuchMethodException e) {
throw new RuntimeException(e);
}
}
@Override
public T mapRow(ResultSet rs, int rowNum) throws SQLException {
T bean = this.constructor.apply(null);
ResultSetMetaData meta = rs.getMetaData();
int count = meta.getColumnCount();
try {
for (int i = 1; i <= count; i++) {
String name = meta.getColumnName(i);
AccessibleProperty prop = this.mapping.get(name.toLowerCase());
if (prop != null) {
Object value = rs.getObject(i);
prop.convertSetter.set(bean, value);
}
}
} catch (IllegalAccessException | InvocationTargetException e) {
throw new RuntimeException(e);
}
return bean;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy