Freezolite 使用教程

Freezolite 使用教程

freezolite Automatically add frozen_string_literals to selected files at compile time 项目地址: https://gitcode.com/gh_mirrors/fr/freezolite

1. 项目介绍

Freezolite 是一个 Ruby 的 gem，旨在自动为指定的文件添加 frozen_string_literal 编译选项。通过使用 Freezolite，开发者可以在不全局启用该选项的情况下，为项目中的特定文件启用字符串冻结功能。这类似于在运行 Ruby 时使用 --enable=frozen-string-literal 选项，但仅限于指定的文件。

Freezolite 还支持实验性的常量冻结功能，可以自动注入 shareable_constant_value 编译指令，以便在 Ractor 驱动的应用程序中轻松将常量转换为 Ractor 可共享的对象。

2. 项目快速启动

安装

首先，将 Freezolite 添加到你的 Gemfile 中：

gem "freezolite"

然后运行 bundle install 安装 gem。

配置

在你的应用程序入口文件中，例如 Rails 项目中的 config/application.rb，在加载依赖项之后和加载应用程序代码之前，添加以下代码：

# config/application.rb
Bundler.require(*Rails.groups)
require "freezolite/auto"
# <application configuration>

默认情况下，Freezolite 使用 Dir.pwd 来确定项目根目录。如果你想使用不同的目录或多个目录，可以手动配置：

require "freezolite"
Freezolite.setup(
  patterns: ["/path/to/dir1/*.rb", "/path/to/dir2/*.rb"],
  exclude_patterns: ["/path/to/dir1/vendor/*"]
)

使用 Bootsnap

Freezolite 与 Bootsnap 兼容。只需确保在 Bootsnap 之后加载 Freezolite，无需手动进行缓存失效。

冻结常量

如果你想启用常量冻结功能，可以进行如下配置：

require "freezolite"
Freezolite.experimental_freeze_constants = true
require "freezolite/auto"

3. 应用案例和最佳实践

应用案例

Freezolite 特别适用于以下场景：

• 性能优化：冻结字符串可以减少内存使用并提高性能。
• 代码一致性：确保项目中的字符串在编译时被冻结，避免意外的字符串修改。
• Ractor 应用：在 Ractor 驱动的应用程序中，自动冻结常量以确保线程安全。

最佳实践

• 选择性启用：建议仅在需要性能优化的文件中启用 frozen_string_literal，而不是全局启用。
• 排除第三方代码：在配置时，确保排除第三方库的目录，以避免影响其正常运行。
• 实验性功能谨慎使用：常量冻结功能目前处于实验阶段，建议在了解其影响后再使用。

4. 典型生态项目

Freezolite 可以与以下 Ruby 生态项目结合使用：

• Rails：在 Rails 项目中，Freezolite 可以自动为模型、控制器等文件启用字符串冻结。
• Bootsnap：与 Bootsnap 结合使用，无需担心缓存失效问题。
• RuboCop：Freezolite 可以替代 RuboCop 的 frozen_string_literal 自动修复功能，提供更细粒度的控制。

通过结合这些生态项目，Freezolite 可以进一步提升 Ruby 项目的性能和代码质量。

freezolite Automatically add frozen_string_literals to selected files at compile time 项目地址: https://gitcode.com/gh_mirrors/fr/freezolite