`
redstarofsleep
  • 浏览: 445505 次
  • 性别: Icon_minigender_1
  • 来自: 苏州
社区版块
存档分类
最新评论

另类的package-info.java文件探讨 [转]

    博客分类:
  • Java
阅读更多

翻看以前的笔记,看到一个特殊的java文件:pacakge-info.java,虽然有记录,但是不全,就尝试着追踪一下该问题,分享一下流水账式的结果。

首先,它不能随便被创建。在Eclipse中, package-info文件不能随便被创建,会报“Type name is notvalid”错误,类名无效,Java变量定义规范是:字母、数字、下划线,还有那个不怎么常用的$符号(顺带说下,Java是支持中文名称的变量,习惯挑战的同学可以尝试下,分享一下这方面的经验),这个中划线可不再之列,那怎么创建这个文件呢?

很简单,用记事本创建一个,然后拷贝进去再改一下就成了,更直接的办法就是从别的项目中拷贝过来一个,这更方便。

其次,服务的对象很特殊。一个类是一类或一组事物的描述,比如Dog这个类,就是描述旺财的,那package-info这个类是描述啥的呢?它总要有一个被描述或被陈述的对象,它是描述和记录本包信息

最后,类不能带有public、private访问权限。package-info.java再怎么特殊,也是一个类文件,也会被编译成package-info.class,但是在package-info.java中只能声明默认访问权限的类,也就是友好类。

其实还有几个特殊的地方,比如不可以继承,没有接口,没有类间关系(关联、组合、聚合等等)等。

这个文件的特殊性说完了,那再说说它有什么作用,它有三个作用:

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

2、声明友好类和包常量;

3、提供包的整体注释说明。

我们来建立一个项目演示这三个作用,建立一个package-info的Java Project,在com.company包三个类:package-info.java 是我们重点关注的,PkgAnnotation.java是一个标注在包上的注解定义,Client.java模拟业务操作类。其结构如下图:


 

 

为标注在包上Annotation提供便利

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

 

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

 

 

 

再定义一个package-info类,这个是一个特殊的类,先看代码:

 

Java代码
  1. @PkgAnnotation
  2. package com.company;
@PkgAnnotation
package com.company;

很简单,就这么个文件,里面啥都没有,就这两句话,没有class类,没有常变量声明。接着写一个模拟交易类,代码如下:

 

Java代码
  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. }
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路径
				 */			
			}
		}
	}
}

运行结果如下所示:

 

 

 

Hi,I'm the PkgAnnotation ,which is be placed on package!

 

 

声明友好类和包常量

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

 

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

 

 

 

提供包的整体注释说明

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

 

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

 

 

 

通过javadoc生成的API文档如下:


 

这与包下放置package.htm没啥区别,只是package-info可以更好的在代码中维护文档的完整性,并且可以实现代码与文档同步更新,package.htm也可以做到,不争论,建议是Java 1.5以上版本都使用package-info.java来注释。

 

与package-info相关的问题

在项目开发中,可以放置在包上的常用注解有: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文件惹的祸,在各个包下创建一个即可。

 

转自: http://blog.csdn.net/antswallow/article/details/6277079

分享到:
评论
3 楼 扬州老鬼 2012-10-30  
11月底,从此就要偏居一偶,难得见面喽。
2 楼 redstarofsleep 2012-10-25  
扬州老鬼 写道
您老的java功力正式胜不可测啊

哪里,哪里。。。这篇是转的。
听说你们快了啊?
1 楼 扬州老鬼 2012-10-25  
您老的java功力正式胜不可测啊

相关推荐

    开源项目经常看到 package-info.java 文件,到底有啥用?(csdn)————程序.pdf

    【package-info.java 文件的作用】 在Java编程中,`package-info.java`文件是一个特殊的源代码文件,它的主要功能是提供包级别的元数据,包括文档注释和包级别的变量。以下是其具体用途的详细解释: 1. **包级文档...

    开源项目中经常看到package-info.java文件,你知道其作用吗?.zip

    计算机技术、IT咨询、人工智能AI理论介绍,学习参考资料 计算机技术、IT咨询、人工智能AI理论介绍,学习参考资料 计算机技术、IT咨询、人工智能AI理论介绍,学习参考资料 计算机技术、IT咨询、人工智能AI理论介绍,...

    基于C#,读取package-lock.json文件,并下载tgz到指定位置

    背景:介于工作环境的问题,我们要把前端vue项目中所用到的各个依赖导入到另一个全新的内网仓库中,所以我就基于C#语言简单的写了个windows程序,实现根据vue项目的package-lock.json文件里相关依赖包的下载路径来...

    实现yarnlock与packagelockjson相互转换

    `yarn.lock` 和 `package-lock.json` 文件都是npm和yarn包管理器为了确保项目依赖一致性而生成的文件。本篇文章将详细探讨这两个文件的作用、差异以及如何实现它们之间的相互转换。 ### `yarn.lock` 文件 `yarn....

    libaio-0.3.105-2.x86_64.rpm

    64位centos按装下按装64位oracle时,centos系统缺少的rpm包,附件内存放着以下rpm按装包: libaio-0.3.105-2.x86_64.rpm libaio-devel-0.3.105-2.i386.rpm libaio-devel-0.3.105-2.x86_64.rpm libaio-devel-0.3.106-...

    oracle-instantclient11.2-basic-11.2.0.4.0-1.x86_64.rpm

    oracle-instantclient11.2-sqlplus-11.2.0.4.0-1.x86_64.rpm --补充包/文件,是为了运行sql*plus的即时客户端; oracle-instantclient11.2-odbc-11.2.0.4.0-1.x86_64.rpm --补充包/文件,为运行ODBC环境附加库; ...

    node-tgz-downloader:根据package-lock.json文件下载所有的node_modules

    本地package-lock.json文件 网址到package-lock.json 包装名称 本地package.json文件 网址到package.json 搜索关键词 安装 npm install node-tgz-downloader -g 用法 来自代码: const downloader = require ( '...

    java-1.8.0-openjdk-devel-1.8.0.262.b10-1.el7.i686.rpm

    java-1.8.0-openjdk-devel-1.8.0.262.b10-1.el7.i686.rpm

    oracle官方精简64位客户端-instantclient-basic-windows.x64-11.2.0.2.0

    Instant Client Package - Basic: All files required to run OCI, OCCI, and JDBC-OCI applications instantclient-basic-windows.x64-11.2.0.4.0.zip (54,956,947 bytes) Instant Client 程序包 — Basic(win64...

    将yarn.lock转换为package-lock.json,反之亦然-JavaScript开发

    synp将yarn.lock转换为package-lock.json,反之亦然。 install npm install -g synp命令行用法yarn.lock =&gt; package-lock.json yarn#确保node_modules文件夹dir和synp将yarn.lock转换为package-lock.json,反之亦然...

    Python脚本自动下载package-lock.json依赖包

    这里我们关注的是如何使用Python脚本来自动化下载`package-lock.json`文件,这是Node.js项目中的一个重要组件,它记录了所有依赖及其精确版本,确保团队成员和构建环境之间的依赖一致性。接下来,我们将深入探讨这个...

    python2.7中所用的get-pip.py文件+安装方法

    1. **安装库**:你可以使用`pip install &lt;package_name&gt;`来安装任何在PyPI(Python Package Index)上可用的库。例如,安装`numpy`库的命令是`pip install numpy`。 2. **升级库**:如果你已经安装了一个库,但想...

    WSDL2Java及axis2-1.5-bin.zip的包

    稍微复杂一些的,-p可以指定生成的package,-o指定生成的路径,-ss生成服务端代码wsdl2java -uri ../wsdl/currencyConvert.wsdl -o ../gen_src -ss -sd -g -p foo.bat再复杂一些,-ns2p 将namespace进行替换,多个...

    maven-plugin-tools-java-3.1-17.el7.x64-86.rpm.tar.gz

    首先,文件标题为“maven-plugin-tools-java-3.1-17.el7.x64-86.rpm.tar.gz”,这表明文件是一个压缩包,其中包含的主文件为“maven-plugin-tools-java-3.1-17.el7.rpm”,这是一种rpm格式的文件,通常用于在基于RPM...

    安装Apache提示缺少 libapr-1.so.0与libaprutil-1完美解决

    本文将深入探讨“安装Apache提示缺少 libapr-1.so.0与libaprutil-1完美解决”的知识点,帮助读者理解其中的问题原因及解决方法。 ### Apache依赖库解析 在尝试安装Apache时遇到“缺少 libapr-1.so.0与libaprutil-1...

    jdk-6u45-linux-i586-rpm.bin

    这个文件采用RPM(Red Hat Package Manager)格式,这是一种在Linux系统中广泛使用的软件包管理器,用于安装、升级和管理软件。 描述中的"//linux jdk 1.6 x86"进一步确认了这是一个适用于Linux平台的JDK,版本为...

    java-1.8.0-openjdk-1.8.0.312.b07-1.el7_9.x86_64.rpm

    官方离线安装包,测试可用。使用rpm -ivh [rpm完整包名] 进行安装

    flink-streaming-java_2.12-1.14.3-API文档-中文版.zip

    赠送Maven依赖信息文件:flink-streaming-java_2.12-1.14.3.pom; 包含翻译后的API文档:flink-streaming-java_2.12-1.14.3-javadoc-API文档-中文(简体)版.zip; Maven坐标:org.apache.flink:flink-streaming-java_...

    jdk-6u45-linux-x64-rpm.bin

    在Linux环境中,RPM(Red Hat Package Manager)是一种广泛使用的软件包管理器,用于安装、升级和管理软件。这个bin文件是一个可执行二进制文件,用户可以通过运行它来安装JDK。 描述中的"linux jdk 1.6 for X64...

    commons-fileupload-1.2.jar和commons-io-1.3.2.jar

    新建一个servlet: FileUpload.java用于文件上传: package com.drp.util.servlet; import java.io.IOException; import java.io.PrintWriter; import javax.servlet.ServletException; import javax.servlet....

Global site tag (gtag.js) - Google Analytics