如何在独立文件中定义Ruby类并将其归入指定模块

完全懂你的痛点！用模块做命名空间隔离是Ruby Gem开发里的必备操作，毕竟谁也不想自己的类名和其他Gem撞车对吧？而且把每个类拆到单独文件里，代码结构会清爽很多，和Java的习惯也对齐。我平时做Gem开发一直这么搞，给你一步步拆解具体怎么做：

第一步：搭建符合规范的目录结构 #

Ruby社区对Gem的目录结构有约定俗成的规范，核心是lib目录要和你的模块名对应。假设你的Gem的根命名空间是MyAwesomeGem，那目录结构应该是这样的：

my_awesome_gem/
├── lib/
│   ├── my_awesome_gem/
│   │   ├── user.rb       # 对应 MyAwesomeGem::User
│   │   ├── post.rb       # 对应 MyAwesomeGem::Post
│   │   └── admin/        # 如果有嵌套命名空间
│   │       ├── dashboard.rb  # 对应 MyAwesomeGem::Admin::Dashboard
│   │       └── admin.rb      # 定义嵌套模块 MyAwesomeGem::Admin
│   └── my_awesome_gem.rb  # Gem的入口文件
└── my_awesome_gem.gemspec

第二步：编写入口文件 #

lib/my_awesome_gem.rb是整个Gem的入口，负责定义根模块并引入所有子文件：

# lib/my_awesome_gem.rb
module MyAwesomeGem
  # 这里可以放模块级的常量、方法，比如版本号
  VERSION = "0.1.0"
end

# 引入各个类文件，用require_relative保证路径正确
require_relative "my_awesome_gem/user"
require_relative "my_awesome_gem/post"
require_relative "my_awesome_gem/admin/admin"
require_relative "my_awesome_gem/admin/dashboard"

第三步：编写独立的类文件 #

每个类文件里，你需要在对应的模块下定义类，比如lib/my_awesome_gem/user.rb：

# lib/my_awesome_gem/user.rb
module MyAwesomeGem
  class User
    attr_reader :name

    def initialize(name)
      @name = name
    end

    def say_hello
      "Hi, I'm #{@name} from MyAwesomeGem!"
    end
  end
end

如果是嵌套命名空间的类，比如MyAwesomeGem::Admin::Dashboard，先在lib/my_awesome_gem/admin/admin.rb里定义嵌套模块：

# lib/my_awesome_gem/admin/admin.rb
module MyAwesomeGem
  module Admin
    # 嵌套模块的通用方法或常量可以放在这里
  end
end

然后在dashboard.rb里定义类：

# lib/my_awesome_gem/admin/dashboard.rb
module MyAwesomeGem
  module Admin
    class Dashboard
      def show_stats
        "Showing admin stats for MyAwesomeGem"
      end
    end
  end
end

第四步：使用你的命名空间类 #

当Gem安装完成后，用户只需要一行代码就能加载所有内容：

require "my_awesome_gem"

# 直接使用命名空间类
user = MyAwesomeGem::User.new("Alice")
puts user.say_hello  # 输出: Hi, I'm Alice from MyAwesomeGem!

admin_dash = MyAwesomeGem::Admin::Dashboard.new
puts admin_dash.show_stats  # 输出: Showing admin stats for MyAwesomeGem

额外小贴士 #

• 在你的gemspec文件里，记得设置require_paths = ["lib"]（这其实是默认值，但明确写出来更稳妥），同时确保spec.files包含所有lib下的文件，这样发布Gem时才会把这些类文件打包进去。
• 如果你的Gem类很多，可以考虑用autoload或者zeitwerk（Ruby 2.5+自带的自动加载器）来自动加载文件，不用手动写一堆require_relative，不过对于中小型Gem来说，手动引入已经足够清晰了。

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