转载:http://www.iteye.com/topic/713770?1306420721
最近一直在研读spring源码和学习设计模式,想把自己的一些领悟与大家分享,前几天发了几篇简单的文章,可能由于文字过于简单,几次被评为新手贴,心中滴汗啊 没办法,工作太忙,大家都知道,写篇文章是要很大精力地~~~~~
今天恰有时间,把这两天的学习所得与大家分享,尽量写得详细一些,专家饶路走,新手觉得好赞一下(不要拍砖哦~~~~)。
文章源码在附件中
注:本文目的意不在“重复发明轮子”,而是借此文来探讨Spring JdbcTemplate的内部实现原理,掌握其运用精妙之处,以便在以后的“造轮运动”中能灵活运用。
话回正转,这两天在读spring的jdbc模板,对Spring源码的精妙真是佩服得五体投地,极为经典。
spring中真是集设计模式之大成,而且用得是炉火纯青。模板方法(template method)就在spring中被大量使用,如:jdbcTemplate,hibernateTemplate,JndiTemplate以及一些包围的包装等都无疑使用了模板模式,但spring并不是单纯使用了模板方法,而是在此基础上做了创新,配合callback(回调)一起使用,用得极其灵活。
OK,为了防止文章再被拍砖,我写得更详细点吧,我们首先来回顾一下模板模式:
所谓模板板式,就是在父类中定义算法的主要流程,而把一些个性化的步骤延迟到子类中去实现,父类始终控制着整个流程的主动权,子类只是辅助父类实现某些可定制的步骤。
有些抽象???
好吧,我们用代码来说话吧:
首先,父类要是个抽象类:
- public abstract class TemplatePattern {
- //模板方法
- public final void templateMethod(){
- method1();
- method2();//勾子方法
- method3();//抽象方法
- }
- private void method1(){
- System.out.println("父类实现业务逻辑");
- }
- public void method2(){
- System.out.println("父类默认实现,子类可覆盖");
- }
- protected abstract void method3();//子类负责实现业务逻辑
- }
父类中有三个方法,分别是method1(),method2()和method3()。
method1()是私有方法,有且只能由父类实现逻辑,由于方法是private的,所以只能父类调用。
method2()是所谓的 勾子方法 。父类提供默认实现,如果子类觉得有必要定制,则可以覆盖父类的默认实现。
method3()是子类必须实现的方法,即制定的步骤。
由此可看出, 算法的流程执行顺序是由父类掌控的,子类只能配合。
下面我们来写第一个子类:
- public class TemplatePatternImpl extends TemplatePattern {
- @Override
- protected void method3() {
- System.out.println("method3()在子类TemplatePatternImpl中实现了!!");
- }
- }
这个子类只覆盖了必须覆盖的方法,我们来测试一下:
- TemplatePattern t1 = new TemplatePatternImpl();
- t1.templateMethod();
在控制台中我们可以看到:
- 父类实现业务逻辑
- 父类默认实现,子类可覆盖
- method3()在子类TemplatePatternImpl中实现了!!
OK,我们来看看 勾子方法 的使用:
定义第2个子类,实现勾子方法:
- public class TemplatePatternImpl2 extends TemplatePattern {
- @Override
- protected void method3() {
- System.out.println("method3()在子类TemplatePatternImpl2中实现了!!");
- }
- /* (non-Javadoc)
- * @see com.jak.pattern.template.example.TemplatePattern#method2()
- */
- @Override
- public void method2() {
- System.out.println("子类TemplatePatternImpl2覆盖了父类的method2()方法!!");
- }
- }
来测试一下:
- TemplatePattern t2 = new TemplatePatternImpl2();
- t2.templateMethod();
我们看控制台:
- 父类实现业务逻辑
- 子类TemplatePatternImpl2覆盖了父类的method2()方法!!
- method3()在子类TemplatePatternImpl2中实现了!!
OK,经典的模板模式回顾完了(大家不要拍砖哦~~~~~~~~~~)
接下来,我们回到正题,自己模仿spring动手写一个基于模板模式和回调的jdbcTemplate。
回顾一下,spring为什么要封装JDBC API,对外提供jdbcTemplate呢(不要仍鸡蛋啊¥·%¥#%)
话说SUN的JDBC API也算是经典了,曾经在某个年代折服了一批人。但随着历史的发展,纯粹的JDBC API已经过于底层,而且不易控制,由开发人员直接接触JDBC API,会造成不可预知的风险。还有,数据连接缓存池的发展,也不可能让开发人员去手工获取JDBC了。
好了,我们来看一段曾经堪称经典的JDBC API代码吧:
- public List<User> query() {
- List<User> userList = new ArrayList<User>();
- String sql = "select * from User";
- Connection con = null;
- PreparedStatement pst = null;
- ResultSet rs = null;
- try {
- con = HsqldbUtil.getConnection();
- pst = con.prepareStatement(sql);
- rs = pst.executeQuery();
- User user = null;
- while (rs.next()) {
- user = new User();
- user.setId(rs.getInt("id"));
- user.setUserName(rs.getString("user_name"));
- user.setBirth(rs.getDate("birth"));
- user.setCreateDate(rs.getDate("create_date"));
- userList.add(user);
- }
- } catch (SQLException e) {
- e.printStackTrace();
- }finally{
- if(rs != null){
- try {
- rs.close();
- } catch (SQLException e) {
- e.printStackTrace();
- }
- }
- try {
- pst.close();
- } catch (SQLException e) {
- e.printStackTrace();
- }
- try {
- if(!con.isClosed()){
- try {
- con.close();
- } catch (SQLException e) {
- e.printStackTrace();
- }
- }
- } catch (SQLException e) {
- e.printStackTrace();
- }
- }
- return userList;
- }
上面的代码要若干年前可能是一段十分经典的,还可能被作为example被推广。但时过境迁,倘若哪位程序员现在再在自己的程序中出现以上代码,不是说明该公司的开发框架管理混乱,就说明这位程序员水平太“高”了。
我们试想,一个简单的查询,就要做这么一大堆事情,而且还要处理异常,我们不防来梳理一下:
1、获取connection
2、获取statement
3、获取resultset
4、遍历resultset并封装成集合
5、依次关闭connection,statement,resultset,而且还要考虑各种异常
6、.....
啊~~~~ 我快要晕了,在面向对象编程的年代里,这样的代码简直不能上人容忍。试想,上面我们只是做了一张表的查询,如果我们要做第2张表,第3张表呢,又是一堆重复的代码:
1、获取connection
2、获取statement
3、获取resultset
4、遍历resultset并封装成集合
5、依次关闭connection,statement,resultset,而且还要考虑各种异常
6、.....
这时候, 使用模板模式的时机到了!!!
通过观察我们发现上面步骤中 大多数都是重复的,可复用的,只有在遍历ResultSet并封装成集合的这一步骤是可定制的,因为每张表都映射不同的java bean 。这部分代码是没有办法复用的,只能定制。那就让我们用一个抽象的父类把它们封装一下吧:
- public abstract class JdbcTemplate {
- //template method
- public final Object execute(String sql) throws SQLException{
- Connection con = HsqldbUtil.getConnection();
- Statement stmt = null;
- try {
- stmt = con.createStatement();
- ResultSet rs = stmt.executeQuery(sql);
- Object result = doInStatement(rs);//abstract method
- return result;
- }
- catch (SQLException ex) {
- ex.printStackTrace();
- throw ex;
- }
- finally {
- try {
- stmt.close();
- } catch (SQLException e) {
- e.printStackTrace();
- }
- try {
- if(!con.isClosed()){
- try {
- con.close();
- } catch (SQLException e) {
- e.printStackTrace();
- }
- }
- } catch (SQLException e) {
- e.printStackTrace();
- }
- }
- }
- //implements in subclass
- protected abstract Object doInStatement(ResultSet rs);
- }
在上面这个抽象类中,封装了SUN JDBC API的主要流程,而遍历ResultSet这一步骤则放到抽象方法doInStatement()中,由子类负责实现。
好,我们来定义一个子类,并继承上面的父类:
- public class JdbcTemplateUserImpl extends JdbcTemplate {
- @Override
- protected Object doInStatement(ResultSet rs) {
- List<User> userList = new ArrayList<User>();
- try {
- User user = null;
- while (rs.next()) {
- user = new User();
- user.setId(rs.getInt("id"));
- user.setUserName(rs.getString("user_name"));
- user.setBirth(rs.getDate("birth"));
- user.setCreateDate(rs.getDate("create_date"));
- userList.add(user);
- }
- return userList;
- } catch (SQLException e) {
- e.printStackTrace();
- return null;
- }
- }
- }
由代码可见,我们在doInStatement()方法中,对ResultSet进行了遍历,最后并返回。
有人可能要问:我如何获取ResultSet 并传给doInStatement()方法啊??呵呵,问这个问题的大多是新手。因为此方法不是由子类调用的,而是由父类调用,并把ResultSet传递给子类的。我们来看一下测试代码:
- String sql = "select * from User";
- JdbcTemplate jt = new JdbcTemplateUserImpl();
- List<User> userList = (List<User>) jt.execute(sql);
就是这么简单!!
文章至此仿佛告一段落,莫急!不防让我们更深入一些...
试想, 如果我每次用jdbcTemplate时,都要继承一下上面的父类,是不是有些不方面呢?
那就让我们甩掉abstract这顶帽子吧, 这时,就该callback(回调)上场了
所谓回调,就是方法参数中传递一个接口,父类在调用此方法时,必须调用方法中传递的接口的实现类。
那我们就来把上面的代码改造一下,改用回调实现吧:
首先,我们来定义一个回调接口:
- public interface StatementCallback {
- Object doInStatement(Statement stmt) throws SQLException;
- }
这时候,我们就要方法的签名改一下了:
- private final Object execute(StatementCallback action) throws SQLException
里面的获取数据方式也要做如下修改:
- Object result = action.doInStatement(stmt);//abstract method
为了看着顺眼,我们来给他封装一层吧:
- public Object query(StatementCallback stmt) throws SQLException{
- return execute(stmt);
- }
修改后的jdbcTemplate.java如下:
public class JdbcTemplate { //template method private final Object execute(StatementCallback action) throws SQLException{ Connection con = HsqldbUtil.getConnection(); Statement stmt = null; try { stmt = con.createStatement(); Object result = action.doInStatement(stmt);//abstract method return result; } catch (SQLException ex) { ex.printStackTrace(); throw ex; } finally { try { stmt.close(); } catch (SQLException e) { e.printStackTrace(); } try { if(!con.isClosed()){ try { con.close(); } catch (SQLException e) { e.printStackTrace(); } } } catch (SQLException e) { e.printStackTrace(); } } } public Object query(StatementCallback stmt) throws SQLException{ return execute(stmt); } }
OK,大功告成!
我们来写一个测试类Test.java测试一下吧:
这时候,访问有两种方式,一种是 内部类 的方式,一种是 匿名方式 。
先来看看内部类的方式:
- //内部类方式
- public Object query(final String sql) throws SQLException {
- class QueryStatementCallback implements StatementCallback {
- public Object doInStatement(Statement stmt) throws SQLException {
- ResultSet rs = stmt.executeQuery(sql);
- List<User> userList = new ArrayList<User>();
- User user = null;
- while (rs.next()) {
- user = new User();
- user.setId(rs.getInt("id"));
- user.setUserName(rs.getString("user_name"));
- user.setBirth(rs.getDate("birth"));
- user.setCreateDate(rs.getDate("create_date"));
- userList.add(user);
- }
- return userList;
- }
- }
- JdbcTemplate jt = new JdbcTemplate();
- return jt.query(new QueryStatementCallback());
- }
在调用jdbcTemplate.query()方法时,传一个StatementCallBack()的实例过去,也就是我们的内部类。
再来看看匿名方式:
- //匿名类方式
- public Object query2(final String sql) throws Exception{
- JdbcTemplate jt = new JdbcTemplate();
- return jt.query(new StatementCallback() {
- public Object doInStatement(Statement stmt) throws SQLException {
- ResultSet rs = stmt.executeQuery(sql);
- List<User> userList = new ArrayList<User>();
- User user = null;
- while (rs.next()) {
- user = new User();
- user.setId(rs.getInt("id"));
- user.setUserName(rs.getString("user_name"));
- user.setBirth(rs.getDate("birth"));
- user.setCreateDate(rs.getDate("create_date"));
- userList.add(user);
- }
- return userList;
- }
- });
- }
相比之下,这种方法更为简洁。
为什么spring不用传统的模板方法,而加之以Callback进行配合呢?
试想,如果父类中有10个抽象方法,而继承它的所有子类则要将这10个抽象方法全部实现,子类显得非常臃肿。而有时候某个子类只需要定制父类中的某一个方法该怎么办呢?这个时候就要用到Callback回调了。
离spring jdbcTemplate再近一点
上面这种方式基本上实现了模板方法+回调模式。但离spring的jdbcTemplate还有些距离。
我们可以再深入一些。。。
我们上面虽然实现了模板方法+回调模式,但相对于Spring的JdbcTemplate则显得有些“丑陋”。Spring引入了RowMapper和ResultSetExtractor的概念。
RowMapper接口负责处理某一行的数据,例如,我们可以在mapRow方法里对某一行记录进行操作,或封装成entity。
ResultSetExtractor是数据集抽取器,负责遍历ResultSet并根据RowMapper里的规则对数据进行处理。
RowMapper和ResultSetExtractor区别是, RowMapper是处理某一行数据,返回一个实体对象 。而 ResultSetExtractor是处理一个数据集合,返回一个对象集合 。
当然,上面所述仅仅是Spring JdbcTemplte实现的基本原理,Spring JdbcTemplate内部还做了更多的事情,比如,把所有的基本操作都封装到JdbcOperations接口内,以及采用JdbcAccessor来管理DataSource和转换异常等。
接下来的主题: 进行范型的改造
我们可能发现,上面的接口中返回的还都是Object对象,在范型日益盛行的今天,我们怎能忍受每次都要把得到的对象进行强制类型转换?那我们就要心情享用JDK1.5给我们带来的范型盛宴。