package-info.java文件分析

最新推荐文章于 2024-08-27 19:00:38 发布

预见才能遇见

最新推荐文章于 2024-08-27 19:00:38 发布

阅读量2.6k

点赞数

分类专栏： # Android原生开发系列文章标签： package-info.java 文件分析 Android NameSpace XmlSchema

本文链接：https://blog.csdn.net/pcaxb/article/details/46876209

版权

Android原生开发系列专栏收录该内容

80 篇文章 1 订阅

订阅专栏

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提供便利

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

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

再定义一个package-info类

@PkgAnnotation  
package com.company;

接着定义一个测试类

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

2.声明友好类和包常量

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

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

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

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

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

生成javadoc文档

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

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

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