Crnk Framework 使用手册

Crank Framework 是一个基于Java实现的JSON API规范库，它旨在简化RESTful应用程序的开发。此框架提供了许多约定和构建块，帮助开发者更高效地构建符合JSON API标准的服务。本手册将引导您了解其基本结构、启动流程以及关键的配置信息。

1. 项目目录结构及介绍

Crank Framework 的项目结构精心设计，以支持模块化和易于扩展：

• crnk-core: 核心模块，包含了JSON API规范的核心实现。
• crnk-data: 数据访问层相关，支持JPA和其他数据源集成。
• crnk-format-plain-json: 支持简单的JSON格式处理。
• crnk-client: 客户端库，方便与JSON API服务交互。
• crnk-validation: 集成Bean Validation进行数据验证。
• crnk-setup-spring-boot2: 提供Spring Boot 2的快速集成方案。
• crnk-ui: 前端UI组件，用于构建管理界面。
• crnk-test, crnk-testkit: 测试工具和支持。
• docs: 文档相关的资源。
• gradle.properties, settings.gradle: 构建系统配置。
• build.gradle: 主要的Gradle构建脚本。
• LICENSE, README.md: 许可证和快速入门指南。

每个模块都有其特定的职责，允许开发者按需引入功能。

2. 项目的启动文件介绍

对于一个基于Crank Framework的应用程序，启动通常依赖于Spring Boot的入口点。虽然具体的启动类名称可能因应用而异，但在crnk-example或你的项目中寻找名为Application.java或遵循类似命名惯例的类是常见的。例如：

@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

此段代码启动了一个Spring Boot应用程序，Crank Framework通过Spring Boot的自动配置特性无缝集成。

3. 项目的配置文件介绍

application.properties 或 application.yml

在Spring Boot应用中，配置主要位于application.properties或application.yml文件中。对于Crank Framework，你需要关注以下类型的配置项：

• 数据源配置（如果使用JPA）：

  spring.datasource.url=...
  spring.datasource.username=yourUsername
  spring.datasource.password=yourPassword
  

• Crank Framework特有配置： 你可能会添加专门针对Crank的配置，如开启或关闭某些特性，指定API的基本路径等：

  crnk.api.path=/api
  

• 版本控制与依赖管理： 通过BOM（Bill Of Materials）来统一管理Crank及其依赖的版本，在build.gradle中指定：

  implementation platform('io.crnk:crnk-bom:INSERT_VERSION_HERE')
  

确保替换INSERT_VERSION_HERE为你当前想使用的Crank Framework版本。此外，日志级别、数据库连接池配置等也常在此文件内定义。

请注意，实际配置细节应根据项目需求和最新文档调整。务必参考最新的Crank Framework官方文档，因为具体配置项和推荐实践可能会随版本更新而变化。