小程序中的大道理–综述

本文介绍: 本文将用一个小程序来探讨包括可扩展性, 抽象与封装, 可维护性, 健壮性, 团队合作, 工具的利用, 可测试性, 自顶向下, 分而治之, 分层, 可读性, 模块化, 松耦合, MVC, 领域模型, 甚至对称性, 香农的信息论等等在内的一些大道理.

以下将用一个小程序来探讨一些大道理, 这些大道理包括可扩展性, 抽象与封装, 可维护性, 健壮性, 团队合作, 工具的利用, 可测试性, 自顶向下, 分而治之, 分层, 可读性, 模块化, 松耦合, MVC, 领域模型, 甚至对称性, 香农的信息论等等.

因为大程序太大了, 代码一端上来, 读者就晕菜了, 看不过来甚至压根不想去看, 这样说理就很抽象了, 效果反而不好.

我们有句话, 叫”以小见大”, 我们又常常有种说法, 叫:

所以呢, 小程序也是可以来说大道理的, 而且小程序又有短小的特点, 大家看得也没那么累, 也很快能看懂. 毕竟那种代码, 叫什么来着, “意大利面条式的代码”, 大家在实际的开发中, 已经见得太多了.

按我们的习惯, 也许叫它”裹脚布式的代码“大家觉得更熟悉, 更形象一点, 也正好符合”又长又臭”的特点.

这种代码我们在工作中见得太多了, 所以这里就不再弄出来考验大家的毅力了, 闲话少提, 让我们看个简单的例子.

  *
 ***
*****

public static void main(String[] args) {
    int i = 3;
    for (int j = 0; j < i; j++) {
        for (int k = 0; k < i - j; k++) {
            System.out.print(" ");
        }
        for (int z = 0; z < 2*j+1; z++) {
            System.out.print("*");
        }
        System.out.println();
    }
}

public void printPattern(int lineCount) {
    String pattern = getPattern(lineCount);
    System.out.print(pattern);
}

我们先借助 getPattern 方法拿到要打印的内容, 这样, 如果哪天要输出到文件, 哪天要供 web service 调用, 我们都可以把这个 getPattern 方法提供出去.

getPattern 就是一个抽象, 是对一系列动作的一个封装.

在 printPattern 层面, 我们不需要知道 getPattern 的细节, 我们只需要传入所需参数及定义好需要的返回值即可.

只要输入与输出定义清楚了, 工具就能自动帮我们生成方法定义, 这里默认它是 private 的, 我们可以把它改成 public.

我们前面说了, 我们可能还要做输出图案到文件的需求, 很可能你有个同事哥们, 他就正做着这个模块, 而他现在呢, 就在等着你这个 getPattern 方法. 你提交了, 他就可以继续写他的代码了:

package org.jcc.core.demo;

public class PatternFile {
    
    private Pattern pattern;

    public PatternFile(Pattern pattern) {
        this.pattern = pattern;
    }
    
    public void generatePatternFile(int lineCount) {
        String content = pattern.getPattern(lineCount);
        saveInFile(content);
    }

    private void saveInFile(String content) {
        // TODO Auto-generated method stub
        //System.out.println(content);
    }
}

可以看到, 他的类依赖你的类, 在他的方法 generatePatternFile 里还调用了 getPattern 方法, 你没实现, 那又怎样呢? 接口好了就行了!

有人可能比较死板, 比较教条主义, 以为呢, 说到接口就一定要弄个 interface, 其实呢, 我们这个方法 getPattern 就是一个承诺, 一个约定, 一个协议, 也是一个广义上的接口.

@Test
public void testGeneratePatternFile() {
    // 用mockito来模拟接口的行为, 为此我们手动构建一个三行的图案
    Pattern pattern = Mockito.mock(Pattern.class);
    String mockContent = "  *" + System.lineSeparator() 
                       + " ***" + System.lineSeparator() 
                       + "*****" + System.lineSeparator();
    
    // 当调用getPattern方法时, 就返回这里定义好的内容. 
    Mockito.when(pattern.getPattern(3)).thenReturn(mockContent);
    
    // 测试generatePatternFile方法, 在它的里面将会调用getPattern方法
    PatternFile pf = new PatternFile(pattern);
    pf.generatePatternFile(3);
    
    // TODO 断言文件存在并且文件中的内容与mockContent一致
    // assert that file is exists and content in file is equals the mock content
}

以上我们用一个 mock 对象以及 when, thenReturn 来主动模拟一个尚未实现的方法.

通过以上举例, 可以看到, 我们可以手动构建一个图案, 并交给程序去判断(注: 为了简短起见, 代码中省略了具体的 assert 细节). 而如果是开头那样直接就打印了呢? 你根本没法让程序去判断, 只能通过人眼去观察输出, 这样就给 自动化的测试(Automatic Test) 带来了困难.

当 getPattern 被抽象出来之后, 可以看到, 不但可以在 printPattern 方法里使用, 也可以在 generatePatternFile 方法里使用. 而如果按开头那样呢? 你没法复用, 你还是不得不重构；又或者你可能只是简单地把代码复制一遍了, 再作些改动.

/**
 * 获取指定行数的图案, 比如3行时: 
 *   *
 *  ***
 * *****
 *  
 * @param lineCount 指定的行数
 * @return 图案的字符串表示, 包括换行符在内
 */
public String getPattern(int lineCount) {
    // TODO Auto-generated method stub
    return null;
}

/**
 * 获取指定行数的图案, 比如3行时: 
 *   *
 *  ***
 * *****
 *  
 * @param lineCount 指定的行数, 1-20之间
 * @return 图案的字符串表示, 包括换行符在内
 */
public String getPattern(int lineCount) {
    if (lineCount < 1) {
        throw new IllegalArgumentException("行数不能小于1!");
    }
    if (lineCount > 20) {
        throw new IllegalArgumentException("行数不能大于20!");
    }
    
    // TODO 
    return null;
}

显示所有内容

声明：本站所有文章，如无特殊说明或标注，均为本站原创发布。任何个人或组织，在未征得本站同意时，禁止复制、盗用、采集、发布本站内容到任何网站、书籍等各类媒体平台。如若本站内容侵犯了原著者的合法权益，可联系我们进行处理。

大道理程序自顶向下

前言

为什么不用大程序来说大道理呢?

小程序中也能说出大道理来吗?

我们的例子

玩具式的代码

生产级的代码

可扩展性(Extensibi lity)

抽象与封装(Abstr action & Encapsulation)

利用好你的工具(Tools)

利用好任务标识(Task Tags)

团队合作(Teamwork)

面向 接口 编程(Interfa ce)

利用 Mockito 来测试

可测试性(Tes tability)

可重用性(Reusabi lity)

不要重复(DRY: Don’t Repeat Yourself)

可维护性(Maintainability)

健壮性(Robustness)

小结

发表回复取消回复

前言

为什么不用大程序来说大道理呢?

小程序中也能说出大道理来吗?

我们的例子

玩具式的代码

生产级的代码

可扩展性(Extensibility)

抽象与封装(Abstraction &amp; Encapsulation)

利用好你的工具(Tools)

利用好任务标识(Task Tags)

团队合作(Teamwork)

面向接口编程(Interface)

利用 Mockito 来测试

可测试性(Testability)

可重用性(Reusability)