android 创建工程的 package-info.java

一.引入 

     上文http://zy19982004.iteye.com/blog/1979208中，提到了注解类JyzTargetPackage可以定义为@Target(ElementType.PACKAGE)，可是在被注解类里我无论怎么加，编译器都报错，于是引入了package-info.java这个文件。

 

二.创建package-info.java

1. "I found that when you create a new package in eclispe there is a check box to check if you want a package-info.java."勾上就行了。
2. 如果不幸的是你已经创建了这个包并在里面定义了很多类，而eclispe又是不能直接创建一个package-info.java文件的。只能在包对应文件夹里，手动创建一个package-info.java，写上包名，最后刷新eclispe即可。

 

三.package-info.java的作用

 

1. "Package annotations must be in file package-info.java",package-info.java为我们提供了包注解的地方。JyzTargetPackage(http://zy19982004.iteye.com/blog/1979208)苦苦寻找终于找到地方了。
2. 提供包级别的类(或接口)，这些类(或接口)只有本包里才能访问，即使是子包也不能访问。
3. 提供包的整体注释说明。

 package-info.java

Java代码  

1. /**   
2.  * <b>package-info不是平常类，其作用有三个:</b><br>   
3.  * 1、为标注在包上Annotation提供便利；<br>   
4.  * 2、声明包的私有类和常量；<br>   
5.  * 3、提供包的整体注释说明。<br>   
6.  *  
7.  * @author JoyoungZhang@gmail.com  
8. */   
9. @JyzTargetPackage(version="1.0")  
10. package com.jyz.study.jdk.annotation;  
11.   
12. class PackageInfo{  
13.     public void common(){  
14.         System.out.println("sa");  
15.     }  
16. }  
17.   
18. class PackageInfoGeneric<T extends Throwable>{  
19.     private T obj;  
20.     public void set(T obj){  
21.         this.obj = obj;  
22.     }  
23.     public void common(){  
24.         System.out.println(obj + "sa");  
25.     }  
26. }  
27.   
28. interface packageInfoInteger{  
29.     public void test();  
30. }  
31.   
32. class PackageConstants{  
33.     public static final String ERROE_CODE = "100001";     
34. }  

 

 

TestPackageInfo.java

Java代码  

1. package com.jyz.study.jdk.annotation;  
2.   
3. import java.io.IOException;  
4.   
5. /** 
6.  * 测试package-info.java文件的作用 
7.  * 1、为标注在包上Annotation提供便利；<br>   
8.  * 2、声明包的私有类和常量；<br>   
9.  * @author JoyoungZhang@gmail.com 
10.  * 
11.  */  
12. public class TestPackageInfo {  
13.   
14.     public static void main(String[] args) {  
15.         //1  
16.         Package p = Package.getPackage("com.jyz.study.jdk.annotation");  
17.         if(p != null && p.isAnnotationPresent(JyzTargetPackage.class)){  
18.             JyzTargetPackage nav = p.getAnnotation(JyzTargetPackage.class);  
19.             if(nav != null){   
20.                 System.out.println("package version:" + nav.version());  
21.             }  
22.         }  
23.           
24.         //2  
25.         PackageInfo packageInfo = new PackageInfo();  
26.         packageInfo.common();  
27.           
28.         //泛型也能很好的工作，在pakcage-info.java里定义的类和普通类没什么区别  
29.         PackageInfoGeneric<Exception> packageInfoGeneric = new PackageInfoGeneric<Exception>();  
30.         packageInfoGeneric.set(new IOException("device io"));  
31.         packageInfoGeneric.common();  
32.           
33.           
34.         Sub sub = new Sub();  
35.         sub.test();  
36.           
37.         System.out.println(PackageConstants.ERROE_CODE);  
38.     }  
39. }  
40.   
41. class Sub implements packageInfoInteger{  
42.       
43.     @Override  
44.     public void test() {  
45.         System.out.println("sub");  
46.     }  
47.       
48. }  
49.   
50.   
51. console output:  
52. package version:1.0  
53. sa  
54. java.io.IOException: device iosa  
55. sub  
56. 100001  

 

  需要注意两点

1. package-info.java里不能声明public class(或 interface)
2. 刚开始p.isAnnotationPresent(JyzTargetPackage.class)返回false，后来找到原因JyzTargetPackage没有加上@Retention(RetentionPolicy.RUNTIME)。