模仿与学习MyBatis - 1.6 注解与Session：sql语句

本文收录于模仿与学习MyBatis系列

---

简述

在上一篇中，实现了一个MapperProxy类，代入接口会生成一个mapper，通过它来调用方法，将输出begin #方法名 end这样的字串。
而在本篇中将讨论的是，什么是注解，MapperProxy如何与注解搭配起来，回调session中的方法。即要达到如下图中的效果，最后分析一下这样设计的原因。

最终结果是一个Java Maven项目，代码存在github上。

注解与解析

首先需要新建一个annotation包，加一个SQL类，代码如下：

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface SQL {
    String value();
}

@interface表示这是一个注解，@Target里可以指定它能被注在哪个地方，选项有METHOD \ TYPE \ FIELD等等，此处选择注在METHOD（方法）上。@Retention中可以选择存活的时期，选择RUNTIME（运行中）。然后具体使用注解的方式如下：

public interface ArticleMapper {
    // 正规写法是@SQL(value="xxxx")，若只有value属性可略去
    @SQL("select * from article where id = {0}")
    void findById(int id);
}

这样，当我们使用时，直接从method中可以取到此注解的值。

@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable 
{
    SQL sql = method.getAnnotation(SQL.class);
    System.out.println(sql.value());
    return null;
}

---

参数代入与回调Session

上面的代码，正常的输出了注解上的select from article where id = {0}，下一步就是想着如何将{0}这种数字替换为参数中的第0个（int id）了。以下先写一段比较简陋的代码，用正则表达式找到sql语句中的所有{xxx}格式的字串，替换为参数，勉强实现一下功能：

public class MapperProxy<T> implements InvocationHandler {

    private Session session;

    @SuppressWarnings("unchecked")
    public static <T> T newInstance(Class<T> clazz, Session session) 
    {
        MapperProxy<T> proxy = new MapperProxy<>();
        proxy.session = session;
        // 动态代理
        return (T) Proxy.newProxyInstance(clazz.getClassLoader(), new Class[] { clazz }, proxy);
    }

    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable 
    {
        SQL anno = method.getAnnotation(SQL.class);
        if (anno == null) {
            return null;
        }
        String sql = anno.value();
        Pattern p = Pattern.compile("\\{[^\\}]+\\}");
        Matcher m = p.matcher(sql);
        if (m.find()) {
            StringBuffer sb = new StringBuffer();
            do {
                //获取{param}，用BeanWrapper处理后的返回值来替换
                String s = m.group();
                int index = Integer.valueOf(s.substring(1, s.length() - 1));
                m.appendReplacement(sb, args[index].toString());
            } while (m.find());
            sql = m.appendTail(sb).toString();
        }
        System.out.println(sql);
        session.exec(sql);
        return null;
    }
}

注意改动了构造函数，需要代入session，因为在执行时我们希望回调session了。而session中也新增一个接口：

@Override
public <T> T getMapper(Class<T> clazz) {
    return MapperProxy.newInstance(clazz, this);
}    

以上代码虽然有点绕，但是已经完整的，把SessionFactory->Session->Mapper->invoke的这个流程走通了：

public static void main(String args[]) throws Exception {
    SessionFactory factory = new VSessionFactory("config.xml");
    Session session = factory.openSession();
    ArticleMapper mapper = session.getMapper(ArticleMapper.class);
    mapper.findById(1);
}

输出结果为：

select * from article where id = 1
--------------------print--------------------
id=1
title=欢迎来到自由茶社
brief=这里是大门的入口
content=这里是大门的入口
father_id=0
author_name=me
create_time=2016-11-16 23:44:36.0
modify_time=2016-12-06 00:41:07.0

结果正确，目前流程走通，已经可以通过接口与注解，实现sql语句查询了。后续将继续完善，将sql查询到的值转为Java类返回，而不是简单的打在屏幕上。