Question

我的团队和我是TypeScript和NodeJS的新手，我们在实施这个项目时遇到了一些严重的麻烦。它意味着是一个用TypeScript编写的模块化游戏资产管道，用于NodeJS（我在这里没有参与决策，讨论仍在进行中，但我们仍然需要一个原型）。

我们已经很好地了解了这个架构，但是有点难以让原型运行起来，因为我似乎无法理解模块如何与之结合使用接口和外部依赖。我们的一些组件还需要使用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
        - ...
    /...

我们想要使用它的方式是我们为接口提供默认实现（以涵盖基础知识，例如运行控制台命令，记录到文件或流，读取JSON和XML配置，......），以及接口本身，以便其他团队可以创建自己的扩展（例如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做我们想做的事情并不容易，特别是考虑到这一点。日志组件的定义可以很容易地有几个接口和枚举（工厂，记录器，logitem，logtarget，loglevel）。据我所知，NodeJS模块需要是一个单独的JS文件，但是甚至使用一个import将您的模块转换为外部模块，而那些不再编译成单个文件，所以这似乎对我来说是一个非常陡峭的障碍。

有没有办法通过TypeScript定位NodeJS来实现结构和预期用途？如果是，那么文件需要看起来像什么（特别是关于模块层次结构和组件FQN，例如pipeline.log.X，pipeline.task.Y等;我将如何正确使用module和{{1 }} 为了它）？如果不是，有什么方法可以实现我们的目标？

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

export

error TS2095: Could not find symbol 'LogItem'.是LogItem中定义的类，/log在同一文件夹中使用该类。 IntelliJ为我提供了多个定义（很明显，一个是StdOutLog.ts类本身，另一个是LogItem索引文件中的导出文件。我尝试过使用模块符号/log，但这并没有奏效。将所有默认实现文件添加到全局声明文件中也不起作用。的 [/更新]

[Update2] 这里有更多关于错误发生位置的代码。只有在运行grunt-ts任务时，才能在IntelliJ中获得任何错误/标记。

// src / log / LogItem.ts：

log.LogItem

// src / log / Log.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 / pipeline.d.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;

[/ 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个文件。

现在每个打字稿文件都会输出一些类，例如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');

现在，如果您导入管道/ 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

如何在TypeScript中使用NodeJS目标正确使用模块和接口？

1 个答案: