web-sugar

Syntactic sugar of Tapir for web development with Scala 3.

Target of this project

This project would collect all things we used in the development of web server with Scala 3. The libraries of this project would not treat Performance or Cooperation as first thing, but easily use and write less code.

So instead of using this project as well promised web framework, just treat it as a syntactic sugar wrapper of Scalatra Web Framework. You could copy the codebase everywhere or import this project using git submodule to your project (This is how we used this project).

We recommend you fork this project, and change it for your needs.

The dependencies the project used

DB

We choose Postgres for its wonderful complex index support, like array/bson/geo. scalikejdbc-ORM is used as ORM. Flyway is used as database migration tool.

Code Generate From Database

This has some bugs to fix. very.util.persistence.scalikejdbc.mapper is from scalikejdbc official code source. We rewrite it to match our own needs.

import com.typesafe.config.ConfigFactory
import very.util.persistence.scalikejdbc.mapper.{Model, CodeGenerator, DateTimeClass, GeneratorConfig}


object DatabaseInit {
  def main(args:Array[String]):Unit = {
    val config = ConfigFactory.load()
    val url = config.getString("db.default.url")
    val username = config.getString("db.default.user")
    val password = config.getString("db.default.password")
    val driver = config.getString("db.default.driver")
    Class.forName(driver)

    val model = Model(url, username, password)

    val generatorConfig = GeneratorConfig(
      packageName = "com.timzaak.entity",
      dateTimeClass = DateTimeClass.OffsetDateTime,
      daoExtendImport = Some("very.util.persistence.scalikejdbc.Dao")
    )
    // where table to generate
    val tables = Map(
//      "consignor"-> "Consignor",
//      "fee_config" -> "FeeConfig",
    )
    model.allTables("public").foreach { table =>
      if (tables.contains(table.name)) {
        new CodeGenerator(table, None)(generatorConfig.copy(tableNameToClassName = (a:String)=> tables(a))).writeModel()
      }
    }
  }
}

Web Framework: Tapir with Netty

We have switched from Scalatra, for it has no well mixed Swagger, OpenTelemetry, zio-json(Swagger With json4s、metrics is Ok).

Http Client: sttp

We used scalaj-http at Scala 2, but it's archived now. So we switch to sttp which provide wrapper of HttpClient, It also has very useful plugins.

Json: circe

Both zio-json and circe is ok, they all support Scala 3 well(except enum). But zio-json need more template code.

GRPC: ScalaPB

There's no alternative choose of GRPC at Scala world. and we choose Netty runtime of GRPC.

Others:

Typesafe Config

Scala world love typesafe config, others not.

Documentation

We provide startup template for this project.

What's more

Sometimes we would rewrite the codebase if it could not support our projects, just like switch Scalatra to Playframework for Async. So we could not promise this project would be long term support.

License

Apache License 2.0