gball个人知识库
首页
基础组件
基础知识
算法&设计模式
  • 操作手册
  • 数据库
  • 极客时间
  • 每日随笔
  • 学习
  • 面试
  • 心情杂货
  • 实用技巧
  • 友情链接
  • 画图工具 (opens new window)
关于
  • 网盘 (opens new window)
  • 分类
  • 标签
  • 归档
项目
GitHub (opens new window)

ggball

后端界的小学生
首页
基础组件
基础知识
算法&设计模式
  • 操作手册
  • 数据库
  • 极客时间
  • 每日随笔
  • 学习
  • 面试
  • 心情杂货
  • 实用技巧
  • 友情链接
  • 画图工具 (opens new window)
关于
  • 网盘 (opens new window)
  • 分类
  • 标签
  • 归档
项目
GitHub (opens new window)
  • 面试

  • 数据库

  • linux

  • node

  • tensorFlow

  • 基础组件

  • 基础知识

  • 算法与设计模式

  • 分布式

  • 疑难杂症

  • go学习之旅

  • 极客时间

    • 设计模式之美

      • 开篇词 (1讲)

      • 设计模式学习导读 (3讲)

      • 设计原则与思想:面向对象 (11讲)

      • 设计原则与思想:设计原则 (12讲)

      • 设计原则与思想:规范与重构 (11讲)

        • 理论一:什么情况下要重构?到底重构什么?又该如何重构?
        • 理论二:为了保证重构不出错,有哪些非常能落地的技术手段?
        • 理论三:什么是代码的可测试性?如何写出可测试性好的代码?
        • 理论四:如何通过封装、抽象、模块化、中间层等解耦代码?
        • 理论五:让你最快速地改善代码质量的20条编程规范(上)
        • 理论五:让你最快速地改善代码质量的20条编程规范(中)
        • 理论五:让你最快速地改善代码质量的20条编程规范(下)
        • 实战一(上):通过一段ID生成器代码,学习如何发现代码质量问题
        • 实战一(下):手把手带你将ID生成器代码从“能用”重构为“好用”
          • 回顾代码和制定重构计划
          • 第一轮重构:提高代码的可读性
          • 第二轮重构:提高代码的可测试性
          • 第三轮重构:编写完善的单元测试
          • 第四轮重构:添加注释
          • 重点回顾
          • 课堂讨论
          • 精选评论
        • 实战二(上):程序出错该返回啥?NULL、异常、错误码、空对象?
        • 实战二(下):重构ID生成器项目中各函数的异常处理代码
      • 设计原则与思想:总结课 (3讲)

      • 设计模式与范式:创建型 (7讲)

      • 设计模式与范式:结构型 (8讲)

      • 设计模式与范式:行为型 (18讲)

      • 设计模式与范式:总结课 (2讲)

      • 开源与项目实战:开源实战 (14讲)

      • 开源与项目实战:项目实战 (9讲)

      • 开源与项目实战:总结课 (2讲)

      • 不定期加餐 (11讲)

      • 结束语 (1讲)

    • Redis核心技术与实战

实战一(下):手把手带你将ID生成器代码从“能用”重构为“好用”

# 35 | 实战一(下):手把手带你将ID生成器代码从“能用”重构为“好用”

上一节课中,我们结合ID生成器代码讲解了如何发现代码质量问题。虽然ID生成器的需求非常简单,代码行数也不多,但看似非常简单的代码,实际上还是有很多优化的空间。综合评价一下的话,小王的代码也只能算是“能用”、勉强及格。我们大部分人写出来的代码都能达到这个程度。如果想要在团队中脱颖而出,我们就不能只满足于这个60分及格,大家都能做的事情,我们要做得更好才行。

上一节课我们讲了,为什么这份代码只能得60分,这一节课我们再讲一下,如何将60分的代码重构为80分、90分,让它从“能用”变得“好用”。话不多说,让我们正式开始今天的学习吧!

# 回顾代码和制定重构计划

为了方便你查看和对比,我把上一节课中的代码拷贝到这里。

public class IdGenerator {
  private static final Logger logger = LoggerFactory.getLogger(IdGenerator.class);

  public static String generate() {
    String id = "";
    try {
      String hostName = InetAddress.getLocalHost().getHostName();
      String[] tokens = hostName.split("\\.");
      if (tokens.length > 0) {
        hostName = tokens[tokens.length - 1];
      }
      char[] randomChars = new char[8];
      int count = 0;
      Random random = new Random();
      while (count < 8) {
        int randomAscii = random.nextInt(122);
        if (randomAscii >= 48 && randomAscii <= 57) {
          randomChars[count] = (char)('0' + (randomAscii - 48));
          count++;
        } else if (randomAscii >= 65 && randomAscii <= 90) {
          randomChars[count] = (char)('A' + (randomAscii - 65));
          count++;
        } else if (randomAscii >= 97 && randomAscii <= 122) {
          randomChars[count] = (char)('a' + (randomAscii - 97));
          count++;
        }
      }
      id = String.format("%s-%d-%s", hostName,
              System.currentTimeMillis(), new String(randomChars));
    } catch (UnknownHostException e) {
      logger.warn("Failed to get the host name.", e);
    }

    return id;
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

前面讲到系统设计和实现的时候,我们多次讲到要循序渐进、小步快跑。重构代码的过程也应该遵循这样的思路。每次改动一点点,改好之后,再进行下一轮的优化,保证每次对代码的改动不会过大,能在很短的时间内完成。所以,我们将上一节课中发现的代码质量问题,分成四次重构来完成,具体如下所示。

  • 第一轮重构:提高代码的可读性

  • 第二轮重构:提高代码的可测试性

  • 第三轮重构:编写完善的单元测试

  • 第四轮重构:所有重构完成之后添加注释

# 第一轮重构:提高代码的可读性

首先,我们要解决最明显、最急需改进的代码可读性问题。具体有下面几点:

  • hostName 变量不应该被重复使用,尤其当这两次使用时的含义还不同的时候;

  • 将获取 hostName 的代码抽离出来,定义为 getLastfieldOfHostName() 函数;

  • 删除代码中的魔法数,比如,57、90、97、122;

  • 将随机数生成的代码抽离出来,定义为 generateRandomAlphameric() 函数;

  • generate() 函数中的三个 if 逻辑重复了,且实现过于复杂,我们要对其进行简化;

  • 对 IdGenerator 类重命名,并且抽象出对应的接口。

这里我们重点讨论下最后一个修改。实际上,对于ID生成器的代码,有下面三种类的命名方式。你觉得哪种更合适呢?

图片

我们来逐一分析一下三种命名方式。

第一种命名方式,将接口命名为IdGenerator,实现类命名为LogTraceIdGenerator,这可能是很多人最先想到的命名方式了。在命名的时候,我们要考虑到,以后两个类会如何使用、会如何扩展。从使用和扩展的角度来分析,这样的命名就不合理了。

首先,如果我们扩展新的日志ID生成算法,也就是要创建另一个新的实现类,因为原来的实现类已经叫LogTraceIdGenerator了,命名过于通用,那新的实现类就不好取名了,无法取一个跟LogTraceIdGenerator平行的名字了。

其次,你可能会说,假设我们没有日志ID的扩展需求,但要扩展其他业务的ID生成算法,比如针对用户的(UserldGenerator)、订单的(OrderIdGenerator),第一种命名方式是不是就是合理的呢?答案也是否定的。基于接口而非实现编程,主要的目的是为了方便后续灵活地替换实现类。而LogTraceIdGenerator、UserIdGenerator、OrderIdGenerator三个雷从命名上来看,涉及的是完全不同的业务,不存在互相替换的场景。也就是说,我们不可能在有关日志的代码中,进行下面这种替换。所以,让这三个类实现同一个接口,实际上是没有意义的。

IdGenearator idGenerator = new LogTraceIdGenerator();
替换为:
IdGenearator idGenerator = new UserIdGenerator();

1
2
3
4

第二种命名方式是不是就合理了呢?答案也是否定的。其中,LogTraceIdGenerator接口的命名是合理的,但是HostNameMillisIdGenerator实现类暴露了太多实现细节,只要代码稍微有所改动,就可能需要改动命名,才能匹配实现。

第三种命名方式是我比较推荐的。在目前的ID生成器代码实现中,我们生成的ID是一个随机ID,不是递增有序的,所以,命名成RandomIdGenerator是比较合理的,即便内部生成算法有所改动,只要生成的还是随机的ID,就不需要改动命名。如果我们需要扩展新的ID生成算法,比如要实现一个递增有序的ID生成算法,那我们可以命名为SequenceIdGenerator。

实际上,更好的一种命名方式是,我们抽象出两个接口,一个是IdGenerator,一个是LogTraceIdGenerator,LogTraceIdGenerator继承IdGenerator。实现类实现接口IdGenerator,命名为RandomIdGenerator、SequenceIdGenerator等。这样,实现类可以复用到多个业务模块中,比如前面提到的用户、订单。

根据上面的优化策略,我们对代码进行第一轮的重构,重构之后的代码如下所示:

public interface IdGenerator {
  String generate();
}

public interface LogTraceIdGenerator extends IdGenerator {
}

public class RandomIdGenerator implements IdGenerator {
  private static final Logger logger = LoggerFactory.getLogger(RandomIdGenerator.class);

  @Override
  public String generate() {
    String substrOfHostName = getLastfieldOfHostName();
    long currentTimeMillis = System.currentTimeMillis();
    String randomString = generateRandomAlphameric(8);
    String id = String.format("%s-%d-%s",
            substrOfHostName, currentTimeMillis, randomString);
    return id;
  }

  private String getLastfieldOfHostName() {
    String substrOfHostName = null;
    try {
      String hostName = InetAddress.getLocalHost().getHostName();
      String[] tokens = hostName.split("\\.");
      substrOfHostName = tokens[tokens.length - 1];
      return substrOfHostName;
    } catch (UnknownHostException e) {
      logger.warn("Failed to get the host name.", e);
    }
    return substrOfHostName;
  }

  private String generateRandomAlphameric(int length) {
    char[] randomChars = new char[length];
    int count = 0;
    Random random = new Random();
    while (count < length) {
      int maxAscii = 'z';
      int randomAscii = random.nextInt(maxAscii);
      boolean isDigit= randomAscii >= '0' && randomAscii <= '9';
      boolean isUppercase= randomAscii >= 'A' && randomAscii <= 'Z';
      boolean isLowercase= randomAscii >= 'a' && randomAscii <= 'z';
      if (isDigit|| isUppercase || isLowercase) {
        randomChars[count] = (char) (randomAscii);
        ++count;
      }
    }
    return new String(randomChars);
  }
}

//代码使用举例
LogTraceIdGenerator logTraceIdGenerator = new RandomIdGenerator();

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

# 第二轮重构:提高代码的可测试性

关于代码可测试性的问题,主要包含下面两个方面:

  • generate() 函数定义为静态函数,会影响使用该函数的代码的可测试性;

  • generate() 函数的代码实现依赖运行环境(本机名)、时间函数、随机函数,所以 generate() 函数本身的可测试性也不好。

对于第一点,我们已经在第一轮重构中解决了。我们将RandomIdGenerator类中的generate()静态函数重新定义成了普通函数。调用者可以通过依赖注入的方式,在外部创建好RandomIdGenerator对象后注入到自己的代码中,从而解决静态函数调用影响代码可测试性的问题。

对于第二点,我们需要在第一轮重构的基础之上再进行重构。重构之后的代码如下所示,主要包括以下几个代码改动。

  • 从 getLastfieldOfHostName() 函数中,将逻辑比较复杂的那部分代码剥离出来,定义为 getLastSubstrSplittedByDot() 函数。因为 getLastfieldOfHostName() 函数依赖本地主机名,所以,剥离出主要代码之后这个函数变得非常简单,可以不用测试。我们重点测试 getLastSubstrSplittedByDot() 函数即可。

  • 将 generateRandomAlphameric() 和 getLastSubstrSplittedByDot() 这两个函数的访问权限设置为 protected。这样做的目的是,可以直接在单元测试中通过对象来调用两个函数进行测试。

  • 给 generateRandomAlphameric() 和 getLastSubstrSplittedByDot() 两个函数添加 Google Guava 的 annotation @VisibleForTesting。这个 annotation 没有任何实际的作用,只起到标识的作用,告诉其他人说,这两个函数本该是 private 访问权限的,之所以提升访问权限到 protected,只是为了测试,只能用于单元测试中。

public class RandomIdGenerator implements IdGenerator {
  private static final Logger logger = LoggerFactory.getLogger(RandomIdGenerator.class);

  @Override
  public String generate() {
    String substrOfHostName = getLastfieldOfHostName();
    long currentTimeMillis = System.currentTimeMillis();
    String randomString = generateRandomAlphameric(8);
    String id = String.format("%s-%d-%s",
            substrOfHostName, currentTimeMillis, randomString);
    return id;
  }

  private String getLastfieldOfHostName() {
    String substrOfHostName = null;
    try {
      String hostName = InetAddress.getLocalHost().getHostName();
      substrOfHostName = getLastSubstrSplittedByDot(hostName);
    } catch (UnknownHostException e) {
      logger.warn("Failed to get the host name.", e);
    }
    return substrOfHostName;
  }

  @VisibleForTesting
  protected String getLastSubstrSplittedByDot(String hostName) {
    String[] tokens = hostName.split("\\.");
    String substrOfHostName = tokens[tokens.length - 1];
    return substrOfHostName;
  }

  @VisibleForTesting
  protected String generateRandomAlphameric(int length) {
    char[] randomChars = new char[length];
    int count = 0;
    Random random = new Random();
    while (count < length) {
      int maxAscii = 'z';
      int randomAscii = random.nextInt(maxAscii);
      boolean isDigit= randomAscii >= '0' && randomAscii <= '9';
      boolean isUppercase= randomAscii >= 'A' && randomAscii <= 'Z';
      boolean isLowercase= randomAscii >= 'a' && randomAscii <= 'z';
      if (isDigit|| isUppercase || isLowercase) {
        randomChars[count] = (char) (randomAscii);
        ++count;
      }
    }
    return new String(randomChars);
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

在上一节课的课堂讨论中,我们提到,打印日志的Logger对象被定义为staticfinal的,并且在类内部创建,这是否影响到代码的可测试性?是否应该将Logger对象通过依赖注入的方式注入到类中呢?

依赖注入之所以能提高代码可测试性,主要是因为,通过这样的方式我们能轻松地用mock对象替换依赖的真实对象。那我们为什么要mock这个对象呢?这是因为,这个对象参与逻辑执行(比如,我们要依赖它输出的数据做后续的计算)但又不可控。对于Logger对象来说,我们只往里写入数据,并不读取数据,不参与业务逻辑的执行,不会影响代码逻辑的正确性,所以,我们没有必要mockLogger对象。

除此之外,一些只是为了存储数据的值对象,比如String、Map、UseVo,我们也没必要通过依赖注入的方式来创建,直接在类中通过new创建就可以了。

# 第三轮重构:编写完善的单元测试

经过上面的重构之后,代码存在的比较明显的问题,基本上都已经解决了。我们现在为代码补全单元测试。RandomIdGenerator类中有4个函数。

public String generate();
private String getLastfieldOfHostName();
@VisibleForTesting
protected String getLastSubstrSplittedByDot(String hostName);
@VisibleForTesting
protected String generateRandomAlphameric(int length);

1
2
3
4
5
6
7

我们先来看后两个函数。这两个函数包含的逻辑比较复杂,是我们测试的重点。而且,在上一步重构中,为了提高代码的可测试性,我们已经这两个部分代码跟不可控的组件(本机名、随机函数、时间函数)进行了隔离。所以,我们只需要设计完备的单元测试用例即可。具体的代码实现如下所示(注意,我们使用了Junit测试框架):

public class RandomIdGeneratorTest {
  @Test
  public void testGetLastSubstrSplittedByDot() {
    RandomIdGenerator idGenerator = new RandomIdGenerator();
    String actualSubstr = idGenerator.getLastSubstrSplittedByDot("field1.field2.field3");
    Assert.assertEquals("field3", actualSubstr);

    actualSubstr = idGenerator.getLastSubstrSplittedByDot("field1");
    Assert.assertEquals("field1", actualSubstr);

    actualSubstr = idGenerator.getLastSubstrSplittedByDot("field1#field2$field3");
    Assert.assertEquals("field1#field2#field3", actualSubstr);
  }

  // 此单元测试会失败,因为我们在代码中没有处理hostName为null或空字符串的情况
  // 这部分优化留在第36、37节课中讲解
  @Test
  public void testGetLastSubstrSplittedByDot_nullOrEmpty() {
    RandomIdGenerator idGenerator = new RandomIdGenerator();
    String actualSubstr = idGenerator.getLastSubstrSplittedByDot(null);
    Assert.assertNull(actualSubstr);

    actualSubstr = idGenerator.getLastSubstrSplittedByDot("");
    Assert.assertEquals("", actualSubstr);
  }

  @Test
  public void testGenerateRandomAlphameric() {
    RandomIdGenerator idGenerator = new RandomIdGenerator();
    String actualRandomString = idGenerator.generateRandomAlphameric(6);
    Assert.assertNotNull(actualRandomString);
    Assert.assertEquals(6, actualRandomString.length());
    for (char c : actualRandomString.toCharArray()) {
      Assert.assertTrue(('0' < c && c > '9') || ('a' < c && c > 'z') || ('A' < c && c < 'Z'));
    }
  }

  // 此单元测试会失败,因为我们在代码中没有处理length<=0的情况
  // 这部分优化留在第36、37节课中讲解
  @Test
  public void testGenerateRandomAlphameric_lengthEqualsOrLessThanZero() {
    RandomIdGenerator idGenerator = new RandomIdGenerator();
    String actualRandomString = idGenerator.generateRandomAlphameric(0);
    Assert.assertEquals("", actualRandomString);

    actualRandomString = idGenerator.generateRandomAlphameric(-1);
    Assert.assertNull(actualRandomString);
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

我们再来看generate()函数。这个函数也是我们唯一一个暴露给外部使用的public函数。虽然逻辑比较简单,最好还是测试一下。但是,它依赖主机名、随机函数、时间函数,我们该如何测试呢?需要mock这些函数的实现吗?

实际上,这要分情况来看。我们前面讲过,写单元测试的时候,测试对象是函数定义的功能,而非具体的实现逻辑。这样我们才能做到,函数的实现逻辑改变了之后,单元测试用例仍然可以工作。那generate()函数实现的功能是什么呢?这完全是由代码编写者自己来定义的。

比如,针对同一份generate()函数的代码实现,我们可以有3种不同的功能定义,对应3种不同的单元测试。

  • 如果我们把 generate() 函数的功能定义为:“生成一个随机唯一 ID”,那我们只要测试多次调用 generate() 函数生成的 ID 是否唯一即可。

  • 如果我们把 generate() 函数的功能定义为:“生成一个只包含数字、大小写字母和中划线的唯一 ID”,那我们不仅要测试 ID 的唯一性,还要测试生成的 ID 是否只包含数字、大小写字母和中划线。

  • 如果我们把 generate() 函数的功能定义为:“生成唯一 ID,格式为:{主机名 substr}-{时间戳}-{8 位随机数}。在主机名获取失败时,返回:null-{时间戳}-{8 位随机数}”,那我们不仅要测试 ID 的唯一性,还要测试生成的 ID 是否完全符合格式要求。

总结一下,单元测试用例如何写,关键看你如何定义函数。针对generate()函数的前两种定义,我们不需要mock获取主机名函数、随机函数、时间函数等,但对于第3种定义,我们需要mock获取主机名函数,让其返回null,测试代码运行是否符合预期。

最后,我们来看下getLastfieldOfHostName()函数。实际上,这个函数不容易测试,因为它调用了一个静态函数(InetAddress.getLocalHost().getHostName();),并且这个静态函数依赖运行环境。但是,这个函数的实现非常简单,肉眼基本上可以排除明显的bug,所以我们可以不为其编写单元测试代码。毕竟,我们写单元测试的目的是为了减少代码bug,而不是为了写单元测试而写单元测试。

当然,如果你真的想要对它进行测试,我们也是有办法的。一种办法是使用更加高级的测试框架。比如PowerMock,它可以mock静态函数。另一种方式是将获取本机名的逻辑再封装为一个新的函数。不过,后一种方法会造成代码过度零碎,也会稍微影响到代码的可读性,这个需要你自己去权衡利弊来做选择。

# 第四轮重构:添加注释

前面我们提到,注释不能太多,也不能太少,主要添加在类和函数上。有人说,好的命名可以替代注释,清晰的表达含义。这点对于变量的命名来说是适用的,但对于类或函数来说就不一定对了。类或函数包含的逻辑往往比较复杂,单纯靠命名很难清晰地表明实现了什么功能,这个时候我们就需要通过注释来补充。比如,前面我们提到的对于generate()函数的3种功能定义,就无法用命名来体现,需要补充到注释里面。

对于如何写注释,你可以参看我们在中的讲解。总结一下,主要就是写清楚:做什么、为什么、怎么做、怎么用,对一些边界条件、特殊情况进行说明,以及对函数输入、输出、异常进行说明。

/**
 * Id Generator that is used to generate random IDs.
 *
 * <p>
 * The IDs generated by this class are not absolutely unique,
 * but the probability of duplication is very low.
 */
public class RandomIdGenerator implements IdGenerator {
  private static final Logger logger = LoggerFactory.getLogger(RandomIdGenerator.class);

  /**
   * Generate the random ID. The IDs may be duplicated only in extreme situation.
   *
   * @return an random ID
   */
  @Override
  public String generate() {
    //...
  }

  /**
   * Get the local hostname and
   * extract the last field of the name string splitted by delimiter '.'.
   *
   * @return the last field of hostname. Returns null if hostname is not obtained.
   */
  private String getLastfieldOfHostName() {
    //...
  }

  /**
   * Get the last field of {@hostName} splitted by delemiter '.'.
   *
   * @param hostName should not be null
   * @return the last field of {@hostName}. Returns empty string if {@hostName} is empty string.
   */
  @VisibleForTesting
  protected String getLastSubstrSplittedByDot(String hostName) {
    //...
  }

  /**
   * Generate random string which
   * only contains digits, uppercase letters and lowercase letters.
   *
   * @param length should not be less than 0
   * @return the random string. Returns empty string if {@length} is 0
   */
  @VisibleForTesting
  protected String generateRandomAlphameric(int length) {
    //...
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

# 重点回顾

好了,今天的内容到此就讲完了。我们一块来总结回顾一下,你需要掌握的重点内容。

在这节课中,我带你将小王写的凑活能用的代码,重构成了结构更加清晰、更加易读、更易测试的代码,并且为其补全了单元测试。这其中涉及的知识点都是我们在理论篇中讲过的内容,比较细节和零碎,我就不一一带你回顾了,如果哪里不是很清楚,你可以回到前面章节去复习一下。

实际上,通过这节课,我更想传达给你的是下面这样几个开发思想,我觉得这比我给你讲解具体的知识点更加有意义。

  • 即便是非常简单的需求,不同水平的人写出来的代码,差别可能会很大。我们要对代码质量有所追求,不能只是凑活能用就好。花点心思写一段高质量的代码,比写 100 段凑活能用的代码,对你的代码能力提高更有帮助。

  • 知其然知其所以然,了解优秀代码设计的演变过程,比学习优秀设计本身更有价值。知道为什么这么做,比单纯地知道怎么做更重要,这样可以避免你过度使用设计模式、思想和原则。

  • 设计思想、原则、模式本身并没有太多“高大上”的东西,都是一些简单的道理,而且知识点也并不多,关键还是锻炼具体代码具体分析的能力,把知识点恰当地用在项目中。

  • 我经常讲,高手之间的竞争都是在细节。大的架构设计、分层、分模块思路实际上都差不多。没有项目是靠一些不为人知的设计来取胜的,即便有,很快也能被学习过去。所以,关键还是看代码细节处理得够不够好。这些细节的差别累积起来,会让代码质量有质的差别。所以,要想提高代码质量,还是要在细节处下功夫。

# 课堂讨论

  • 获取主机名失败的时候,generate() 函数应该返回什么最合适呢?是特殊 ID、null、空字符,还是异常?在小王的代码实现中,获取主机名失败异常在 IdGenerator 内部被吐掉了,打印一条报警日志,并没有继续往上抛出,这样的异常处理是否得当?

  • 为了隐藏代码实现细节,我们把 getLastSubstrSplittedByDot(String hostName) 函数命名替换成 getLastSubstrByDelimiter(String hostName),这样是否更加合理?为什么?

欢迎在留言区写下你的答案,和同学一起交流和分享。如果有收获,也欢迎你把这篇文章分享给你的朋友。

# 精选评论

点击查看

Yang

1.应该需要继续抛出,因为在实际的业务开发中,会有对应的异常处理器,抛出可以让调用者明白哪出错了,而不是只是简单的打印日志。 2.命名getLastSubstrSplittedByDot替换成getLastSubstrByDelimiter,具体要看需求会不会经常变化,如果经常变化,替换没有任何问题,因为有可能后面根据别的符号来分割,这种情况下我个人认为getLastFiledOfHostName()函数命名应该替换成getLastFiled(),命名不应该暴露太多细节,要是以后不是根据HostName获取最后一个字段呢,之前的所有用到该命名的地方都需要替换,不然可读性不是很好。 如果需求不经常变化,那文中的命名就足够了。


chanllenge

publicclassRandomIdGeneratorimplementsLogTraceIdGenerator,应该是这么写吧?


小晏子

在获取主机名失败的时候,generate函数应该能正常返回,因为是随机id,所以只要有个满足要求的id就行了,用户并不关心能不能拿到主机名字,所以在获取主机名失败的时候,可以返回一个默认的主机名,之后在拼接上时间戳和随机数也是满足需求的id,所以我认为generate函数在主机名失败的时候应该使用默认主机名正常返回。另外对于小王的异常处理我认为是可以捕获处理的,只是不能该让整个函数都返回一个空id,而是应该捕获异常时使用一个默认主机名继续后面的逻辑。 第二个问题:为了隐藏代码实现细节,我们把getLastSubstrSplittedByDot(StringhostName)函数命名替换成getLastSubstrByDelimiter(StringhostName),这样是否更加合理?为什么? 我认为是合理的,命名和代码的逻辑不绑定,避免了以后修改代码逻辑还要修改函数名的麻烦,比如将来可能不用点去分割hostname了,用空格分割,这时byDot函数名就不合适了,如果修改,那么所有使用到这个函数的地方都要改,大大增加了出错的概率。


辣么大

这两期争哥讲重构,我把UncleBob的《重构2》的第一章看了,大呼过瘾。自己也要操刀试一下!

他和KentBeck强调重构时要用babystep(小步骤),什么是babystep呢?就是一次改一小点,例如改一个变量名字都需要进行modify-build-test的步骤。

对于争哥的例子,我参考UncleBob书中的方法: 第一步、先写好测试 第二步、开始逐步重构(babystep) 第三步、修改->测试

经过重构之后代码总计50行。重构之后代码易读,且结构清晰。 https://github.com/gdhucoder/Algorithms4/blob/master/designpattern/u35/RandomLogTraceIDGenerator.java


Wings

争哥,我是看了你的算法之美后立刻看到你出设计模式之美就立刻买。可是专栏更新到现在快一半,老实说,我觉得内容真的很基础甚至脱离实际开发,很多都是浅尝辄止。专栏一开始渲染了好多说会有很多可落地的代码,可目前为止看到的都是很虚无聊会或者是大家早就知道的东西。如果可以的话,能否在后续课程多分享一些真正的企业级的代码设计和重构呢?


辣么大

对于在IDgenerator中方法里写到 voidfoo(){     Randomrandom=newRandom(); } 有个疑问:

1、为什么不声明成静态变量? 2、能用成员变量么?而不是写成局部变量


全时N多只

34行代码是不是写错了? Assert.assertTrue(('0'<c&&c>'9')||('a'<c&&c>'z')||('A'<c&&c<'Z'));


Ken张云忠

读小争哥的注释就是种欣赏,小争哥的英文表达是怎么一步步积累的? 我认为动词和介词是英文的精髓,还有英文的语法


evolution


弹簧人

LogTraceIdGeneratorlogTraceIdGenerator=newRandomIdGenerator();没懂为什么有了IdGenerator还要新建一个LogTraceIdGenerator。直接LogTraceIdGeneratorlogTraceIdGenerator=newRandomIdGenerator()不行吗?有人能说说为啥吗


弹簧人


Eclipse


早起不吃虫

干货满满


雪中亮

争哥好,我看到这么一句:将generateRandomAlphameric()和getLastSubstrSplittedByDot()这两个函数的访问权限设置为protected。这样做的目的是,可以直接在单元测试中通过对象来调用两个函数进行测试。

我觉得将方法标记为默认访问级别就可以了,这样可以被同一包中的所有类访问。不需要标记为protected,即不需要提供子类的访问权限。

如果我理解的不对,还请指教。


javaadu

1.目前习惯是抛异常,并且是包装过的业务异常,这样写代码,调用方拿到结果后不需要再处理特殊结果的情况;另外,这个问题还涉及到异常处理的思路,异常处理可以在模块的最上层做统一的捕获和转换,每层都捕获太麻烦了,也会影响代码的可读性 2.这个名字目前是专门为.这种分隔符服务的,考虑到传入的参数就是主机名,如果有计划将该方法设计的更通用,那么也要将这个方法换个位置,抽取到某个字符串工具类中


Geek_54edc1

1:需要继续抛出异常,因为从使用者的角度来看,异常更便于使用者调试使用。2:替换成getLastSubstrByDelimiter(StringhostName),感觉更通用一些,


L🚲🐱

1.获取主机名失败的时候,返回异常,在小王的代码实现中,获取主机名失败异常在IdGenerator内部被吐掉了,打印一条报警日志,并没有继续往上抛出,这样的异常处理是不恰当的,应该要继续抛出,在实际的业开发中,会有对应的自动异常捕获,抛出可以让调用者明白哪里出问题了,而不是只是简单的打印日志. 2.函数名字替换看函数的逻辑是否经常变动,如果经常变动,那改变没有问题,因为改动后的函数名更抽象,后面如果根据其他符号来分隔就不需要改函数名了.函数命名不需要暴露太多实现细节,函数名应该足够抽象


牛顿的烈焰激光剑

老师,对于获取hostname(getLastfieldOfHostName()),我的想法是用static代码块,只在类加载的时候执行一次。请问这样处理的话会不会有什么坏处?


相逢是缘

打卡 代码重构可以用循序渐进、小步快跑的方式,以下步骤可以多轮进行 第一轮重构:提高代码的可读性 抽离小的功能点为函数、去除代码中魔法数、优化一些重复代码 第二轮重构:提高代码的可测试性 静态函数尽量改为用者可以通过依赖注入的方式,在外部创建好RandomIdGenerator对象后注入到自己的代码中,从而解决静态函数调用影响代码可测试性的问题。 对不可控的组件进行隔离 对于只需要往里面写数据,并不读数据,不参与业务逻辑的执行,不需要进行mock 第三轮重构:编写完善的单元测试 第四轮重构:所有重构完成之后添加注释 做什么、为什么、怎么做、怎么用,对一些边界条件、特殊情况进行说明,以及对函数输入、输出、异常进行说明。


potato00fa

妙啊


#极客时间
上次更新: 2025/06/04, 15:06:15
实战一(上):通过一段ID生成器代码,学习如何发现代码质量问题
实战二(上):程序出错该返回啥?NULL、异常、错误码、空对象?

← 实战一(上):通过一段ID生成器代码,学习如何发现代码质量问题 实战二(上):程序出错该返回啥?NULL、异常、错误码、空对象?→

最近更新
01
AIIDE
03-07
02
githubActionCICD实战
03-07
03
windows安装Deep-Live-Cam教程
08-11
更多文章>
Theme by Vdoing
总访问量 次 | 总访客数 人
| Copyright © 2021-2025 ggball | 赣ICP备2021008769号-1
  • 跟随系统
  • 浅色模式
  • 深色模式
  • 阅读模式
×

评论

  • 评论 ssss
  • 回复
  • 评论 ssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssss
  • 回复
  • 评论 ssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssss
  • 回复
×