采用模板方法优化try-catch-finally

Java 处理异常的语句try-catch-finally应该大家都不陌生, 程序中很多地方都会使用到, 比如IO操作, 对文件的读写, 数据库读写等, 另外事务处理也会用到, 在try块中处理逻辑, catch中回滚事务 ,finally中提交事务, 举个例子:
FileReadDemo.java

    public class FileReadDemo {  
        public void readFile() throws IOException {  
            byte[] buff = new byte[1024];  
            FileInputStream input = null;  
            try {  
                input = new FileInputStream(new File("D:/test/itart.txt"));  
                while (-1 != input.read(buff)) {  
                    System.out.println(new String(buff));  
                }  
            } catch (IOException e) {  
                throw e;  
            } finally {  
                if (null != input) {  
                    try {  
                        input.close();  
                    } catch (IOException e) {  
                        throw e;  
                    }  
                }  
            }  
        }  
      
        public static void main(String[] args) {  
            try {  
                new FileReadDemo().readFile();  
            } catch (IOException e) {  
                e.printStackTrace();  
            }  
      
        }  
    }

注意: 上面的例子实际上存在异常丢失的隐患, 如果第一个try中出现异常, 接着在执行finally中的input.close()也出现异常, 这时main 方法只能接收到input.close的异常信息, 第一个异常会被覆盖, 导致异常信息丢失, 详见: try-catch-finally异常信息丢失

所以正确的写法如下:

    public class FileReadDemo {  
        public void readFile() throws ApplicationException {  
            byte[] buff = new byte[1024];  
            IOException processException = null;  
            FileInputStream input = null;  
            try {  
                input = new FileInputStream(new File("D:/test/itart.txt"));  
                while (-1 != input.read(buff)) {  
                    System.out.println(new String(buff));  
                }  
            } catch (IOException e) {  
                processException = e;  
            } finally {  
                try {  
                    if(null != input){  
                        input.close();  
                    }  
                } catch (IOException e) {  
                    if(null == processException){  
                        throw new ApplicationException(e);  
                    }else{  
                        throw new ApplicationException("FileInputStream close exception", processException);  
                    }  
                }  
                if(processException !=null){  
                    throw new ApplicationException(processException);  
                }  
            }  
              
        }  
      
        public static void main(String[] args){  
            try {  
                new FileReadDemo().readFile();  
            } catch (ApplicationException e) {  
                e.printStackTrace();  
            }  
              
        }  
    }

这种写法是不是很糟糕, 我们实际关注的代码就只是第一个try中的四行代码, 这样的缺陷很明显, 一旦系统中有多处地方要用到类似的文件处理操作时, 就需要重复的做try-catch-finally, 很明显, 这就违背了程序开发中的一个重要原则: DRY(Don’t repeat yourself), 代码重复, 不容易阅读和维护, 同时也存在一个隐患, 忘记关闭, 异常没正确处理等, 引入模板方法就可以很好的解决这个问题.

咱们先对代码进行重构, 剥离业务代码和异常处理代码.

    public class FileReadDemo {  
        public void readFile(String path) throws ApplicationException {  
      
            IOException processException = null;  
            FileInputStream input = null;  
            try {  
                input = new FileInputStream(new File(path));  
                process(input);  
            } catch (IOException e) {  
                processException = e;  
            } finally {  
                try {  
                    if (null != input) {  
                        input.close();  
                    }  
                } catch (IOException e) {  
                    if (null == processException) {  
                        throw new ApplicationException(e);  
                    } else {  
                        throw new ApplicationException(  
                                "FileInputStream close exception", processException);  
                    }  
                }  
                if (processException != null) {  
                    throw new ApplicationException(processException);  
                }  
            }  
      
        }  
      
        public void process(FileInputStream input) throws IOException {  
            byte[] buff = new byte[1024];  
            while (-1 != input.read(buff)) {  
                System.out.println(new String(buff));  
            }  
        }  
      
        public static void main(String[] args) {  
            try {  
                new FileReadDemo().readFile("D:/test/itart.txt");  
            } catch (ApplicationException e) {  
                e.printStackTrace();  
            }  
      
        }  
    }

可以看到, 在实际项目中每个功能对文件处理的差异地方就只有process方法, readFile中的异常处理是都一样的, 所以可以将readFile当成模板方法可以重复使用, process定义为抽象类, 由具体代码实现, 这样代码就可以变为:

    public abstract class FileReadDemo {  
        public void readFile(String path) throws ApplicationException {  
      
            IOException processException = null;  
            FileInputStream input = null;  
            try {  
                input = new FileInputStream(new File(path));  
                process(input);  
            } catch (IOException e) {  
                processException = e;  
            } finally {  
                try {  
                    if (null != input) {  
                        input.close();  
                    }  
                } catch (IOException e) {  
                    if (null == processException) {  
                        throw new ApplicationException(e);  
                    } else {  
                        throw new ApplicationException(  
                                "FileInputStream close exception", processException);  
                    }  
                }  
                if (processException != null) {  
                    throw new ApplicationException(processException);  
                }  
            }  
      
        }  
      
        public abstract void process(FileInputStream input) throws IOException;  
      
        public static void main(String[] args) {  
            try {  
                new FileReadDemo() {  
                    @Override  
                    public void process(FileInputStream input) throws IOException {  
                        byte[] buff = new byte[1024];  
                        while (-1 != input.read(buff)) {  
                            System.out.println(new String(buff));  
                        }  
                    }  
                }.readFile("D:/test/itart.txt");  
            } catch (ApplicationException e) {  
                e.printStackTrace();  
            }  
      
        }  
    }

最后分离模板, 整理效果如下:
模板类: FileInputStreamTemplate.java

    public abstract class FileInputStreamTemplate {  
        public void readFile(String path) throws ApplicationException {  
      
            IOException processException = null;  
            FileInputStream input = null;  
            try {  
                input = new FileInputStream(new File(path));  
                process(input);  
            } catch (IOException e) {  
                processException = e;  
            } finally {  
                try {  
                    if (null != input) {  
                        input.close();  
                    }  
                } catch (IOException e) {  
                    if (null == processException) {  
                        throw new ApplicationException(e);  
                    } else {  
                        throw new ApplicationException(  
                                "FileInputStream close exception", processException);  
                    }  
                }  
                if (processException != null) {  
                    throw new ApplicationException(processException);  
                }  
            }  
      
        }  
      
        public abstract void process(FileInputStream input) throws IOException;  
      
    }

使用方式: Client.java


    public abstract class Client {  
      
        public static void main(String[] args) throws ApplicationException {  
            new FileInputStreamTemplate() {  
                @Override  
                public void process(FileInputStream input) throws IOException {  
                    byte[] buff = new byte[1024];  
                    while (-1 != input.read(buff)) {  
                        System.out.println(new String(buff));  
                    }  
                }  
            }.readFile("D:/test/itart.txt");  
        }  
    }

这样代码是不是清晰很多, 为了让代码更加容易阅读, 我们可以进一步改进, 将模板方法改为静态模板方法, 定义一个process方法的接口, 具体如下

定义一个处理器接口InputStreamProcessor.java

    public interface InputStreamProcessor {  
        public void process(FileInputStream input) throws IOException;  
    }

模板方法改为静态模板方法


    public class FileInputStreamTemplate {  
        public static void readFile(String path, InputStreamProcessor processor) throws ApplicationException {  
      
            IOException processException = null;  
            FileInputStream input = null;  
            try {  
                input = new FileInputStream(new File(path));  
                processor.process(input);  
            } catch (IOException e) {  
                processException = e;  
            } finally {  
                try {  
                    if (null != input) {  
                        input.close();  
                    }  
                } catch (IOException e) {  
                    if (null == processException) {  
                        throw new ApplicationException(e);  
                    } else {  
                        throw new ApplicationException(  
                                "FileInputStream close exception", processException);  
                    }  
                }  
                if (processException != null) {  
                    throw new ApplicationException(processException);  
                }  
            }  
        }  
      
    }

调用方式: Client.java

    public abstract class Client {  
      
        public static void main(String[] args) throws ApplicationException {  
            FileInputStreamTemplate.readFile("D:/test/itart.txt", new InputStreamProcessor() {  
                @Override  
                public void process(FileInputStream input) throws IOException {  
                    byte[] buff = new byte[1024];  
                    while (-1 != input.read(buff)) {  
                        System.out.println(new String(buff));  
                    }  
                }  
            });  
        }  
    }

InputStreamProcessor的实现类是采用匿名实现方式, 这是因为一般情况下这个类是不会被重复使用, 没有必要再定义一个子类.

模板方法可以有效的减少重复代码, 提高代码的可阅读性, 可维护性, 实际项目开发中, 可以应用模板方法的地方很多, 就像IO操作的地方, 如: 读写文件, 还有JDBC, 事务管理等等

最后编辑于：2017.12.10 07:01:00

人面猴
序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
沈念sama阅读 203,456评论 5赞 477
死咒
序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
沈念sama阅读 85,370评论 2赞 381
救了他两次的神仙让他今天三更去死
文/潘晓璐我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
开封第一讲书人阅读 150,337评论 0赞 337
道士缉凶录：失踪的卖姜人
文/不坏的土叔我叫张陵，是天一观的道长。经常有香客问我，道长，这世上最难降的妖魔是什么？我笑而不...
开封第一讲书人阅读 54,583评论 1赞 273
港岛之恋（遗憾婚礼）
正文为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
茶点故事阅读 63,596评论 5赞 365
恶毒庶女顶嫁案：这布局不是一般人想出来的
文/花漫我一把揭开白布。她就那样静静地躺着，像睡着了一般。火红的嫁衣衬着肌肤如雪。梳的纹丝不乱的头发上，一...
开封第一讲书人阅读 48,572评论 1赞 281
城市分裂传说
那天，我揣着相机与录音，去河边找鬼。笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。我是一名探鬼主播，决...
沈念sama阅读 37,936评论 3赞 395
双鸳鸯连环套：你想象不到人心有多黑
文/苍兰香墨我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
开封第一讲书人阅读 36,595评论 0赞 258
万荣杀人案实录
序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
沈念sama阅读 40,850评论 1赞 297
护林员之死
正文独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋以下内容为张勋视角年9月15日...
茶点故事阅读 35,601评论 2赞 321
白月光启示录
正文我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
茶点故事阅读 37,685评论 1赞 329
活死人
序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
沈念sama阅读 33,371评论 4赞 318
日本核电站爆炸内幕
正文年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
茶点故事阅读 38,951评论 3赞 307
男人毒药：我在死后第九天来索命
文/蒙蒙一、第九天我趴在偏房一处隐蔽的房顶上张望。院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
开封第一讲书人阅读 29,934评论 0赞 19
一桩弑父案，背后竟有这般阴谋
文/苍兰香墨我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。一阵脚步声响...
开封第一讲书人阅读 31,167评论 1赞 259
情欲美人皮
我被黑心中介骗来泰国打工，没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。一个月前我还...
沈念sama阅读 43,636评论 2赞 349
代替公主和亲
正文我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
茶点故事阅读 42,411评论 2赞 342

采用模板方法优化try-catch-finally

推荐阅读更多精彩内容