【JAVA】package-info.java 的用法

原创 已于 2025-10-14 11:38:28 修改 · 7.6k 阅读 · 14 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#package-info

于 2021-08-14 15:24:59 首次发布
本文介绍了如何在Java中利用package-info.java提供包级别注释，自定义包注解，并展示了如何使用@Deprecated标记过时包。还涵盖了创建、注解和获取包注解的方法，以及处理中文乱码的技巧。

目录

package-info.java 介绍

pacakge-info.java 是一个 Java 文件，目标是提供一个包级的文档说明及包级的注释。在 Java 5 之前，包级的文档是 package.html，是通过 JavaDoc 生成的。而在 Java 5 之后版本，包的描述以及相关的文档都可以写入 pacakge-info.java 文件。

创建 package-info.java

pacakge-info.java 不能随便被创建，会报 This is not a valid Java qualified name 错误，类名无效，因为类名不能包括 -，那么怎么创建这个文件呢？

创建一个普通的文件，文件名设置为 package-info.java 即可，或者从其它项目中复制一个。

pacakge-info.java 的内容只需要声明 package。

package com.test;

package-info.java 作用

提供包级别的注释

为 package-info.java 添加注释

/**
 * 测试 package-info 的包注释功能
 * 
 * @author mimi
 * @since 1.0.0-RELEASE
 * @version 2.0.0-RELEASE
 */
package com.test;

执行 javadoc 之后查看效果图

在这里插入图片描述

  • 如何在 idea 中执行 javadoc

Tools -> Generate JavaDoc，选择 Output directory，在 Othre Command line arguments 中填入 -encoding utf-8 -charset UTF-8，用于解决中文乱码问题。

在这里插入图片描述

提供包级别的注解

自定义一个注解


                

                
                
        

    


  


        

            

                      
                        最低0.47元/天 解锁文章
                          
                      
            

        


    



                



	

		

			

				
					
Java中的package-info.java作用

				
			

			

				

					m0_67401660的博客
				

				

					05-29
					
					328
					
				

			

		

		

			
				
前言
之前在Eclipse中，总是会不小心勾选到这个复选框，之前并没有怎么在意这个java文件，毕竟生成之后只有以下这么点内容。
　　
　　
　　而且你也不能直接创建package-info文件，因为编辑器会报 Type name is not valid 错误，类名无效。我也尝试在上述生成的 package-info.java 文件中定义一个class，由于Java变量定义的规范是由字母、数字、下划线和 $ 符号组成且首字母不为数字，不允许有 - , 所以这个显然是行不通的。
　　
　　所以我就很纳闷，这

			
		

	



                

            
              



	

		

			

				
					
Java模块化系统深度解析：module-info.java配置完全指南

				
			

			

				

					记录学习的过程
				

				

					06-05
					
					1459
					
				

			

		

		

			
				
Java 9模块化系统(JPMS)是Java平台的重要架构革新，通过module-info.java配置文件实现强封装和精确依赖管理。文章详细解析了模块化系统的关键特性：1) 模块描述符语法结构，包括requires、exports等核心指令；2) 多层次的依赖管理机制，区分强依赖、传递依赖等类型；3) 精细化的可见性控制策略；4) 类型安全的服务加载机制。通过典型三层应用和Spring集成的实战示例，展示了模块化的实施方法，并提出了从传统JAR到模块的渐进式迁移路径。模块化系统有效解决了JAR地狱、弱封装

			
		

	



              


  
              

                


	

		

			

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

				
			

			

				

					Diligence is the mother of success.
				

				

					04-23
					
					9838
					
				

			

		

		

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

			
		

	





	

		

			

				
					
java info info_package-info.java文件详解

				
			

			

				

					weixin_36333097的博客
				

				

					02-16
					
					615
					
				

			

		

		

			
				
欢迎关注我的社交账号：pacakge-info.java介绍pacakge-info.java是一个Java文件，可以添加到任何的Java源码包中。pacakge-info.java的目标是提供一个包级的文档说明或者是包级的注释。pacakge-info.java文件中，唯一要求包含的内容是包的声明语句，比如：package edu.jiangxin.tools;包文档在Java 5之前，包级的文...

			
		

	



		

			
		



	

		

			

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

				
			

			

				

					shenpeihui的专栏
				

				

					03-27
					
					1424
					
				

			

		

		

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

			
		

	





	

		

			

				
					
什么是package-info.java

				
			

			

				

					weixin_34061042的博客
				

				

					03-26
					
					1175
					
				

			

		

		

			
				
在java项目中创建package以后，可以在package下放一个package-info.java文件。
这个文件有什么作用？如何生成？
三个作用：


为标注在包上Annotation提供便利；



声明友好类和包常量；


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

			
		

	





	

		

			

				
					
package-info.java文件详解

				
			

			

				

					chszs的专栏
				

				

					05-14
					
					2万+
					
				

			

		

		

			
				
package-info.java文件详解作者：chszs，转载需注明。博客主页：http://blog.csdn.net/chszs一、pacakge-info.java介绍pacakge-info.java是一个Java文件，可以添加到任何的Java源码包中。pacakge-info.java的目标是提供一个包级的文档说明或者是包级的注释。pacakge-info.java文件中，唯一要求包含的

			
		

	





	

		

			

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

					
热门推荐

				
			

			

				

					枫夜
				

				

					05-06
					
					2万+
					
				

			

		

		

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

			
		

	





	

		

			

				
					
package-info.java_什么是package-info.java

				
			

			

				

					weixin_39829166的博客
				

				

					02-21
					
					276
					
				

			

		

		

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

			
		

	





	

		

			

				
					
javacv-1.5.5.jar中文文档.zip

				
			

			

				

					03-01
				

			

		

		

			
				
# 使用方法： 	解压 【javacv-***.jar中文文档.zip】，再解压其中的 【javacv-***-javadoc-API文档-中文(简体)版.zip】，双击 【index.html】 文件，即可用浏览器打开、进行查看。  # 特殊说明： 	·本文档为人性化...

			
		

	





	

		

			

				
					
javacv-1.5.3.jar中文-英文对照文档.zip

				
			

			

				

					03-01
				

			

		

		

			
				
# 使用方法： 	解压 【javacv-***.jar中文-英文对照文档.zip】，再解压其中的 【javacv-***-javadoc-API文档-中文(简体)-英语-对照版.zip】，双击 【index.html】 文件，即可用浏览器打开、进行查看。  # 特殊说明：...

			
		

	





	

		

			

				
					
javacv-1.4.4.jar中文文档.zip

				
			

			

				

					03-01
				

			

		

		

			
				
# 使用方法： 	解压 【javacv-***.jar中文文档.zip】，再解压其中的 【javacv-***-javadoc-API文档-中文(简体)版.zip】，双击 【index.html】 文件，即可用浏览器打开、进行查看。  # 特殊说明： 	·本文档为人性化...

			
		

	





	

		

			

				
					
package-info.java作用详解

				
			

			

				

					wenwenxiong的专栏
				

				

					05-26
					
					1658
					
				

			

		

		

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

			
		

	





	

		

			

				
					
package-info.java

				
			

			

				

					live的专栏
				

				

					01-28
					
					400
					
				

			

		

		

			
				
package-info.java

spring开源源码的时候，发现每个目录都有一个package-info.java文件

package-info.java是一个Java文件，可以放到任意Java源码包执行。不过里面的内容有特定的要求，其主要目的是为了提供包级别相关的操作，比如包级别的注解、注释及公共变量。

			
		

	





	

		

			

				
					
Java包注解和package-info.java文件的作用和用法

				
			

			

				

					快乐李同学的博客
				

				

					09-04
					
					6709
					
				

			

		

		

			
				
1 问题背景
博主最近在深入学习Java注解，其中就了解到注解可用于修饰包声明，因为@Target元注解的value元素数组可以包含ElementType.PACKAGE元素，接着博主就发现@Deprecated注解就支持修饰包声明：
package java.lang;
import java.lang.annotation.*;
import static java.lang.annotation.ElementType.*;

@Documented
@Retention(RetentionPolic

			
		

	





	

		

			

				
					
[改善Java代码]使用package-info类为包服务

				
			

			

				

					weixin_34306446的博客
				

				

					04-24
					
					544
					
				

			

		

		

			
				
建议50： 使用package-info类为包服务
 
Java中有一个特殊的类：package-info类，它是专门为本包服务的，为什么说它特殊呢？主要体现在3个方面：
（1）它不能随便被创建
在一般的IDE中，Eclipse、package-info等文件是不能随便被创建的，会报“Type name is notvalid”错误，类名无效。在Java变量定义规范中规定如下字符是允许的：...

			
		

	





	

		

			

				
					
状态估计电力系统状态估计中的异常检测与分类（Matlab代码实现）

					
最新发布

				
			

			

				

					12-07
				

			

		

		

			
				
【状态估计】电力系统状态估计中的异常检测与分类（Matlab代码实现）内容概要：本文围绕电力系统状态估计中的异常检测与分类展开，介绍了基于Matlab代码实现的相关方法和技术。通过对电力系统测量数据的分析，利用状态估计技术识别和分类异常数据，如坏数据或错误操作，从而提升电力系统监控的准确性与可靠性。文中可能涉及残差分析、假设检验、标准化残差、加权最小二乘法（WLS）等核心技术，并结合具体Matlab代码演示异常检测流程与分类策略，帮助研究人员深入理解状态估计在实际工程中的应用。;  
适合人群：具备电力系统基础知识和Matlab编程能力的高校研究生、科研人员及电力行业相关技术人员。;  
使用场景及目标：①应用于智能电网监控与调度系统中，实现对实时测量数据的质量控制；②用于教学与科研，加深对电力系统状态估计理论与异常处理机制的理解；③为电力系统自动化与可靠性分析提供技术支持。;  
阅读建议：建议读者结合Matlab代码实践操作，逐步调试并理解每一步算法实现，同时参考电力系统状态估计的经典文献，以加强对异常检测数学模型和工程背景的认识。

			
		

	





	

		

			

				
					
package-info.Java

				
			

			

				

					08-05
				

			

		

		

			
				
<think>首先，用户的问题是关于Java的package-info.java文件的作用和使用方法。根据系统级指令，我需要：

1. 所有行内数学表达式使用$...$格式。

2. 独立公式使用$$...$$格式并单独成段。

3. LaTeX语法正确。

4. 使用中文回答。

5. 生成相关问题。

6. 回答中引用的段落末尾自然地添加引用标识，如[^1]。

用户提供了几个引用，我需要参考这些引用，因为它们与主题相关。引用内容是关于package-info.java文件的：

- 引用[^1]：介绍了package-info.java文件和包注释的作用和用法。

- 引用[^2]：讨论了package-info.java的使用，包括包级别的注释、注解和变量。

- 引用[^3]：解释了package-info.java的三个作用：为包上的Annotation提供便利、声明包的私有类和常量、提供包的整体注释说明。

- 引用[^4]：似乎是一个Student类的示例，但可能不直接相关，我会忽略它，除非必要。

用户意图是了解package-info.java文件的作用和使用方法，所以我需要基于这些引用构建回答。

回答结构要清晰，帮助用户逐步解决问题。尽量保证真实可靠。

最后，生成相关问题。

**回答结构：**

1. **介绍package-info.java文件**：简要说明它是什么。

2. **作用**：详细列出其作用，参考引用。

3. **使用方法**：如何创建和使用它。

4. **示例**：提供代码示例。

5. **注意事项**：任何需要注意的点。

6. **生成相关问题**：在回答末尾。

使用中文回答。

关于数学表达式：用户的问题中没有数学内容，但指令说所有行内数学表达式必须使用$...$格式。在这个上下文中，可能没有数学，但如果有变量或方程，我应该使用。例如，如果提到版本号，如$version="1.0"$，但通常不需要。我会确保如果有数学元素，正确格式化。

现在，构建回答：

- **开头**：直接回答问题。

- **主体**：分点解释作用和用法。

- **结尾**：总结并生成相关问题。

引用标识：在回答中引用段落时，在末尾添加[^n]。例如，如果引用引用[^1]，就在相关句子后加[^1]。

引用内容：

- [^1]: Java包注解和package-info.java文件的作用和用法。

- [^2]: package-info.java的使用，包括包级别的注释、注解和变量。

- [^3]: package-info.java的三个作用。

我会整合这些。

**步骤：**

1. 解释package-info.java是什么：一个特殊的Java文件，用于包级别的元数据。

2. 作用：

   - 提供包级别的注释（文档）。

   - 提供包级别的注解（如@Deprecated）。

   - 声明包级别的常量或私有类（但Java中包常量不直接支持，需用类）。

3. 使用方法：

   - 如何创建：在包目录下创建package-info.java文件。

   - 内容：包含包声明和可选注释、注解。

4. 示例代码：从引用[^3]中提取。

5. 注意事项：如文件必须命名为package-info.java，包声明必须匹配等。

生成相关问题：

- 基于主题，如：如何为包添加注解？package-info.java的常见错误？

确保回答真实可靠：基于标准Java实践。</think>### Java package-info.java 文件的作用和使用方法

package-info.java 是 Java 中的一个特殊文件，用于管理包级别的元数据。它不是常规的 Java 类文件，而是专门设计来处理包相关的注释、注解和常量声明。这个文件通常放置在包的根目录下（例如 `com/example/mypackage/package-info.java`），帮助开发者更好地组织和文档化代码结构[^1]。下面我将逐步解释其作用和使用方法，确保内容清晰可靠。

#### 1. **package-info.java 的主要作用**
package-info.java 文件的核心功能包括三个方面，这些功能提升了代码的可维护性和文档化水平：

- **提供包级别的注释（文档说明）**：  
  通过在文件中添加 Javadoc 注释，可以为整个包生成统一的文档说明。例如，在 IDE 或 Javadoc 工具中，这些注释会显示为包的概述，帮助其他开发者快速理解包的用途和功能[^2]。  
  示例：在文件中添加 `/** 这是一个示例包的说明 */`，Javadoc 会将其作为包的文档输出。

- **提供包级别的注解（Annotation）**：  
  这个文件允许在包声明上直接应用注解，用于元数据处理。例如，使用 `@Deprecated` 标记整个包为过时，或自定义注解（如 `@PackageAnnotation`）来添加包级别的元数据，如版本号或作者信息[^3]。这在框架开发中特别有用，比如 Spring 或 Hibernate 中处理包扫描。  
  参考示例：`@PackageAnnotation(version="1.0")` 可以定义包的版本，便于工具解析[^3]。

- **声明包级别的常量或私有类**：  
  虽然 Java 不支持直接在包中定义常量或私有类，但 package-info.java 可以包含静态内部类或常量字段。这些内容在包内共享，但对外部不可见，有助于封装包内部实现细节[^3]。例如，定义包专用的工具类或配置常量。

  这些作用综合起来，使 package-info.java 成为管理包元数据的理想选择，尤其在大型项目中提升代码组织和文档化[^1][^2]。

#### 2. **使用方法：创建和使用 package-info.java**
使用 package-info.java 文件非常简单，但需遵循特定步骤以确保正确性。以下是详细指南：

- **创建文件**：  
  在目标包的目录下，创建一个名为 `package-info.java` 的文件（注意文件名必须严格匹配）。文件内容以包声明开头，后跟可选的注释和注解。  
  示例结构：
  ```java
  /**
   * 这个包包含所有与用户管理相关的类。
   * 提供用户创建、更新和删除功能。
   * 
   * @author 开发者名称
   * @version 1.0
   */
  @Deprecated // 标记整个包为过时，不推荐使用
  @PackageAnnotation(version = "1.0") // 自定义注解
  package com.example.mypackage;
  
  // 可选：声明包级别的常量或工具类
  class PackageConstants {
      public static final int MAX_USERS = 100;
  }
  ```
  说明：  
  - 包声明 `package com.example.mypackage;` 必须与文件所在目录匹配。
  - Javadoc 注释用于生成文档，注解（如 `@Deprecated`）用于元数据。
  - 常量或类声明在文件末尾，但需注意这些类默认是包私有（package-private），外部包无法访问[^3]。

- **编译和使用**：  
  - 使用标准 Java 编译器（如 `javac`）编译时，package-info.java 会被自动处理。注解和注释会集成到字节码或文档中。
  - 在代码中引用时，通过包名访问常量或类（例如 `com.example.mypackage.PackageConstants.MAX_USERS`）。
  - 在 IDE（如 IntelliJ IDEA 或 Eclipse）中，文件会被识别并显示在包视图中，便于维护。

- **注意事项**：  
  - **命名必须准确**：文件名必须为 `package-info.java`，否则编译器忽略。
  - **包声明一致性**：文件中的包名必须与实际包路径一致，否则编译错误。
  - **使用场景**：仅在需要包级别元数据时使用（如大型框架或文档化项目），否则可能增加冗余[^1]。例如，如果项目不需要包注释或注解，可以省略此文件。
  - **兼容性**：从 Java 5 开始支持，但需确保构建工具（如 Maven 或 Gradle）配置正确。

#### 3. **实际应用示例**
以下是一个完整示例，基于引用[^3]的简化版本：
```java
/**
 * <b>用户管理包</b><br>
 * 包含用户实体和服务类，支持 CRUD 操作。<br>
 * 注意：此包在版本 2.0 后可能废弃。
 */
@Deprecated(since = "1.5") // 标记包过时
package com.example.user;

// 包私有常量
class UserConstants {
    public static final String DEFAULT_ROLE = "USER";
}
```
在这个示例中：
- Javadoc 注释提供了包的总体描述。
- `@Deprecated` 注解警告开发者该包已过时。
- `UserConstants` 类定义了包内共享的常量。

#### 总结
package-info.java 文件是 Java 开发中一个强大但低调的工具，主要用于包级别的文档、注解和常量管理。它能显著提升代码的可读性和维护性，尤其适合大型项目或框架开发[^1][^3]。然而，在简单项目中，如果不需要这些元数据功能，可以避免使用以保持简洁。如果您在实现时遇到问题（如编译错误），建议检查文件名和包声明是否匹配。



			
		

	



              




          




        



    





    



      

      

        
      

      





	

		评论	
	

  

	
    

      

      

      

        
        

          
          

            

              成就一亿技术人!
            

            

              拼手气红包6.0元
            

          

        

        

          

            还能输入1000个字符
          

          

             
          

          

            

              红包
              添加红包
            

            

              表情包
              插入表情
              

                

              

            

            

              表情包
              代码片
              

                
              

            

            

              
              
              
              
              
              
              
            

          

        

      

    

		

			

			

			

					 条评论被折叠 查看
			

			

				
			

		

	

	




  

    

      添加红包
      
    

    

      

        
        

          
          
        

        
请填写红包祝福语或标题

      

      

        
        

          
          个
        

        
红包个数最小为10个

      

      

        
        

          
          元
        

        
红包金额最低5元

      

      

        
        

          当前余额3.43元
          前往充值 >
        

      

      

        

          需支付：10.00元
        

        
        
      

    

  





  

    
    
  

  

    
    
  








  

    

      

        

          

            
            
成就一亿技术人!

          

          

        

        

          

          

            领取后你会自动成为博主和红包主的粉丝
            规则
          

        

      

      

        

          

            
              
            
            

              
hope_wisdom
 发出的红包
            

          

        

        

          

          

          

        

      

    

    

  



      
      

      
实付元

      
使用余额支付

      

        

          

            
            点击重新获取
          

        

        
扫码支付

      

      

        
          
            
          
          
        
      

      

        
        钱包余额
          0
          

            
            

              

                
抵扣说明：

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

              

            

          

      

      余额充值