使用Java package-info类为包服务

原创 2016年05月31日 06:35:26
Java 中有一个特殊的类:package-info 类,它是专门为本包服务的,为什么说它特殊呢?主要体现在3 个方面:
  • 它不能随便被创建
    在一般的IDE 中,Eclipse、package-info 等文件是不能随便被创建的,会报“Type name is notvalid”错误,类名无效。在Java 变量定义规范中规定如下字符是允许的:字母、数字、下划线,以及那个不怎么常用的$ 符号,不过中划线可不在之列,那怎么创建这个文件呢?很简单,用记事本创建一个,然后拷贝进去再改一下就成了,更直接的办法就是从别的项目中拷贝过来。
  • 它服务的对象很特殊
    一个类是一类或一组事物的描述,比如Dog 这个类,就是描述“旺财”的,那package-info这个类是描述什么的呢?它总要有一个被描述或被陈述的对象吧,它是描述和记录本包信息的。
  • package-info 类不能有实现代码
    package-info 类再怎么特殊也是一个类, 也会被编译成package-info.class, 但是在package-info.java 文件里不能声明package-info 类。

package-info 类还有几个特殊的地方,比如不可以继承,没有接口,没有类间关系(关联、组合、聚合等)等,不再赘述,Java 中既然允许存在这么一个特殊的类,那肯定有其特殊的作用了,我们来看看它的作用,主要表现在以下三个方面:
  • 声明友好类和包内访问常量
    这个比较简单,而且很实用,比如一个包中有很多内部访问的类或常量,就可以统一放到package-info 类中,这样很方便,而且便于集中管理,可以减少友好类到处游走的情况,代码如下:
    // 这里是包类,声明一个包使用的公共类
    class PkgClass{
        public void test(){ }
    }
    // 包常量,只允许包内访问
    class PkgConst{
        static final String PACAKGE_CONST="ABC";
    }
    注意以上代码是存放在package-info.java 中的,虽然它没有编写package-info 的实现,但是package-info.class 类文件还是会生成。通过这样的定义,我们把一个包需要的类和常量都放置在本包下,在语义上和习惯上都能让程序员更适应。
  • 为在包上标注注解提供便利
    比如我们要写一个注解(Annotation),查看一个包下的所有对象,只要把注解标注到package-info 文件中即可, 而且在很多开源项目也采用了此方法, 比如Struts2 的@namespace、Hibernate 的@FilterDef 等。
  • 提供包的整体注释说明
    如果是分包开发,也就是说一个包实现了一个业务逻辑或功能点或模块或组件,则该包需要有一个很好的说明文档,说明这个包是做什么用的,版本变迁历史,与其他包的逻辑关系等,package-info 文件的作用在此就发挥出来了,这些都可以直接定义到此文件中,通过javadoc 生成文档时,会把这些说明作为包文档的首页,让读者更容易对该包有一个整体的认识。当然在这点上它与package.htm 的作用是相同的,不过package-info 可以在代码中维护文档的完整性,并且可以实现代码与文档的同步更新。

    解释了这么多,总结成一句话:在需要用到包的地方,就可以考虑一下package-info 这个特殊类,也许能起到事半功倍的作用。
版权声明:本文为芝麻软件工作室原创文章,未经芝麻软件工作室允许不得转载。

建议50: 使用package-info类为包服务

建议50: 使用package-info类为包服务 Java中有一个特殊的类:package-info类,它是专门为本包服务的,为什么说它特殊呢?主要体现在3个方面: (1)它不能随便被创...

Java注解学习三:package-info.java的使用

 Java注解学习三:package-info.java的使用 http://zy19982004.iteye.com/blog/1979308 另类的package-info.ja...

Java注解学习二:package-info.java的使用

一.引入       上文中,提到了注解类JyzTargetPackage可以定义为@Target(ElementType.PACKAGE),可是在被注解类里我无论怎么加,编译器都报错,于是引入了p...
  • achuo
  • achuo
  • 2016年01月30日 10:41
  • 5477

PACKAGE-INFO.JAVA 作用及用法详解

package-info.java对于经常使用外部包的程序员来说应该是熟悉陌生人。因为不是专门开发包的程序员很少需要关注它,而又常在其他包中看到他,眼很熟。它到底有哪些特性和作用及如何使用呢?程序员讲...

package-info.java的作用

在阅读一些开源的Java Source Code时,我们通常会发现在每个package的下面,会有一个这样的文件: package-info.java 乍看之下,它并不符合Java类的命名...

package-info.java文件详解

package-info.java文件详解作者:chszs,转载需注明。博客主页:http://blog.csdn.net/chszs一、pacakge-info.java介绍pacakge-info...
  • chszs
  • chszs
  • 2015年05月14日 22:14
  • 7417

package-info.java文件解读

一个特殊的java文件:pacakge-info.java,虽然有记录,但是不全,就尝试着追踪一下该问题, 分享一下流水账式的结果。 首先,它不能随便被创建。在Eclipse中, pac...

PACKAGE-INFO.JAVA 作用及用法详解

package-info.java对于经常使用外部包的程序员来说应该是熟悉陌生人。因为不是专门开发包的程序员很少需要关注它,而又常在其他包中看到他,眼很熟。它到底有哪些特性和作用及如何使用呢?程序员讲...

PACKAGE-INFO.JAVA 作用及用法详解

package-info.java对于经常使用外部包的程序员来说应该是熟悉陌生人。因为不是专门开发包的程序员很少需要关注它,而又常在其他包中看到他,眼很熟。它到底有哪些特性和作用及如何使用呢?程序员讲...

package-info.java文件的详细介绍

使用package-info类为包服务 Java中有一个特殊的类:package-info类,它是专门为本包服务的,为什么说它特殊呢?主要体现在3个方面: (1)它不能随便被创建 在一般的IDE中,E...
  • xwq1012
  • xwq1012
  • 2013年12月05日 10:17
  • 710
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:使用Java package-info类为包服务
举报原因:
原因补充:

(最多只允许输入30个字)