org.docshare.orm.DBTool Maven / Gradle / Ivy
package org.docshare.orm;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import org.docshare.log.Log;
import org.docshare.mvc.Config;
import org.docshare.util.BeanUtil;
import org.docshare.util.FileTool;
import com.alibaba.fastjson.JSON;
/**
* ORM类库最核心的类。 负责数据库表的查询。所有数据库查询均需先创建此类。
* 创建方法:
* DBTool tool = DBTool.getIns("book"); //book为数据库表名
* LasyList list = tool.all().limit(10); //查询数据库的前10行， all()并非获取了所有列，当添加完参数，真正读取时才进行查询。它实际上是一个SQL语句的Builder
* 得到LasyList可以使用像ArrayList一样使用了。
*
* @author Tongfeng Yang
*
*/
public class DBTool {
private String tname;
private HashMap columns; //所有列的列名,及其值（值都为空）
public Map c_to_remarks;
String key ;
IDBDelegate delegate = DelegateFactory.getIns(Config.dbtype);
//DBHelper helper = DBHelper.getIns();
public IDBDelegate getDelegate(){
return delegate;
}
private DBTool(String tname){
Log.v("create a DBTool of "+tname);
this.tname = tname;
if("rawsql".equals(tname)){
c_to_remarks = new HashMap();
}else{
c_to_remarks = delegate.listColumn(tname,true);
}
//Log.map(c_to_remarks);
columns = new HashMap();
for(String s:c_to_remarks.keySet()){
columns.put(s, null);
}
if( ! tname.equals("rawsql")){ //原始sql没有key
key = delegate.keyColumn(tname);
}
}
/**
* 获取列的注释
* @param column 列名
* @return 指定列的列名
*/
public String getColumnRemark(String column){
return c_to_remarks.get(column).remark;
}
/**
* 获取列的类型（int类型）
* @param column 字段名
* @return 类型
*/
public int getColumnType(String column){
return c_to_remarks.get(column).type;
}
/**
* 获取列的类型名
* @param column 字段名
* @return 字段类型
*/
public String getColumnTypeName(String column){
ColumnDesc d = c_to_remarks.get(column);
if(d == null){
Log.d("getColumnTypeName find null "+ column +" reload column info ");
c_to_remarks = delegate.listColumn(tname,false);
Log.d("reload data = "+ JSON.toJSONString(c_to_remarks));
d = c_to_remarks.get(column);
if(d == null){
Log.d("getColumnTypeName is null again ,return varchar" + column );
}
return "varchar";
}
return d.typeName;
}
/**
* 列举所有的列名
* @return 所有列名的集合
*/
public Set listColumns(){
return columns.keySet();
}
/**
* 根据用户自定义的sql来获取list
* 如果需要使用原生的SQL，请使用LasyList.fromRawSQL实现
*
* @param sql SQL语句
* @return 返回一个包含了该SQL结果的LasyList（并没有真正查询，在你读取数据时真正查询
*/
@Deprecated
public static LasyList fromSQL(String sql){
return LasyList.fromRawSql(sql);
}
/**
* 获取key为id的记录并返回模型。注意必须有主键，且主键为整数
* @param id 主键的值
* @return 符合条件的模型
*/
public Model get(Object id){
return get(key,id);
}
/**
* 获取column列等于id的所有集合的第一个
* @param column 字段名
* @param value 值
* @return 找到列column等于value的对象
*/
public Model get(String column, Object value) {
ResultSet rs=null;
try {
rs = delegate.resultById(tname, column, value);
Model tb=null;
if(rs.next()){
tb = db2Table(rs);
}
rs.close();
return tb;
} catch (SQLException e) {
Log.e(e);
}finally{
FileTool.safelyClose(rs);
}
return null;
}
public Model create(){
Model model =new Model(tname, columns);
model.isCreated = true;
model.joined_tool = this;
return model;
}
// private String valueWrapper(String c,Object v){
// String type = getColumnTypeName(c);
// String r ;
// if(type.contains("VAR") || type.contains("TEXT") || type.contains("DATE") || type.contains("TIME")){
// if(v == null) r= "null";
//
// String vv= v.toString();
// if(vv.contains("'")){
// vv = vv.replace("'", "''");
// }
//
// r= "'"+v+"'";
// }else{
// if(v == null){
// r=0+"";
// }else{
// r= v.toString();
// }
// }
// return r;
//// String s = v.toString();
//// s = s.replace("'", "''");
//// return "'"+s+"'";
// }
/**
* 插入或保存数据。当m的主键为非空时，则为更新，主键为空是为插入。
* @param m 模型变量
* @return 影响的数据库行数
*/
public int save(Model m){
return save(m,false);
}
public int save(Object obj,boolean isInsert ){
Model m = Model.fromObject(tname, obj);
int r = save(m,isInsert);
if(r!=0){ //将获得的主键返回
String key = m.key();
BeanUtil.set(obj, key, m.get(key));
}
return r;
}
public int save(Object obj){
return save(obj,false);
}
/**
* 更新或保存数据。
* 当主键为null 或isInsert为真时， 执行插入数据
* 否则，执行更新操作。
* @param m 模型
* @param isInsert 是否强制为插入操作
* @return 影响的数据库行数
*/
public int save(Model m,boolean isInsert){
if(m == null){
Log.e("DBTool save a null model "+ m +", tname is "+tname);
return 0;
}
if(key == null){
Log.e("DBTool.save table must has a Key ,数据库表必须有主键");
return 0;
}
int r = delegate.save(this, m, key, isInsert);
m.isCreated = false;
return r;
}
/**
* 执行一次插入操作
* @param m 模型
* @return 插入影响的行数
*/
public int insert(Model m){
return save(m,true);
}
/**
* 获取表格所有行，这里采用了延迟加载技术，并不会真的查询所有的行，
* 可以调用返回的LasyList的过滤器添加查询条件，在读取数据时才真正进行查询。
* 如: tool.all().eq("id",12).gt("no",333) ; 相当于
* select * from tablea where id = 12 and no>333
* @return LasyList对象
*/
public LasyList all(){
LasyList list = new LasyList(this,tname);
return list;
}
@SuppressWarnings("unchecked")
public Model db2Table(ResultSet rs,Map c, Set column_set){
if(c == null){
c = columns;
}
Model tb = new Model(tname,(Map) c);
tb.joined_tool = this;
for(String key : c.keySet()){
Object v=null;
try {
//如果过滤集不存在，或者包含这个 key 的时候，才显示，否则不显示
if(column_set==null || column_set.contains(key)){
v = rs.getObject(key);
}
} catch (SQLException e) {
Log.e(e);
}
tb.innerPut(key, v);
}
return tb;
}
private Model db2Table(ResultSet rs){
return db2Table(rs,columns,null);
}
/**
* 根据表的主键删除表格的一行
* @param id 主键的值
* @return 影响的数据库的行数
*/
public int del(Object id) {
return delegate.delete(tname, key, id);
}
/**
* 根据某个列的值进行删除
* @param column 列名
* @param val 值
* @return 影响的数据库行数
*/
public int delBy(String column,Object val){
return delegate.delete(tname, column, val);
}
/**
* 根据Model对象删除数据表的一行
* @param m 模型
* @return 影响的数据库行数
*/
public int del(Model m){
Object kv = m.get(key);
if(kv !=null){
return del(kv);
}
return 0;
}
@Override
protected void finalize() throws Throwable {
Log.d("dbtool finalize called");
try{
DBHelper.removeThreadLocal();
}catch(Exception e){
}
super.finalize();
}
/**
* 获取当前数据表的某一行的信息
* @param column 列名
* @return 获取column列描述信息
*/
public ColumnDesc getColumnDesc(String column) {
return c_to_remarks.get(column);
}
public int run(String sql,Object...objects) {
Log.i("DBTool run :" ,sql ," param=[",ArrayTool.join(",", objects)+"]" );
return DBHelper.getIns().update(sql,objects);
}
static ConcurrentHashMap toolCache = new ConcurrentHashMap();
public static DBTool getIns(String tname) {
if("rawsql".equals(tname)){
return new DBTool(tname);
}
DBTool ret ;
if(toolCache.containsKey(tname)){
ret= toolCache.get(tname);
}else{
ret = new DBTool(tname);
toolCache.put(tname, ret);
}
return ret;
}
public static void clearCache(){
toolCache.clear();
}
public DBTool tran(){
delegate.beginTransaction();
return this;
}
public DBTool commit(){
delegate.commit();
return this;
}
public DBTool rollback(){
delegate.rollback();
return this;
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy