前端 - 我们看到很多面向对象编程的优秀的项目，为何能设计的非常好呢？

Question

我们看到很多面向对象编程的优秀的项目,

我们看到一个类继承一个类地，并且传递的类实例，看起来是相当庞大的项目，拥有相当多设计好的类，并且每个类设计的都很好：

但是比如我这等初级程序员，设计项目的时候，
1、根本很难把一个类设计的很好
2、想不到很多的接口继承或类实现接口的设计
3、比如在设计这个类的时候：

class TypeScriptDocumentSymbolProvider implements vscode.DocumentSymbolProvider {

    public constructor(
        private readonly client: ITypeScriptServiceClient,
        private readonly cachedResponse: CachedResponse<Proto.NavTreeResponse>,
    ) { }

    public async provideDocumentSymbols(document: vscode.TextDocument, token: vscode.CancellationToken): Promise<vscode.DocumentSymbol[] | undefined> {
        const file = this.client.toOpenTsFilePath(document);
        if (!file) {
            return undefined;
        }

        const args: Proto.FileRequestArgs = { file };
        const response = await this.cachedResponse.execute(document, () => this.client.execute('navtree', args, token));
        if (response.type !== 'response' || !response.body?.childItems) {
            return undefined;
        }

        // The root represents the file. Ignore this when showing in the UI
        const result: vscode.DocumentSymbol[] = [];
        for (const item of response.body.childItems) {
            TypeScriptDocumentSymbolProvider.convertNavTree(document.uri, result, item);
        }
        return result;
    }

1）不会想到：private readonly 这些字段的功能，不会纳入类设计
2）不会想到泛型的利用

private readonly cachedResponse: CachedResponse<Proto.NavTreeResponse>

3）比如这个参数：是有固定的类依据，如果是我的话，会可能直接想到传输string或者number这样的初级的类型：这些优秀的软件工程师为何就能思考到使用document: vscode.TextDocument 这样的高级参数呢？

public async provideDocumentSymbols(document: vscode.TextDocument, token: vscode.CancellationToken)

4）比如返回的这个值，是这样，我看都看不懂，他们是基于什么来进行设计的呢？是在设计的时候就想要一个什么样的形式结果（eg. : Promise<vscode.DocumentSymbol[] | undefined>）再进行设计的是吗？

: Promise<vscode.DocumentSymbol[] | undefined>

Answer 1

没有写过什么牛��的东西。以我写业务代码的经验来看，优秀的设计来自以下几个方面：
1，重复的思考和迭代。对着一个功能、一段逻辑，思考的多了，自然有成长。
2，模仿他人的写法，学习一些最佳实践
3，悟性

以上要素按重要性排序。

好的设计不是一蹴而就的，一开始可能只是勉强实现功能，在不断的迭代中去优化，慢慢就变成你看到的样子。

Answer 2

这是因为 VSCode 的总负责人兼设计师 Erich Gamma, 是《设计模式：可服用面向对象软件基础》的四人帮之一，目前我们看到的各种设计模式的理论基础都由此书奠定。此外，Erich Gamma 还参与设计了 Eclipse（另一款知名的编辑器）。除负责人外的其它核心成员也有丰富的编辑器开发经验，平均年龄40+。新成员也是开源社区知名插件的开发者。

而对于我们这些没有优秀设计能力的开发者，可以先提高抽象能力，抽象的多了，自然也知道应该如何设计了。

项目刚开始的时候功能比较简单，只有简单几个类。

但是随着项目的进行，功能越来越多，代码越来越复杂，这时候就会将重复的功能抽象出来作为公共基类，让其它类继承它。

项目继续发展，只继承一次也不够，就需要增加中间层，编写各种各样的接口和抽象类。

刚开始的时候传递 number/string 就行了，但是随着项目逐渐复杂，已经不能满足需要，就重构成复杂对象，携带足够多的信息，这样才能满足我们的需要。

大型项目也是从小型项目发展而来的。但是当你有了多个主导大型项目的经验，就可以在开始新项目时大概明白项目的发展方向，提前设计和规划。

Answer 3

在面向对象编程中，设计出优秀的项目通常依赖于多方面的因素，包括但不限于设计原则、实践经验、对领域知识的深入理解以及对编程语言和工具的熟练掌握。针对你提到的具体问题和观察，以下是一些可能的解释和建议：

1. 优秀的类设计

• 使用private readonly字段：这表明开发者对类的封装性和不可变性有深入的理解。private确保字段只能在类内部被访问，减少外部对内部状态的直接操作，有助于维护类的封装性。readonly则确保字段一旦被赋值后就不能被修改，这有助于保持对象状态的一致性，减少因误修改导致的问题。
• 接口和继承的使用：接口定义了类必须实现的方法，而继承则允许类复用其他类的代码。这些机制使得代码更加模块化和可维护。在大型项目中，接口和继承的使用有助于构建清晰、灵活的系统架构。

2. 泛型的使用

泛型（如CachedResponse<Proto.NavTreeResponse>）允许开发者编写更加灵活和可重用的代码。通过泛型，开发者可以编写与类型无关的代码，然后在需要时指定具体的类型。这有助于减少代码重复，提高代码的可读性和可维护性。

3. 高级参数和返回类型的选择

• 使用vscode.TextDocument等高级参数：这通常是因为开发者对所使用的库或框架有深入的了解。在Visual Studio Code扩展开发中，vscode.TextDocument是代表文档的标准类型，使用它而不是原始类型（如string）可以提供更多的上下文和功能。
• 返回类型的设计：返回类型（如Promise<vscode.DocumentSymbol[] | undefined>）的选择反映了开发者对异步编程和错误处理的深入理解。使用Promise可以处理异步操作的结果，而vscode.DocumentSymbol[] | undefined则表明操作可能成功返回符号数组，也可能因为某些原因（如文件不存在）而返回undefined。

4. 设计时的考虑

• 结果形式的设计：在设计函数或方法时，开发者通常会考虑其预期用途和调用者的需求。例如，在provideDocumentSymbols方法中，返回Promise<vscode.DocumentSymbol[] | undefined>可能是因为调用者需要异步地获取文档符号，并且需要处理可能找不到符号的情况。
• 基于需求进行设计：优秀的软件工程师在设计代码时会优先考虑系统的需求、用户的期望以及代码的可维护性和可扩展性。他们会从整体架构出发，逐步细化到具体的类和函数设计。

建议

• 深入学习：不断学习和掌握编程语言、框架和工具的新特性和最佳实践。
• 阅读优秀代码：通过阅读和分析优秀项目的代码，学习其设计思想和实现方式。
• 实践经验：通过实际的项目开发，积累实践经验，不断反思和改进自己的设计。
• 参与社区：参与技术社区，与同行交流和学习，获取更多的灵感和建议。