Zstd-JNI 项目使用教程

1. 项目目录结构及介绍

Zstd-JNI 项目的目录结构如下：

zstd-jni/
├── gradle/
│   └── wrapper/
├── jni/
├── project/
├── sbt-java-module-info/
├── src/
│   ├── main/
│   └── test/
├── .gitignore
├── CMakeLists.txt
├── LICENSE
├── README.md
├── build.gradle
├── build.sbt
├── codecov.yml
├── libzstd-jni.so.exported
├── libzstd-jni.so.map
├── make_so.sh
├── make_so_cross.sh
├── make_so_cross_buster.sh
├── sbt
└── version

目录结构介绍

• gradle/wrapper/: 包含 Gradle 包装器的配置文件。
• jni/: 包含 JNI (Java Native Interface) 相关的文件。
• project/: 包含项目构建和配置文件。
• sbt-java-module-info/: 包含 SBT (Simple Build Tool) 的 Java 模块信息。
• src/: 包含项目的源代码，分为 main/ 和 test/ 两个子目录。
• .gitignore: Git 忽略文件配置。
• CMakeLists.txt: CMake 构建配置文件。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• build.gradle: Gradle 构建配置文件。
• build.sbt: SBT 构建配置文件。
• codecov.yml: Codecov 配置文件。
• libzstd-jni.so.exported: 导出的共享库文件。
• libzstd-jni.so.map: 共享库映射文件。
• make_so.sh: 生成共享库的脚本。
• make_so_cross.sh: 跨平台生成共享库的脚本。
• make_so_cross_buster.sh: 针对 Buster 版本的跨平台生成共享库的脚本。
• sbt: SBT 启动脚本。
• version: 版本文件。

2. 项目启动文件介绍

Zstd-JNI 项目的启动文件主要是 sbt 脚本。该脚本用于启动 SBT 构建工具，执行项目的编译、测试和打包等操作。

启动步骤

1. 打开终端或命令行工具。

2. 导航到项目根目录。

3. 运行以下命令启动 SBT：

   ./sbt
   

4. 在 SBT 控制台中，可以执行各种构建任务，例如编译 (compile)、测试 (test) 和打包 (package)。

3. 项目配置文件介绍

Zstd-JNI 项目的主要配置文件包括 build.gradle 和 build.sbt。

build.gradle

build.gradle 是 Gradle 构建工具的配置文件，用于定义项目的依赖、任务和插件等。以下是该文件的部分内容示例：

plugins {
    id 'java'
}

repositories {
    mavenCentral()
}

dependencies {
    implementation 'com.github.luben:zstd-jni:VERSION'
    testImplementation 'org.scalatest:scalatest_2.13:3.2.0'
}

build.sbt

build.sbt 是 SBT 构建工具的配置文件，用于定义项目的依赖、任务和插件等。以下是该文件的部分内容示例：

name := "zstd-jni"

version := "1.5.0"

scalaVersion := "2.13.4"

libraryDependencies += "org.scalatest" %% "scalatest" % "3.2.0" % Test

其他配置文件

• CMakeLists.txt: 用于 CMake 构建工具的配置文件。
• codecov.yml: 用于 Codecov 代码覆盖率工具的配置文件。
• version: 定义项目的版本号。

通过这些配置文件，可以对 Zstd-JNI 项目进行构建、测试和打包等操作。