展开菜单
首页 精品内容 本月促销 装机必备 Windows PDF教程 macOS软件 IOS软件 Android AI 专题
全部分类

当前位置:

首页 > 编程开发 > 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
    作者最新文章
    编程开发
    相关文章 更多
    精品专题 更多
    装机必备

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

    Windows

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

    PDF教程

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

    macOS软件

    正软商城macOS软件专区,精选适用于Mac电脑的办公、设计、影音、效率、开发和系统工具,提供软件功能介绍、macOS兼容版本、正版授权及购买下载服务。

    IOS软件

    正软商城iOS软件专区,精选适用于iPhone和iPad的办公、学习、影音、设计、效率及AI应用,提供功能介绍、适用设备、系统要求和正版获取方式等信息。

    AI

    正软商城AI软件专区,汇集AI写作、AI绘画、AI视频、AI办公、AI编程、AI翻译、智能客服和数据分析等人工智能工具,提供功能介绍、适用平台、收费方式及正版购买信息。

    Mac软件 更多
    Postman macOS版
    Postman macOS版

    Postman是一套面向API全生命周期的开发与测试平台,可在Mac上发送和调试多种协议请求,管理集合、环境及认证信息,并完成脚本测试、模拟服务、监控、文档发布和团队协作。它适合开发、测试及运维人员使用,提供个人免费方案。

    Docker Desktop macOS版
    Docker Desktop macOS版

    Docker Desktop 是 Docker 官方为 Mac 提供的容器开发环境,集成 Docker Engine、命令行工具、Compose、Build、Kubernetes 与图形化管理界面。

    Android Studio macOS版
    Android Studio macOS版

    Android Studio 是 Google 面向安卓应用开发提供的官方集成开发环境,基于 IntelliJ IDEA 构建。它整合智能代码编辑、Gradle 构建、界面预览、设备模拟、性能分析、调试测试及 APK 分析等工具。

    Xcode macOS版
    Xcode macOS版

    Xcode 是苹果面向 Mac 提供的官方集成开发环境,将代码编辑、项目构建、SwiftUI 实时预览、设备模拟、自动化测试、断点调试、性能分析和应用分发整合在同一套工作流中,适合开发与维护 iPhone、iPad、Mac、Apple Wa

    JetBrains WebStorm macOS版
    JetBrains WebStorm macOS版

    JetBrains WebStorm 是面向 JavaScript、TypeScript 和现代 Web 技术的专业集成开发环境,可智能理解项目结构,提供代码补全、重构、错误检查、运行调试、测试及 Git 工具。

    PhpStorm macOS版
    PhpStorm macOS版

    PhpStorm 是 JetBrains 推出的专业 PHP 集成开发环境,可在 Mac 上完成代码编写、智能检查、重构、调试、测试和数据库管理。它支持主流 PHP 框架、Composer、Git、Docker 与远程解释器。

    JetBrains PyCharm macOS版
    JetBrains PyCharm macOS版

    JetBrains PyCharm 是面向 Python 开发者的集成开发环境,提供智能补全、代码检查、重构、调试、测试、版本控制及虚拟环境管理功能。Mac 版兼容 Intel 与 Apple 芯片,核心功能可免费使用。

    JetBrains IntelliJ IDEA macOS版
    JetBrains IntelliJ IDEA macOS版

    IntelliJ IDEA 是 JetBrains 推出的专业集成开发环境,重点服务于 Java、Kotlin 与 JVM 项目开发。软件集成代码补全、静态检查、重构、调试、测试、版本控制及构建工具,并可借助插件扩展语言和框架支持。

    Visual Studio Code macOS版
    Visual Studio Code macOS版

    Visual Studio Code 是微软提供的免费代码编辑器,支持 macOS,并为 Intel 与 Apple 芯片 Mac 提供适配版本。软件集代码编辑、调试、Git 源代码管理、集成终端和扩展市场于一体。

    REAPER macOS版
    REAPER macOS版

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

    Adobe Audition macOS版
    Adobe Audition macOS版

    Adobe Audition 是面向播客、影视后期、音乐制作及内容创作者的专业音频工作站,提供波形精修、多轨录制与混音、频谱编辑、降噪修复、响度匹配和效果处理工具,并可与 Adobe Premiere 协同完成视频声音制作。

    Pro Tools macOS版
    Pro Tools macOS版

    Pro Tools 是 Avid 推出的专业数字音频工作站,覆盖多轨录音、无损剪辑、MIDI 编曲、插件处理、自动化混音及声音与画面同步等工作。它拥有 Intro、Artist、Studio 和 Ultimate 等方案。

    WINDOWS 更多
    Postman Windows版
    Postman Windows版

    Postman 是面向 API 全生命周期的开发与协作平台。Windows 桌面版可用于构建和发送 HTTP、GraphQL、gRPC、WebSocket、MQTT 等请求,并提供环境变量、集合、脚本测试、模拟服务、监控、文档及团队工作区等

    Docker Desktop Windows版
    Docker Desktop Windows版

    Docker Desktop 为 Windows 开发者提供集成式容器环境,内置 Docker Engine、命令行工具、Compose、Build 与 Kubernetes 等组件,可在本机完成镜像构建、容器运行、日志查看和资源管理。

    Android Studio Windows版
    Android Studio Windows版

    Android Studio 是 Google 面向 Android 应用开发提供的官方集成开发环境,以 IntelliJ IDEA 为基础,集成智能代码编辑、Gradle 构建、设备模拟、界面预览、调试测试及性能分析工具,

    JetBrains WebStorm Windows版
    JetBrains WebStorm Windows版

    WebStorm 是 JetBrains 面向 JavaScript、TypeScript 和现代 Web 技术打造的集成开发环境。它提供项目级代码分析、智能补全、安全重构、导航搜索,并集成调试、测试、终端、Git 与常用前端工具,

    JetBrains PhpStorm Windows版
    JetBrains PhpStorm Windows版

    PhpStorm 是 JetBrains 面向 PHP 与现代 Web 开发打造的专业集成开发环境,提供代码补全、静态检查、重构、调试、测试、数据库、版本控制及前端语言支持。Windows 用户可直接下载安装程序,

    JetBrains PyCharm Windows版
    JetBrains PyCharm Windows版

    PyCharm 是 JetBrains 推出的 Python 集成开发环境,提供智能代码补全、错误检查、重构、调试、测试、Git、终端及 Jupyter Notebook 支持。统一版安装后可体验 30 天 Pro 功能,

    JetBrains IntelliJ IDEA Windows版
    JetBrains IntelliJ IDEA Windows版

    JetBrains IntelliJ IDEA 是以 Java、Kotlin 和 JVM 项目为核心的专业集成开发环境,提供智能补全、代码检查、安全重构、调试、测试、版本控制及构建工具集成。统一发行版的核心功能可免费用于商业和非商业项目,

    Visual Studio Code Windows版
    Visual Studio Code Windows版

    Visual Studio Code 是微软推出的免费代码编辑器,Windows 版集成智能补全、代码导航、调试、终端和版本控制,并可通过扩展添加语言、格式化及远程开发能力。它启动较快、配置灵活,

    REAPER Windows版
    REAPER Windows版

    REAPER 是 Cockos 推出的数字音频工作站,适用于录音、MIDI 编曲、音频编辑、混音、母带制作及声音设计。软件安装包小巧,支持多轨录制、灵活路由、自动化、第三方插件和脚本扩展,并提供完整功能的 60 天免费评估期。

    Adobe Audition Windows版
    Adobe Audition Windows版

    Adobe Audition 是面向播客、影视后期、广播与音乐制作的专业音频工作站,提供波形编辑、多轨混音、频谱分析、录音、降噪修复和效果处理等功能。Windows 版通过 Adobe Creative Cloud 安装和管理,

    Pro Tools Windows版
    Pro Tools Windows版

    Pro Tools 是 Avid 推出的专业数字音频工作站,提供多轨录音、音频剪辑、MIDI编曲、插件处理、自动化混音及影视声音制作能力。它适合音乐人、录音师、制作人和音频后期团队使用,并提供免费入门版、订阅方案及永久授权选择。

    Cubase Windows版
    Cubase Windows版

    Cubase 是 Steinberg 推出的数字音频工作站,提供 MIDI 编曲、多轨录音、音频编辑、虚拟乐器、效果处理、自动化、混音和母带输出工具。其 Pro、Artist 与 Elements 版本面向不同预算和制作规模,