package-info.java

参考文章: http://blog.sina.com.cn/s/blog_93dc666c0101gzlr.html

对于package-info.java我们并不陌生，但又陌生。

在我们每次建立package包的时候会自动生成一个package-info.java文件。但这个文件内部并没有任何东西。

因-为特殊字符在java中不能作为文件名，因此我们不能在java中new Class的形式建立。

一种是建立一个package生成package-info.java，另一种是用文本编辑器建立一个文件复制进来。

package-info.java 属于特殊java文件，不同于以往的java文件。没有继承没有public、private修饰符

package-info.java作用：

• 为标注在包上Annotation提供便利；
• 声明友好类和包常量；
• 提供包的整体注释说明。

以下是例子：

 其中 PackAnnotation注明作用到Package上：

@Target(ElementType.PACKAGE)
@Retention(RetentionPolicy.RUNTIME)
public @interface PackAnnotation {
}

 

package-info.java

/**
 * 本包主要做测试用，用于学习package-info.java文件的作用.
 * @author DennyZhao
 *
 */
@PackAnnotation
package pack.info.test;

import java.lang.annotation.Annotation;

/**
 * 本包单用Utils
 * @author DennyZhao
 *
 */
class CommonPackUtils{
    public static void formatPackage(String packName) {
        Package pack = Package.getPackage(packName);
        Annotation[] annotations = pack.getAnnotations();
        for(Annotation anno : annotations) {
            System.out.println(anno.annotationType().getName());
        }
    }
}
/**
 * 本包单用约束
 * @author DennyZhao
 *
 */
class CommonPackConstants{
    public static final String PACK_NAME = "pack.info.test";
}

 

 PackTest.java

public class PackTest {
    public static void main(String[] args) {
        CommonPackUtils.formatPackage(CommonPackConstants.PACK_NAME);
    }
}

 

从以上例子可以看出：

1. 我们的公共类CommonPackUtils只能在本package中使用，子包和兄弟包都不能使用。

2. 注解的作用范围控制在包上，则除此之外无法调用。

3. pack-info添加注释，会作为package的javadoc而存在。