package-info.java的作用

最新推荐文章于 2022-11-05 22:10:23 发布

lzhfdxhxm

最新推荐文章于 2022-11-05 22:10:23 发布

阅读量682

点赞数 1

分类专栏： JAVA 文章标签： java package-info

本文链接：https://blog.csdn.net/lzhfdxhxm/article/details/117166155

版权

JAVA 专栏收录该内容

46 篇文章 0 订阅

订阅专栏

本文详细介绍了Java中package-info.java文件的作用，包括提供包级别的注释，展示在IDEA和Javadoc中的效果，以及如何通过包级别的注解标记整个包为过时。此外，还讲解了如何利用package-info.java来定义包内友好的类和变量，实现集中管理和限制访问。创建package-info.java的方法也在文中提及。

摘要由CSDN通过智能技术生成

2.在别的包里就不能使用，包括子包也不能使用

创建方式

作用

一、提供包级别的注释

如在component包里放了package-info.java

/**
 * 组件
 */
package com.xxx.component;

在component.config包下放了package-info.java

/**
 * 组件配置
 */
package com.xxx.component.config;

1.在idea里的体现：

鼠标在component上悬浮的时候，就会显示component包的注释

鼠标在config上悬浮的时候，就会显示config包的注释

2.在Javadocs里的体现：

类似下图，package的注释：

二、提供包级别的注解

比如，在helper包下建package-info.java，如下：

@Deprecated
package com.xxx.helper;

那么表示整个包都过时了，不推荐使用：

当然，前提是这个注解本身支持包级别，如@Deprecated

也可以自定义包级别的注解，然后在package-info.java里使用，这里就不演示了。

三、提供包级别的友好类和变量

比如一个包中有很多的内部访问的类或常量，就可以统一的放到package-info类中，这样就比较方便，而且集中管理，减少友好类到处游走的情况

/**
 * 组件
 */
package com.xxx.component;

 class CompomentHelper {
    public static String getCompomentPayName() {
        return "test";
    }
}

class CompomentErrorCode {
    public static final String COMPOMENT_PAY_001="0001";
}

/**
 * 组件
 */
package com.xxx.component;

class CompomentHelper {
    public static String getCompomentPayName() {
        return "test";
    }
}

class CompomentErrorCode {
    public static final String COMPOMENT_PAY_001="0001";
}