一、MyBatis核心组件
在开始实现我们的mybatis框架之前我觉得有必要先学习一下[MyBatis核心组件],如下示意图(出自前文)，在图中可以了解到更多的细节。
二、MyBatis手写实现
1. 从测试用例作为入口
/** * 测试用例，将整个工程串联起来 */public class MybatisTest { public static void main(String[] args) throws IOException { //1.读取配置文件,将配置文件转换为输入流 InputStream in = Resources.getResourceAsStream("mybatis-config.xml"); //2.创建SqlSessionFactory工厂 SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder(); //返回DefaultSqlSessionFactory对象，利用XMLConfigBuilder类从输入流中读取配置信息。 // 封装成Configuration对象传入DefaultSqlSessionFactory的构造方法 SqlSessionFactory factory = builder.build(in); //3.使用工厂(DefaultSqlSessionFactory)生产SqlSession对象, SqlSession session = factory.openSession(); //4.使用SqlSession创建Dao接口的代理对象 IUserMapper mapper = session.getMapper(IUserMapper.class); //5.使用代理对象执行方法 List users = mapper.findAll(); for (User user : users) { System.out.println(user); } //6.释放资源 session.close(); try { in.close(); } catch (IOException e) { e.printStackTrace(); } }}我们根据这个测试用例将整个mybatis执行sql过程分为几步去实现它：
- SqlSessionFactoryBuilder：从 XML 配置文件或一个预先定制的 Configuration 的实例构建出 SqlSessionFactory 的实例，将Configuration对象传入。(配置信息封装成Configuration对象)。
- SqlSessionFactory: 根据之前builder传入的封装好的Configuration，可以创建SqlSession对象。Configuration: 将从XML配置文件中解析到的内容封装起来，其中包括数据源信息(数据库连接配置),还有一个sqlMappers(HashMap对象)，其中key是由Mapper接口的全限定类名和方法名组成，value是一个SqlMapper对象。SqlMapper: 存放的是要执行的SQL语句和要封装的实体类全限定类名。
- SqlSession: 其中有要执行sql语句用的sqlMappers，并且持有数据库的连接。这些属性，都是在SqlSessionFactory创建SqlSession时传入的Configuration中的属性。它可以用于获取Mapper接口的增强代理对象(由jdk动态代理实现，非常关键的一步)。
- MapperProxy: 实现了InvocationHandler接口，定义了代理对象的增强行为。他持有sqlMappers的引用，和数据库连接(SqlSession创建代理对象时传入)。然后拦截Mapper接口的所有方法，根据Method对象获取方法名和接口的权限名。然后拼接在一起，就是sqlmappers中需要的key，然后获取到maper对象，在使用数据库连接去数据库查询，并且封装返回数据。
我认为上面这段分析远远比具体实现代码更加重要，如果有不懂可以查看代码后，反过来结合这段内容去分析代码，你会发现整个脉络分非常清晰。对动态代理不熟悉的可以多去GitHub上查查资料，动态代理在所有的框架中如spring、mybatis都扮演着十分重要的角色。
2.整个项目结构
3. 实现代码
可以打开右边的目录栏来快速跳转
(1)、Resources
/** * 使用类加载器读取配置文件的类 */public class Resources { public static InputStream getResourceAsStream(String filePath) { return Resources.class.getClassLoader().getResourceAsStream(filePath); }}(2)、SqlSessionFactoryBuilder
/** * 根据输入流构建SqlSessionFactory对象 */public class SqlSessionFactoryBuilder { public SqlSessionFactory build(InputStream inputStream) { return new DefaultSqlSessionFactory( XMLConfigBuilder.loadConfiguration(inputStream) ); }}(3)、SqlSessionFactory
/** * 创建SqlSession对象的工厂类 */public interface SqlSessionFactory { SqlSession openSession();}/** * 根据传入的Configuration创建SqlSession */public class DefaultSqlSessionFactory implements SqlSessionFactory { private Configuration cfg; @Override public SqlSession openSession() { return new DefaultSqlSession(cfg.getMappers(), DataSourceUtil.getConnection(cfg)); } public DefaultSqlSessionFactory(Configuration cfg) { this.cfg = cfg; }}(4)、SqlSession
/** * 自定义Mybatis中和数据库交互的核心类,可以创建dao包中Mapper接口的代理对象 */public interface SqlSession { /** * 通过mapper字节码获取代理对象 * * @param mapperClass 被代理对象字节码对象 * @param 被代理类型 * @return 代理对象 */ T getMapper(Class mapperClass); /** * 释放资源 */ void close();}/** * 获取Mapper代理对象执行查询 */public class DefaultSqlSession implements SqlSession { private Map sqlMappers; private Connection connection; public DefaultSqlSession(Map sqlMappers, Connection connection) { this.sqlMappers = sqlMappers; this.connection = connection; } @Override public T getMapper(Class mapperClass) { return (T) Proxy.newProxyInstance(mapperClass.getClassLoader(), new Class[]{mapperClass}, new MapperProxy(sqlMappers, connection)); } @Override public void close() { if (connection != null) { try { connection.close(); } catch (Exception e) { e.printStackTrace(); } } }}(5)、MapperProxy
/** * 增强Mapper，生成代理对象 */public class MapperProxy implements InvocationHandler { private Map sqlMappers; private Connection connection; public MapperProxy(Map sqlMappers, Connection connection) { this.sqlMappers = sqlMappers; this.connection = connection; } @Override public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { //获取方法名和全限名，根据方法名得到Mapper对象 String methodName = method.getName(); String className = method.getDeclaringClass().getName(); SqlMapper sqlMapper = sqlMappers.get(className + "." + methodName); return new Executor().selectList(sqlMapper, connection); }}(6)、SqlMapper
/** * 要查询的sql语句和返回类型的全限定名，封装dao包类的每一个接口的每一个方法 */public class SqlMapper { /** * 要查询的sql语句 */ private String queryString; /** * 查询后要封装的类型 */ private String resultType; public String getQueryString() { return queryString; } public void setQueryString(String queryString) { this.queryString = queryString; } public String getResultType() { return resultType; } public void setResultType(String resultType) { this.resultType = resultType; }}(7)、Configuration
/** * 数据库连接的配置信息 */public class Configuration { private String driver; private String url; private String password; private String username; private Map sqlMappers = new HashMap<>(); public Map getMappers() { return sqlMappers; } public void setMappers(Map mappers) { this.sqlMappers.putAll(mappers); } public String getUsername() { return username; } public void setUsername(String username) { this.username = username; } public String getDriver() { return driver; } public void setDriver(String driver) { this.driver = driver; } public String getUrl() { return url; } public void setUrl(String url) { this.url = url; } public String getPassword() { return password; } public void setPassword(String password) { this.password = password; }}(8)、Select注解
/** * mybatis自定义注解 */@Retention(RetentionPolicy.RUNTIME)@Target(ElementType.METHOD)public @interface Select { /** * 配置SQL语句的 */ String value();}(9)、User
/** * 实体类 */public class User implements Serializable { private Integer id; private String username; private Date birthday; private String sex; private String address; @Override public String toString() { return "User{" + "id=" + id + ", username='" + username + ''' + ", birthday=" + birthday + ", sex='" + sex + ''' + ", address='" + address + ''' + '}'; } public Integer getId() { return id; } public void setId(Integer id) { this.id = id; } public String getUsername() { return username; } public void setUsername(String username) { this.username = username; } public Date getBirthday() { return birthday; } public void setBirthday(Date birthday) { this.birthday = birthday; } public String getSex() { return sex; } public void setSex(String sex) { this.sex = sex; } public String getAddress() { return address; } public void setAddress(String address) { this.address = address; }}(10)、IUserMapper
/** * Dao类接口 */public interface IUserMapper { @Select("select * from user") List findAll();}(10)、工具类(不是重点，理解即可)
- DataSourceUtil
/** * 根据Configuration创建连接 */public class DataSourceUtil { /** * 通过配置类用于获取一个连接 * * @param cfg 配置类 * @return 根据配置类读取的配置信息创建的连接 */ public static Connection getConnection(Configuration cfg) { try { Class.forName(cfg.getDriver()); return DriverManager.getConnection(cfg.getUrl(), cfg.getUsername(), cfg.getPassword()); } catch (Exception e) { throw new RuntimeException(e); } }}- Executor
/** * 根据mapper和connection封装查询结果 */public class Executor { public List selectList(SqlMapper sqlMapper, Connection conn) { PreparedStatement pstm = null; ResultSet rs = null; try { //1.取出mapper中的数据 String queryString = sqlMapper.getQueryString(); String resultType = sqlMapper.getResultType(); Class domainClass = Class.forName(resultType); //2.获取PreparedStatement对象 pstm = conn.prepareStatement(queryString); //3.执行SQL语句，获取结果集 rs = pstm.executeQuery(); //4.封装结果集 List list = new ArrayList(); while (rs.next()) { //实例化要封装的实体类对象 E obj = (E) domainClass.newInstance(); //取出结果集的元信息：ResultSetMetaData ResultSetMetaData rsmd = rs.getMetaData(); //取出总列数 int columnCount = rsmd.getColumnCount(); //遍历总列数 for (int i = 1; i <= columnCount; i++) { //获取每列的名称，列名的序号是从1开始的 String columnName = rsmd.getColumnName(i); //根据得到列名，获取每列的值 Object columnValue = rs.getObject(columnName); //给obj赋值：使用Java内省机制(借助PropertyDescriptor实现属性的封装) //要求：实体类的属性和数据库表的列名保持一种 PropertyDescriptor pd = new PropertyDescriptor(columnName, domainClass); //获取它的写入方法 Method writeMethod = pd.getWriteMethod(); //把获取的列的值，给对象赋值 writeMethod.invoke(obj, columnValue); } //把赋好值的对象加入到集合中 list.add(obj); } return list; } catch (Exception e) { throw new RuntimeException(e); } finally { release(pstm, rs); } } private void release(PreparedStatement pstm, ResultSet rs) { if (rs != null) { try { rs.close(); } catch (Exception e) { e.printStackTrace(); } } if (pstm != null) { try { pstm.close(); } catch (Exception e) { e.printStackTrace(); } } }}- XMLConfigBuilder
/** * 解析xml封装Configuration对象 */public class XMLConfigBuilder { /** * 解析主配置文件，把里面的内容填充到DefaultSqlSession所需要的地方 * 使用的技术： * dom4j+xpath */ public static Configuration loadConfiguration(InputStream in) { try { //定义封装连接信息的配置对象(mybatis的配置对象) Configuration cfg = new Configuration(); //1.获取SAXReader对象 SAXReader reader = new SAXReader(); //2.根据字节输入流获取Document对象 Document document = reader.read(in); //3.获取根节点 Element root = document.getRootElement(); //4.使用xpath中选择指定节点的方式，获取所有property节点 List propertyElements = root.selectNodes("//property"); //5.遍历节点 for (Element propertyElement : propertyElements) { //判断节点是连接数据库的哪部分信息 //取出name属性的值 String name = propertyElement.attributeValue("name"); if ("driver".equals(name)) { //表示驱动 //获取property标签value属性的值 String driver = propertyElement.attributeValue("value"); cfg.setDriver(driver); } if ("url".equals(name)) { //表示连接字符串 //获取property标签value属性的值 String url = propertyElement.attributeValue("value"); cfg.setUrl(url); } if ("username".equals(name)) { //表示用户名 //获取property标签value属性的值 String username = propertyElement.attributeValue("value"); cfg.setUsername(username); } if ("password".equals(name)) { //表示密码 //获取property标签value属性的值 String password = propertyElement.attributeValue("value"); cfg.setPassword(password); } } //取出mappers中的所有mapper标签，判断他们使用了resource还是class属性 List mapperElements = root.selectNodes("//mappers/mapper"); //遍历集合 for (Element mapperElement : mapperElements) { //判断mapperElement使用的是哪个属性 Attribute attribute = mapperElement.attribute("resource"); if (attribute != null) { System.out.println("使用的是XML"); //表示有resource属性，用的是XML //取出属性的值 String mapperPath = attribute.getValue(); //把映射配置文件的内容获取出来，封装成一个map Map sqlMappers = loadMapperConfiguration(mapperPath); //给configuration中的sqlMappers赋值 cfg.setMappers(sqlMappers); } else { System.out.println("使用的是注解"); //表示没有resource属性，用的是注解 //获取class属性的值 String maperClassPath = mapperElement.attributeValue("class"); //根据daoClassPath获取封装的必要信息 Map sqlMappers = loadMapperAnnotation(maperClassPath); //给configuration中的sqlMappers赋值，这里的set方法是putAll，追加进去，不要覆盖。 cfg.setMappers(sqlMappers); } } //返回Configuration return cfg; } catch (Exception e) { throw new RuntimeException(e); } finally { try { in.close(); } catch (Exception e) { e.printStackTrace(); } } } /** * 根据传入的参数，解析XML，并且封装到Map中 * * @param mapperPath 映射配置文件的位置 * @return map中包含了获取的唯一标识(key是由Mapper接口的全限定类名和方法名组成) * 以及执行所需的必要信息(value是一个Mapper对象，里面存放的是执行的SQL语句和要封装的实体类全限定类名) */ private static Map loadMapperConfiguration(String mapperPath) throws IOException { InputStream in = null; try { //定义返回值对象 Map sqlMappers = new HashMap<>(); //1.根据路径获取字节输入流 in = Resources.getResourceAsStream(mapperPath); //2.根据字节输入流获取Document对象 SAXReader reader = new SAXReader(); Document document = reader.read(in); //3.获取根节点 Element root = document.getRootElement(); //4.获取根节点的namespace属性取值 String namespace = root.attributeValue("namespace"); //5.获取所有的select节点 List selectElements = root.selectNodes("//select"); //6.遍历select节点集合 for (Element selectElement : selectElements) { //取出id属性的值 组成map中key的部分 String id = selectElement.attributeValue("id"); //取出resultType属性的值 组成map中value的部分 String resultType = selectElement.attributeValue("resultType"); //取出文本内容 组成map中value的部分 String queryString = selectElement.getText(); //创建Key String key = namespace + "." + id; //创建Value SqlMapper sqlMapper = new SqlMapper(); sqlMapper.setQueryString(queryString); sqlMapper.setResultType(resultType); //把key和value存入sqlMappers中 sqlMappers.put(key, sqlMapper); } return sqlMappers; } catch (Exception e) { throw new RuntimeException(e); } finally { in.close(); } } /** * 根据传入的参数，得到dao中所有被select注解标注的方法。 * 根据方法名称和类名，以及方法上注解value属性的值，组成Mapper的必要信息 * * @param mapperClassPath * @return */ private static Map loadMapperAnnotation(String mapperClassPath) throws Exception { //定义返回值对象 Map sqlMappers = new HashMap<>(); //1.得到dao接口的字节码对象 Class daoClass = Class.forName(mapperClassPath); //2.得到dao接口中的方法数组 Method[] methods = daoClass.getMethods(); //3.遍历Method数组 for (Method method : methods) { //取出每一个方法，判断是否有select注解 boolean isAnnotated = method.isAnnotationPresent(Select.class); if (isAnnotated) { //创建Mapper对象 SqlMapper sqlMapper = new SqlMapper(); //取出注解的value属性值 Select selectAnno = method.getAnnotation(Select.class); String queryString = selectAnno.value(); sqlMapper.setQueryString(queryString); //获取当前方法的返回值，还要求必须带有泛型信息，取出具体要封装的对象 Type type = method.getGenericReturnType();//List //判断type是不是参数化的类型 if (type instanceof ParameterizedType) { //强转 ParameterizedType ptype = (ParameterizedType) type; //得到参数化类型中的实际类型参数 Type[] types = ptype.getActualTypeArguments(); //取出第一个，User Class domainClass = (Class) types[0]; //获取domainClass的类名 String resultType = domainClass.getName(); //给Mapper赋值 sqlMapper.setResultType(resultType); } //组装key的信息 //获取方法的名称 String methodName = method.getName(); String className = method.getDeclaringClass().getName(); String key = className + "." + methodName; //给map赋值, sqlMappers.put(key, sqlMapper); } } return sqlMappers; }}4. 配置信息
(1)、mybatis-config.xml
<?xml version="1.0" encoding="UTF-8" ?>(2)、UserMapper.xml
<?xml version="1.0" encoding="UTF-8" ?> select * from user5. 运行结果
本文章为转载内容，我们尊重原作者对文章享有的著作权。如有内容错误或侵权问题，欢迎原作者联系我们进行内容更正或删除文章。
