• 【Java 基础篇】Java 模块化详解


    在这里插入图片描述

    Java 9引入了一项重要的功能:模块化(Module System)。模块化是一种将代码和资源封装到可重用和独立的单元中的方法,它有助于改善代码的可维护性、可重用性和安全性。本文将介绍Java模块化的基本概念、如何创建和使用模块以及一些最佳实践。

    什么是Java模块化?

    在Java 9之前,Java应用程序是以JAR文件的形式组织的,其中包含了一堆类和资源。这种方式存在一些问题:

    • 可维护性差:JAR文件可以包含大量的类和资源,这使得应用程序的结构变得混乱,难以维护。
    • 可重用性差:在多个应用程序之间共享代码和资源比较困难。
    • 安全性问题:所有的类都在同一个类路径中,这可能导致意外的访问和依赖关系。

    Java模块化解决了这些问题。模块是一种新的编程单元,它可以包含类、资源和其他模块的依赖关系。模块化的代码更容易维护,更容易重用,同时也提供了更好的安全性。

    模块化的基本概念

    在开始使用Java模块化之前,让我们先了解一些基本概念:

    1. 模块(Module)

    一个模块是一个可重用的单元,它包含了一组相关的类和资源。每个模块都有一个名字,并可以声明自己的依赖关系。

    2. 模块声明(Module Declaration)

    一个模块声明是一个包含在module-info.java文件中的文件,它定义了一个模块的名称、依赖关系和其他特性。

    3. 模块路径(Module Path)

    模块路径是一组目录和JAR文件,其中包含了模块的JMOD文件和module-info.class文件。模块路径用于告诉JVM哪些模块可用。

    4. 模块化 JAR 文件(Modular JAR File)

    模块化JAR文件是一种特殊类型的JAR文件,它包含了一个模块的类和资源,以及module-info.class文件。

    5. 自动模块(Automatic Module)

    如果一个JAR文件没有module-info.class文件,它被称为自动模块。自动模块的名称基于JAR文件的文件名,并且具有一些默认的依赖关系。

    6. 依赖性(Dependency)

    一个模块可以声明对其他模块的依赖关系,以便在编译时和运行时使用其他模块的类和资源。

    创建一个简单的模块

    让我们从创建一个简单的Java模块开始,以便更好地理解模块化的概念。假设我们有一个应用程序,它有两个模块:一个模块用于处理数据库连接,另一个模块用于处理用户界面。

    第一步:创建数据库模块

    首先,我们创建一个数据库模块,它包含了一个简单的类DatabaseConnection

    // DatabaseConnection.java
    package com.example.database;
    
    public class DatabaseConnection {
        public void connect() {
            System.out.println("Connected to the database.");
        }
    }
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8

    然后,我们为该模块创建一个module-info.java文件,声明该模块的名称:

    // module-info.java
    module databaseModule {
    }
    
    • 1
    • 2
    • 3

    这个模块不依赖于其他模块,所以module-info.java文件中没有声明任何依赖关系。

    第二步:创建用户界面模块

    接下来,我们创建一个用户界面模块,它包含了一个简单的类UserInterface

    // UserInterface.java
    package com.example.ui;
    
    public class UserInterface {
        public void display() {
            System.out.println("User interface displayed.");
        }
    }
    
    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 8

    为该模块创建一个module-info.java文件,声明该模块的名称和对数据库模块的依赖:

    // module-info.java
    module uiModule {
        requires databaseModule;
    }
    
    • 1
    • 2
    • 3
    • 4

    这个模块声明了对databaseModule的依赖,这意味着它可以使用databaseModule中的类和资源。

    第三步:编译和运行模块

    现在,我们可以使用Java 9编译器来编译这两个模块:

    javac -d out/database databaseModule/*.java
    javac -d out/ui --module-path out databaseModule/*.java uiModule/*.java
    
    • 1
    • 2

    然后,我们可以运行UserInterface类来启动我们的应用程序:

    java --module-path out -m uiModule/com.example.ui.UserInterface
    
    • 1

    这将会输出:

    Connected to the database.
    User interface displayed.
    
    • 1
    • 2

    模块化的更多操作

    当您在Java应用程序中使用模块化时,可以执行许多不同的操作,以更好地组织、管理和优化您的代码。以下是一些模块化的更多操作:

    1. 导出和打包模块:您可以使用exports关键字在module-info.java中声明哪些包可以被其他模块访问。这允许您控制哪些部分的代码对外可见。例如:

      module myModule {
          exports com.example.mypackage;
      }
      
      • 1
      • 2
      • 3

      您还可以使用opens关键字导出包,以便其他模块可以反射地访问包中的非公开类型。

    2. 开放模块:如果您希望模块对所有其他模块开放,可以使用open关键字。这对于编写插件或扩展模块很有用。

      module myModule {
          open com.example.mypackage;
      }
      
      • 1
      • 2
      • 3
    3. 命令行工具:Java 9引入了一些命令行工具,如jdeps,用于分析模块之间的依赖关系,以及jlink,用于创建自定义运行时映像。

    4. 运行时图像:您可以使用jlink命令将您的模块化应用程序与JRE一起打包成自定义运行时图像。这有助于减小应用程序的大小,因为只包括了应用程序所需的模块。

    5. 模块路径:模块路径是一个包含模块的目录或JAR文件的集合,它用于在运行时加载模块。您可以使用--module-path选项来指定模块路径。

    6. 自动模块:如果您的应用程序包含非模块化的JAR文件,Java会自动将它们转换为自动模块,以便它们可以与模块一起使用。

    7. 模块化JAR文件:您可以使用jar工具创建模块化的JAR文件,其中包含了模块描述文件(module-info.class)。

    8. 模块化库:许多常用的Java库已经进行了模块化,以便更好地与模块化应用程序集成。您可以在模块路径上指定这些库,而无需手动管理它们的依赖关系。

    9. 模块化测试:使用模块路径和--module选项,您可以在单元测试中模拟模块化环境。

    10. 版本管理:在module-info.java中可以使用requires static关键字来声明可选依赖关系,这些依赖关系只在模块可用时才会生效。

    这些是模块化Java应用程序中的一些更多操作。模块化使得Java应用程序更易于维护和扩展,同时提供了更好的封装和可重用性。根据您的项目需求,您可以选择适当的操作来更好地利用模块化的优势。

    模块化的最佳实践

    以下是一些模块化的最佳实践:

    1. 模块命名规范:给模块取一个有意义的名字,通常使用逆域名表示法(例如:com.example.myapp)。

    2. 明确的依赖关系:在module-info.java文件中明确声明模块的依赖关系,以确保应用程序的模块之间的依赖关系清晰可见。

    3. 最小依赖原则:尽量减少模块之间的依赖关系,只依赖于真正需要的模块。

    4. 版本化的依赖关系:如果可能的话,使用版本化的依赖关系来确保模块依赖的是正确的版本。

    5. 单一责任原则:将每个模块限制为一个特定的功能或领域,以提高可维护性和可重用性。

    6. 测试和验证:确保模块之间的依赖关系和交互在编译时和运行时都能正常工作。

    7. 模块路径管理:管理模块路径以确保应用程序能够正确加载和运行。

    注意事项

    在编写和使用模块化的Java应用程序时,有一些重要的注意事项,以确保您的应用程序正确运行和维护。以下是一些模块化的注意事项:

    1. 模块依赖关系:仔细考虑您的模块之间的依赖关系。确保模块之间的依赖关系是明确的,避免循环依赖。使用requires语句声明依赖关系,并根据需要使用requires transitiverequires static

    2. 版本管理:了解模块之间的版本管理。Java 9引入了模块化版本的概念,允许模块依赖于特定版本的其他模块。考虑使用requires static来声明可选的、仅在特定版本下才有效的依赖关系。

    3. 模块命名:为您的模块选择合适的名称。模块名称应该唯一且易于理解。遵循Java的包命名约定,使用反向域名(例如com.example.mymodule)。

    4. 模块路径:在运行应用程序时,使用--module-path选项指定模块路径。确保正确设置模块路径,以便Java可以找到并加载您的模块。

    5. 非模块化库:如果您使用了非模块化的JAR文件,将其包装为自动模块或创建模块化的版本。非模块化库的依赖关系可能会引入复杂性。

    6. 模块化库:考虑使用已经模块化的库,以减少与模块路径和版本管理相关的问题。

    7. 运行时图像:如果您使用jlink创建自定义运行时图像,请确保包括了所有必要的模块,并排除不必要的模块,以减小应用程序的大小。

    8. 测试:编写单元测试以确保模块化应用程序的正确性。使用模块路径和--module选项来模拟模块化环境进行测试。

    9. 模块描述文件:模块描述文件(module-info.java)是模块化应用程序的关键组成部分。确保正确声明依赖关系、导出和打包模块,以及使用其他关键字来管理可见性。

    10. 模块间通信:模块之间的通信应该在依赖模块的基础上进行。不要尝试绕过模块系统的可见性控制。

    11. 跨模块访问:如果需要在模块之间共享数据或访问非公开成员,请使用opensopens...to语句,以允许受信任的模块进行反射操作。

    12. 性能和内存开销:模块化应用程序的启动时间和内存开销可能会有所增加。在部署和测试应用程序时,要考虑性能方面的因素。

    13. 迁移:如果您正在迁移现有的应用程序到模块化架构,确保逐步迁移,以减少中断和问题。

    14. 文档和培训:为开发团队提供关于模块化的文档和培训,以确保所有开发人员都理解和遵守模块化的最佳实践。

    15. 工具支持:使用Java 9及更高版本,以充分利用模块化系统和相关的工具,如jdepsjlinkjmod

    这些注意事项有助于确保您的模块化Java应用程序能够正确运行

    结论

    Java模块化是一个强大的工具,可以帮助您更好地组织和管理代码,提高可维护性和可重用性。本文介绍了模块化的基本概念,以及如何创建和使用模块。遵循最佳实践,可以使您的Java应用程序更加健壮和可维护。希望本文对您理解Java模块化有所帮助。

    作者信息

    作者 : 繁依Fanyi
    CSDN: https://techfanyi.blog.csdn.net
    掘金:https://juejin.cn/user/4154386571867191
  • 相关阅读:
    笔试面试相关记录(3)
    TCP为什么要三次握手?
    数据库自动备份到gitee上,实现数据自动化备份
    「高效程序员的修炼」代码版本管理工具 Git 用起来 01 Git 基础
    Android 12 适配攻略
    题目:2695.包装数组
    让我们第一次走进Java的世界
    数据结构之单链表代码总结
    PX4模块设计之十七:ModuleBase模块
    手撸Redis分布式锁(8个版本的渐进式源码实践解读)
  • 原文地址:https://blog.csdn.net/qq_21484461/article/details/133282010