基于反射与动态代理实现注解SQL

基于反射与动态代理实现注解SQL

在许多框架中，都应用到反射机制进行简化开发流程，而且，很多时候反射与动态代理的应用是同步的，即结合动态代理去使用同步，今天，我将给大家展示一下基于反射与动态代理实现注解SQL。

---

一、总体步骤

总体步骤如下：

• 创建简化注解
• 创建注解扫描管理类
• 创建代理工厂
• 创建应用了简化注解的实际类

以上讲了基本需要的内容的步骤，以下就按照这些步骤逐个讲解。

---

1、创建简化注解

/**
 * @author linxu
 * @date 2019/4/15
 * SQL注解，用于简化SQL编写
 */
//用在对应的DAO方法上面
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface SqlAnnotation {
  //该值用于存储SQL语句
    String value() default "";
}
//以下这个注解用于放置在DAO类的上面
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER})
public @interface DaoMapper {
}

总结：

• 创建一个用于在DAO的方法上填写SQL语句的注解
• 创建一个用于在DAO层的类上添加SQL语句的注解

---

2、创建注解扫描管理类

这个类的作用主要是管理添加了 DaoMapper注解的Dao类。

/**
 * @author linxu
 * @date 2019/4/15
 * 管理DAO的简化
 */
public class SqlManager {
    /**
     * 获取类加载器
     */
    private static final ClassLoader CLASS_LOADER = SqlManager.class.getClassLoader();
    private static final List<Class> DAO_LIST = new ArrayList<>();

    /**
     * 用于加载目的包下的类，主要是模拟一个拦截效果：
     * 将添加了@DaoMapper注解的类添加进mapper列表
     *
     * @return
     * @throws ClassNotFoundException
     */
    public static List<Class> loadMapper() throws ClassNotFoundException {
        //加载使用了mapper的注解的dao接口
        Class clazz = CLASS_LOADER.loadClass("com.flyingstars.www.expand.demo.TestDaoImpl");
        DAO_LIST.add(clazz);
        return DAO_LIST;
    }
}

这个类的总结：

• DAO_LIST相当于维护了一个添加了 DaoMapper注解的Dao类的缓存
• CLASS_LOADER.loadClass("com.flyingstars.www.expand.demo.TestDaoImpl");使用类加载器加载对应注解下的Class对象，用于反射与代理部分使用，这里只是做一个手动的添加，实际开发成框架应当是自动扫描添加了 DaoMapper注解的类

---

3、创建代理工厂

代理工厂的作用主要是拦截与实际底层的封装，在这个Demo中，做一个拦截与SQL语句的实际执行操作（模拟）

/**
 * @author linxu
 * @date 2019/4/15
 * 代理工厂，用于代理反射
 */
public class ProxyFactory implements InvocationHandler {
    private Object target;

    public ProxyFactory(Object target) {
        this.target = target;
    }

    public Object getProxyInstance() {
        return Proxy.newProxyInstance(target.getClass().getClassLoader(), target.getClass().getInterfaces(), this::invoke);
    }

    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        before();
        Class clazz =null;
        for (Class c:SqlManager.loadMapper()) {
            //判断类型
            if (target.getClass() == c ){
                clazz=c;
                break;
            }
            //如果一个类型都匹配不到
            return null;
        }
        Annotation[] annotations = clazz.getAnnotations();
        for (Annotation a : annotations) {
            //如果类或者接口上存在mapper注解
            if (a instanceof DaoMapper) {
                Method[] methods = clazz.getMethods();
                for (Method m : methods) {
                    if (m.getAnnotation(SqlAnnotation.class) != null) {
                        //仿真：用输出模拟sql语句的提取
                        System.err.println(m.getAnnotation(SqlAnnotation.class).value());
                    }
                }
            }
        }
        after();
        return null;
    }
    private void before() {
        System.err.println("create sql connection");
    }

    private void after() {
        System.err.println("commit sql connection");
    }
}

解析：

• invoke（）方法中执行的是封装的实现以及对应应用了 DaoMapper与 SqlAnnotation注解的处理，应用了反射的机制进行判断处理
• getProxyInstance() 主要是用于获取代理后的对象实例，这个实例其实就是实现“拦截”的作用

---

4、创建应用了简化注解的实际类

public interface TestDao {
    void save();
}
@DaoMapper
public class TestDaoImpl implements TestDao {
    @Override
    @SqlAnnotation("insert into t1 (id,time_come) values (15,'test sql annotation');")
    public void save() {
    }
}
/**
 * @author linxu
 * @date 2019/4/15
 * 这是一个测试类
 */
public class TestProxyAndReflect {
    public static void main(String[] args) {
        ProxyFactory proxyFactory=new ProxyFactory(new TestDaoImpl());
        TestDao testDao=(TestDao) proxyFactory.getProxyInstance();
        testDao.save();
    }
}

运行结果是：

create sql connection
insert into t1 (id,time_come) values (15,'test sql annotation');
commit sql connection

看到这个输出，证明你的程序的仿真成功了！

总结

• 以上的demo就是通过反射机制与动态代理实现的一个SQL简化框架仿真程序
• 所有的操作步骤以及解析都在上述，如果读者对实现封装一个SQL简化框架感兴趣，那么可以基于上述的原理进行自己的一个创造开发，有问题可以留言！谢谢!