JavaSE注释

注解在JavaSE中算是比较高级的一种用法了,为什么要学习注解,我想大概有以下几个原因:

1. 可以更深层次地学习Java,理解Java的思想.

2. 有了注解的基础,能够方便阅读各种框架的源码,比如hibernate,SpringMVC等等。里面就用到了大量的注解。即便无法阅读源码,以后使用这些框架,会有一种心理上的安全感

3. 方便今后跟别人吹牛。(当然,这也很重要。)

好了,话不多说,我们开始吧。

1. 从注释的角度来理解注解

我想了很久,最终决定以这个小标题作为第一节的标题,我们在编写Java代码的时候,为了让我们的代码看起来通俗易懂,就会加上注释信息。

比如,我们写一个方法,会标注上这个方法的作者,作用,版本等信息。是的,作为一个程序员,编写优雅的注释是一个非常重要的好习惯。

例:

/**
 * 用于判断是否是空字符串
 * 方法名:isEmpty
 * 创建人:剽悍一小兔
 * 时间:2016年9月21日-下午6:56:33
 * @param str
 * @return boolean
 */
public static boolean isEmpty(String str) {
    return null == str  || str.equals("")
            || str.matches("\\s*");
}

这是一个字符串判空的函数,函数名为isEmpty,虽然看名字大概也能猜到它的作用,可是,一旦加上了注释,瞬间就变得更加清晰了,不是吗?

这种注释,当代码被执行的时候,执行机制会自动忽略掉他们,因为这些文字其实是给程序员看的,而不是给执行机制看的。

写注释是一种美德。

那么,注解又是什么呢?

我个人对它的看法是:所谓的注解,就是写给电脑看的高级注释。

你可能经常会看到代码里面出现@XXX的标志,乍一看感觉挺高深的。反正我当年就是这种感觉,头脑里第一个反应就是这肯定很难!

我还是那句话,如果你总想着复杂,那么就永远看不到简单。

我们写注释,是给人看的,而注解就是写给电脑看的。就这么简单。

这么说可能有点抽象,没关系,我们来一个快速入门吧。

2.提出问题

新建一个Java项目

项目名称就叫做Annotation吧

在src旁边右键,新建一个util包,也就是工具包。

弄一个专门处理日期的工具类

随便写一个日期格式化的方法。

package util;

import java.util.Date;
import java.text.SimpleDateFormat;

public class DateUtil {

    public static String formatDate( Date date , String formatPattern ){
        return new SimpleDateFormat(formatPattern).format(date);
    }

}

注意,导包的时候要是java.util.Date;,而不是java.sql.Date;

测试:

Date now = new Date();//获取当前日期
System.out.println(now);
System.out.println(formatDate(now,"yyyy-MM-dd hh:mm:ss"));

控制台打印:
Wed Sep 21 19:24:57 CST 2016
2016-09-21 07:24:57

这说明,我们写的方法应该是正确的。

很好,那么接下来要解决一个什么问题呢?就是说,如果我想通过代码来获取关于这个方法的信息,那么该如何做呢?

写注释肯定是不行的,因为注释是写个程序员看的,电脑看不懂,更别提获取注释的内容了,是吧?

于是,注解,这一种高级的注释就出现了。

3.编写注解

关于注解,要明确三个问题:

  1. 要给谁加注解啊?
  2. 什么时候注解起作用啊?
  3. 要注解那些东西呢?

因为是快速入门,所以大概知道这些就足够了。

现在,我们来新建一个注解,毫无疑问,所谓的注解,它还是一个Java类,你不要被它吓到。

新建一个注解包。

new一个Annotation,就叫MethodNote,意思就是说,这个是加在方法上的,为了给方法加一些电脑能看得懂的说明。

第一个问题是要给谁加注解啊?那么,这个注解类是需要加在方法上的,于是就这样写:

这就表示,该注解要加在方法上。

接下来,让我们来明确第二个问题:什么时候注解起作用啊?

我们希望在程序运行的时候,注解发挥作用,就是说,当你的程序跑起来了,电脑才开始阅读这些注解。

这句话的意思就是说,我这个注解啊,是在程序跑起来的时候,RUNTIME嘛,就是跑起来的时候,才发挥作用的。

非常好,那么最后一个问题:要注解那些东西呢?

一个方法,最重要的信息包括:作用,创建时间,作者,版本,返回值等等。我们随便抽取几个,就作用和创建时间吧!

这种写法有点类似于写接口的方法。

好了,我们的第一个注解就编写完成了!写好了就马上用呗,现在我们给日期格式化的方法加上咱自己编写的注解。

@MethodNote(createTime = "2016-9-21")
public static String formatDate(Date date , String formatPattern){
    return new SimpleDateFormat(formatPattern).format(date);
}

这就是所谓的注解,其实也很简单的吧。就是这么来的,它归根到底还是一个Java类。

4.通过Java反射获取方法的注解信息

好了,回到正题,我们已经对formatDate方法进行了注解,那么,既然这个注解是写给电脑看的,那么电脑就肯定有办法在其他Java类中获得这些信息,对吧?

如何获得呢,对了,用反射机制。

上代码:

public static void main(String[] args) throws NoSuchMethodException, SecurityException {

    Class classOfDateUtil = DateUtil.class;
    Method formatDate = classOfDateUtil.getMethod("formatDate", Date.class,String.class);
    MethodNote methodNote = formatDate.getAnnotation(MethodNote.class);

    System.out.println("方法描述:" + methodNote.description());
    System.out.println("创建日期:" + methodNote.createTime());
}

结果:

方法描述:作者很懒,没有写本方法的作用。
创建日期:2016-9-21

本章结束 ...

本章对Java自定义注解做了一个快速入门,希望对你有所帮助。

时间: 2025-01-05 06:13:28

JavaSE注释的相关文章

java-se基础 2(注释和原生数据类型)

Java SE 第二讲: 1. Windows: notepad, editplus, ultraedit, gvim Linux: vi, vim, gedit 2. Java中的数据类型分为两大类: 1) 原生数据类型 (Primitive Data Type) 2) 引用类型(对象类型) (Reference Type) 3. 变量与常量:所谓常量,就是值不会变化的量:所谓变量,就是值可以变化的量. 4. 如何定义变量? 变量类型 变量名; int a; 5. 如何为变量赋值? 变量名 =

(二) JavaSE之注释

一 注释(comment) 用于注解说明解释程序的文字就是注释,注释提高了代码的阅读性: 注释是一个程序员必须要具有的良好编程习惯.将自己的思想通过注释先整理出来,再用代码去体现. 二 Java中的注释类型 1) 单行注释 格式: //注释文字 以两个/开头后面跟要注释掉的文字,只注释掉当前行; 2) 多行注释 格式:/* 注释文字 */ 以/* 开始,以*/结束,中间部分是要注释的内容 3) 文档注释 (java特有) 注释内容可以被JDK提供的工具 javadoc 所解析,生成一套以网页文件

JavaSE入门学习23:Java面向对象之构造方法

学了JavaSE面向对象这一部分,也该对构造方法做一个总结了. 一构造方法 在多数情况下,初始化一个对象的最终步骤是去调用这个对象的构造方法.构造方法负责对象的初始化工作,为 实例变量赋予合适的初始值.构造方法必须满足以下语法规则: (1)方法名必须与类名相同: (2)不要声明返回类型: (3)不能被static.final.synchronized.abstract和native修饰.构造方法不能被子类继承,所以用final和abstract 修饰没有意义.构造方法用于初始化一个新建的对象,所

javase基础

目录 目录... 1 第一天... 5 1:计算机概述(了解) 5 2:键盘功能键的认识和快捷键(掌握) 5 3:常见的DOS命令(掌握) 6 4:Java语言概述(了解) 6 5:JDK,JRE,JVM的作用及关系(掌握) 7 6:JDK的下载,安装,卸载(掌握) 7 7:第一个程序:HelloWorld案例(掌握) 7 8:常见的问题(掌握) 8 9:path环境变量(掌握) 8 10:classpath环境变量(理解) 8 第二天... 10 1:关键字(掌握) 10 2:标识符(掌握)

JavaSE基础笔记513

JavaSE笔记整理 java概述 1. 人机交互 人机交互:是指人与计算机之间使用某种对话语言,以一定的交互方式,为完成确定任务的人与计算机之间的信息交换过程. 交互方式 图形化界面:这种方式简单直观,使用者易于接受,容易上手操作. 命令行方式:需要有一个控制台,输入特定的指令,让计算机完成一些操作.较为麻烦,需要记住一些命令. 2. 键盘功能键介绍 这些按键要求的不是认识:而是常用. ′ Tab *** 缩格 ′ 空格 Enter ****** ′ Window ′ Shift *** (C

JavaSE编程基础2

JavaSE编写程序2 一.JRE出错时,如何修改? 项目名 -->右键 -->properties -->java build path -->add library -->jre system library; 二.删除文件夹: (1).Delete,选中√时物理删除,永不可恢复: (2).将文件夹复制到桌面中.导入-->import -->general -->existing.project into workspace -->broese -

JavaSE学习笔记(一)———Java简介与基础

一.  Java语言简介 1.1           计算机语言的发展过程 计算机语言发展主要分为三个阶段: 1.第一代:机器语言 2.第二代:低级语言 3.第三代:高级语言 1.2           Java发展简史 1.Java 是一种程序开发语言,既然是一门语言,就像其他语言一样,具备一定的语法 和自己的数据结构. 2.Java语言来源于sun公司,sun指的是斯坦福大学网络.由james gosling领导并开发. Java语言的具体发展历程 1991~1995  Sun 为了占领智能

javaDoc 注释规范

Javadoc虽然是Sun公司为Java文档自动生成设计的,可以从程序源代码中抽取类.方法.成员等注释形成一个和源代码配套的API帮助文档.但是Javadoc的注释也符合C的注释格式,而且doxyen也支持该种风格的注释. 官方文档:http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html 维基百科:https://en.wikipedia.org/wiki/Javadoc Javadoc 的注释结构和 C

JavaSE中线程与并行API框架学习笔记1——线程是什么?

前言:虽然工作了三年,但是几乎没有使用到多线程之类的内容.这其实是工作与学习的矛盾.我们在公司上班,很多时候都只是在处理业务代码,很少接触底层技术. 可是你不可能一辈子都写业务代码,而且跳槽之后新单位很可能有更高的技术要求.除了干巴巴地翻书,我们可以通过两个方式来解决这个问题:一是做业余项目,例如在github上传自己的demo,可以实际使用:二是把自己的学习心得写成博客,跟同行们互相交流. 3.1 线程的初窥门径 我们在之前的文章里提到的程序其实都是单线程程序,也就说启动的程序从main()程