制作自己的java类库-阿里云开发者社区

开发者社区> 开发与运维> 正文
登录阅读全文

制作自己的java类库

简介: http://blog.csdn.net/qiumengchen12/article/details/44550059 随着自己编程能力的提升以及参加项目的增多,越来越强烈地感觉到,好多曾经项目中使用过的Java类以及方法, 在正在参加的项目中也需要使用,而如果只是单纯地复制,粘贴,显然既不美观,也会出现很多问题,比如忘记方 法到底是如何实现,返回类型,传入参数等等
http://blog.csdn.net/qiumengchen12/article/details/44550059
   随着自己编程能力的提升以及参加项目的增多,越来越强烈地感觉到,好多曾经项目中使用过的Java类以及方法,
   在正在参加的项目中也需要使用,而如果只是单纯地复制,粘贴,显然既不美观,也会出现很多问题,比如忘记方
   法到底是如何实现,返回类型,传入参数等等,而且也不便于和自己组内的人共享你的智慧。
      所以呢,一种超级赞的方法就出现了,个人觉得建立自己的类库,方便自己,方便他人,一次劳动,永久享用成果。
   我想好多大公司,一定有自己的类库,这样开发的效率提高不仅一个数量级。好了,废话不多说,下面我们来介绍一下
   如何导出自己的Java第三方类库以及如何制作相应的Javadoc。
   PS:在阅读这篇文章之前,请确保你会使用Eclipse进行最基本的操作。

一、如何导出自己的Java第三方类库

1. 首先呢,你需要创建自己的Java工程,当然了,至于名字啥的,随便起。我创建的工程如下:

我的Java工程

2. 然后呢,在你创建的工程中的某个类(我是Test类)中写入我们的测试方法,比如我写入的sayHello方法
和getName方法(**这里要特殊说一下,如果你制作的类库,希望在以后调用其中的方法,而不是把这个
类库当做一个单独的程序,则不要在这个类库中写入Main方法,main是入口,你懂的,只能有一个。**),
具体方法内容如下,其实很简单的。如下:

Test类中的方法

3. 准备工作呢,到此结束,下面我们来导出自己的类库,操作方法如下,首先,第一步,在你的项目文件夹上
右键,选择export,然后进入下面的界面:

export界面 
然后,你选择Java分类下面的JAR file ,然后点击Next。会出现如下界面: 
导出文件选择界面 
在这个界面,上面两个窗格部分,你可以选择需要导出的类文件(也就是.java文件),我们这里选择Test.java。 
然后下面的JAR file中可以选择类库的生成位置以及文件名称。 我们这里是选择输出到桌面,文件名为QscJavaLibrary.jar。 
然后直接点击finish就可以了,然后你会看到桌面增加了一个如下文件。 
生成的JAR文件 
导出工作呢,到这里就结束了。

4. 已经成功导出我们自己的JAR包了,那么该如何使用呢,同样我们创建一个工程,如下所示。当然了,这时候肯定
需要Main函数的,因为我们一会要运行的嘛。

创建测试工程 
同时,我们看到,这个工程中现在还没有引入我们自己编写的JAR包,这样当然是不能调用我们自己的方法了,所以 
Build Path,再选择Configure Build Path,然后会弹出如下界面,此时再选择Add External JARs,如下: 
Configure Build Path 
此时,找到你刚刚生成的JAR包,然后点击打开,在点击确定,如下: 
找到生成的JAR包 
再点击OK,你会发现项目的目录结构发生了变化,如下,多出了一个Referenced Libraries分类,而且分类下多了一个QscJavaLibrary.jar。 
项目结构发生变化

5. 下面,我们来调用自己写的JAR包,在main函数中写下如下代码。

main函数代码 
然后,千万别忘记,import my_java_library.Test;最后,运行代码,你会发现。Hello World。到这里,你已经成功地 
学会了如何导出自己的JAR包,以及如何使用其中的方法。 
Hello World

二、如何制作自己类库的Javadoc。

1. 首先,你要明白,Java中一共有三种注释方法,第一种是//注释,第二种是/* 注释 */ , 第三种是 / ** 注释 */,而,
只有第三种注释可以生成Javadoc,前两种注释都无法生成Javadoc,还有就是,只有标准的Javadoc标记才会被自动
识别和处理,自己YY的标记是不会被识别和处理的,如果Javadoc你不知道是什么,标准标记,你也不知道有哪些,那
请自行百度或者参考百度百科:

百度百科,Javadoc

2. 首先,看一下我写的两个Javadoc示例,如下:

Javadoc示例

3. 那么,按照规定写完了,如何自动化生成呢,很简单,还有右键工程文件夹,然后选择Export,然后在Java分类下
选择Javadoc。如下,

导出Javadoc 
然后一直下一步,就好了。然后,最后会出现如下提示框,选择Yes To All就可以了。然后你会看到控制台输出了 
如下一些东西: 
控制台输出 
然后,工程的根目录下出现了doc文件夹,如下: 
doc文件夹 
然后,你可以在Eclipse中直接双击index.html,或者找到doc文件夹,使用浏览器打开index.html。我是用后一种 
方法打开的,效果如下: 
Javadoc效果 
Javadoc效果 
是不是瞬间感觉,好高大上。。。。好有成就感啊。

三、补充说明

1. 必须说明一点,其实,Javadoc生成的效果是使用HTML来展示的。也就是说,注释中的HTML标记都可以
被正确的解析。比如说< br >标签,也就是换行标签。我们比较一下,sayHello和getName方法的注释的区别,如下

方法注释区别 
细心的朋友会发现,sayHello注释中没有使用< br >标签,但是getName注释中使用了< br >标签,那么生成 
Javadoc时候,会有什么区别呢,请看: 
效果比较 
你会发现,虽然sayHello的注释,我们分两行来写,但是生成的Javadoc呢,却挤在一行上,显然,如果你写了 
很多行注释的话,也会都挤在一行上,显然看着非常乱,而,getName方法的注释因为使用了< br >标签,所以 
起到了换行的作用,所以看起来更加清晰一些。

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

分享: