Java基础:包机制、JavaDoc、小结

包机制

问题发现

存在这样一个问题:当定义了多个类的时候,可能会发生类名的重复问题。

解决方式:在java中采用包机制处理开发者定义的类名冲突问题。

就好比我们平时的用电脑,一个文件夹下不能存在同名的文件,我们要是有这样的需求,但是又不想换名字,我们就可以考虑使用新建一个文件夹来存放!在我们的Java中也是这样的。

【演示:重名文件】

还有一个问题:我们平时在IDE中可以跑的文件,用命令行就会报错;

【演示:HelloWorld!IDE和命令行】

这是为什么呢?

罪魁祸首正是代码第一行:package com.kuang.demo01;

这就是Java中的包机制,使用package com.kuang.demo01;

就要求此份.java文件必须保存在这样一个目录下,这样Java解释器才能找到它。 在IDEA中能正确运行,你可以去Windows下的工程中查看,HelloWorld这个文件必是在这样的目录结构下的。

包的作用

为了更好地组织类,Java 提供了包机制,用于区别类名的命名空间。

包的作用:

  1. 把功能相似或相关的类或接口组织在同一个包中,方便类的查找和使用。
  2. 如同文件夹一样,包也采用了树形目录的存储方式。同一个包中的类名字是不同的,不同的包中的类的名字是可以相同的,当同时调用两个不同包中相同类名的类时,应该加上包名加以区别。因此,包可以避免名字冲突。
  3. 包也限定了访问权限,拥有包访问权限的类才能访问某个包中的类。

Java 使用包(package)这种机制是为了防止命名冲突,访问控制,提供搜索和定位类(class)、接口、枚举(enumerations)和注释(annotation)等。

包语句的语法格式为:

package pkg1[.pkg2[.pkg3…]];

例如,一个Something.java 文件它的内容:

package net.java.util;
public class Something{
    ...
}

那么它的路径应该是 net/java/util/Something.java 这样保存的。 package(包) 的作用是把不同的 java 程序分类保存,更方便的被其他 java 程序调用。

一个包(package)可以定义为一组相互联系的类型(类、接口、枚举和注释),为这些类型提供访问保护和命名空间管理的功能。

以下是一些 Java 中的包:

  • java.lang-打包基础的类
  • java.io-包含输入输出功能的函数

开发者可以自己把一组类和接口等打包,并定义自己的包。而且在实际开发中这样做是值得提倡的,当你自己完成类的实现之后,将相关的类分组,可以让其他的编程者更容易地确定哪些类、接口、枚举和注释等是相关的。

由于包创建了新的命名空间(namespace),所以不会跟其他包中的任何名字产生命名冲突。使用包这种机制,更容易实现访问控制,并且让定位相关类更加简单。

创建包

创建包的时候,你需要为这个包取一个合适的名字。之后,如果其他的一个源文件包含了这个包提供的类、接口、枚举或者注释类型的时候,都必须将这个包的声明放在这个源文件的开头。

包声明应该在源文件的第一行,每个源文件只能有一个包声明,这个文件中的每个类型都应用于它。

如果一个源文件中没有使用包声明,那么其中的类,函数,枚举,注释等将被放在一个无名的包(unnamed package)中。

一般利用公司域名倒置作为报名;

例子:

www.baidu.com 包名:com.baidu.www

bbs.baidu.com 包名:com.baidu.bbs

blog.baidu.com 包名:com.baidu.blog

我们平时也可以按照自己的公司域名去写,比如:com.kuangstudy.utils

import 关键字

为了能够使用某一个包的成员,我们需要在 Java 程序中明确导入该包。使用 "import" 语句可完成此功能。

在 java 源文件中 import 语句应位于 package 语句之后,所有类的定义之前,可以没有,也可以有多条,其语法格式为:

import package1[.package2…].(classname|*);

如果在一个包中,一个类想要使用本包中的另一个类,那么该包名可以省略。

要是要用到其他包下的类,就必须要先导包!

如果两个类重名,需要导入对应的包,否则就需要写出完整地址:

com.kuang.dao.Hello hello = new com.kuang.dao.Hello()

import 关键字引入,使用通配符 "*" , 导入io包下的所有类!

import java.io.*;

【不建议这样使用,因为会全局扫描,影响速度!】

使用 import 关键字引入指定类:

import com.kuang.Hello;

【注意】类文件中可以包含任意数量的 import 声明。import 声明必须在包声明之后,类声明之前。

【编码规范:推荐参考阿里巴巴开发手册编程规范】

下载地址:阿里巴巴开发手册

JavaDoc

简介

JavaDoc是一种将注释生成HTML文档的技术,生成的HTML文档类似于Java的API,易读且清晰明了。在简略介绍JavaDoc写法之后,再看一下在Intellij Idea 中如何将代码中的注释生成HTML文档。

javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形成程序的开发文档了。javadoc命令是用来生成自己API文档的,使用方式:使用命令行在目标文件所在目录输入javadoc +文件名.java。

先看一段样例代码:

/** 这是一个Javadoc测试程序
 *  @author Kuangshen
 *  @version 1.0
 *  @since 1.5
 * */
public class HelloWorld {
    
    public String name;
    /**
     * @param name 姓名
     * @return 返回name姓名
     * @throws  Exception 无异常抛出
     * */
    public String function(String name) throws Exception{
        return name;
    }
}

稍微解释一下:

以 /* 开始,以 / 结束。

@author 作者名

@version 版本号

@since 指明需要最早使用的jdk版本

@param 参数名

@return 返回值情况

@throws 异常抛出情况

命令行生成Doc

1569078162995.png

-encoding UTF-8 -charset UTF-8
//解决GBK乱码问题,在中间添加编码设置

【操作:生成并查看文档,index.html】

回顾及总结

这一章,我们学习了Java的基础

  • 安装使用了IDEA
  • 使用注释
  • 了解了Java的关键字
  • 数据类型
  • 怎么定义一个变量
  • 怎么操作这些变量
  • 如何生成一篇完整的文档
  • 。。。

以后这些东西在我们的生活中会天天遇到!

不积跬步,无以至千里;不积小流,无以成江海!

一生二,二生三,三生万物!

一切一切都说明了基础的重要性!

所以,简单的东西,不要忽略,高手之间的区分,就在于这些细节方面的东西!

Java基础