java 自定义注解打印日志 java实现自定义注解

java自定义注解：

  如果说反射使得很多技术实现（动态代理、依赖注入等）有了基础，那么注解就是使这些技术实现变得平民化的基础。

      站在java虚拟机的角度来看，class保留和运行时保留的注解已经和java二进制码放在了同等的地位。虚拟机在加载class文件时，会为注解内容分配空间

     并进行解析，最终还会为注解和对应的二进制码建立关联。尽管这些注解不会被运行，但其对代码的说明能力，结合反射技术已经足够我们做太多的事情。

      要实现一个自定义注解，必须通过@interface关键字来定义。且在@interface之前，需要通过元注解来描述该注解的使用范围（@Target）、生命周期（@Retention）

      及其他。

 

 Java注解是附加在代码中的一些元信息，用于一些工具在编译、运行时进行解析和使用，起到说明、配置的功能。
        注解不会也不能影响代码的实际逻辑，仅仅起到辅助性的作用。包含在 java.lang.annotation 包中。

       注解的定义类似于接口的定义，知识需要在inteface关键字前面加一个@符号，声明一个方法即为注解类型定义了一个元素，方法的声明不允许有参数或throw语句，返回值

       类型被限定为原始数据类型、字符串String、Class、枚举enums、注解类型，或前面这些的数组，方法可以有默认值。

 

    Annotation的工作原理：

                JDK5.0中提供了注解的功能，允许开发者定义和使用自己的注解类型。该功能：由一个定义注解类型的语法和描述一个注解声明的语法，

                读取注解的API，一个使用注解修饰的class文件和一个注解处理工具组成。

                Annotation并不直接影响代码的语义，但是他可以被看做是程序的工具或者类库。它会反过来对正在运行的程序语义有所影响。

                Annotation可以从源文件、class文件或者在运行时通过反射机制多种方式被读取。

 

 

1、元注解

     元注解是指注解的注解。包括  @Retention @Target @Document @Inherited四种。（java.lang.annotation中提供，为注释类型）。

    1.1、

@Retention: 定义注解的保留策略

               @Retention(RetentionPolicy.SOURCE)   //注解仅存在于源码中，在class字节码文件中不包含

               @Retention(RetentionPolicy.CLASS)    // 默认的保留策略，注解会在class字节码文件中存在，但运行时无法获得，

               @Retention(RetentionPolicy.RUNTIME)  // 注解会在class字节码文件中存在，在运行时可以通过反射获取到

     使用注解功能时，如果需要用反射读取注解，就必须设置@Retention(RetentionPolicy.RUNTIME)，因为默认情况下为CLASS，读取的时候会报异常

 

   1.2、

@Target：定义注解的作用目标
    
               @Target(ElementType.TYPE)   //接口、类、枚举、注解
  
               @Target(ElementType.FIELD) //字段、枚举的常量
       
               @Target(ElementType.METHOD) //方法
 
               @Target(ElementType.PARAMETER) //方法参数
 
               @Target(ElementType.CONSTRUCTOR)  //构造函数
 
               @Target(ElementType.LOCAL_VARIABLE)//局部变量
 
               @Target(ElementType.ANNOTATION_TYPE)//注解
 
               @Target(ElementType.PACKAGE) ///包

        其定义的源码为：

@Documented
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.ANNOTATION_TYPE)
 public @interface Target {
     ElementType[] value();
 }

由以上的源码可以知道，他的elementType 可以有多个，一个注解可以为类的，方法的，字段的等等  
  

    1.3、

    @Document：说明该注解将被包含在javadoc中

   

     1.4、

      @Inherited：说明子类可以继承父类中的该注解

 

2、java 注解的自定义

 

      下面是自定义注解的一个例子。

// 说明该注解将被包含在javadoc中
@Documented
// 这个注解可以是类注解，也可以是方法的注解
@Target({ ElementType.TYPE, ElementType.METHOD })
// 定义的这个注解是注解会在class字节码文件中存在，在运行时可以通过反射获取到。
@Retention(RetentionPolicy.RUNTIME)
// 子类可以继承父类中的该注解
@Inherited
public @interface MyAnnotation {

	// 为注解定义一个方法即为注解定义了一个元素，返回的默认值为hell world
	public String name() default "hello world";
}

3、如何使用自定义的注解（很简单，就像使用其他注解一下）

public class Client {

	@MyAnnotation
	public static void say(String name ) {
		System.out.println("  ~~~~~~~~~~~  :  welcome : "+ name);
	}
}

  至此，我们知道了如何自定义注解以及如何使用自定义的注解，但是这样的注解对我们来说没有任何意义。

  如果想让自定义的注解起到我们预期的作用，那我们就应该编写自己的注解处理器了。

 

    -- 注解处理器 其实就是一段用于解释或处理自定义注解的代码而已，没有太多复杂的概念或者技术。

 

public class ParseMyAnnotation {

	// 定义的注解可以在方法上也可以在类上，所以需要两个方法进行不同类型的处理
	// 处理定义在方法上的注解
	/**
	 * @param clazz
	 *            为注解所在的目标类
	 * @throws Exception
	 */
	public void parseMethod(final Class<?> clazz) throws Exception {
		// 生成目标类的一个实例
		final Object obj = clazz.getConstructor(new Class[] {}).newInstance(new Object[] {});
		// 得到目标类的方法集
		final Method[] methods = clazz.getDeclaredMethods();
		for (final Method method : methods) {
			// 获取方法上的注解，同时判断是否存在
			final MyAnnotation my = method.getAnnotation(MyAnnotation.class);
			if (null != my) {
				// 如果存在则将注解上的值传递个目标方法，并执行。
				method.invoke(obj, my.name());
			}
		}
	}
}

public class Client {

	@MyAnnotation(name = "zhangsan")
	public static void say(final String name) {
		System.out.println("  ~~~~~~~~~~~  :  welcome : " + name);
	}

	// 通过main来模拟注解的使用
	public static void main(final String[] args) throws Exception {
		final ParseMyAnnotation pm = new ParseMyAnnotation();
		pm.parseMethod(Client.class);
	}
}

   控制台打印的结果是：  ~~~~~~~~~~~  :  welcome : zhangsan

 

 

 

附录：

 

　　尽管很多人认为Aspect适用于像事务管理、缓存、持久化、基于角色的安全等方面的横向关注点（cross-cutting concerns），Ramnivas Laddad提到了其另外一种重要价值，就是作为普通项目应用注解的推动者。

注解，在Java SE 5.0中作为Java元数据工具（JSR 175）被加入，提供了一种给程序元素增加元数据的方法。它们被用来配置容器、描述持久层配置、设置安全角色，并且由几乎全部最新的JSR标准所定义。它们还包含了给Java代码增加自定义注解的机制，以及通过反射提供编程访问元数据注解的方法。

　　面向方面编程（ AOP）已经被用来实现各种横向关注点（cross-cutting concerns），范围从简单的日志到高级的应用程序安全和事务管理。使用Aspects作为一种实现注解处理器的方法，则是对它们的一种不同思考方法，不同于传统架构师的“横向关注点（cross cutting concerns）”视角的方法。Ramnivas 谈到了利用Aspect和AOP注解，通过使用自定义注解给Java应用程序增加横向行为（cross-cutting behavior）。他谈论了元数据和AOP相互给对方带来了什么。元数据给选择连接点（join points）带来了附加信息，在那里 Pointcuts使用注解来捕获连接点（join points）。在特定用例情况下，它还帮助创建松耦合的aspect。而AOP则带来了一种消费和供应注解的系统的方法。使用AOP供应元数据还给我们带来了整洁代码。使用AOP消费元数据比起使用注解处理工具（ APT）选项来有不少好处。

　　Ramnivas告诫说使用元数据扩展Java语言可能是双刃剑（既强大又危险）。另一方面，注解使我们无需修改核心语言就可以给Java语言增加新的特性，这就使其成为了一个开放的语言；在最好情况下，原则性的扩展能够克服宿主语言的局限性。另一方面，不标准的、特别的、不连贯注解集可能导致代码不容易被理解。

　　从AOP获得大部分好处的最佳实践之一就是使用元数据去为横向关注点（cross-cutting concerns）捕获连接点（join points）。记住，注解应该在连接点处描述什么是“true”（条件）——在这些points处什么不应该发生（动作）。他还建议开发者使用已有的注解（比如 @Entity、 @Table、 @WebService等）。把没有元数据的pointcut看作是首选并依赖于编程元素本身。而且，要避免特定实现的注解。了解一起使用元数据和AOP的代价和好处是有帮助的。元数据可以以各种方式被消费，了解这些使用方式将帮助我们洞悉AOP和元数据的结合。Ramnivas在其AOP和元数据的文章（ 第1部分和 第2部分）中给出了一些最佳实践并且建议开发者不要过分追求自定义注解。

在实现自定义注解过程中主要的设计考虑是，什么（元数据，行为）、何时（编译时，运行时）、如何（APT，运行时反射，AOP）在Java应用程序中应用注解。John Heintz最近做了一个关于给Java注解增加行为的片子，里面他比较了在Java应用中实现自定义注解的不同设计技术。John讨论了字节码转换，其包括Aspect，将其作为三种类型注解处理选项之一。

• 产生器：这一注解处理选项包括读取源码并产生新的源码或修改已有源码。ATP和XDoclet属于这一类型。
• 字节码转换：这些注解处理器解析带有注解的类文件并释放出修改过的类和新产生的类。它们还可能产生非类产物如XML配置文件。字节码转换的例子包括AspectJ、Spring、Hibernate、CGLib和BCEL。
• 运行时反射：这个选项使用反射API在运行时用程序检查对象。运行时反射的例子有如Java 5+ 反射和Commons Attributes类库。测试框架JUnit和TestNG使用运行时反射处理注解。

InfoQ就实现自定义注解过程中Aspect所扮演的角色采访了John。他说实际上它只是在实现自定义注解时应该被考虑的一种平衡力量（工程上的折中）。他还提到注解基于方面的实现提供了实现注解行为的大多数简便方法和一个集中的定义。但是开发者必须清楚地记录非本地语义和对于构建或部署工具链（tool-chain）（编译或运行时编织）的影响。