package-info.java文件分析

一、特点：

1.不能随便被创建：在Eclipse中， package-info文件不能随便被创建，会报“Type name is notvalid”错误，类名无效(Java变量定义规范是字母、数字、下划线、$符号)。用记事本创建拷贝进去或者是从别的地方复制一个进去。
2.服务的对象很特殊：描述和记录本包信息
3.类不能带有public、private访问权限：package-info.java中只能声明默认访问权限的类，也就是友好类。
4.不可以继承，没有接口，没有类间关系等

二、作用：

1.为标注在包上Annotation提供便利
2.声明友好类和包常量
3.提供包的整体注释说明

1.为标注在包上Annotation提供便利

首先定义一个包类型的注解，它只能放置的一个包上

[java] view plain copy

1. /** 
2.  *定义只能标注在package上的注解 
3.  */    
4. @Target(ElementType.PACKAGE)    
5. @Retention(RetentionPolicy.RUNTIME)    
6. public @interface PkgAnnotation {    
7. }   

再定义一个package-info类

[java] view plain copy

1. @PkgAnnotation    
2. package com.company;

接着定义一个测试类

[java] view plain copy

1. public class Client {       
2.     public static void main(String[] args) {    
3.         //可以通过I/O操作或配置项获得包名    
4.         String pkgName = "com.company";         
5.         Package pkg = Package.getPackage(pkgName);    
6.         //获得包上的注解    
7.         Annotation[] annotations = pkg.getAnnotations();    
8.         //遍历注解数组    
9.         for(Annotation an:annotations){    
10.             if(an instanceof PkgAnnotation){    
11.                 System.out.println("Hi,I'm the PkgAnnotation ,which is be placed on package!");    
12.                 /* 
13.                  * 注解操作 
14.                  * MyAnnotation myAnn = (PkgAnnotation)an; 
15.                  * 还可以操作该注解包下的所有类，比如初始化，检查等等 
16.                  * 类似Struts的@Namespace，可以放到包名上，标明一个包的namespace路径 
17.                  */             
18.             }    
19.         }    
20.     }    
21. }    

2.声明友好类和包常量

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

[java] view plain copy

1. @PkgAnnotation  
2. package com.company;  
3.  //这里是包类，声明一个包使用的公共类，强调的是包访问权限  
4. class PkgClass{  
5.     public void test(){  
6.     }  
7. }  
8. //包常量，只运行包内访问，适用于分“包”开发  
9. class PkgConst{  
10.     static final String PACAKGE_CONST="ABC";  
11. }  

3.提供包的整体注释说明

 如果是分“包”开发，也就是说一个包实现一个业务逻辑或功能点、或模块、或组件，则需要对一个包有很好的说明，说明这个包是干啥的，有啥作用，版本变迁，特别说明等等

[java] view plain copy

1. /** 
2.  * <b>package-info不是平常类，其作用有三个:</b><br> 
3.  * 1、为标注在包上Annotation提供便利；<br> 
4.  * 2、声明包的私有类和常量；<br> 
5.  * 3、提供包的整体注释说明。<br>   
6. */    
7. package com.company;    

生成javadoc文档

在需要的包下建立此文件并通过@XmlSchema来设定命名空间，这样就不需要在DTO中都定义NameSpace

[java] view plain copy

1. @javax.xml.bind.annotation.XmlSchema( namespace = "http://www.laune.at/hospital",elementFormDefault = javax.xml.bind.annotation.XmlNsForm.QUALIFIED)  
2. package hospital;    

[java] view plain copy

1. @javax.xml.bind.annotation.XmlSchema( namespace="http://msb.neptune.net/messageprocessing",elementFormDefault=javax.xml.bind.annotation.XmlNsForm.QUALIFIED )  
2. package net.neptune.mp.model;  

三、相关问题

在项目开发中，可以放置在包上的常用注解有：Struts的@namespace、Hibernate的@FilterDef和@TypeDef等等。在包下，随便一个类中的包名前加这些注解，Eclipse会提示“Package annotations must be in file package-info.java”,在该包下建立package-info.java文件，把注解移到这里即可。使用Checkstyle插件做代码检查时，会报一个警告“Missing package-info.java file.”也是这个package-info文件惹的祸，在各个包下创建一个即可。