当前位置:

首页 > 编程开发 > Ruby 中的 module

Ruby 中的 module

module_function将模块的实例方法复制到单例类,原方法变为私有,仅能通过模块名调用。extendself不改变可见性,public方法既可通过模块名也可通过实例调用。两者均用于暴露模块级方法,但权限不同。

在阅读开源 Ruby 代码或者编写可维护性代码时,经常会碰到 module_function 和 extend self 这两个东西。它们看起来有点像,但实际用起来差别不小。那么,它们到底有什么共同点,又有什么区别?别急,咱们一个一个拆开看。

Ruby 中的 module

module_function

Ruby 的 module 本质上是方法和常量的集合。module 里的方法又分为 instance method 和 module method。当一个 module 被 include 进一个 class 时,module 中那些没有被 module_function 标记的方法就会成为 class 的实例方法——也就是说,需要先把 class 实例化,然后才能通过对象调用。

一旦某个方法被 module_function 标记,不管它原来是被声明为 public 还是 private,它都会变成 module method,并且原来的实例方法会被改成 private。对于包含这个 module 的 class 来说,这个被标记的方法就成了私有实例方法,所以用 对象.module_method 的方式会报错。而 module method 则可以通过 模块名.方法名 直接调用。没有被 module_function 标记的 public 方法,则不能用模块名直接调用。

简单来说:module_function 把模块里的方法复制到模块的单例类中,同时将原来的实例方法设为 private。

看一段代码应该会更清楚:

# test.rb
module MyModule
 def public_meth
  p "a public method, if the module is included to a class , can be call as object.public_meth"
 end
 def module_method
  p "a module method,can be called as module_name.module_method. but can not be call as object.module_method"
 end
 private
 def private_method_to_module_function
  p "a private_method, but can be call as module_name.module_method, because it was assigned to module_function"
 end
 def private_method
  p "I am a private method"
 end
 module_function :module_method, :private_method_to_module_function
end

MyModule.module_method
MyModule.private_method_to_module_function
begin
 MyModule.public_meth
rescue
 p "public method can not be called by module_name.public_meth"
end
begin
 MyModule.private_method
rescue NoMethodError
 p "private method can not be called by module_name.module_method"
end

class MyClass
 include MyModule
end

obj = MyClass.new
obj.public_meth

begin
 obj.private_method
rescue NoMethodError
 p "private method in module can not be call by object.method_name"
end

begin
 obj.module_method
rescue NoMethodError
 p "module method can not be called by object.method_name, for object, module method is private instance method"
end

#调用
ruby test.rb
"a module method,can be called as module_name.module_method. but can not be call as object.module_method"
"a private_method, but can be call as module_name.module_method, because it was assigned to module_function"
"public method can not be called by module_name.public_meth"
"private method can not be called by module_name.module_method"
"a public method, if the module is included to a class , can be call as object.public_meth"
"private method in module can not be call by object.method_name"
"module method can not be called by object.method_name, for object, module method is private instance method"

总结成两句话:

  • 方法会被复制到类的单例类中
  • 实例方法的可见性会变成 private

extend self

先回顾一下基础:include 是给类的实例添加实例方法,而 extend 是给类或模块添加类方法(也就是单例方法)。

那 extend self 是干什么的呢?它让 module 中的实例方法能够通过 模块名.方法名 直接调用,同时保留方法原有的 public 或 private 属性。不像 module_function 那样会把被标记的方法强制变成 private,extend self 不会改变方法的可见性。

换句话说,extend self 就是在模块内部自己扩展自己,相当于把模块本身当作一个对象,把它自己的实例方法变成它自己的单例方法。

再来看代码:

#!/usr/bin/env ruby
# encoding: utf-8
# test_extend.rb
module MyModule
 extend self
 def public_meth
  p "a public_method extended by self can be called by module_name.public_meth and object.public_meth, included by a class"
  private_method
 end
 private
 def private_method
  p "a private method, can be call in module internal"
 end
end

class MyClass
 include MyModule
end

MyModule.public_meth

begin
 MyModule.private_method
rescue NoMethodError
 p "private method in extend self module can not be called module_name.private_method"
end

obj = MyClass.new
obj.public_meth

begin
 obj.private_method
rescue NoMethodError
 p "private method can not be called by object.private_method"
end

# 调用 ruby test_extend.rb
"a public_method extended by self can be called by module_name.public_meth and object.public_meth, included by a class"
"a private method, can be call in module internal"
"private method in extend self module can not be called module_name.private_method"
"a public_method extended by self can be called by module_name.public_meth and object.public_meth, included by a class"
"a private method, can be call in module internal"
"private method can not be called by object.private_method"

这里的总结也很清晰:

  • 不会涉及方法复制
  • 不改变方法的可见性

总结

module_function 会改变模块内方法原有的 public/private 属性,把方法变成 module method,同时原来的实例方法被设成 private。因此,只有被标记的方法才能通过 模块名.方法名 调用,而未被标记的 public 方法只能通过包含该模块的类的实例来调用。

extend self 则是在模块内部做了一次自引用,不会改变方法的可见性,所以模块里的 public 方法既能通过 模块名.方法名 调用,也能通过类的实例调用(因为 include 后仍为实例方法)。private 方法则只能在模块内部使用,外部无论通过模块名还是对象都无法访问。

两者的选择完全取决于你希望对外暴露什么样的接口:如果想让某些方法同时支持模块级调用和实例级调用,并且不破坏原有可见性,extend self 更合适;如果想把一部分方法“升级”成模块方法,同时让原来的实例方法变成私有,那就用 module_function。

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
作者最新文章
编程开发
相关文章 更多
PHP递归遍历目录文件:RecursiveDirectoryIterator与自定义实现
PHP递归遍历目录文件:RecursiveDirectoryIterator与自定义实现

深入解析在PHP中递归遍历多级目录文件的两种核心方案:基于SPL标准库的RecursiveDirectoryIterator高效流式迭代,与基于scandir/opendir的自定义递归函数实现,剖析执行机制、内存表现与实战避坑指南。

gradle安装步骤详解及环境变量配置教程
gradle安装步骤详解及环境变量配置教程

本文详细介绍Gradle的下载、解压、环境变量配置步骤以及安装验证方法,帮助开发者快速完成Gradle本地开发环境搭建。

shell脚本怎么执行命令并获取执行结果的方法
shell脚本怎么执行命令并获取执行结果的方法

详细讲解在Shell脚本中执行命令并获取执行结果的常用方法,涵盖标准输出捕获、退出状态码判断、错误流重定向、多行结果处理及常见避坑要点。

Java变量声明与初始化:局部、成员及静态变量的定义语法
Java变量声明与初始化:局部、成员及静态变量的定义语法

系统解析Java局部变量、成员变量与静态变量的定义语法、声明与初始化机制、生命周期及JVM内存驻留规则,结合图解与代码示例分析常见编译错误与认知误区。

windows claude code 安装
windows claude code 安装

详解如何在Windows 10/11上安装Claude Code。涵盖WSL与Git Bash终端选择、Node.js版本检查、npm全局安装步骤、身份验证流程及claude doctor诊断方法,帮助开发者快速搭建本地AI编码助手。

typescript是什么语言?一文看懂其定义与用途
typescript是什么语言?一文看懂其定义与用途

深入浅出解析TypeScript是什么语言。本文详细介绍TypeScript的语言定义、超集架构、核心运行原理、与JavaScript的核心对比以及四类典型工业级应用场景,帮助读者全面看懂TS的价值与用途。

codex安装windows教程桌面版完整安装步骤指南
codex安装windows教程桌面版完整安装步骤指南

详解如何在 Windows 电脑上通过 Microsoft Store 安装 Codex 桌面应用,包括启动登录、切换 Codex 模式、关联本地代码项目及终端环境配置的界面操作指引。

github配置ssh key windows
github配置ssh key windows

本文详解如何在Windows环境中使用PowerShell生成SSH密钥对,配置ssh-agent自动加载私钥,并将公钥安全添加至GitHub账户,最后通过git remote set-url切换为SSH地址,解决每次操作需输入账号密码的问题。

backdrop和background区别
backdrop和background区别

深入解析backdrop与background在网页开发及视觉设计中的区别。通过CSS代码示例,展示如何正确使用background设置元素背景,以及利用backdrop-filter创建弹窗遮罩模糊效果,避免概念混用。

windsurf ide download Windows版安装教程
windsurf ide download Windows版安装教程

详解 Windsurf IDE 在 Windows 系统的下载来源、安装步骤及首次启动界面。指导用户如何导入编辑器设置、打开项目文件夹及使用终端与 AI 功能,适合初次接触该工具的开发者阅读。

查看更多
精品专题 更多
装机必备
装机必备

正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

Windows
Windows

正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

PDF教程
PDF教程

正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

Mac软件 更多
WPS Office macOS版
WPS Office macOS版
macOS

WPS Office是一款面向macOS用户的综合办公套件,将文字处理、电子表格、演示文稿、PDF工具、模板与云协作整合在同一应用中。它兼容常见Microsoft Office格式,支持Intel及Apple芯片Mac,基础功能可免费使用,

Shapr3D macOS版
Shapr3D macOS版
Mac

Shapr3D是一款面向工业设计、机械工程、建筑概念和三维打印工作流的CAD软件。Mac版采用Parasolid建模内核,支持草图约束、实体建模、工程图、可视化渲染及常见CAD格式交换,并可通过账户在多台设备之间同步项目。

REAPER macOS版
REAPER macOS版
Mac

REAPER是Cockos开发的数字音频工作站,提供多轨音频与MIDI录制、剪辑、处理、混音和母带制作工具。Mac版兼容Intel与Apple芯片,支持AU、VST、VST3、CLAP等插件格式,并提供高度可定制的工作流程。

WINDOWS 更多
Adobe Photoshop Windows版
Adobe Photoshop Windows版
Windows

Adobe Photoshop 是面向摄影师、设计师和内容创作者的专业图像处理工具,可在 Windows 上完成照片修饰、选区抠图、图层合成、文字排版、绘画及生成式编辑。软件采用订阅授权,由 Creative Cloud 管理安装、更新与许

Adobe InDesign Windows版
Adobe InDesign Windows版
Windows

Adobe InDesign 是面向印刷与数字出版的专业页面排版工具,可制作书籍、杂志、宣传册、海报、交互式 PDF 和电子书。它提供精细的文字样式、多页面管理、印前检查及多格式输出能力,并能与 Photoshop、Illustrator

Adobe Illustrator Windows版
Adobe Illustrator Windows版
Windows

Adobe Illustrator 是用于绘制矢量图形、插画、图标、徽标和版式的专业设计工具。它以路径和锚点为核心,作品放大后仍能保持清晰,并提供画板、文字、渐变、图像描摹及精确变换等功能,适合品牌视觉、印刷物料、数字界面和商业插画创作。