package-info.java 作用及用法详解

【JAVA】package-info.java 的用法 摘要: package-info.java是Java中用于提供包级文档和注释的特殊文件,替代了早期package.html的作用。它支持包级别的Javadoc注释、自定义注解(如@Deprecated标记废弃包)以及声明包内默认访问权限的常量类。创建时需直接命名为package-info.java,内容仅需package声明。通过IDEA生成Javadoc时需配置编码参数避免乱码。此外,包注解可通过反射获取,而包内常量仅限同包访问。该文件是组织包元数据和文档的重要工具。 阅读详情
package-info.java对于经常使用外部包的程序员来说应该是熟悉陌生人。因为不是专门开发包的程序员很少需要关注它,而又常在其他包中看到他,眼很熟。它到底有哪些特性和作用及如何使用呢?程序员讲究动口不如动手,何不创建一个试试。打开Eclipse,new class,哦!创建失败,‘-’ 作为特殊字符不允许在类名称里出现,什么情况。原来它本来就是个特例当然得用特别方法创建,记事本上,好了成功了。我喜欢追根问底,还什么特殊的,google 吧,果然有先辈,转过来收藏了。

原文地址:http://strong-life-126-com.iteye.com/blog/806246

特点:
首先,它不能随便被创建。在Eclipse中,package-info文件不能随便被创建,会报“Type name is notvalid”错误,类名无效,Java变量定义规范是:字母、数字、下划线,还有那个不怎么常用的$符号(顺带说下,Java是支持中文名称的变量,习惯挑战的同学可以尝试下,分享一下这方面的经验)。
其次,服务的对象很特殊。一个类是一类或一组事物的描述,比如Dog这个类,就是描述旺财的,那package-info这个类是描述啥的呢?它总要有一个被描述或被陈述的对象,它是描述和记录本包信息。
最后,类不能带有public、private访问权限。package-info.java再怎么特殊,也是一个类文件,也会被编译成package-info.class,但是在package-info.java中只能声明默认访问权限的类,也就是友好类。
其实还有几个特殊的地方,比如不可以继承,没有接口,没有类间关系(关联、组合、聚合等等)等。

这个文件的特殊性说完了,那再说说它有什么作用,它有三个作用:
为标注在包上Annotation提供便利;
声明友好类和包常量;
提供包的整体注释说明。
    我们来建立一个项目演示这三个作用,建立一个package-info的Java Project,在com.company包三个类:package-info.java是我们重点关注的,PkgAnnotation.java是一个标注在包上的注解定义,Client.java模拟业务操作类。其结构如下图:


为标注在包上Annotation提供便利
     首先定义一个包类型的注解,它只能放置的一个包上:
Java代码   
     
    @Target(ElementType.PACKAGE)  
      @Retention(RetentionPolicy.RUNTIME)  
    public @interface PkgAnnotation {  
    } 
 再定义一个package-info类,这个是一个特殊的类,先看代码:
@PkgAnnotation  
package com.company; 
 很简单,就这么个文件,里面啥都没有,就这两句话,没有class类,没有常变量声明。接着写一个模拟交易类,代码如下
Java代码:
    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");  
                        
                }  
            }  
        }  
    }  
      运行结果如下所示:

Hi,I'm the PkgAnnotation!

 声明友好类和包常量

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

Java代码:

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

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

Java代码:
     
    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文件惹的祸,在各个包下创建一个即可。
【Java基础】25.包(package) 为了更好地组织类,Java 提供了包机制,用于区别类名的命名空间。 阅读详情

相关推荐

在ros里给机械臂加上夹爪和底盘后,控制真实机械臂

使用ur3_bringup 可以连接真实机械臂 使用官方的ur3_moveit_planning_execution.launch 可以对机械臂 moveit规划。 但是只有机械臂,没有夹爪。 官方如图: 我把原来的ur3_moveit_config 复制出来,修改 然后把ur3.xacro 等模型文件复制出来修改,修改完之后,有了夹爪,有了底盘。 规划组什么的使用moveit setup assistant 配置过了。 在rviz中可以笛卡尔空间规划了。 ...

超级菜 2721

一文带你看懂:不为人知的 package-info.java 文件

许多同学日常开发时,都不太注意到,原来自己维护这么久的 web 工程中,居然还有 package-info.java 这么一个类。但只要我们在 idea 中搜索一下,就能够发现很多依赖包,都用到了这个类的实现。那么,下面我们一起研究下,到底什么是package-info.java 类文件~~【目录】1)注解技术2)package-info类拆解3)动态ClassLoad...

Diligence is the mother of success. 1万+

Unity UI适配核心:Canvas Scaler模式解析与2023版避坑指南

UI适配是游戏与应用开发中的基础挑战,其核心在于确保界面元素在不同屏幕分辨率与设备上保持视觉一致与功能可用。原理上,系统通过坐标转换与缩放计算,将设计稿的布局映射到物理屏幕。技术价值在于提升用户体验的一致性与产品的跨平台兼容性。应用场景广泛覆盖手游、PC端应用及各类交互界面。本文聚焦Unity引擎中的Canvas Scaler组件,深入剖析其Scale With Screen Size等模式的工作原理,并结合锚点设置、安全区域处理等高频搜索热词,提供解决UI错位、拉伸及异形屏适配等常见问题的工程实践方案,帮

weixin_30920597的博客 623

Java学习系列:package-info.java的作用

学习开源源码的时候,发现每个目录都有一个package-info.java文件,查找其用法,并整理总结。

枫夜 2万+

LEC/FORMAL --- PARTIII debug

lec(logic equivalence checking)又叫formal check,是对ic design的综合,PR前后的设计进行逻辑对比检查的工具/手段,保证综合不改变rtl原始的logic function。目前用的较多的就是C家的formal工具。接下来介绍一下lec过程中遇到的问题以及debug手段。...

sinat_27691203的博客 7715

AlphaFold-multimer实战:从零开始预测STAT1-STAT2蛋白复合物结构

本文详细介绍了使用AlphaFold-multimer从零开始预测STAT1-STAT2蛋白复合物结构的完整实战流程。内容涵盖环境配置、数据库准备、序列处理、参数优化及结果可信度评估,为研究者利用这一AI工具进行复合物结构预测提供了系统指南和深度解析。

weixin_29094301的博客 889

什么是package-info.java

在java项目中创建package以后,可以在package下放一个package-info.java文件。 这个文件有什么作用?如何生成? 三个作用: 为标注在包上Annotation提供便利; 声明友好类和包常量; 比如一个包中有很多的内部访问的类或常量,就可以统一的放到package-info类中,这样就方便,而且集中管理,减少friendly类到处游走的情况,看例子: //这...

weixin_34061042的博客 1221

Jasper Report使用JSON数据源创建报表

最近在做一个项目小功能,表单结案要生成PDF报表。 起初,想用HTML模板(art-template模板引擎)编写,利用浏览器的打印功能保存成pdf文件下载。但是HTML编写好的模板,页码、页眉、页脚设置有坑,表单内容中的表格较多,表格不能设置跨页,导致跨页的表格内容与页眉重叠,没能解决这个问题。 于是,转战研究Jasper report生成报表,用更加专业的报表生成工具来做。刚开始,也是跌跌撞撞,遇到了很多问题,因为觉得没有退路了,必须要用这个搞出来,所以就硬着头皮去找各种资料。 主要使用的json

xiaogege2012的专栏 3321

java package-info_PACKAGE-INFO.JAVA 作用及用法详解

package-info.java对于经常使用外部包的程序员来说应该是熟悉陌生人。因为不是专门开发包的程序员很少需要关注它,而又常在其他包中看到他,眼很熟。它到底有哪些特性和作用及如何使用呢?程序员讲究动口不如动手,何不创建一个试试。打开Eclipse,new class,哦!创建失败,‘-’ 作为特殊字符不允许在类名称里出现,什么情况。原来它本来就是个特例当然得用特别方法创建,记事本上,好了成功...

weixin_32165903的博客 1129

rk3576 点亮 LCD(mipi)

瑞芯微 RK3576 是一款面向中高端 AIoT 市场的 SoC,其 MIPI DSI (Display Serial Interface) 接口在性能和灵活性上相比前代(如 RK3399/RK3568)有显著提升,特别是在物理层协议的支持上更加现代化。相比RK3399 RK3568的mipi 接口少了 8lane,但是RK3576 MIPI DSI 增加更低功耗的 C-PHY。

weixin_35723192的博客 365

RT-DETR改进策略【Conv和Transformer】| HiLo注意力机制 通过分离处理图像的高频和低频信息,高效处理图像特征

本文记录的是利用改进检测模型,针对目标检测中面临的多尺度特征融合效率与长距离依赖建模难题,HiLo注意力模块的引入旨在通过频率解耦策略优化高分辨率特征处理,将高频细节(如目标边缘)与低频语义(如场景结构)分离建模,提升目标检测精度。Fast Vision Transformers with HiLo AttentionHiLo注意力模块的提出源于对传统自注意力机制局限性的反思。传统多头自注意力(MSA)在处理高分辨率图像时存在以下问题:HiLo将注意力模块分为高频(Hi-Fi)和低频(Lo-Fi)两个分支,

Limiiiing的博客 818

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

package-info.java对于经常使用外部包的程序员来说应该是熟悉陌生人。因为不是专门开发包的程序员很少需要关注它,而又常在其他包中看到他,眼很熟。它到底有哪些特性和作用及如何使用呢?程序员讲究动口不如动手,何不创建一个试试。打开Eclipse,new class,哦!创建失败,‘-’ 作为特殊字符不允许在类名称里出现,什么情况。原来它本来就是个特例当然得用特别方法创建,记事本上,好了

shenpeihui的专栏 1458

ABAP CDS HAVING 全解析:聚合之后的精准过滤、最佳实践与可运行示例

摘要: 本文针对具备ABAP与CDS基础的开发者,详解HAVING在ABAP CDS中的核心用法。HAVING专用于过滤GROUP BY后的聚合结果(如SUM、COUNT),与WHERE的分工明确:前者处理聚合值,后者过滤原始记录。通过销售额阈值、质量分析、财务对账三类典型场景,结合性能优化建议(如优先使用WHERE索引过滤),说明实际应用。文中提供经典CDS View与View Entity两种实现代码,并附Open SQL消费示例,帮助开发者快速落地。常见误区(如聚合条件误写至WHERE)与规避方法亦被

2007 年 ~ 2025 年,深耕 SAP 技术 18 年 226

package-info.java_package-info.java 作用及用法详解

这个文件的特殊性说完了,那再说说它有什么作用,它有三个作用:为标注在包上Annotation提供便利;声明友好类和包常量;提供包的整体注释说明。我们来建立一个项目演示这三个作用,建立一个package-info的Java Project,在com.company包三个类:package-info.java是我们重点关注的,PkgAnnotation.java是一个标注在包上的注解定义,Client...

weixin_39613692的博客 468

迈瑞BS系列全自动生化分析仪LIS协议接口手册(内含HL7和ASTM)

迈瑞BS系列全自动生化分析仪LIS协议接口手册,内含HL7和ASTM)

WINCC7.3破解文件

WINCC7.3硬件够破解文件,有需要的下载!WINCC7.3硬件够破解文件,有需要的下载!

package-info.java作用详解

package-info.java对于经常使用外部包的程序员来说应该是熟悉陌生人。因为不是专门开发包的程序员很少需要关注它,而又常在其他包中看到他,眼很熟。它到底有哪些特性和作用及如何使用呢?程序员讲究动口不如动手,何不创建一个试试。打开Eclipse,new class,哦!创建失败,‘-’ 作为特殊字符不允许在类名称里出现,什么情况。原来它本来就是个特例当然得用特别方法创建,记事本上,好了成功

wenwenxiong的专栏 1701

ssm框架搭建

这个是一个在idea上成功跑起来的ssm框架项目,保存在这里方便以后使用直接下载

Java的info用法_PACKAGE-INFO.JAVA 作用及用法详解

package-info.java对于经常使用外部包的程序员来说应该是熟悉陌生人。因为不是专门开发包的程序员很少需要关注它,而又常在其他包中看到他,眼很熟。它到底有哪些特性和作用及如何使用呢?程序员讲究动口不如动手,何不创建一个试试。打开Eclipse,new class,哦!创建失败,‘-’ 作为特殊字符不允许在类名称里出现,什么情况。原来它本来就是个特例当然得用特别方法创建,记事本上,好了成功...

weixin_33649132的博客 1703

假人有限元模型

假人模型,车辆碰撞假人有限元模型,适合做乘员安全的研究者利用

从PID到Backstepping:动态面控制(DSC)如何帮你搞定非线性系统跟踪?附Matlab对比案例

本文深入探讨了从PID到动态面控制(DSC)的非线性系统跟踪解决方案,重点介绍了反步法控制(Backstepping)的革新思路及其局限性,以及动态面控制(DSC)如何通过引入一阶低通滤波器解决微分爆炸问题。通过Matlab对比案例,展示了DSC在非线性系统跟踪中的优越性能,包括更小的超调、更快的响应速度和更高的稳态精度。文章还提供了DSC参数整定的实用建议和常见问题排查方法,为工程师在实际应用中实现高效控制提供了宝贵参考。

weixin_33733810的博客 448
上一篇: Eclipse 专用等宽字体,Yahei_Consola字体
下一篇: hashCode与equals的区别与联系
Ding-
博客等级 码龄12年 2粉丝 10原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值