如何为Ruby on Rails类优雅、简洁且通用地创建专属日志记录器？

针对大型Rails项目中零散添加日志导致的代码冗余问题，以下几种通用方案可以帮你优雅实现类专属日志记录器：

1. 用Mixin模块封装通用日志逻辑 #

最简洁的方式是把日志初始化逻辑封装成可复用模块，需要的类只需include即可获得专属日志器，彻底告别复制粘贴：

# app/logging/class_logger.rb
module ClassLogger
  def logger
    @logger ||= begin
      log_file = Rails.root.join('log', "#{self.class.name.underscore}.log")
      logger_instance = ActiveSupport::Logger.new(log_file, shift_age: 'daily') # 启用每日轮转
      logger_instance.level = Rails.env.production? ? Logger::INFO : Logger::DEBUG
      logger_instance.formatter = proc do |severity, timestamp, _, msg|
        "[#{timestamp.strftime('%Y-%m-%d %H:%M:%S')}] #{severity.ljust(5)} [#{self.class.name}] #{msg}\n"
      end
      logger_instance
    end
  end
end

在业务类中使用：

class OrderProcessingService
  include ClassLogger

  def execute(order_id)
    logger.info("开始处理订单 #{order_id}")
    # 业务逻辑...
    logger.error("订单 #{order_id} 处理失败: #{e.message}") rescue nil
  end
end

2. 基于TaggedLogging实现统一日志中的类标记 #

如果不想维护多份日志文件，可利用Rails内置的ActiveSupport::TaggedLogging，在主日志中添加类名标签，方便快速筛选：

# app/logging/tagged_class_logger.rb
module TaggedClassLogger
  def logger
    @logger ||= ActiveSupport::TaggedLogging.new(Rails.logger).tagged(self.class.name)
  end
end

使用后日志会自动带上类名标签：

[2024-05-20 14:30:00] INFO [OrderProcessingService] 开始处理订单 12345

3. 支持自定义配置的灵活日志模块 #

如果需要部分类指定特殊日志文件或格式，可以给模块添加类级配置：

# app/logging/configurable_logger.rb
module ConfigurableLogger
  def self.included(base)
    base.extend(ClassMethods)
  end

  module ClassMethods
    def log_to(filename)
      @custom_log_file = filename
    end

    def log_level(level)
      @custom_log_level = level
    end
  end

  def logger
    @logger ||= begin
      log_file = self.class.instance_variable_get(:@custom_log_file) || "#{self.class.name.underscore}.log"
      log_level = self.class.instance_variable_get(:@custom_log_level) || (Rails.env.production? ? Logger::INFO : Logger::DEBUG)
      
      logger_instance = ActiveSupport::Logger.new(Rails.root.join('log', log_file), shift_age: 7) # 保留7天日志
      logger_instance.level = log_level
      logger_instance.formatter = proc do |severity, timestamp, _, msg|
        "[#{timestamp}] #{severity} [#{self.class.name}] #{msg}\n"
      end
      logger_instance
    end
  end
end

自定义配置示例：

class PaymentGatewayClient
  include ConfigurableLogger
  log_to 'payment_gateway.log'
  log_level Logger::WARN # 生产环境仅输出警告及以上日志

  def charge(amount)
    logger.warn("支付金额超过阈值: #{amount}") if amount > 10000
    # 支付逻辑...
  end
end

最佳实践 #

• 统一格式化：确保所有日志器使用相同的时间格式、字段结构，便于后续用日志分析工具解析
• 避免重复初始化：用@logger ||= 确保每个类只创建一次日志实例，减少性能开销
• 日志轮转：生产环境务必启用日志轮转，防止单个日志文件过大占用磁盘空间
• 环境适配：根据Rails环境动态调整日志级别，开发环境输出debug信息，生产环境仅保留info及以上级别

内容的提问来源于stack exchange，提问作者Slth