如何在不损害 java + PDFBox 中的 DRY 原则的情况下格式化代码？

Question

请原谅这个问题的阴暗面，请允许我解释一下。

我使用 PDFBox 创建了一个 PDFGenerator。 PDF 大约有 9 页，实际的 PDFGenerator.java 是一个拥有近 4k 行代码的怪物，大部分代码是 PDF 内文本的恒定像素定位。

当前版本 (v1) 包括 2 个主要变量，一个供应和一个排气。因此，对于某物的每一行，都有一个供应值和一个排放值。

整个事情完美运行，我对整个生成过程非常满意。然而，现在 v2 已经到来，客户希望能够创建供应或排放，或两者兼而有之。

这就是我对 DRY 原则的问题所在。理论上，两者的代码都已经存在。当它是一个或另一个时，唯一改变的是文本的位置，现在它在两列之间居中。

示例：两者（当前正在生成）

属性............供应......排气

高度 ....................................5 .5

宽度 ....................................5 ..5

示例：一个或另一个

属性............供应......

高度 ....................................5....... ......

宽度 ....................................5........ .......

这是一个生成一行的块：

    pdContentStream.beginText();
    pdContentStream.setFont(boldFont, BOLD_FONT_SIZE);
    pdContentStream.newLineAtOffset(TEXT_BEGIN, currentYCoord);
    pdContentStream.showText(messageSource.getMessage("pdf.value.TDVentilator", null, this.locale));
    pdContentStream.endText();

    pdContentStream.beginText();
    pdContentStream.setFont(boldFont, BOLD_FONT_SIZE);
    pdContentStream.newLineAtOffset(SUPPLY_BEGIN, currentYCoord);
    pdContentStream.showText(messageSource.getMessage("pdf.supply", null, this.locale));
    pdContentStream.endText();

    pdContentStream.beginText();
    pdContentStream.setFont(boldFont, BOLD_FONT_SIZE);
    pdContentStream.newLineAtOffset(EXHAUST_BEGIN, currentYCoord);
    pdContentStream.showText(messageSource.getMessage("pdf.exhaust", null, this.locale));
    pdContentStream.endText();

请记住，这类块会在整个生成过程中重复出现。现在是我的 DRY 问题出现的地方。

我想到的第一件事是将当前代码导出到仅用于生成两者的函数中，并创建（复制/粘贴）用于其中一个或另一个的第二个函数。但是大部分代码会重复这样做（少了一个块，因为我们只有一个输出变量而不是两个）。

我能想到的另一种方法是在每个代码块之前创建一个 if() ，如果这种情况则采用该代码块，如果这种情况采用该代码块。再一次，DRYness 不存在（因为相同的 if 必须出现在每个代码块之前）。

我的问题是：通常最好的方法是什么？我不介意怪物是否再次从 4k 行代码增长到 8k 行代码，但如果有更简单（更好）的方法来做到这一点，我会全力以赴。

干杯:)

Answer 1

查看您的代码：

pdContentStream.beginText();
pdContentStream.setFont(boldFont, BOLD_FONT_SIZE);
pdContentStream.newLineAtOffset(EXHAUST_BEGIN, currentYCoord);
pdContentStream.showText(messageSource.getMessage("pdf.exhaust", null, this.locale));
pdContentStream.endText();

我认为不同的唯一部分是给messageSource.getMessage()的第一个参数。

所以你的重构可能会从引入：

public void prepareContent(Whatever pdContentStream, String message) {
    pdContentStream.beginText();
    pdContentStream.setFont(boldFont, BOLD_FONT_SIZE);
    pdContentStream.newLineAtOffset(EXHAUST_BEGIN, currentYCoord);
    pdContentStream.showText(messageSource.getMessage(message, null, this.locale));
    pdContentStream.endText();
}

然后你的主要代码归结为：

prepareContent(pdContenStream, "pdf.value.TDVentilator");
prepareContent(pdContenStream, "...

等等。然后：您可能会将这些东西放在它自己的类中，在其中创建 pdContentStream 一个字段；摆脱每次调用都需要该参数。

之后应该更好地“组织”这些字符串。写下来没有意义：

foo("bla");
foo("blub");

相反，您将诸如“pdf.value.TDVentilator”之类的值推送到列表中；然后暗示迭代列表/集合/任何东西，从那里获取所需的信息。

长话短说：你不会长出怪物。你甚至不允许它们存在。您显示的代码已经是对 DRY 的严重违规，绝对应该不被容忍！