如何创建通用Ruby函数供所有应用调用及Rails共享日志配置

一、存放位置选择 #

1. 系统级共享目录 #

推荐放在服务器上的固定共享目录，比如/opt/rails_shared/或者/usr/local/share/rails_common/。这类路径不受单个应用位置影响，所有Rails应用都能稳定访问，适合不需要频繁更新的通用函数。

2. Git托管独立仓库 #

如果需要版本管理和便捷更新，可以把审计日志函数所在的lib目录做成独立Git仓库。每个应用通过Git submodule将仓库拉取到本地指定路径（比如vendor/shared_libs/），这样既能共享代码，又能灵活控制版本。

二、调用方法 #

1. 绝对路径直接Require #

最稳妥的方式是用绝对路径引入文件，避免相对路径的不确定性：

# 在应用的config/application.rb或config/initializers/audit_logger.rb中添加
require '/opt/rails_shared/audit_logger.rb'

2. 基于应用根目录的相对路径引用 #

如果用Git submodule拉取到应用内的子目录，比如vendor/shared_libs/，可以通过Rails根路径构建相对路径，确保引用稳定：

# 在需要引入的文件中
require Rails.root.join('vendor', 'shared_libs', 'audit_logger.rb').to_s

3. 加入Ruby加载路径（LOAD_PATH） #

把共享目录加入Ruby的$LOAD_PATH，之后直接require文件名即可：

# 在config/application.rb中添加
$LOAD_PATH.unshift('/opt/rails_shared')

# 之后在任意文件中直接调用
require 'audit_logger'

4. 封装模块后Include使用 #

如果把日志逻辑封装成Ruby模块，还能直接在控制器/模型中引入使用：

# 共享文件/opt/rails_shared/audit_logger.rb内容
module AuditLogger
  def log_audit(action, user, details)
    # 示例：写入系统审计日志
    File.open('/var/log/rails_combined_audit.log', 'a') do |f|
      f.puts "#{Time.now.utc} | #{action} | User: #{user&.id || 'anonymous'} | #{details}"
    end
  end
end

在应用的控制器中引入：

require '/opt/rails_shared/audit_logger.rb'

class ApplicationController < ActionController::Base
  include AuditLogger

  # 业务代码中直接调用
  def some_action
    log_audit('update_profile', current_user, params.slice(:name, :email))
    # ...其他逻辑
  end
end

三、注意事项 #

• 权限配置：确保共享目录和日志文件的权限允许所有Rails应用的运行用户（如www-data）读写，避免权限报错。
• 日志轮转：如果多应用共享单个日志文件，建议配置logrotate工具定期切割日志，防止文件过大。
• 版本同步：用Git托管时，要保证各应用使用的共享代码版本一致，避免兼容性问题。

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