Delphi-Neon 项目教程

Delphi-Neon 项目教程

1. 项目目录结构及介绍

Delphi-Neon 项目的目录结构如下：

delphi-neon/
├── Demos/
│   ├── Neon Main Demo/
│   └── Neon Benchmarks Demo/
├── Packages/
├── Source/
│   ├── Neon.Core/
│   ├── Neon.Serializers/
│   ├── Neon.Tests/
│   └── Neon.Utils/
├── Tests/
├── .gitattributes
├── .gitignore
├── LICENSE
├── README.md
└── boss-lock.json

目录介绍

• Demos/: 包含两个演示项目，分别是 Neon Main Demo 和 Neon Benchmarks Demo。这些演示项目展示了如何使用 Neon 进行对象的序列化和反序列化。
• Packages/: 包含项目的包文件。
• Source/: 项目的核心源代码目录，包含以下子目录：
  • Neon.Core/: 包含 Neon 的核心功能实现。
  • Neon.Serializers/: 包含自定义序列化器的实现。
  • Neon.Tests/: 包含项目的单元测试代码。
  • Neon.Utils/: 包含一些实用工具类。
• Tests/: 包含项目的测试代码。
• .gitattributes: Git 属性文件，用于指定文件的属性。
• .gitignore: Git 忽略文件，指定哪些文件或目录不需要被 Git 管理。
• LICENSE: 项目的开源许可证文件，采用 Apache-2.0 许可证。
• README.md: 项目的说明文档，包含项目的介绍、使用方法和配置信息。
• boss-lock.json: 项目的依赖管理文件。

2. 项目启动文件介绍

Delphi-Neon 项目没有明确的“启动文件”，因为它是一个库项目，而不是一个独立的应用程序。然而，如果你要运行演示项目，可以参考以下步骤：

1. 打开 Delphi IDE：启动 Delphi 集成开发环境（IDE）。
2. 打开演示项目：在 Demos/ 目录下选择一个演示项目，例如 Neon Main Demo，双击打开项目文件（通常是 .dproj 文件）。
3. 编译并运行：在 Delphi IDE 中，点击 Run 按钮（或按 F9 键）来编译并运行演示项目。

3. 项目的配置文件介绍

Delphi-Neon 项目的配置主要通过代码进行，而不是通过配置文件。以下是一些主要的配置选项：

配置示例

var
  LConfig: INeonConfiguration;
begin
  LConfig := TNeonConfiguration.Default
    .SetMemberCase(TNeonCase.SnakeCase) // 设置成员大小写为 snake_case
    .SetMembers(TNeonMembers.Properties) // 设置成员类型为属性
    .SetIgnoreFieldPrefix(True) // 忽略字段前缀 "F"
    .SetVisibility([mvPublic, mvPublished]); // 设置可见性为公共和发布

  // 自定义序列化器注册
  LConfig.GetSerializers.RegisterSerializer(TGUIDSerializer);
end;

配置选项说明

• SetMemberCase: 设置成员的大小写格式，支持 Unchanged, UPPERCASE, lowercase, PascalCase, camelCase, snake_case。
• SetMembers: 设置要序列化的成员类型，支持 Fields 和 Properties。
• SetIgnoreFieldPrefix: 设置是否忽略字段前缀 "F"。
• SetVisibility: 设置成员的可见性，支持 private, protected, public, published。
• RegisterSerializer: 注册自定义的序列化器。

通过这些配置选项，你可以根据项目需求自定义 Neon 的序列化和反序列化行为。