<em>Mac</em>Book项目 2009年学校开始实施<em>Mac</em>Book项目,所有师生配备一本<em>Mac</em>Book,并同步更新了校园无线网络。学校每周进行电脑技术更新,每月发送技术支持资料,极大改变了教学及学习方式。因此2011
2021-06-01 09:32:01
本文適合有一定java基礎的同學,通過分析jdbc存在的問題,進行手寫自定義持久層框架,可以更加清楚常用的mybatis等開源框架的原理。
本文適合有一定java基礎的同學,通過自定義持久層框架,可以更加清楚常用的mybatis等開源框架的原理。
學習java的同學一定避免不了接觸過jdbc,讓我們來回顧下初學時期接觸的jdbc操作吧
以下程式碼連線資料庫查詢使用者表資訊,使用者表欄位分別為使用者id,使用者名稱username。
Connection connection = null; PreparedStatement preparedStatement = null; ResultSet resultSet = null; User user = new User(); try { // 載入資料庫驅動 //Class.forName("com.mysql.jdbc.Driver"); Class.forName("com.mysql.cj.jdbc.Driver"); // 通過驅動管理類獲取資料庫連結 connection = DriverManager.getConnection("jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf-8", "root", "mimashi3124"); // 定義sql語句?表示預留位置 String sql = "select * from user where username = ?"; // 獲取預處理statement preparedStatement = connection.prepareStatement(sql); // 設定引數,第⼀個引數為sql語句中引數的序號(從1開始),第⼆個引數為設定的引數值 preparedStatement.setString(1, "蓋倫"); // 向資料庫發出sql執⾏查詢,查詢出結果集 resultSet = preparedStatement.executeQuery(); // 遍歷查詢結果集 while (resultSet.next()) { int id = resultSet.getInt("id"); String username = resultSet.getString("username"); // 封裝User user.setId(id); user.setUsername(username); } System.out.println(user); } catch ( Exception e) { e.printStackTrace(); } finally { // 釋放資源 if (resultSet != null) { try { resultSet.close(); } catch (SQLException e) { e.printStackTrace(); } } if (preparedStatement != null) { try { preparedStatement.close(); } catch (SQLException e) { e.printStackTrace(); } } if (connection != null) { try { connection.close(); } catch (SQLException e) { e.printStackTrace(); } } }
檢視程式碼我們可以發現使用JDBC運算元據庫存在以下問題:
問題解決思路
自己動手寫個持久層框架
接下來,我們來一個個解決上面的問題
資料庫連線池我們可以直接使用c3p0提供的ComboPooledDataSource即可
為了解決sql寫死問題,我們要把sql寫到xml檔案中,那自然是要定義一個xml檔案了。
光有sql肯定不行,畢竟我們要先連線資料庫,sql語句才有存在的意義。所以xml中得先定義資料設定資訊,然後才是sql語句。
我們新建一個sqlMapConfig.xml,定義資料來源資訊、並且增加兩個sql語句,parameterType為sql執行引數,resultType為方法返回實體。
程式碼如下(資料庫不同版本使用驅動類可能不同):
<configuration> <!--資料庫連線資訊--> <property name="driverClass" value="com.mysql.cj.jdbc.Driver"/> <!-- <property name="driverClass" value="com.mysql.jdbc.Driver"/>--> <property name="jdbcUrl" value="jdbc:mysql://localhost:3306/mybatis?serverTimezone=Asia/Shanghai"/> <property name="username" value="root"/> <property name="password" value="mimashi3124"/> <select id="selectOne" parameterType="org.example.pojo.User" resultType="org.example.pojo.User"> select * from user where id = #{id} and username =#{username} </select> <select id="selectList" resultType="org.example.pojo.User"> select * from user </select> </configuration>
現在xml檔案資料庫資訊也有了,sql語句定義也有了,還有什麼問題呢?
我們實際中對sql的操作會涉及到不同的表,所以我們改進一下,把每個表的sql語句單獨放在一個xml裡,這樣結構更清晰就容易維護。
優化以後的xml設定現在是這樣了
sqlMapConfig.xml
<configuration> <!--資料庫連線資訊--> <property name="driverClass" value="com.mysql.cj.jdbc.Driver"/> <!-- <property name="driverClass" value="com.mysql.jdbc.Driver"/>--> <property name="jdbcUrl" value="jdbc:mysql://localhost:3306/mybatis?serverTimezone=Asia/Shanghai"/> <property name="username" value="root"/> <property name="password" value="mimashi3124"/> <!--引⼊sql設定資訊--> <mapper resource="mapper.xml"></mapper> </configuration>
mapper.xml
<mapper namespace="user"> <select id="selectOne" parameterType="org.example.pojo.User" resultType="org.example.pojo.User"> select * from user where id = #{id} and username =#{username} </select> <select id="selectList" resultType="org.example.pojo.User"> select * from user </select> </mapper>
順便定義一下業務實體User
public class User { private int id; private String username; public int getId() { return id; } public void setId(int id) { this.id = id; } public String getUsername() { return username; } public void setUsername(String username) { this.username = username; } @Override public String toString() { return "User{" + "id=" + id + ", username='" + username + ''' + '}'; } }
讀取完成以後以流的形式存在,不好操作,所以我們要做解析拿到資訊,建立實體物件來儲存。
Configuration : 存放資料庫基本資訊、Map<唯⼀標識,Mapper> 唯⼀標識:namespace + "." + idMappedStatement:存放sql語句、輸⼊引數型別、輸出引數型別
xml解析我們使用dom4j
首先引入maven依賴
程式碼如下(mysql驅動版本根據實際使用mysql版本調整):
<properties> <maven.compiler.source>8</maven.compiler.source> <maven.compiler.target>8</maven.compiler.target> </properties> <dependencies> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>8.0.22</version> </dependency> <dependency> <groupId>c3p0</groupId> <artifactId>c3p0</artifactId> <version>0.9.1.2</version> </dependency> <dependency> <groupId>log4j</groupId> <artifactId>log4j</artifactId> <version>1.2.12</version> </dependency> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>4.10</version> </dependency> <dependency> <groupId>dom4j</groupId> <artifactId>dom4j</artifactId> <version>1.6.1</version> </dependency> <dependency> <groupId>jaxen</groupId> <artifactId>jaxen</artifactId> <version>1.1.6</version> </dependency> </dependencies>
資料庫設定實體 Configuration
public class Configuration { //資料來源 private DataSource dataSource; //map集合: key:statementId value:MappedStatement private Map<String,MappedStatement> mappedStatementMap = new HashMap<>(); public DataSource getDataSource() { return dataSource; } public Configuration setDataSource(DataSource dataSource) { this.dataSource = dataSource; return this; } public Map<String, MappedStatement> getMappedStatementMap() { return mappedStatementMap; } public Configuration setMappedStatementMap(Map<String, MappedStatement> mappedStatementMap) { this.mappedStatementMap = mappedStatementMap; return this; } }
Sql語句資訊實體
public class MappedStatement { //id private String id; //sql語句 private String sql; //輸⼊引數 private String parameterType; //輸出引數 private String resultType; public String getId() { return id; } public MappedStatement setId(String id) { this.id = id; return this; } public String getSql() { return sql; } public MappedStatement setSql(String sql) { this.sql = sql; return this; } public String getParameterType() { return parameterType; } public MappedStatement setParameterType(String parameterType) { this.parameterType = parameterType; return this; } public String getResultType() { return resultType; } public MappedStatement setResultType(String resultType) { this.resultType = resultType; return this; } }
順便定義一個Resources類來讀取xml檔案流
public class Resources { public static InputStream getResourceAsSteam(String path) { return Resources.class.getClassLoader().getResourceAsStream(path); } }
接下來就是實際的解析了,因為解析程式碼比較多,我們考慮封裝類單獨處理解析
定義XMLConfigBuilder類解析資料庫設定資訊
public class XMLConfigBuilder { private Configuration configuration; public XMLConfigBuilder() { this.configuration = new Configuration(); } public Configuration parserConfiguration(InputStream inputStream) throws DocumentException, PropertyVetoException, ClassNotFoundException { Document document = new SAXReader().read(inputStream); Element rootElement = document.getRootElement(); List<Element> propertyElements = rootElement.selectNodes("//property"); Properties properties = new Properties(); for (Element propertyElement : propertyElements) { String name = propertyElement.attributeValue("name"); String value = propertyElement.attributeValue("value"); properties.setProperty(name,value); } //解析到資料庫設定資訊,設定資料來源資訊 ComboPooledDataSource comboPooledDataSource = new ComboPooledDataSource(); comboPooledDataSource.setDriverClass(properties.getProperty("driverClass")); comboPooledDataSource.setJdbcUrl(properties.getProperty("jdbcUrl")); comboPooledDataSource.setUser(properties.getProperty("username")); comboPooledDataSource.setPassword(properties.getProperty("password")); configuration.setDataSource(comboPooledDataSource); //將configuration傳入XMLMapperBuilder中做sql語句解析。 XMLMapperBuilder xmlMapperBuilder = new XMLMapperBuilder(this.configuration); List<Element> mapperElements = rootElement.selectNodes("//mapper"); for (Element mapperElement : mapperElements) { String mapperPath = mapperElement.attributeValue("resource"); InputStream resourceAsStream = this.getClass().getClassLoader().getResourceAsStream(mapperPath); xmlMapperBuilder.parse(resourceAsStream); } return configuration; } }
定義XMLMapperBuilder類解析資料庫設定資訊
public class XMLMapperBuilder { private Configuration configuration; public XMLMapperBuilder(Configuration configuration) { this.configuration = configuration; } public void parse(InputStream inputStream) throws DocumentException, ClassNotFoundException { Document document = new SAXReader().read(inputStream); Element rootElement = document.getRootElement(); String namespace = rootElement.attributeValue("namespace"); List<Element> select = rootElement.selectNodes("select"); for (Element element : select) { //id的值 String id = element.attributeValue("id"); String parameterType = element.attributeValue("parameterType"); //輸⼊引數 String resultType = element.attributeValue("resultType"); //返回引數 //statementId,後續呼叫通過statementId,找到對應的sql執行 String key = namespace + "." + id; //sql語句 String textTrim = element.getTextTrim(); //封裝 mappedStatement MappedStatement mappedStatement = new MappedStatement(); mappedStatement.setId(id); mappedStatement.setParameterType(parameterType); mappedStatement.setResultType(resultType); mappedStatement.setSql(textTrim); //填充 configuration configuration.getMappedStatementMap().put(key, mappedStatement); } } }
現在我們可以通過呼叫設定解析的方法拿到Configuration物件了。但是我們實際使用,肯定是希望我給你設定資訊、sql語句,再呼叫你的方法就返回結果了。
所以我們還需要定義一個資料庫操作介面(類)
public interface SqlSession { //查詢多個 public <E> List<E> selectList(String statementId, Object... param) throws Exception; //查詢一個 public <T> T selectOne(String statementId,Object... params) throws Exception; }
對操作介面SqlSession做具體實現,這裡主要是通過statementId找到對應的sql資訊,進行執行
程式碼中simpleExcutor做真正的資料庫語句執行、返回引數封裝等操作
public class DefaultSqlSession implements SqlSession { private Configuration configuration; private Executor simpleExcutor = new SimpleExecutor(); public DefaultSqlSession(Configuration configuration) { this.configuration = configuration; } @Override public <E> List<E> selectList(String statementId, Object... param) throws Exception { MappedStatement mappedStatement = configuration.getMappedStatementMap().get(statementId); List<E> query = simpleExcutor.query(configuration, mappedStatement, param); return query; } @Override public <T> T selectOne(String statementId, Object... params) throws Exception { List<Object> objects = selectList(statementId, params); if (objects.size() == 1) { return (T) objects.get(0); } else { throw new RuntimeException("返回結果過多"); } } }
資料庫操作類DefaultSqlSession中的selectList方法呼叫到了simpleExcutor.query()方法
public class SimpleExecutor implements Executor { private Connection connection = null; @Override public <E> List<E> query(Configuration configuration, MappedStatement mappedStatement, Object[] params) throws Exception { //獲取連線 connection = configuration.getDataSource().getConnection(); // select * from user where id = #{id} and username = #{username} String sql = String sql = mappedStatement.getSql(); //對sql進⾏處理 BoundSql boundSql = getBoundSql(sql); // 3.獲取預處理物件:preparedStatement PreparedStatement preparedStatement = connection.prepareStatement(boundSql.getSqlText()); // 4. 設定引數 //獲取到了引數的全路徑 String parameterType = mappedStatement.getParameterType(); Class<?> parameterTypeClass = getClassType(parameterType); List<ParameterMapping> parameterMappingList = boundSql.getParameterMappingList(); for (int i = 0; i < parameterMappingList.size(); i++) { ParameterMapping parameterMapping = parameterMappingList.get(i); String content = parameterMapping.getContent(); //反射 Field declaredField = parameterTypeClass.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; } @Override public void close() throws SQLException { } private Class<?> getClassType(String parameterType) throws ClassNotFoundException { if(parameterType!=null){ Class<?> aClass = Class.forName(parameterType); return aClass; } return null; } private BoundSql getBoundSql(String sql) { //標記處理類:主要是配合通⽤標記解析器GenericTokenParser類完成對設定⽂件等的解 析⼯作,其中 //TokenHandler主要完成處理 ParameterMappingTokenHandler parameterMappingTokenHandler = new ParameterMappingTokenHandler(); //GenericTokenParser :通⽤的標記解析器,完成了程式碼⽚段中的預留位置的解析,然後再根 據給定的 // 標記處理器(TokenHandler)來進⾏表示式的處理 //三個引數:分別為openToken (開始標記)、closeToken (結束標記)、handler (標記處 理器) GenericTokenParser genericTokenParser = new GenericTokenParser("#{", "}", parameterMappingTokenHandler); String parse = genericTokenParser.parse(sql); List<ParameterMapping> parameterMappings = parameterMappingTokenHandler.getParameterMappings(); return new BoundSql(parse, parameterMappings); } }
上面的註釋比較詳細,流程為
通過以上步驟,我們獲取到了資料庫設定、sql語句資訊。定義了資料庫操作類SqlSession,但是我們並沒有在什麼地方呼叫解析組態檔。
我們還需要一個東西把兩者給串起來,這裡我們可以使用工廠模式來生成SqlSession
使用工廠模式建立SqlSession
public interface SqlSessionFactory { public SqlSession openSession(); }
public class DefaultSqlSessionFactory implements SqlSessionFactory{ private Configuration configuration; public DefaultSqlSessionFactory(Configuration configuration) { this.configuration = configuration; } @Override public SqlSession openSession() { return new DefaultSqlSession(configuration); } }
同時為了遮蔽構建SqlSessionFactory工廠類時獲取Configuration的解析過程,我們可以使用構建者模式來獲得一個SqlSessionFactory類。
public class SqlSessionFactoryBuilder { public SqlSessionFactory build(InputStream inputStream) throws PropertyVetoException, DocumentException, ClassNotFoundException { XMLConfigBuilder xmlConfigerBuilder = new XMLConfigBuilder(); Configuration configuration = xmlConfigerBuilder.parserConfiguration(inputStream); SqlSessionFactory sqlSessionFactory = new DefaultSqlSessionFactory(configuration); return sqlSessionFactory; } }
終於好了,通過以上幾個步驟我們現在可以具體呼叫執行程式碼了。
public static void main(String[] args) 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("蓋倫"); User user2 = sqlSession.selectOne("user.selectOne", user); System.out.println(user2); List<User> users = sqlSession.selectList("user.selectList"); for (User user1 : users) { System.out.println(user1); } }
程式碼正確執行,輸出
上述⾃定義框架,解決了JDBC運算元據庫帶來的⼀些問題:例如頻繁建立釋放資料庫連線,硬編
碼,⼿動封裝返回結果集等問題,現在我們繼續來分析剛剛完成的⾃定義框架程式碼,有沒有什麼問題呢?
問題如下:
我們可以使用代理模式,生成代理物件,在呼叫之前獲取到執行方法的方法名、具體類。這樣我們就能獲取到statementId。
為SqlSession類新增getMappper方法,獲取代理物件
public interface SqlSession { public <E> List<E> selectList(String statementId, Object... param) throws Exception; public <T> T selectOne(String statementId,Object... params) throws Exception; //為Dao介面生成代理實現類 public <T> T getMapper(Class<?> mapperClass); }
public class DefaultSqlSession implements SqlSession { private Configuration configuration; private Executor simpleExcutor = new SimpleExecutor(); public DefaultSqlSession(Configuration configuration) { this.configuration = configuration; } @Override public <E> List<E> selectList(String statementId, Object... param) throws Exception { MappedStatement mappedStatement = configuration.getMappedStatementMap().get(statementId); List<E> query = simpleExcutor.query(configuration, mappedStatement, param); return query; } @Override public <T> T selectOne(String statementId, Object... params) throws Exception { List<Object> objects = selectList(statementId, params); if (objects.size() == 1) { return (T) objects.get(0); } else { throw new RuntimeException("返回結果過多"); } } @Override public <T> T getMapper(Class<?> mapperClass) { Object proxyInstance = Proxy.newProxyInstance(DefaultSqlSession.class.getClassLoader(), new Class[]{mapperClass}, new InvocationHandler() { @Override public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { // selectOne String methodName = method.getName(); // className:namespace String className = method.getDeclaringClass().getName(); //statementId String statementId = className+'.'+methodName; Type genericReturnType = method.getGenericReturnType(); //判斷是否實現泛型型別引數化 if (genericReturnType instanceof ParameterizedType){ List<Object> objects = selectList(statementId,args); return objects; } return selectOne(statementId,args); } }); return (T) proxyInstance; } }
定義業務資料dao介面
public interface IUserDao { //查詢所有使用者 public List<User> findAll() throws Exception; //根據條件進行使用者查詢 public User findByCondition(User user) throws Exception; }
接下來我們只需獲取到代理物件,呼叫方法即可。
public class Main2 { public static void main(String[] args) throws Exception { InputStream resourceAsSteam = Resources.getResourceAsSteam("sqlMapConfig.xml"); SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsSteam); SqlSession sqlSession = sqlSessionFactory.openSession(); //獲取到代理物件 IUserDao userDao = sqlSession.getMapper(IUserDao.class); List<User> all = userDao.findAll(); for (User user1 : all) { System.out.println(user1); } } }
為了解決JDBC運算元據庫存在的問題,我們主要乾了這些事
以下為本文的大體流程圖:
原始碼以及資料庫建表語句連結 :java自定義簡易持久層框架
到此這篇關於Java手寫持久層框架的文章就介紹到這了,更多相關Java持久層框架內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com!
相關文章
<em>Mac</em>Book项目 2009年学校开始实施<em>Mac</em>Book项目,所有师生配备一本<em>Mac</em>Book,并同步更新了校园无线网络。学校每周进行电脑技术更新,每月发送技术支持资料,极大改变了教学及学习方式。因此2011
2021-06-01 09:32:01
综合看Anker超能充系列的性价比很高,并且与不仅和iPhone12/苹果<em>Mac</em>Book很配,而且适合多设备充电需求的日常使用或差旅场景,不管是安卓还是Switch同样也能用得上它,希望这次分享能给准备购入充电器的小伙伴们有所
2021-06-01 09:31:42
除了L4WUDU与吴亦凡已经多次共事,成为了明面上的厂牌成员,吴亦凡还曾带领20XXCLUB全队参加2020年的一场音乐节,这也是20XXCLUB首次全员合照,王嗣尧Turbo、陈彦希Regi、<em>Mac</em> Ova Seas、林渝植等人全部出场。然而让
2021-06-01 09:31:34
目前应用IPFS的机构:1 谷歌<em>浏览器</em>支持IPFS分布式协议 2 万维网 (历史档案博物馆)数据库 3 火狐<em>浏览器</em>支持 IPFS分布式协议 4 EOS 等数字货币数据存储 5 美国国会图书馆,历史资料永久保存在 IPFS 6 加
2021-06-01 09:31:24
开拓者的车机是兼容苹果和<em>安卓</em>,虽然我不怎么用,但确实兼顾了我家人的很多需求:副驾的门板还配有解锁开关,有的时候老婆开车,下车的时候偶尔会忘记解锁,我在副驾驶可以自己开门:第二排设计很好,不仅配置了一个很大的
2021-06-01 09:30:48
不仅是<em>安卓</em>手机,苹果手机的降价力度也是前所未有了,iPhone12也“跳水价”了,发布价是6799元,如今已经跌至5308元,降价幅度超过1400元,最新定价确认了。iPhone12是苹果首款5G手机,同时也是全球首款5nm芯片的智能机,它
2021-06-01 09:30:45