学到心塞之 - 自定义持久层框架

淡淡的烟草味﹌ 2023-03-01 12:37 1阅读 0赞

灵魂拷问：如果让你去实现一个持久层框架，你咋弄？

![2020072518150545.png][]

# 1 还记得 JDBC 吗 #

JDBC 已经可以完成与数据库的交互以及增删改查操作，为毛还会出现 MyBatis 之类的持久层框架？因为 JDBC 还不够好啊。下面就分析一下 JDBC 存在的问题：

# 1.1 JDBC 问题分析 #

### **1.1 数据库连接** ###

// 加载数据库驱动
    Class.forName("com.mysql.jdbc.Driver");
    // 通过驱动管理类获取数据连接
    Connection connection =
    DriverManager.getConnection("jdbc:mysql://localhost:3306/mybatis?
    characterEncoding=utf-8", "root", "root");

**问题分析：**

1.  数据库配置信息存在硬编码问题（上述参数都配的固定值，不灵活）；
2.  如果连接代码写在某个方法中，方法被过多调用会引起频繁创建释放数据库连接。

**问题解决：**

1.  把配置信息配在 xml（修改 xml 只需要重新发布，而修改源代码要重新打包部署发布）；
2.  使用连接池管理连接。

### **1.2 sql 与结果集处理** ###

// 定义 sql 语句，？表示占位符
    String sql = "select * from user where username = ?";
    // 获取预处理 statement
    preparedStatement preparedStatement = connection.prepareStatement(sql);
    // 设置参数，第一个参数为 sql 语句中参数的序号（从1开始），第二个参数为设置的参数值
    preparedStatement.setString(1, "tom");
    // 向数据库发出 sql 执行查询，查询出结果集
    ResultSet resultSet = preparedStatement.executeQuery();
    // 遍历查询结果集
    while (resultSet.next()) {
        int id = resultSet.getInt("id");
        String username = resultSet.getString("username");
        // 把每条查询结果封装到 User
        User user = new User();
        user.setId(id);
        user.setUsername(username); 
    }

**问题分析：**

1.  sql 语句，设置参数，获取结果集参数均存在硬编码问题；
2.  上述 user 对象如果有若干属性，手动一个个去 set 的话，就相当繁琐了。

**问题解决：**

1.  使用配置文件，但不建议与数据库配置信息配置在同一文件中。因为数据库的配置信息几乎是不用改动的，而 sql 语句的配置信息是时常要改动的。经常发生改变与不常发生改变的信息不建议配在同一文件中；
2.  使用反射，内省(IntroSpector)机制。

# 2 自定义持久层框架思路分析 #

## 2.1 使用端（项目1） ##

（1）引入自定义持久层框架的 jar 包

（2）数据库配置信息 和 SQL 配置信息（sql 语句，参数类型，返回值类型），通过 xml 来提供

> sqlMapConfig.xml：存放数据库配置信息，存放 mapper.xml 的全路径
> 
> mapper.xml：存放 sql 配置信息

## 2.2 自定义框架端（项目2） ##

本质是对 JDBC 代码进行封装

（1）加载配置文件：根据配置文件的路径，加载配置文件成字节输入流，存储在内存中。

> 创建 Resources 类，方法 InputStream getResourceAsStream(String path)

（2）创建两个 JavaBean（容器对象）：存放对配置文件解析出来的内容。

> Configuration：核心配置类，存放 sqlMapConfig.xml 解析出来的的内容
> 
> MappedStatement：映射配置类，存放 mapper.xml 解析出来的内容

（3）解析配置文件：dom4j

> 创建类 SqlSessionFactoryBuilder 方法：build(InputStream in)
> 
> 第一：使用 dom4j 解析配置文件，将解析出来的内容封装到容器中
> 
> 第二：创建 SqlSessionFactory 对象，生产 SqlSession 会话对象（工厂模式：减少耦合）

（4）创建 SqlSessionFactory 接口及实现类 DefaultSqlSessionFactory

> openSession() 生产 sqlSession

（5）创建 SqlSession 接口及实现类 DefaultSession，定义对数据库的 crud 操作

> selectList()，selectOne()，update()，delete()

（6）创建 Executor 接口及实现类 SimpleExecutor 实现类

> query(Configuration, MappedStatement, Object... params)

# 3 敲码啦 #

## 3.1 使用端 ##

sqlMapConfifig.xml

UserMapper.xml

<mapper namespace="com.wyd.dao.IUserDao">
    
        
        <select id="selectList" resultType="com.wyd.pojo.User" >
            select * from user
        </select>
     
        <select id="selectOne" resultType="com.wyd.pojo.User" parameterType="com.wyd.pojo.User">
            select * from user where id = #{id} and username = #{username}
        </select>
    
        <select id="update" resultType="java.lang.Integer" parameterType="com.wyd.pojo.User">
            update user set username = #{username} where id = #{id}
        </select>
    
        <select id="delete" resultType="java.lang.Integer" parameterType="com.wyd.pojo.User">
            delete from user where id = #{id}
        </select>
    
        <select id="save" resultType="java.lang.Integer" parameterType="com.wyd.pojo.User">
            insert into user(id,username) values(#{id},#{username})
        </select>
    
    </mapper>

User 实体

public class User {
    
        private Integer id;
    
        private String username;
    
        private String password;
    
        private String birthday;
    }

IUserDao

public interface IUserDao {
    
        /**
         * 查询所有用户
         */
        List<User> selectList() throws Exception;
    
        /**
         * 根据条件进行用查询
         */
        User selectOne(User user) throws Exception;
    
        int update(User user) throws Exception;
    
        int delete(User user) throws Exception;
    
        int save(User user) throws Exception;
    
    }

测试类

@Test
    public void test() throws Exception {
            // 传 配置文件给框架端进行解析
            InputStream resourceAsSteam = Resources.getResourceAsSteam("sqlMapConfig.xml");
            // 创建会话
            SqlSessionFactory sqlSessionFactory = new 
    SqlSessionFactoryBuilder().build(resourceAsSteam);
            SqlSession sqlSession = sqlSessionFactory.openSession();
            //调用
            User user = new User();
            user.setId(1);
            user.setUsername("张三");
            IUserDao userDao = sqlSession.getMapper(IUserDao.class);
    
            List<User> all = userDao.findAll();
            for (User user1 : all) {
                System.out.println(user1);
            }
    }

## 3.2 自定义框架端 ##

（1）Resources：将配置文件加载成字节输入流，存储在内存中

public class Resources {
    
        // 根据配置文件的路径，将配置文件加载成字节输入流，存储在内存中
        public static InputStream getResourceAsSteam(String path){
            InputStream resourceAsStream = Resources.class.getClassLoader().getResourceAsStream(path);
            return  resourceAsStream;
        }
    
    }

（2）SqlSessionFactoryBuilder 创建 SqlSessionFactory 和 SqlSession

public class SqlSessionFactoryBuilder {
    
        public SqlSessionFactory build(InputStream in) throws DocumentException, PropertyVetoException {
            // 第一：使用dom4j解析配置文件，将解析出来的内容封装到Configuration中
            XMLConfigBuilder xmlConfigBuilder = new XMLConfigBuilder();
            Configuration configuration = xmlConfigBuilder.parseConfig(in);
    
            // 第二：创建sqlSessionFactory对象：工厂类：生产sqlSession:会话对象
            DefaultSqlSessionFactory defaultSqlSessionFactory = new DefaultSqlSessionFactory(configuration);
            return defaultSqlSessionFactory;
        }
    
    }
    
    public class Configuration {
    
        private DataSource dataSource;
        /*
        *   key: statementid  value:封装好的mappedStatement对象
         * */
        Map<String,MappedStatement> mappedStatementMap = new HashMap<>();
    
    }
    
    public class MappedStatement {
    
        //id标识
        private String id;
        //返回值类型
        private String resultType;
        //参数值类型
        private String paramterType;
        //sql语句
        private String sql;
    }

（3）simpleExecutor：连接数据库，解析 sql，执行 sql

public class simpleExecutor implements  Executor {
    
        @Override                                                                                
        public <E> List<E> query(Configuration configuration, MappedStatement mappedStatement, Object... params) throws Exception {
            // 1. 注册驱动，获取连接
            Connection connection = configuration.getDataSource().getConnection();
            // 2. 获取sql语句 : select * from user where id = #{id} and username = #{username}
                //转换sql语句： select * from user where id = ? and username = ? ，转换的过程中，还需要对#{}里面的值进行解析存储
            String sql = mappedStatement.getSql();
            BoundSql boundSql = getBoundSql(sql);
            // 3.获取预处理对象：preparedStatement
            PreparedStatement preparedStatement = connection.prepareStatement(boundSql.getSqlText());
            // 4. 设置参数
                //获取到了参数的全路径
             String paramterType = mappedStatement.getParamterType();
             Class<?> paramtertypeClass = getClassType(paramterType);
            List<ParameterMapping> parameterMappingList = boundSql.getParameterMappingList();
            for (int i = 0; i < parameterMappingList.size(); i++) {
                ParameterMapping parameterMapping = parameterMappingList.get(i);
                String content = parameterMapping.getContent();
                //反射
                Field declaredField = paramtertypeClass.getDeclaredField(content);
                //暴力访问
                declaredField.setAccessible(true);
                Object o = declaredField.get(params[0]);
                preparedStatement.setObject(i+1,o);
    
            }
            // 5. 执行sql
            ResultSet resultSet = preparedStatement.executeQuery();
            String resultType = mappedStatement.getResultType();
            Class<?> resultTypeClass = getClassType(resultType);
            ArrayList<Object> objects = new ArrayList<>();
            // 6. 封装返回结果集
            while (resultSet.next()){
                Object o =resultTypeClass.newInstance();
                //元数据
                ResultSetMetaData metaData = resultSet.getMetaData();
                for (int i = 1; i <= metaData.getColumnCount(); i++) {
                    // 字段名
                    String columnName = metaData.getColumnName(i);
                    // 字段的值
                    Object value = resultSet.getObject(columnName);
                    //使用反射或者内省，根据数据库表和实体的对应关系，完成封装
                    PropertyDescriptor propertyDescriptor = new PropertyDescriptor(columnName, resultTypeClass);
                    Method writeMethod = propertyDescriptor.getWriteMethod();
                    writeMethod.invoke(o,value);
                }
                objects.add(o);
            }
                return (List<E>) objects;
        }
    
        /**
         * 完成对#{}的解析工作：1.将#{}使用？进行代替，2.解析出#{}里面的值进行存储
         * @param sql
         * @return
         */
        private BoundSql getBoundSql(String sql) {
            //标记处理类：配置标记解析器来完成对占位符的解析处理工作
            ParameterMappingTokenHandler parameterMappingTokenHandler = new ParameterMappingTokenHandler();
            GenericTokenParser genericTokenParser = new GenericTokenParser("#{", "}", parameterMappingTokenHandler);
            //解析出来的sql
            String parseSql = genericTokenParser.parse(sql);
            //#{}里面解析出来的参数名称
            List<ParameterMapping> parameterMappings = parameterMappingTokenHandler.getParameterMappings();
            BoundSql boundSql = new BoundSql(parseSql,parameterMappings);
             return boundSql;
        }
    }

# 4 引入动态代理进行优化 #

动态代理获取 Mapper 对象

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d5ZHlkMTEw_size_16_color_FFFFFF_t_70][]

@Override
    public <T> T getMapper(Class<?> mapperClass) {
            // 使用JDK动态代理来为Dao接口生成代理对象，并返回
            Object proxyInstance = Proxy.newProxyInstance(DefaultSqlSession.class.getClassLoader(), new Class[]{mapperClass}, new InvocationHandler() {
                @Override
                public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
                    // 底层都还是去执行JDBC代码 //根据不同情况，来调用selctList或者selectOne
                    // 准备参数 1：statmentid :sql语句的唯一标识：namespace.id= 接口全限定名.方法名
                    // 方法名：findAll
                    String methodName = method.getName();
                    String className = method.getDeclaringClass().getName();
                    String statementId = className+"."+methodName;
                    // 准备参数2：params:args
                    // 获取被调用方法的返回值类型
                    Type genericReturnType = method.getGenericReturnType();
                    // 判断是否进行了 泛型类型参数化
                    if(genericReturnType instanceof ParameterizedType){
                        List<Object> objects = selectList(statementId, args);
                        return objects;
                    }
                    return selectOne(statementId,args);
    
                }
            });
            return (T) proxyInstance;
    }

[2020072518150545.png]: /images/20230208/e92bcc395dbe4526840a4477575bd0b7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d5ZHlkMTEw_size_16_color_FFFFFF_t_70]: /images/20230208/7a68451b903b423597c34a552938d1fb.png