我们如何实现编写可重用和模块化的代码

Question

我们如何实现在企业代码中编写可重用和模块化的代码。入门的基础知识是什么

Answer 1

编写模块化代码是一门编程艺术。

在企业产品中，编写可重用代码是使产品长期可靠、可测试和可维护的关键。模块化和可重用的代码是任何标准产品的核心。

让我们举一个例子来了解如何将现有代码转换为更加模块化和可重用的代码。

假设产品中存在一种方法/逻辑，它采用正整数的一维数组作为输入并计算所有元素的总和。

// Method signature
// Business: Each element of array holds the amount of total transaction done by the user on each day for a year. Hence the array length is 365.(ignore leap year)
int sumYear (int [] A) {
        
        // logic
        sum of elements from index 0 to last index (364) of array A
}

该方法实际上是评估用户在给定年份的总交易金额。考虑到这是最初的业务需求，因此代码是以这种方式编写的。

现在，假设有一个新的业务需求，想要评估上半年的用户交易情况。你将如何实现它？也许再写一个可以评估上半年的方法。正确的。让我们看看这个方法是什么样的。

// Method signature
// Business: Each element of array holds the amount of total transaction the user has done on each day for a year. Hence the array length is 365.
int sumHalfYear (int [] A) {
        
        // logic
        sum of elements from index 0 to last index (182) of array A (ignore leap year)
}

很酷，我们已经做到了。 :)
但是否可以通过其他方式来完成，或者可能是更好的方式。让我们看看。

我们实际上可以编写一个更通用/可重用的方法，它可以给出给定时间段内的交易总和。像这样的

// Method signature
// Business: Each element of array holds the amount of transaction the user has done on each day for a year. Hence the array length is 365.
// startIndex: Starting index to consider for evaluation
// endIndex: Ending index to consider for evaluation
int sum (int [] A, int startIndex, int endIndex) {
        
        // logic
        sum of elements from index "startIndex" to "endIndex" of array A (ignore leap year)
}

现在我们可以为两个现有的需求调用这个可重用的方法。

// Method signature
// Business: Each element of array holds the amount of transaction the user has done on each day for a year. Hence the array length is 365.
int sumYear (int [] A) {
        
        //sum of elements from index 0 to last index (364) of array A
        return sum(A, 0, 364);

}

// Method signature
// Business: Each element of array holds the amount of transaction the user has done on each day for a year. Hence the array length is 365.
int sumHalfYear(int[] A) {
        
        //sum of elements from index 0 to last index (182) of array A (ignore leap year)
        return sum(A, 0, 182);
}

甚至任何未来的要求，比如说一月份，我们都需要简单地调用像这样的相同方法

// Method signature
// Business: Each element of array holds the amount of transaction an user has done on each day for a year. Hence the array length is 365.
int sumJanuray (int [] A) {
        
        //sum of elements from index 0 to last index (30) of array A
        return sum(A, 0, 30);
}

为什么我们正在寻找更好的方法？可能是为了适应未来的需求并减少代码行。

我们取得的成果：

1. 更高的可用性
2. 更高的可维护性
3. 更少的代码行
4. 更不容易因业务逻辑修改而导致未来回归

谢谢！