SafeQL 项目教程

1. 项目的目录结构及介绍

SafeQL 项目的目录结构如下：

SafeQL/
├── docs/
│   ├── project/
│   └── ...
├── src/
│   ├── main/
│   │   ├── scala/
│   │   └── ...
│   └── test/
│       ├── scala/
│       └── ...
├── .gitignore
├── .scala-steward.conf
├── .travis.yml
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── LICENSE
├── README.md
├── build.sbt
└── ...

目录结构介绍

• docs/: 包含项目的文档文件，通常用于存放项目文档和教程。
• src/: 项目的源代码目录，包含主要的代码文件。
  • main/scala/: 存放主要的 Scala 代码文件。
  • test/scala/: 存放测试代码文件。
• .gitignore: Git 忽略文件，用于指定不需要版本控制的文件和目录。
• .scala-steward.conf: Scala Steward 配置文件，用于自动化依赖管理和更新。
• .travis.yml: Travis CI 配置文件，用于持续集成和自动化测试。
• CHANGELOG.md: 项目变更日志，记录项目的版本更新和变更内容。
• CODE_OF_CONDUCT.md: 项目的行为准则，规定了项目参与者的行为规范。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的介绍文件，通常包含项目的概述、安装和使用说明。
• build.sbt: 项目的 SBT 构建配置文件。

2. 项目的启动文件介绍

SafeQL 项目的启动文件通常位于 src/main/scala/ 目录下。具体启动文件的名称和路径可能因项目的具体实现而有所不同。以下是一个示例启动文件的介绍：

// src/main/scala/com/company/db/Main.scala

package com.company.db

import fr.loicknuchel.safeql.gen.Generator
import fr.loicknuchel.safeql.gen.writer.ScalaWriter

object Main {
  def main(args: Array[String]): Unit = {
    // 生成数据库表类
    Generator.flyway("classpath:sql_migrations")
      .writer(ScalaWriter(packageName = "com.company.db"))
      .generate()
      .unsafeRunSync()

    // 执行查询
    USERS.insert.values(UserId(4), "Lou", "[e-mail]").run(xa).unsafeRunSync()
    USERS.update.set(_.NAME, "LouLou").set(_.EMAIL, "[e-mail]").where(_.ID is UserId(4)).run(xa).unsafeRunSync()
  }
}

启动文件介绍

• Main.scala: 项目的启动文件，包含主要的业务逻辑和数据库操作。
• Generator: 用于生成数据库表类的工具。
• ScalaWriter: 用于将生成的表类写入指定包路径。
• USERS: 生成的数据库表类，用于执行 SQL 查询。

3. 项目的配置文件介绍

SafeQL 项目的配置文件主要包括 build.sbt 和 .travis.yml。以下是这两个配置文件的介绍：

build.sbt

// build.sbt

name := "SafeQL"

version := "0.1.3"

scalaVersion := "2.12.10"

libraryDependencies += "fr.loicknuchel" %% "safeql" % "0.1.3"

配置文件介绍

• name: 项目的名称。
• version: 项目的版本号。
• scalaVersion: 项目使用的 Scala 版本。
• libraryDependencies: 项目的依赖库配置，指定 SafeQL 库的版本。

.travis.yml

# .travis.yml

language: scala

scala:
  - 2.12.10

script:
  - sbt test

配置文件介绍

• language: 指定项目使用的编程语言。
• scala: 指定项目使用的 Scala 版本。
• script: 指定 Travis CI 执行的脚本，通常用于运行测试。

通过以上配置文件，可以确保项目在开发和测试过程中的一致性和自动化。