Scala-TS 使用教程

Scala-TS 使用教程

scala-ts:wrench: Scala datamodel transpiler项目地址:https://gitcode.com/gh_mirrors/sc/scala-ts

项目介绍

Scala-TS 是一个将 Scala 数据模型转换为 TypeScript 类型的工具，旨在简化 RESTful Scala 后端与 TypeScript 前端之间的集成。通过 Scala-TS，开发者可以轻松地在后端定义数据模型，并自动生成前端可用的 TypeScript 接口和类型定义。

项目快速启动

安装

Scala-TS 可以通过 SBT 插件或 Scala 编译器插件进行安装和使用。以下是通过 SBT 插件的安装步骤：

1. 在 project/plugins.sbt 文件中添加以下内容：

   addSbtPlugin("io.github.scala-ts" % "sbt-scala-ts" % "0.5.19")
   

2. 在项目中启用插件：

   enablePlugins(ScalatsGeneratorPlugin)
   

使用

假设我们有一个 Scala 数据模型如下：

package scalats

case class Incident(id: String, message: String)

在 SBT 中运行 sbt compile 命令后，Scala-TS 会自动生成对应的 TypeScript 接口：

export interface Incident {
  id: string;
  message: string;
}

应用案例和最佳实践

案例一：Akka HTTP 与 TypeScript Svelte 前端集成

假设我们有一个 Akka HTTP 后端和一个 TypeScript Svelte 前端，我们可以使用 Scala-TS 来共享数据模型。

1. 在 Scala 后端定义数据模型：

   package scalats
   
   case class User(id: String, name: String)
   

2. 使用 Scala-TS 生成 TypeScript 接口：

   export interface User {
     id: string;
     name: string;
   }
   

3. 在前端 Svelte 项目中使用生成的 TypeScript 接口：

   import type { User } from './generated/User';
   
   async function fetchUser(): Promise<User> {
     const response = await fetch('/api/user');
     return response.json();
   }
   

最佳实践

• 保持数据模型的一致性：确保后端和前端的数据模型保持一致，避免类型不匹配的问题。
• 自动化生成：利用 SBT 插件自动生成 TypeScript 接口，减少手动编写的工作量。
• 版本控制：将生成的 TypeScript 文件纳入版本控制，确保团队成员使用相同的接口定义。

典型生态项目

idonttrustlikethat

idonttrustlikethat 是一个 SBT 插件扩展，可以与 Scala-TS 结合使用，生成 TypeScript 的验证器和派生类型。

1. 在 project/plugins.sbt 文件中添加以下内容：

   addSbtPlugin("io.github.scala-ts" % "sbt-scala-ts-idtlt" % "0.5.19")
   

2. 在项目中启用插件：

   enablePlugins(ScalatsIdtltPlugin)
   

3. 示例：

   package scalats.idtlt
   
   import java.time.LocalDate
   
   case class Bar(name: String, age: Int, amount: Option[BigInt], updated: LocalDate, created: LocalDate)
   

   生成的 TypeScript 验证器和类型：

   import * as idtlt from 'idonttrustlikethat';
   
   export const idtltBar = idtlt.object({
     created: idtlt.isoDate,
     updated: idtlt.isoDate,
     amount: idtlt.number.optional(),
     age: idtlt.number,
     name: idtlt.string
   });
   
   export type Bar = typeof idtltBar.T;
   

通过结合 Scala-TS 和 idonttrustlikethat，可以进一步提升前端数据验证的可靠性和开发效率。

scala-ts:wrench: Scala datamodel transpiler项目地址:https://gitcode.com/gh_mirrors/sc/scala-ts