Concerning 开源项目教程

Concerning 开源项目教程

concerningBite-sized separation of concerns项目地址:https://gitcode.com/gh_mirrors/co/concerning

---

项目介绍

Concerning 是一个基于 Ruby 的 gem，由 Basecamp 开发并维护，旨在提供一种优雅的方式来组织 Ruby 类中的关注点（或称为横切关注点）。它允许开发者通过模块化的方式管理类的行为，将类中相关的功能划分到单独的模块里，从而提高代码的可读性和可维护性。这尤其适用于那些需要跨多个类共享行为的情况，比如权限控制、状态管理等。

---

项目快速启动

安装

首先，确保你的环境中已经安装了 Ruby 和 bundler。然后，在你的项目目录下添加以下行到 Gemfile：

gem 'concerning'

紧接着，执行 bundler 来安装 gem：

bundle install

使用示例

在你的 Ruby 类中使用 Concerning，首先创建一个新的关心点模块：

# app/models/concerns/my_concern.rb
module MyConcern
  extend ActiveSupport::Concern

  included do
    # 在这里定义实例方法
    def greet
      puts "Hello, World!"
    end
  end

  module ClassMethods
    # 在这里定义类方法
    def say_hello
      puts "Class says Hi!"
    end
  end
end

然后，在需要的地方引入这个关心点：

# app/models/user.rb
class User < ApplicationRecord
  include MyConcern
end

现在，你可以这样调用方法：

user = User.first
user.greet     # 输出: Hello, World!
User.say_hello # 输出: Class says Hi!

---

应用案例和最佳实践

使用 Concerning 的最佳实践通常涉及：

1. 职责明确：每个关心点模块只负责一类特定的行为。
2. 减少重复：当多个模型需要相同的行为时，使用关心点来避免代码重复。
3. 测试独立：确保每个关心点都有其对应的测试，以便于验证其正确性且易于维护。
4. 清晰命名：关心点模块应该根据它们处理的功能进行明确命名，例如 Authorization 或 Logging.

---

典型生态项目

虽然 Concerning 是一个相对简单的 gem，专注于单一的代码组织模式，但它紧密集成在 Ruby on Rails 生态系统内。在 Rails 应用中，你经常会看到它与 Active Record 模型一同使用，用于数据模型的扩展，比如权限控制、日志记录、状态机实现等。此外，结合其他如 ActiveModel, ActiveSupport 等库，可以进一步增强模块化和复用能力。

由于 Concerning 直接面向的是 Ruby 社区尤其是 Rails 开发者，它的生态更多体现在实际应用项目中而非独立的生态系统项目上。开发过程中，合理利用此 gem 结合其他社区的最佳实践和模式，能够显著提升项目结构的整洁度和可维护性。

---

这个教程简单介绍了如何使用 Concerning gem，以及一些基本的应用场景。希望对你在组织和扩展 Ruby 类的时候有所帮助。记得实践是最好的老师，不断尝试和调整以适应你的具体需求。

concerningBite-sized separation of concerns项目地址:https://gitcode.com/gh_mirrors/co/concerning