Angular 6打字稿与KotlinJs的集成

时间:2018-09-27 05:04:40

标签: javascript angular typescript kotlin requirejs

我刚刚设法将Kotlin编译的javascript模块导入一个有角度的6个打字稿文件中。这并不容易,结果使我感到困惑。我想知道是否存在更优雅的方式。

最初我带了一个Kotlin文件:

package com.example.test

data class SomeInterface(
    var id: String? = null,
    var value: String? = null
) {
}

它可以很好地编译为以下JavaScript

(function (root, factory) {
  if (typeof define === 'function' && define.amd)
    define(['exports', 'kotlin'], factory);
  else if (typeof exports === 'object')
    factory(module.exports, require('kotlin'));
  else {
    if (typeof kotlin === 'undefined') {
      throw new Error("Error loading module 'TestKotlinCompiled'. Its dependency 'kotlin' was not found. Please, check whether 'kotlin' is loaded prior to 'TestKotlinCompiled'.");
    }
    root.TestKotlinCompiled = factory(typeof TestKotlinCompiled === 'undefined' ? {} : TestKotlinCompiled, kotlin);
  }
}(this, function (_, Kotlin) {
  'use strict';
  var Kind_CLASS = Kotlin.Kind.CLASS;
  function SomeInterface(id, value) {
    if (id === void 0)
      id = null;
    if (value === void 0)
      value = null;
    this.id = id;
    this.value = value;
  }
  SomeInterface.$metadata$ = {
    kind: Kind_CLASS,
    simpleName: 'SomeInterface',
    interfaces: []
  };
  SomeInterface.prototype.component1 = function () {
    return this.id;
  };
  SomeInterface.prototype.component2 = function () {
    return this.value;
  };
  SomeInterface.prototype.copy_rkkr90$ = function (id, value) {
    return new SomeInterface(id === void 0 ? this.id : id, value === void 0 ? this.value : value);
  };
  SomeInterface.prototype.toString = function () {
    return 'SomeInterface(id=' + Kotlin.toString(this.id) + (', value=' + Kotlin.toString(this.value)) + ')';
  };
  SomeInterface.prototype.hashCode = function () {
    var result = 0;
    result = result * 31 + Kotlin.hashCode(this.id) | 0;
    result = result * 31 + Kotlin.hashCode(this.value) | 0;
    return result;
  };
  SomeInterface.prototype.equals = function (other) {
    return this === other || (other !== null && (typeof other === 'object' && (Object.getPrototypeOf(this) === Object.getPrototypeOf(other) && (Kotlin.equals(this.id, other.id) && Kotlin.equals(this.value, other.value)))));
  };
  var package$com = _.com || (_.com = {});
  var package$example = package$com.example || (package$com.example =     {});
  var package$test = package$example.test || (package$example.test = {});
  package$test.SomeInterface = SomeInterface;
  Kotlin.defineModule('TestKotlinCompiled', _);
  return _;
}));

在package.json中,我将"kotlin": "^1.2.70",添加到依赖项部分。 在角度组件中,我必须使用此类代码进行导入。

import * as TestKotlinCompiled from "../../generated/TestKotlinCompiled";

// @ts-ignore
const SomeInterface = TestKotlinCompiled.com.example.test.SomeInterface;
// @ts-ignore
type SomeInterface = TestKotlinCompiled.com.example.test.SomeInterface;

这是最小强制代码,以使用为模块SomeInterfac生成的包com.example.test中的类TestKotlinCompiled

以下是问题。

// @ts-ignore是必需的,因为ts-comiler在编译时看不到正在导入的模块的内容。

const对于new SomeInterface()是必需的

type对于let x: SomeInterface;是必需的

所有这些看起来都很骇人。 我喜欢更轻松的东西 没有import {SomeInterface} from '../../generated/TestKotlinCompiled' using namespace com.example.testconst的{​​{1}}。 因此,有没有一种方法可以简化我的上述代码?

2 个答案:

答案 0 :(得分:2)

我成功地提高了Angular中KotlinJ的可用性。我将实验放在https://github.com/svok/kotlin-multiplatform-sample

首先,我们必须在Gradle中创建一个多平台子模块。这样,我们生成了js文件(以及其他可能的平台)。

然后我们将其添加到package.json ...

{
  "dependencies": {
    "kotlin": "^1.3.21",
    "proj-common": "file:../build/javascript-compiled"
  }
}

proj-common是我们编译的Kotlin模块。这里是构建kotlin-js文件的路径。

因此,在打字稿中,我们只使用了一个npm模块

import {sample} from 'proj-common/proj-common';

// For class Sample
sample = new sample.Sample();

// For object Platform
platform = sample.Platform;

编译顺利进行,无需使用// @ts-ignore

更新

在上面的解释中,存在从属关系问题。它们没有导出,但是并非所有子依赖项在npm存储库中都有它们的等效项。下面的代码解决了这个问题。

tasks {
    task<Sync>("assembleWeb") {
        val dependencies = configurations.get("jsMainImplementation").map {
            val file = it
            val (tDir, tVer) = "^(.*)-([\\d.]+-\\w+|[\\d.]+)\\.jar$"
                .toRegex()
                .find(file.name)
                ?.groupValues
                ?.drop(1)
                ?: listOf("", "")
            var jsFile: File? = null
            copy {
                from(zipTree(file.absolutePath), {
                    includeEmptyDirs = false
                    include { fileTreeElement ->
                        val path = fileTreeElement.path
                        val res = (path.endsWith(".js") || path.endsWith(".map"))
                                && (path.startsWith("META-INF/resources/") || !path.startsWith("META-INF/"))
                        if (res && path.endsWith(".js") && ! path.endsWith(".meta.js")) jsFile = fileTreeElement.file
                        res
                    }
                })
                into("$npmTarget/$tDir")
            }
            jsFile?.also { packageJson(tDir, it, tVer) }
            tDir to jsFile
        }
            .filter { it.second != null }
            .map { it.first to it.second!! }
            .toMap()

        packageJson(npmDir, File(jsOutputFile), project.version.toString(), dependencies)
        dependsOn("jsMainClasses")
    }

    assemble.get().dependsOn("assembleWeb")
}

fun packageJson(dir: String, jsFile: File, version: String, dependencies: Map<String, File> = emptyMap()) {
    val deps = dependencies.map {
        """"${js2Name(it.value)}": "file:../${it.key}""""
    }.joinToString(",\n            ")
    val text = """
        {
          "name": "${js2Name(jsFile)}",
          "version": "${version}",
          "main": "./${jsFile.name}",
          "dependencies": {
            ${deps}
          }
        }
    """.trimIndent()
    File("$npmTarget/$dir/package.json").apply {
        if (parentFile.exists()) {
            parentFile.delete()
        }
        parentFile.mkdirs()
        writeText(text)
    }
}

fun js2Name(jsFile: File) = jsFile.name.replace("""\.js$""".toRegex(), "")

然后,从前子模块导入:

{
  "dependencies": {
    "proj-common": "file:../build/npm"
  }
}

在打字稿文件中:

import {sample} from 'proj-common';

// For class Sample
sample = new sample.Sample();

// For object Platform
platform = sample.Platform;

示例项目请参见https://github.com/svok/kotlin-multiplatform-sample

更新2

现在,您可以使用kotlin common子项目创建全栈项目,就像在gradle中附加插件一样简单

plugins {
    id("com.crowdproj.plugins.jar2npm")
}

此插件将在编译过程中自动将所有kotlin-js jar包注入到您的node_modules中。

https://github.com/svok/kotlin-multiplatform-sample项目现在已使用此插件重写。请参阅proj-angularfront子模块。

答案 1 :(得分:1)

我也可以解决这种整合, 有许多问题需要克服,即

  • 生成打字稿声明文件
  • 将kotlin JS模块解压缩到node_modules
  • 第三方库

描述问题的博客文章位于https://medium.com/@dr.david.h.akehurst/building-applications-with-kotlin-and-typescript-8a165e76252c

我还创建了一个gradle插件,使这一切变得更加容易, https://github.com/dhakehurst/net.akehurst.kotlin.kt2ts