java 自定义注解 spring aop 实现注解

版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/jidetashuo/article/details/54406872

java自定义注解    

1.几个常用的注解解释

              @Target说明了Annotation所修饰的对象范围:Annotation可被用于 packages、types(类、接口、枚举、Annotation类型)、类型成员(方法、构造方法、成员变量、枚举值)、方法参数和本地变量(如循环变量、catch参数)。在Annotation类型的声明中使用了target可更加明晰其修饰的目标。

         作用:用于描述注解的使用范围(即:被描述的注解可以用在什么地方)

  取值(ElementType)有:

    1.CONSTRUCTOR:用于描述构造器
    2.FIELD:用于描述域
    3.LOCAL_VARIABLE:用于描述局部变量
    4.METHOD:用于描述方法
    5.PACKAGE:用于描述包
    6.PARAMETER:用于描述参数
    7.TYPE:用于描述类、接口(包括注解类型) 或enum声明   

       @Retention定义了该Annotation被保留的时间长短:某些Annotation仅出现在源代码中,而被编译器丢弃;而另一些却被编译在class文件中;编译在class文件中的Annotation可能会被虚拟机忽略,而另一些在class被装载时将被读取(请注意并不影响class的执行,因为Annotation与class在使用上是被分离的)。使用这个meta-Annotation可以对 Annotation的“生命周期”限制。

  作用:表示需要在什么级别保存该注释信息,用于描述注解的生命周期(即:被描述的注解在什么范围内有效)

  取值(RetentionPoicy)有:

    1.SOURCE:在源文件中有效(即源文件保留)
    2.CLASS:在class文件中有效(即class保留)
    3.RUNTIME:在运行时有效(即运行时保留)

   @Documented用于描述其它类型的annotation应该被作为被标注的程序成员的公共API,因此可以被例如javadoc此类的工具文档化。Documented       是一个标记注解,没有成员。

  @Inherited 元注解是一个标记注解,@Inherited阐述了某个被标注的类型是被继承的。如果一个使用了@Inherited修饰的annotation类型被用于一个class,则这个annotation将被用于该class的子类。

  注意:@Inherited annotation类型是被标注过的class的子类所继承。类并不从它所实现的接口继承annotation,方法并不从它所重载的方法继承annotation。

  当@Inherited annotation类型标注的annotation的Retention是RetentionPolicy.RUNTIME,则反射API增强了这种继承性。如果我们使用java.lang.reflect去查询一个@Inherited annotation类型的annotation时,反射代码检查将展开工作:检查class和其父类,直到发现指定的annotation类型被发现,或者到达类继承结构的顶层。

 2.声明自定义注解方式

   

使用@interface自定义注解时,自动继承了java.lang.annotation.Annotation接口,由编译程序自动完成其他细节。在定义注解时,不能继承其他的注解或接口。@interface用来声明一个注解,其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是基本类型、Class、String、enum)。可以通过default来声明参数的默认值。

  定义注解格式:
  public @interface 注解名 {定义体}

  注解参数的可支持数据类型:

    1.所有基本数据类型(int,float,boolean,byte,double,char,long,short)
    2.String类型
    3.Class类型
    4.enum类型
    5.Annotation类型
    6.以上所有类型的数组

  Annotation类型里面的参数该怎么设定: 
  第一,只能用public或默认(default)这两个访问权修饰.例如,String value();这里把方法设为defaul默认类型;   
  第二,参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和 String,Enum,Class,annotations等数据类型,以        及这一些类型的数组.例如,String value();这里的参数成员就为String;  

简单demo验证一下:

注解类:

         

package xhsoft.yxd.admin.controller;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

/**
 * @author WangMeng
 * @date 2017年1月11日
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
public @interface PersonAnnotation
{
	String name();
	int age();
}
测试类:

package xhsoft.yxd.admin.controller;

/**
 * @author WangMeng
 * @date 2017年1月11日
 */
@PersonAnnotation(name = "11", age = 22)
public class TestAnnotation
{

	public static void print(Class c)
	{
		System.out.println(c.getName());

		// java.lang.Class的getAnnotation方法,如果有注解,则返回注解。否则返回null
		PersonAnnotation person = (PersonAnnotation) c.getAnnotation(PersonAnnotation.class);

		if (person != null)
		{
			System.out.println("name:" + person.name() + " age:" + person.age());
		}
		else
		{
			System.out.println("person unknown!");
		}
	}
	public static void main(String[] args)
	{
		TestAnnotation.print(TestAnnotation.class);
	}

}

一般的项目中应用场景可能是记录系统日志,登录验证等地方,结合spring 的aop 去实现 

项目中用到了登录的验证 逻辑是:加上我们自定义注解的方法,需要进行验证,是否登录过,登录过的通过,没登录过的跳转到登录页面

注解类:

package xhsoft.web.tools.logined;

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;

/**
 * 
 * @author Corpse-work
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Logined
{
	/**
	 * 其它附加信息
	 * @return
	 * @author Corpse-work 
	 * @Date 2016年10月21日
	 */
	String[] others() default {};
}
注解实现类  (使用了这个注解需要做什么)

package xhsoft.web.tools.logined;

import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

/**
 * 用于登录校验
 * 
 * @author Corpse-work
 */
@Aspect// 这个注解表明 使用spring 的aop,需要开启aop <!--开启AOP自动代理 --><aop:aspectj-autoproxy />
@Component
public class LoginedAspect
{
	@Autowired
	private AbsLoginHelper loginHelper;

	@Around(value = "@annotation(logined)")// 标示遇到logined这个注解的方法进行拦截 @Around 等注解可查看 spring aop相关知识
	public Object checkLogin(ProceedingJoinPoint join, Logined logined) throws Throwable
	{

		// 获取到使用了注解的方法的参数 这里面根据测试类 是 request,response
		Object[] args = join.getArgs();
                //获取使用了注解的方法的 注解的参数  这里面根据测试类 是 username,password
                String[] orherString=logined.others();
		// 执行使用注解方法并返回信息   
		Object ret = join.proceed();
		// 下面是验证登录身份的逻辑代码 省略。。。。。。。
		return null;
	}

}


测试类:

package xhsoft.yxd.admin.controller;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

import xhsoft.web.tools.logined.Logined;

/**
 * @author WangMeng
 * @date 2017年1月13日
 */
@Controller
@RequestMapping("/admin")
public class Test
{

	@RequestMapping("/logintest")
	@Logined(others="username,password")
	public void loginTest(HttpServletRequest request, HttpServletResponse response)
	{
		System.out.println("logintest......");
	}
}


关于自定义注解中的 一些注解详细的解释,可参考文章  http://www.cnblogs.com/peida/archive/2013/04/24/3036689.html


展开阅读全文

没有更多推荐了,返回首页