package-info.java的作用

目录

作用

一、提供包级别的注释

1.在idea里的体现：

2.在Javadocs里的体现：

二、提供包级别的注解

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

1.在同一个包里能正常使用

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";
}

1.在同一个包里能正常使用

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

创建方式

创建package-info.java的方式：包上右键-new-package-info.java