Spring JdbcTemplate的原理及实际使用

Spring JdbcTemplate的实现原理

JDBC已经能够满足大部分用户最基本的对数据库的需求,但是在使用JDBC时,应用必须自己来管理数据库资源。Spring对数据库操作需求提供了很好的支持,并在原始JDBC基础上,构建了一个抽象层,提供了许多使用JDBC的模板和驱动模块,为Spring应用操作关系数据库提供了更大的便利。

Spring封装好的模板,封装了数据库存取的基本过程,方便用户。

一、模板方法

Spring JDBCTemplate从名字来说,这就是一个模板,的确是,它确实实现了设计模式中的模板模式。如下:

JDBCTemplate继承了基类JdbcAccessor和接口类JdbcOperation。在基类JdbcAccessor的设计中,对DataSource数据源进行管理和配置。在JdbcOperation接口中,定义了通过Jdbc操作数据库的基本操作方法,而JdbcTemplate提供这些接口方法的实现,比如execute方法、query方法、update方法等。

二、使用JdbcTemplate

JdbcTemplate temp = new JdbcTemplate(datasource);  
class ExecuteStatementCallback implements StatementCallback<object>,Sqlprovider{  
    public Object doInStatement(Statement stmt) throws SQLException  {  
    //spring封装数据库操作  
        stmt.execute();  
        return null;  
    }  
    public String getSql(){  
        return sql;  
    }  
}  
temp.sexecute(new ExecuteStatemnetCallback());  

三、JdbcTemplate实现之Execute

以Execute为例:

通过上图看到,Execute方法封装了对数据库的操作,首先取得数据库连接Connection,根据应用对数据库操作的需要创建数据库的Statement,对数据库操作进行回调,处理数据库异常,最后把数据库Connection关闭。

代码:

public void execute(final String sql)throws DataAccessException{  
   if(logger.isDebugEnabled()){  
       logger.debug("Executing SQL statement ["+ sql +"]");  
   }  
   class ExecuteStatementCallback implements StatementCallback<Object>,SqlProvider{  
       public Object doInStatement(Statement stmt) throws SQLException{  
           stmt.execute(sql);  
           return null;  
       }  
       public String getSql(){  
           return sql;  
       }  
   }  
   execute(new ExecuteStatementCallback());  
  }  
  //使用java.sql.Statement处理静态SQL语句  
  public <T> T execute(StatementCallback<T> action) throws DataAccessException{  
   Assert.notNull(action,"Callback object must not be null");  
   //这里取得数据库的Connection,这个数据库的Connection已经在Spring的事务管理之下  
   Connection con = DataSourceUtils.getConnection(getDataSource());  
   Statement stmt = null;  
   try {  
    Connection conToUse = con;  
    if (this.nativeJdbcExtractor != null && this.nativeJdbcExtractor.isNativeConnectionNecessaryForNativeStatements()) {  
        conToUse = this.nativeJdbcExtractor.getNativeConnection(con);  
    }  
    //创建Statement  
    stmt = conToUse.createStatement();  
    applyStatementSettings(stmt);  
    Statement stmtToUse = stmt;  
    if (this.nativeJdbcExtractor != null) {  
        stmtToUse =  this.nativeJdbcExtractor.getNativeStatement(stmt);  
    }  
    //这里调用回调函数  
    T result = action.doInStatement(stmtToUse);  
    handleWarnings(stmt);  
    return result;  
} catch (SQLException ex) {  
    //如果捕捉到异常,把数据库连接释放掉,抛出一个经过Spring转换过的Spring数据库异常  
    JdbcUtils.closeStatement(stmt);  
    stmt = null;  
    DataSourceUtils.releaseConnection(con, getDataSource());  
    con = null;  
    throw getExceptionTranslator().translate("StatementCallback",getSql(action),ex);  
}  
finally{  
      JdbcUtils.closeStatement(stmt);  
      //释放数据库链接  
      DataSourceUtils.releaseConnection(con, getDataSource());  
   }  
  }  

四、总结

通过这种方式,一方面提高了应用开发的效率,另一方面又为应用开发提供了灵活性。另外spring建立的JDBC框架中,还涉及了一种更面向对象的方法,相对于JDBC模板,这种实现更像是一个简单的ORM工具,为应用提供了另外一种选择。

下面继续介绍使用Spring JDBCTemplate实现动态建表。

前面介绍了,它封装了数据库的基本操作,让我们使用起来更加灵活,下面来实战,下面的实例是用传统的项目部署方式,并不是SpringBoot项目。

1、准备工作

引入jar包

2、applicationContext.xml

<?xml version="1.0" encoding="UTF-8"?>  
<beans xmlns="http://www.springframework.org/schema/beans"  
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
    xmlns:aop="http://www.springframework.org/schema/aop"  
    xmlns:tx="http://www.springframework.org/schema/tx"  
    xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.0.xsd  
           http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-2.0.xsd  
           http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-2.0.xsd">  
  
    <!-- JDBC 操作模板 -->   
    <bean id="jdbcTemplate" class="org.springframework.jdbc.core.JdbcTemplate">  
        <constructor-arg>  
            <ref bean="dataSource"/>  
        </constructor-arg>  
    </bean>         
 <!-- 配置数据库连接 -->  
     <bean id="dataSource"    
         class="org.springframework.jdbc.datasource.DriverManagerDataSource">    
        <property name="driverClassName" value="com.mysql.jdbc.Driver" />    
         <property name="url" value="jdbc:mysql://localhost:3306/dynamic" />    
        <property name="username" value="root" />    
         <property name="password" value="123456" />    
     </bean>     
</beans>  

3、代码

private static ApplicationContext context = null;  
    //通过测试类测试  
    public static void main(String[] args) {    
        context = new ClassPathXmlApplicationContext("applicationContext.xml");         
        Users user = new Users();    
        user.setUserName("liutengteng");    
        user.setUserPass("liutengteng");           
        int re = insertObject("users",user);    
        System.out.println("================" + re + "====================");    
    }   
    /** 
     * 创建表,添加记录 
     * @param tableName 
     * @param obj 
     * @return 
     */  
    public static int insertObject(String tableName,Object obj){    
        int re = 0;         
        try {    
            JdbcTemplate jt = (JdbcTemplate)context.getBean("jdbcTemplate");    
            SimpleDateFormat format = new SimpleDateFormat("yyyy_MM");              
            String tname = tableName + "_" + format.format(new Date());    
            // 判断数据库是否已经存在这个名称的表,如果有某表,则保存数据;否则动态创建表之后再保存数据  
            if(getAllTableName(jt,tname)){    
                re = saveObj(jt,tname,obj);    
            }else{    
                re = createTable(jt,tname,obj);    
                re = saveObj(jt,tname,obj);    
            }               
        } catch (Exception e) {    
            e.printStackTrace();    
        }           
        return re;    
    }   
    /**  
     * 根据表名称创建一张表  
     * @param tableName  
     */    
    public static int createTable(JdbcTemplate jt,String tableName,Object obj){    
        StringBuffer sb = new StringBuffer("");    
        sb.append("CREATE TABLE `" + tableName + "` (");    
        sb.append(" `id` int(11) NOT NULL AUTO_INCREMENT,");            
        Map<String,String> map = ObjectUtil.getProperty(obj);    
        Set<String> set = map.keySet();    
        for(String key : set){    
            sb.append("`" + key + "` varchar(255) DEFAULT '',");    
        }           
        sb.append(" `tableName` varchar(255) DEFAULT '',");    
        sb.append(" PRIMARY KEY (`id`)");    
        sb.append(") ENGINE=InnoDB DEFAULT CHARSET=utf8;");    
        try {    
            jt.update(sb.toString());    
            return 1;    
        } catch (Exception e) {    
            e.printStackTrace();    
        }    
        return 0;    
    }       
      
    /**  
     * 拼接语句,往表里面插入数据 
     */    
    public static int saveObj(JdbcTemplate jt,String tableName,Object obj){    
        int re = 0;    
        try{                
            String sql = " insert into " + tableName + " (";    
            Map<String,String> map = ObjectUtil.getProperty(obj);    
            Set<String> set = map.keySet();    
            for(String key : set){    
                sql += (key + ",");    
            }    
            sql += " tableName ) ";                 
            sql += " values ( ";    
            for(String key : set){    
                sql += ("'" + map.get(key) + "',");    
            }    
            sql += ("'" + tableName + "' ) ");    
            re = jt.update(sql);            
        } catch (Exception e) {    
            e.printStackTrace();    
        }           
        return re;    
    }       
      
     
    /**  
     * 查询数据库是否有某表  
     * @param cnn  
     * @param tableName  
     * @return  
     * @throws Exception  
     */    
    @SuppressWarnings("unchecked")    
    public static boolean getAllTableName(JdbcTemplate jt,String tableName) throws Exception {    
        Connection conn = jt.getDataSource().getConnection();    
        ResultSet tabs = null;    
        try {    
            DatabaseMetaData dbMetaData = conn.getMetaData();    
            String[]   types   =   { "TABLE" };    
            tabs = dbMetaData.getTables(null, null, tableName, types);    
            if (tabs.next()) {    
                return true;    
            }    
        } catch (Exception e) {    
            e.printStackTrace();    
        }finally{    
            tabs.close();    
            conn.close();    
        }    
        return false;    
    }  

4、总结

通过这种方式,让我们更加灵活的运用,但是也有弊端,如果系统的代码量很大,用最基本的这套框架就会有很多重复性的代码,这时就需要一层层的抽象,封装。抽象之后让代码的复用性更高。其实每一套框架也是抽象封装来的,不断的抽象封装,让我们的代码更灵活,质量更高。

延伸一下,ORM 设计与实现

通常情况下,ORM用的最多的是Hibernate。使用它,除了需要处理像Session、SessionFactory这些Hibernate类之外,还需要处理诸如事务处理、打开Session和关闭Session这样的问题,在某种程度上增加了使用Hibernate的难度。而Spring提供的Hibernate封装,如HibernateDaoSupport、HIbernateTemplate等,简化了这些通用过程。

Spring的ORM包提供了对许多ORM产品的支持。通常使用Spring提供的Template类。在这些模板类里,封装了主要的数据操作方法,比如query、update等,并且在Template封装中,已经包含了Hibernate中Session的处理,Connection的处理、事务的处理等。通过封装将Hibernate的持久化数据操作纳入到Spring统一的事务处理框架中,这部分是通过Spring的AOP来实现的。

类图:

DaoSupport是一个核心类,通过HIbernateTemplate支持对HIbernate的操作。

Spring的ORM模块并不是重新开发的,通过IOC容器和AOP模块对Hibernate的使用进行封装。使用Hibernate,需要对Hibernate进行配置,这些配置通过SessionFactory来完成,在Spring的Hibernate模块中,提供了LocalSessionFactoryBean来封装SessionFactory的配置,通过这个LocalSessionFactory封装,可以将SessionFactory的配置信息通过Bean定义,注入到IOC容器中实例化好的SessionFactory单例对象中。这个LocalSessionFactoryBean设计为HIbernate的使用奠定了基础。

以hibernateTemplate为例

与JdbcTemplate的使用类似,Spring使用相同的模式,通过execute回调来完成。如下:

代码

public <T> T execute(HibernateCallback<T> action) throws DataAccessException{  
        return doExecute(action,false,false);  
    }  
    protected <T> T doExecute(HIbernateCallback<T> action,boolean enforceNewSession,boolean enforceNativeSession) throws DataAccessException{  
        Assert.notNull(action,"Callback object must not be null");  
        //这里是取得HIbernate的Session,判断是否强制需要新的Session,  
        //如果需要,则直接通过SessionFactory打开一个新的session,否则需要结合配置和当前的Transaction的情况来使用Session  
        Session session = (enforceNewSession ? SessionFactoryUtils.getNewSession(getSessionFactory(),getEntityInterceptor()):getSession());  
          
        //判断Transaction是否已经存在,如果是,则使用的就是当前的Transaction的session  
        boolean existingTransaction = (!enforceNewSession &&  
                (!isAllowCreate()||SessionFactoryUtils.isSessionTransactional(session, getsessionFactory())));  
        if(existingTransaction){  
            logger.debug("Found thread-bound Session for HIbernateTemplate");  
        }  
        FlushMode previousFlushMode = null;  
        try {  
            previousFlushMode = applyFlushMOde(session,existingTransaction);  
            enableFilters(session);  
            Session sessionToExpose = (enforceNativeSession || isExposeNativeSession() ? session : createSessionProxy(session));  
            //这里是对HIbernateCallback中回调函数的调用,Session作为参数可以由回调函数使用  
            T result = action.doInHibernate(sessionToExpose);  
            flushIfNecessary(session,existingTransaction);  
            return result;  
        } catch (HibernateException ex) {  
            throw convertHibernateAccessException(ex);  
        }catch(SQLException ex){  
            throw convertJdbcAccessException(ex);  
        }catch(RuntimeException ex){  
            throw ex;  
            //如果存在Transaction,当前回调完成使用完session后,不关闭这个session  
        }finally{  
            if(existingTransaction){  
                logger.debug("Not closing pre-bound Hibernate Session after HibernateTemplate");  
                disableFilters(session);  
                if(previousFlushMode != null){  
                    session.setFlushMode(previousFlushMode);  
                }  
            }  
            //如果不存在Transaction,那么关闭当前Session  
            else{  
                if(isAlwaysUseNewSession()){  
                    SessionFactoryUtils.closeSession(session);  
                }else{  
                    SessionFactoryUtils.closeSessionOrRegisterDeferredClose(session,getSessionFactory());  
                }  
            }  
        }  
    }  

总结

Spring封装了事务处理,以及通过HibernateTemplate封装了Session,不直接对Session进行操作。

Spring不提供具体的ORM实现,只为应用提供对ORM产品的集成环境和使用平台。

并且Spring封装的Hibernate的API,方便了用户。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,425评论 4 361
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,058评论 1 291
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,186评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,848评论 0 204
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,249评论 3 286
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,554评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,830评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,536评论 0 197
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,239评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,505评论 2 244
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,004评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,346评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,999评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,060评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,821评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,574评论 2 271
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,480评论 2 267

推荐阅读更多精彩内容