node.js - 如何在带有 NodeJS 目标的 TypeScript 中正确使用模块和接口(interface)？

Question

我和我的团队是 TypeScript 和 NodeJS 的新手，我们在启动这个项目时遇到了一些严重的麻烦。它旨在成为一个用 TypeScript 编写的模块化游戏 Assets 管道，用于与 NodeJS 一起使用(我没有参与这里的决策，讨论仍在进行中，但我们仍然需要一个原型(prototype))。

我们已经对架构有了很好的了解，但即使让原型(prototype)运行起来也有点困难，因为我似乎无法完全理解模块如何与接口(interface)和外部依赖项结合工作。我们的一些组件还需要使用 NodeJS 或其他库模块(例如用于读取/写入文件的 NodeJS.fs)，我们更希望能够使用 ///reference 添加适当的d.ts 文件以在开发时保持类型安全。

假设的项目结构的一个例子是:

/pipeline
    /log
        - ILog.d.ts
        - StdOutLog.ts
        - FileLog.ts
        - ...
    /reader
        - IReader.d.ts
        - TextReader.ts
        - ...
    /parser
        - IParser.d.ts
        - XmlParser.ts
        - JsonParser.ts
        - ...
    /task
        - ITask.d.ts
        - JsTask.ts
        - CliTask.ts
        - ...
    /...

我们想要使用它的方式是为我们的接口(interface)提供默认实现(以涵盖基础知识，例如运行控制台命令、记录到文件或流、读取 JSON 和 XML 配置，...)，以及接口(interface)本身，以便其他团队可以创建自己的扩展(例如 class GitTask extends CliTask 以封装存储库操作，或 class JpgReader implements IReader)。

在调用方，在不同的项目/运行器应用程序中，它应该像这样工作:

import pipeline = require('pipeline');

//...

var log = new pipeline.log.FileLog();
log.info("filelog started");

var parser = new pipeline.parser.XmlParser();
parser.parse(somexmldata);
log.info("parsing XML");

// ...

我很可能只是做错了 (tm)，但我觉得用 TypeScript 做我们想做的事情并不容易，尤其是考虑到例如日志组件的定义可以轻松地具有多个接口(interface)和枚举(工厂、记录器、logitem、logtarget、loglevel)。据我了解，NodeJS 模块需要是单个 JS 文件，但即使使用单个 import 也会将您的模块转换为外部模块，而这些模块将不再编译为单个文件，因此对我来说，这似乎是一个非常陡峭的障碍。

有没有办法实现针对 NodeJS 的 TypeScript 的结构和预期用途？如果是，文件需要看起来像什么(特别是关于模块层次结构和组件 FQN，例如 pipeline.log.X、pipeline.task.Y 等；我将如何正确使用 module 和export )？如果不是，有哪些合适的替代方案可以实现我们的目标？

---

[更新] 我根据basarat的建议重构了我的原型(prototype)，它看起来比以前好多了。但是，我在使用另一个类中的一个类时遇到了编译错误:

error TS2095: Could not find symbol 'LogItem'.

LogItem 是在 /log 中定义的类，它由同一文件夹中的 StdOutLog.ts 使用。 IntelliJ 为它提供了多个定义(显然，一个是 LogItem 类本身，另一个在 /log 的导出索引文件中)。我试过使用模块符号 log.LogItem，但没有用。将所有默认实现文件添加到全局声明文件也不起作用。 [/更新]

[Update2] 下面是关于错误发生位置的更多代码。仅在运行 grunt-ts 任务时，我在 IntelliJ 中没有收到任何错误/标记。

//src/log/LogItem.ts:

///<reference path='../pipeline.d.ts'/>
class LogItem implements ILogItem {
    // ...

    constructor(level:LogLevel, message:string) {
        // ...
    }

    public static create(level:LogLevel, message:string):ILogItem {
        return new LogItem(level, message);
    }

    // ...
}

export = LogItem;

//src/log/Log.ts:

///<reference path='../pipeline.d.ts'/>
class Log implements ILog {
    // ...

    private getLogItem(level:LogLevel, message:string):ILogItem {
        return LogItem.create(level, message); // <-- that's where I get the "symbol not found" error
    }

    // ...
}

export = Log;

//src/pipeline.d.ts:

///<reference path="../typings/node/node.d.ts" />

//grunt-start
/// <reference path="pipeline.ts" />
/// <reference path="log/Log.ts" />
/// <reference path="log/LogFactory.ts" />
/// <reference path="log/LogItem.ts" />
/// <reference path="log/StdLogEmitter.ts" />
/// <reference path="log/log.d.ts" />
/// <reference path="log/log.ts" />
/// <reference path="parser/JsonParser.ts" />
/// <reference path="parser/parser.d.ts" />
/// <reference path="parser/parser.ts" />
//grunt-end

[/Update2]

Answer 1

引用你所有的.d.ts全局文件 globals.d.ts具有 ///<reference 的文件所有个人引用的标签 + vendor.d.ts (例如 node.d.ts )文件。

/pipeline
    /globals.d.ts
    /log
        - ILog.d.ts
        - StdOutLog.ts
        - FileLog.ts
        - ...
    /reader
        - IReader.d.ts
        - TextReader.ts
        - ...
    /parser
        - IParser.d.ts
        - XmlParser.ts
        - JsonParser.ts
        - ...
    /task
        - ITask.d.ts
        - JsTask.ts
        - CliTask.ts
        - ...
    /...

这可以防止您不断引用 .d.ts文件。

现在每个 typescript 文件都会导出一些类，例如XmlParser.ts :

/// <reference path='../globals.d.ts'/>
class XMLParser implements IParser{
}
export = XMLParser;

每个文件夹还有一个 index.ts导入和导出该文件夹中的所有类外部模块样式:

export import XmlParser = require('./xmlParser'); 
// so on 

上一级(pipeline/index.ts)相同:

export import parser = require('./parser/index');

现在，如果您导入 pipeline/index.ts，您的代码将按预期工作:

import pipeline = require('./pipeline/index');


var parser = new pipeline.parser.XmlParser();
parser.parse(somexmldata);
log.info("parsing XML");

注意:Grunt-ts 可以创建这些 import/export声明，这样您就不必担心文件路径:https://github.com/grunt-ts/grunt-ts/issues/85