进阶之 spring中使用自定义注解

通过自定义注解的使用搭配AOP可将技术代码与 业务代码进行有效的拆分，可使代码简洁明了。

该demo是基于springboot的一个简单web项目，这里只贴出自定义注解主要的代码，其他部分代码不做赘述。

这里要用到 spring中AOP的知识

自定义注解类：TestAnnotation 该类中只有两个字段，name、work

package com.example.demo.testaop;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {

	String name();
	
	String work();
 }

注解解析类。这其中要用到springAOP的知识，切点、增强等AOP部分…

package com.example.demo.testaop;

import java.lang.reflect.Method;
import java.util.ArrayList;


import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.Signature;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.core.LocalVariableTableParameterNameDiscoverer;
import org.springframework.stereotype.Component;

import com.example.demo.bean.User;
import com.example.demo.testaop.TestAnnotation;


@Aspect
@Component
public class TestAnnotationAcpt {

	//设置自定义注解AOP的切入点，该注解意思是：凡是使用TestAnnotation这个注解的方法都会被拦截
	@Pointcut("@annotation(com.example.demo.testaop.TestAnnotation)")
	public void log() {
	}
	
	//设置前置通知
	@Before("log()")
	public void before(JoinPoint joinPoint) throws Throwable {
		System.out.println("执行前-----");
		Signature signature = joinPoint.getSignature();
		System.out.println(signature.getName());
		System.out.println("执行后-----");
	}
	
	@Around("@annotation(acpt)")
	public Object get(ProceedingJoinPoint pjp,TestAnnotation acpt) throws Throwable {
		//获取实际的方法
		Method method =((MethodSignature) pjp.getSignature()).getMethod();
		//获取该方法的参数列表--形参列表
		String[] parameterNames = new LocalVariableTableParameterNameDiscoverer().getParameterNames(method);
		//获取目标方法的参数列表   --实际传入的参数
		Object[] args = pjp.getArgs();
		//获取注解中的参数  --"#name"
		System.out.println("注解参数值-name："+acpt.name());
		System.out.println("注解参数值-work："+acpt.work());
		//此处自定义getKey方法用于动态转换注解中的参数值： 即 "#name" --> "半仙"的转换
		String name = getKey(acpt.name(),parameterNames,args);
		String work = getKey(acpt.work(),parameterNames,args);
		System.out.println("动态获取数据：name:"+name+"--work:"+work);
		//目标方法的调用
		Object proceed = pjp.proceed();
		//返回目标方法的调用结果
		return proceed;
	}
	
	/**
	 * 自定义get方法
	 * @param key --要动态获取的注解属性
	 * @param paramers  --目标方法的形参列表
	 * @param args  --目标方法的实参列表
	 * @return  --动态获取的实际key值
	 */
	public String getKey(String key,String[] paramers,Object[] args) {
		
		for(int i=0;i<paramers.length;i++) {
			if(key.substring(1).equals(paramers[i])) {
				key=(String) args[i];
			}
		}
		return key;
	}
	
}

自定义注解的使用，在service中使用： UserService

package com.example.demo.service;

import java.util.List;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;

import com.example.demo.bean.User;
import com.example.demo.dao.UserRepository;
import com.example.demo.testaop.TestAnnotation;

@Service
public class UserService {

	@Autowired
	private UserRepository userRepository;
	
	
	//使用表达式，进行动态获取属性值
	@TestAnnotation(name = "#name", work = "#work")
	public String find(String name,String work) {
		return name+work;
	}

}

UserController： controller层调用

package com.example.demo.controller;

import java.util.List;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

import com.example.demo.bean.User;
import com.example.demo.dao.UserRepository;
import com.example.demo.service.UserService;
import com.example.demo.testaop.TestAnnotation;
import com.example.demo.testaop.TestAspect;

@RestController
public class UserController {
	
	@Autowired
	private UserRepository userRepository;
	
	@Autowired
	private UserService userService;
	
	@RequestMapping(value="/get")
	public String  get() {
		return userService.find("001", "修道");
	}

最后启动项目，浏览器输入：localhost:8080/get

 在控制台可以看到如下输出