错过的注解

在学习时候,各位同学接触注解方式比较少,因此大家可能感觉注解方式很熟悉中带着陌生的感觉,但是到了框架阶段的时候,你会发现不管是之前学习的Servlet也好,特别后面学习的SpringMVC+MyBatis+Spring的框架中,大部分我们都在使用注解,那么对于注解我们需要重新进行了解,其实注解[Annotation]在JDK5的时候,就已经被引入了,现在JDK版本都到8了!
官方的解释为,注解是用来描述代码的元信息的或者说是一种代码注释,通常情况下注解不会直接影响代码的执行，尽管有些注解可以用来做到影响代码执行。

疑问: 注解可以做什么?

Java中的注解通常扮演以下角色

  • 编译器指令[SOURCE]
  • 构建时指令[CLASS]
  • 运行时指令[RUNTIME] 

如何定义呢?

一个简单的Java注解类似与@Entity[hibernate中我们用过]。其中@的意思是告诉编译器这是一个注解。而Entity则是注解的名字。代码如下: 代码001

package com.hanpang.java;
/**
* 类说明: 如何定义个注解?
* @Author: lusid
* @Create: 2016-04-27 09:43
* @Home: http://www.cnblogs.com/lusid/
*/
public @interface Entity {

}

设置属性或者说注解的元素设置?

Java注解可以使用元素来进行设置一些值，注解中的元素类似于属性或者参数。

代码如下: 代码002

package com.hanpang.java;
public @interface Entity {
String tableName();//设置表明-->模拟操作

}

那么该注解就可以这么使用了,示例代码

package com.hanpang.java;
/**
* 类说明: 该注解暂时演示,还没有讲解完
*/
@Entity(tableName = "sys_demo")
public class Demo {

}

上述注解的元素名称为tableName，设置的值为sys_demo。没有元素的注解不需要使用括号。

如果注解包含多个元素，意味着在代码02中,新增属性就可以了,代码如下:

@Entity(tableName="sys_demo",primaryKey = "id")

有种特殊情况的写法,就是我们只有一个元素的时候,推荐写法为:

package com.hanpang.java;
public @interface EXcelExport{
String value();//建议取名为value

}

如果出现这种情况下,就有两种写法:

标准写法:
@EXcelExport(value= "wukong")
    
简写方式:
@EXcelExport("bajie")

注解的使用

注解可以用来修饰代码中的这些元素,穿越一下,想想Spring和SpringMVC中我们都学习过哪些注解?

  • 类
  • 接口
  • 方法
  • 方法参数
  • 属性
  • 局部变量

 先看看一个完整的注解的示例?其实回想SpringMVC的我们就一目了然了! 

@Entity //类
public class Vehicle {
@Persistent //属性
protected String vehicleName = null; 
@Getter //方法
public String getVehicleName() {
return this.vehicleName;
}
public void setVehicleName(@Optional/*方法形参*/ vehicleName) {
this.vehicleName = vehicleName;
}
public List addVehicleNameToList(List names) {
@Optional //局部变量
List localNames = names; 
if(localNames == null) {
localNames = new ArrayList();
}
localNames.add(getVehicleName());
return localNames;
}
}

暂时先放一放,我们来看看一阶段我们接触过的内置注解,还是再次了解一下,不要忽略,可以通过内置注解来进行学习的,很有效的方式方法,从模仿开始,查看源代码进行学习!

内置的Java注解

 

Java中有三种内置注解，这些注解用来为编译器提供指令。它们是

 

  • @Deprecated
  • @Override
  • @SuppressWarnings

@Deprecated

  • 可以用来标记类，方法，属性。
  • 如果上述三种元素不再使用，使用@Deprecated注解
  • 如果代码使用了@Deprecated注解的类，方法或属性，编译器会进行警告。[你也可以继续使用的]

@Deprecated使用很简单，如下为注解一个弃用的类。

package com.hanpang.java;
/**
* 类说明: 内置注解@Deprecated
* @Author: lusid
* @Create: 2016-04-27 10:11
* @Home: http://www.cnblogs.com/lusid/
*/
@Deprecated
public class MyTest {

}

当我们使用@Deprecated注解后，建议配合使用对应的@deprecated JavaDoc符号，并解释说明为什么这个类，方法或属性被弃用，已经替代方案是什么。

package com.hanpang.java;
@Deprecated
/**
当我们使用@Deprecated注解后，建议配合使用对应的@deprecated JavaDoc符号，并解释说明为什么这个类，
方法或属性被弃用，已经替代方案是什么。友好的提示说明,是一个优秀代码必须具备的!
@deprecated This class is full of bugs. Use MyNewTest instead.
*/
public class MyTest {

}

@Override

@Override注解用来修饰对父类进行重写的方法。如果一个并非重写父类的方法使用这个注解，编译器将提示错误。

实际上在子类中重写父类或接口的方法，@Overide并不是必须的。但是还是建议使用这个注解，在某些情况下，假设你修改了父类的方法的名字，那么之前重写的子类方法将不再属于重写，如果没有@Overide，你将不会察觉到这个子类的方法。有了这个注解修饰，编译器则会提示你这些信息。

使用Override注解的例子

package com.hanpang.java;
public class MySuperClass {
public void doTheThing() {
System.out.println("Do the thing");
}
}
public class MySubClass extends MySuperClass{
@Override
public void doTheThing() {
System.out.println("Do it differently");
}
}

@SuppressWarnings

  • @SuppressWarnings用来抑制编译器生成警告信息。
  • 可以修饰的元素为类，方法，方法参数，属性，局部变量

使用场景：当我们一个方法调用了弃用的方法或者进行不安全的类型转换，编译器会生成警告。我们可以为这个方法增加@SuppressWarnings注解，来抑制编译器生成警告。

注意：使用@SuppressWarnings注解，采用就近原则[想一想,该原则我们还在哪里学过?留言哟!]，比如一个方法出现警告，我们尽量使用@SuppressWarnings注解这个方法，而不是注解方法所在的类。虽然两个都能抑制编译器生成警告，但是范围越小越好，因为范围大了，不利于我们发现该类下其他方法的警告信息。

代码如下:

public class Demo{
@SuppressWarnings("unchecked")//或者@SuppressWarnings({"unchecked"})
public void methodWithWarning(){
}
} 

自定义注解:

在Java中，我们可以自定义注解，注解和类，接口文件一样定义,在Java文件中。代码如下

package com.hanpang.java;
/**
* 类说明: 自定义注解练习和说明
* 定义了好多的属性
* @Author: lusid
* @Create: 2016-04-27 10:29
* @Home: http://www.cnblogs.com/lusid/
*/
public @interface MyAnnotation {
String value();
String name();
int age();
String[] newNames();
}

上述代码定义了一个叫做MyAnnotation的注解，它有4个元素。
再次强调一下，@interface这个关键字用来告诉java编译器这是一个注解。

仔细一看，你会发现，注解元素的定义很类似于接口的方法。这些元素有类型和名称。类型包含如下:

  • 原始数据类型
  • String
  • Class
  • annotation
  • 枚举
  • 一维数组

使用一下我们的自定义的注解,会发现一个问题,请注意!

package com.hanpang.java;
/**
* 问题:所有的属性都需要进行赋值,但是实际开发中我们一般是有选择性的
*/
@MyAnnotation(
value="9527",
name="pangsir",
age=18,
newNames={"Hanpang", "Lwm"}
)
public class MyTest {

}

注意，我们需要为所有的注解元素设置值，一个都不能少!

注解元素默认值

对于注解中的元素，我们可以为其设置默认值，使用方法为

package com.hanpang.java;
/**
* 设置默认值的写法
*/
public @interface MyAnnotation {
String value() default "";
String name();
int age() default -1;
String[] newNames();
}


package com.hanpang.java;
@MyAnnotation(
name="pangsir",
newNames={"Hanpang", "Lwm"}
)
public class MyTest {

}

在我们查看内置注解的时候,我们会发现源代码对你定义的注解也有修饰,那么我们就开始认识一下!

@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
@Retention(RetentionPolicy.SOURCE)
public @interface SuppressWarnings {
/**
* The set of warnings that are to be suppressed by the compiler in the
* annotated element. Duplicate names are permitted. The second and
* successive occurrences of a name are ignored. The presence of
* unrecognized warning names is <i>not</i> an error: Compilers must
* ignore any warning names they do not recognize. They are, however,
* free to emit a warning if an annotation contains an unrecognized
* warning name.
* <p> The string {@code "unchecked"} is used to suppress
* unchecked warnings. Compiler vendors should document the
* additional warning names they support in conjunction with this
* annotation type. They are encouraged to cooperate to ensure
* that the same names work across multiple compilers.
* @return the set of warnings to be suppressed
*/
String[] value();

}

@Retention

@Retention是用来修饰注解的注解，使用这个注解，我们可以做到

  • 控制注解是否写入class文件
  • 控制class文件中的注解是否在运行时可见

控制很简单，使用使用以下三种策略之一即可。

  • RetentionPolicy.SOURCE 表明注解仅存在源码之中，不存在.class文件，更不能运行时可见。常见的注解为@Override, @SuppressWarnings。
  • RetentionPolicy.CLASS 这是默认的注解保留策略。这种策略下，注解将存在与.class文件，但是不能被运行时访问。通常这种注解策略用来处于一些字节码级别的操作。
  • RetentionPolicy.RUNTIME 这种策略下可以被运行时访问到。通常情况下，我们都会结合反射来做一些事情。[使用最频繁]

@Retention的使用示例,代码如下 

package com.hanpang.java;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;   
/**
* 控制注解的范围
*/   
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
String value() default "";
String name();
int age();
String[] newNames();
}

@Target

使用@Target注解，我们可以设定自定义注解可以修饰哪些java元素。简单示例 

package com.hanpang.java;  
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;   
/**
* 告之该注解修饰哪些元素
* 下面的代码: MyAnnotation注解只能修饰方法
* 如果这样,会导致我们之前写的注解有错误了,如右图
*/
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
String value() default "";
String name();
int age();
String[] newNames();
}
--->>>报错了!

@Target可以选择的参数值有如下这些

  • ElementType.ANNOTATION_TYPE（注：修饰注解）
  • ElementType.CONSTRUCTOR //构造函数
  • ElementType.FIELD //字段、枚举的常量
  • ElementType.LOCAL_VARIABLE //局部变量
  • ElementType.METHOD //方法
  • ElementType.PACKAGE //包
  • ElementType.PARAMETER //方法参数
  • ElementType.TYPE（注：任何类型，即上面的的类型都可以修饰）//接口、类、枚举、注解

@Inherited

如果你想让一个类和它的子类都包含某个注解，就可以使用@Inherited来修饰这个注解。

模拟这个过程,代码如下:

package com.hanpang.java;
import java.lang.annotation.*;
@Inherited
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
String value() default "";
String name();
int age();
String[] newNames();
} 
package com.hanpang.java;
@MyAnnotation(
value="9527",
name="pangsir",
age=18,
newNames={"Hanpang", "Lwm"}
)
public class ParentClass {

} 
package com.hanpang.java;
public class ChildClass extends ParentClass {

}

代码整体说明:

  • 使用@Inherited修饰注解MyAnnotation
  • 使用MyAnnotation注解ParentClass
  • 实现一个类ChildClass继承自ParentClass
  • 通过以上几步，ChildClass也拥有了ParentClass注解。

关于Java中的注解，一些基本的概念就是这些。

我们去看看SpringMVC中的Controller中的是否有该属性 

package org.springframework.stereotype;  
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;   
/** --->>>真实漂亮的注释,学习啊!
* Indicates that an annotated class is a "Controller" (e.g. a web controller).
* <p>This annotation serves as a specialization of {@link Component @Component},
* allowing for implementation classes to be autodetected through classpath scanning.
* It is typically used in combination with annotated handler methods based on the
* {@link org.springframework.web.bind.annotation.RequestMapping} annotation.
* @author Arjen Poutsma
* @author Juergen Hoeller
* @since 2.5
* @see Component
* @see org.springframework.web.bind.annotation.RequestMapping
* @see org.springframework.context.annotation.ClassPathBeanDefinitionScanner
*/
@Target({ElementType.TYPE}) // 只能注解在类上
@Retention(RetentionPolicy.RUNTIME) // 控制范围为运行时
@Documented // 内置注解,文档注释
@Component // Spring的组件注释,想想之前,Spring和SpringMVC我们学过在类上的注解有哪些
public @interface Controller {   
/**
* The value may indicate a suggestion for a logical component name,
* to be turned into a Spring bean in case of an autodetected component.
* @return the suggested component name, if any
*/
String value() default "";   
}

@Controller中不存在@Inherited的注解,所有你在我们BasetController中标注后,继承BaseController的类,如果也标注了@Controller,那么将覆盖原来设置的@Controller.

请同学们在看看@RequestMapping的注解源代码和注释,也有收获哟,可以自行补充,慢慢来,一点点的进步!

posted @ 2016-04-28 17:28  01源代码  阅读(186)  评论(0)  编辑  收藏  举报