package-info类

Java中有一个特殊的类：package-info类，它是专门为本包服务的。

一、特殊性

1、它不能随便被创建
在一般的IDE中，Eclipse、package-info等文件是不能随便被创建的，会报“Type name is notvalid”错误，类名无效。在Java变量定义规范中规定如下字符是允许的：字母、数字、下划线，以及那个不怎么常用的$符号，不过中划线可不在之列，那怎么创建这个文件呢？很简单，用记事本创建一个，然后拷贝进去再改一下就成了，更直接的办法就是从别的项目中拷贝过来。
2、它服务的对象很特殊
一个类是一类或一组事物的描述，比如Dog这个类，就是描述“旺财”的，那package-info这个类是描述什么的呢？它总要有一个被描述或被陈述的对象吧，它是描述和记录本包信息的。
3、package-info类不能有实现代码
package-info类再怎么特殊也是一个类，也会被编译成package-info.class，但是在package-info.java文件里不能声明package-info类。
package-info类还有几个特殊的地方，比如不可以继承，没有接口，没有类间关系（关联、组合、聚合等）等

二、作用

1、声明友好类和包内访问常量
这个比较简单，而且很实用，比如一个包中有很多内部访问的类或常量，就可以统一放到package-info类中，这样很方便，而且便于集中管理，可以减少友好类到处游走的情况，代码如下：

//这里是包类，声明一个包使用的公共类
2 class PkgClass{
3      public void test(){    }
4 }
5 //包常量，只允许包内访问
6 class PkgConst{
7      static final String PACAKGE_CONST="ABC";
8 }

注意以上代码是存放在package-info.java中的，虽然它没有编写package-info的实现，但是package-info.class类文件还是会生成。通过这样的定义，我们把一个包需要的类和常量都放置在本包下，在语义上和习惯上都能让程序员更适应。
2、为在包上标注注解提供便利
比如我们要写一个注解（Annotation），查看一个包下的所有对象，只要把注解标注到package-info文件中即可，而且在很多开源项目也采用了此方法，比如Struts2的@namespace、Hibernate的@FilterDef等。
3、提供包的整体注释说明
如果是分包开发，也就是说一个包实现了一个业务逻辑或功能点或模块或组件，则该包需要有一个很好的说明文档，说明这个包是做什么用的，版本变迁历史，与其他包的逻辑关系等，package-info文件的作用在此就发挥出来了，这些都可以直接定义到此文件中，通过javadoc生成文档时，会把这些说明作为包文档的首页，让读者更容易对该包有一个整体的认识。当然在这点上它与package.htm的作用是相同的，不过package-info可以在代码中维护文档的完整性，并且可以实现代码与文档的同步更新。

解释了这么多，总结成一句话：在需要用到包的地方，就可以考虑一下package-info这个特殊类，也许能起到事半功倍的作用。

原文链接：https://www.cnblogs.com/DreamDrive/p/5428573.html

package-info类相关推荐

jdb 调试含package的类
jdb 调试含package的类类准备执行编译执行dba命令类准备项目对应的目录为:E:\person\test 父类. package pers.chenxi;public abstrac ...
SpringBoot无法找到加载类，应用Feign其他服务无法package两类问题
无法找到加载类 1.如果在一系列简单的故障(有没有加注解或者有没有依赖有没有全面),或者说加载类有没有在根目录src/main/java/(包名)的直接路径下如果这些都没有重点来了把你 ...
idea点击“install”或“package”报“类文件具有错误的版本 55.0, 应为 52.0，请删除该文件或确保该文件位于正确的类路径子目录中。”
最近在开发项目新功能,完了之后打包时报错"类文件具有错误的版本 55.0, 应为 52.0,请删除该文件或确保该文件位于正确的类路径子目录中." 找到报错的类版本确实是55.0, ...
Java axis 配置host_Java AxisProperties类代码示例
import org.apache.axis.AxisProperties; //导入依赖的package包/类 private StringBuilder getDefaultClasspath() ...
java面向对象（包package）
包package 对类文件进行分类管理给类提供多层命名空间写在程序文件的第一行类名的全称是包名.类名包也是一种封装形式包与包之间进行访问,被访问的包中的类以及类中的成员,需要public修 ...
java uml 类图加号_UML建模基础 UML类图的组成元素和关系解析
本文和大家重点讨论一下在UML建模中UML类图的java代码表现,主要包括UML类图元素和关系两大部分内容,相信通过本文的介绍你对UML类图的概念一定会与明确的认识. 在UML建模中UML类图的jav ...
JAVA接口的访问权限_Java中访问权限－类和接口
(1)类和接口的访问权限种类一样 , 有两中public,default,它们的不同在于是否能访问不同包中的类或接口 default:只能在本包中访问 public:任何地方都可以访问,当然不同的包中 ...
使用System.IO.Packaging.Package进行文件压缩所产生的问题
最近在项目中需要进行文件压缩,即将打包好的压缩文件提供给用户,用户进行下载. 获知微软提供了一个System.IO.Packaging.Package的类,从而可以进行打包,那么我就进行了使用.谁知道 ...
java中utilities类_Java PHUtilities类代码示例
import com.philips.lighting.hue.sdk.utilities.PHUtilities; //导入依赖的package包/类 private void setLampSta ...
Java读书笔记05 类与对象
本文为java中对象与类等的基本知识,包括方法.构造.析构.静态域.初始化.包.路径等. 对象与对象变量在Java中,任何对象变量的值都是对存储在另外一处的一个对象的引用.new操作符的返回值也是一 ...

package-info类

一、特殊性

二、作用

package-info类相关推荐

最新文章

热门文章