一、JDBC:
public static void main (String[]args){ Connection connection = null; PreparedStatement preparedStatement = null; ResultSet resultSet = null; try { // 加载数据库驱动 Class.forName("com.mysql.jdbc.Driver"); // 通过驱动管理类获取数据库链接 connection = DriverManager.getConnection("jdbc:mysql://localhost:3306/mybatis? characterEncoding = utf - 8", " root", " root"); // 定义sql语句?表示占位符 String sql = "select * from user where username = ?"; // 获取预处理statement preparedStatement = connection.prepareStatement(sql); // 设置参数,第⼀个参数为sql语句中参数的序号(从1开始),第⼆个参数为设置的参数值 preparedStatement.setString(1, "tom"); // 向数据库发出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的写法,存在两个缺点:
硬编码:不管是sql语句,还是参数,还是取值,都是硬编码,不好维护。
链接频繁创建和释放:每次访问都会创建新的链接,用完后释放,造成系统资源浪费。
解决办法:
可以通过连接池管理链接。
可以用xml文件,将sql等信息配置,通过反射等技术实现动态映射。
二、自定义mybatis框架
业务项目A
1、定义全局配置文件sqlMapConfig.xml来存放数据源信息; 定义Mapper.xml来动态配置sql语句,比如,定义UserMapper.xml操作User。
sqlMapConfig.xml:
<configuration> <!--数据库配置信息--> <dataSource> <property name="driverClass" value="com.mysql.jdbc.Driver"></property> <property name="jdbcUrl" value="jdbc:mysql:///zdy_mybatis"></property> <property name="username" value="root"></property> <property name="password" value="root"></property> </dataSource> <!--存放mapper.xml的全路径--> <mapper resource="UserMapper.xml"></mapper> </configuration>
UserMapper.xml:
<mapper namespace="User"> <select id="selectOne" paramterType="com.lagou.pojo.User" resultType="com.lagou.pojo.User"> select * from user where id = #{id} and username =#{username} </select> <select id="selectList" resultType="com.lagou.pojo.User"> select * from user </select> </mapper>
User实体:
public class User { private Integer id; private String username; 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; } @Override public String toString() { return "User{" + "id=" + id + ", username='" + username + '\'' + '}'; } }
持久层框架项目B
在业务项目A中配置了xml文件,持久层框架要做的事,就是将配置文件通过流的方式读取, 并创建javaBean,才能传递使用。具体流程:
导入相关依赖:
<properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <maven.compiler.encoding>UTF-8</maven.compiler.encoding> <java.version>1.8</java.version> <maven.compiler.source>1.8</maven.compiler.source> <maven.compiler.target>1.8</maven.compiler.target> </properties><dependencies> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>5.1.17</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> <!--配合dom4j使用--> <dependency> <groupId>jaxen</groupId> <artifactId>jaxen</artifactId> <version>1.1.6</version> </dependency> </dependencies>
创建MappedStatement类对应mapper.xml中的每个sql标签:
public class MappedStatement { //id标识 private String id; //返回值类型 private String resultType; //参数值类型 private String paramterType; //sql语句 private String sql; public String getId() { return id; } public void setId(String id) { this.id = id; } public String getResultType() { return resultType; } public void setResultType(String resultType) { this.resultType = resultType; } public String getParamterType() { return paramterType; } public void setParamterType(String paramterType) { this.paramterType = paramterType; } public String getSql() { return sql; } public void setSql(String sql) { this.sql = sql; } }
创建Configuration类对应sqlMapConfig.xml,封装数据源信息
public class Configuration {
private DataSource dataSource;
/*
* key为statementid(即mapper.xml中namespace的值+标签作用id来确定唯一) value为封装好的mappedStatement对象,对应着一个个select标签的内容
* */
Map<String,MappedStatement> mappedStatementMap = new HashMap<>();
public DataSource getDataSource() {
return dataSource;
}
public void setDataSource(DataSource dataSource) {
this.dataSource = dataSource;
}
public Map<String, MappedStatement> getMappedStatementMap() {
return mappedStatementMap;
}
public void setMappedStatementMap(Map<String, MappedStatement> mappedStatementMap) {
this.mappedStatementMap = mappedStatementMap;
}
}
如上,使用DataSource封装xml中的数据库信息,另外,在mapper.xml中有多个select标签,所以这里用map封装到一起传递,后续可以选择具体的某一个来填充业务参数。
有了承载xml的java类后,就需要通过流,读取到对应的javaBean中。
定义Resource类,读取配置文件为流:
import java.io.InputStream; public class Resources { // 根据配置文件的路径,将配置文件加载成字节输入流,存储在内存中 public static InputStream getResourceAsSteam(String path){ InputStream resourceAsStream = Resources.class.getClassLoader().getResourceAsStream(path); return resourceAsStream; } }
定义XMLConfigBuilder类,将流中的信息读取到Configuration中
public class XMLConfigBuilder { private Configuration configuration; public XMLConfigBuilder() { this.configuration = new Configuration(); } /** * 该方法就是使用dom4j对配置文件进行解析,封装Configuration */ public Configuration parseConfig(InputStream inputStream) throws DocumentException, PropertyVetoException { Document document = new SAXReader().read(inputStream); //<configuration> Element rootElement = document.getRootElement(); List<Element> list = rootElement.selectNodes("//property"); Properties properties = new Properties(); for (Element element : list) { String name = element.attributeValue("name"); String value = element.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); //mapper.xml解析: 拿到路径--字节输入流---dom4j进行解析 List<Element> mapperList = rootElement.selectNodes("//mapper"); for (Element element : mapperList) { String mapperPath = element.attributeValue("resource"); InputStream resourceAsSteam = Resources.getResourceAsSteam(mapperPath); XMLMapperBuilder xmlMapperBuilder = new XMLMapperBuilder(configuration); xmlMapperBuilder.parse(resourceAsSteam); } return configuration; } }
定义XMLMapperBuilder,将mapper.xml的流信息读取到MappedStatement,并设置到Configuration的map属性中
import org.dom4j.Document;
import org.dom4j.DocumentException;
import org.dom4j.Element;
import org.dom4j.io.SAXReader;
import java.io.InputStream;
import java.util.List;
public class XMLMapperBuilder {
private Configuration configuration;
public XMLMapperBuilder(Configuration configuration) {
this.configuration =configuration;
}
public void parse(InputStream inputStream) throws DocumentException {
Document document = new SAXReader().read(inputStream);
Element rootElement = document.getRootElement();
String namespace = rootElement.attributeValue("namespace");
List<Element> list = rootElement.selectNodes("//select");
for (Element element : list) {
String id = element.attributeValue("id");
String resultType = element.attributeValue("resultType");
String paramterType = element.attributeValue("paramterType");
String sqlText = element.getTextTrim();
MappedStatement mappedStatement = new MappedStatement();
mappedStatement.setId(id);
mappedStatement.setResultType(resultType);
mappedStatement.setParamterType(paramterType);
mappedStatement.setSql(sqlText);
String key = namespace+"."+id;
configuration.getMappedStatementMap().put(key,mappedStatement);
}
}
}
上面的两个类,可以把xml中的配置读取到Configuration中,在哪里调用的呢?
首先创建一个SqlSessionFactoryBuilder,该类的作用是一个建造者,通过它调用读取配置,得到Configuration后,再创建出一个SqlSessionFactory工厂类,使用该工厂去创建SqlSession,在此过程中依次传递Configuration。
最终在SqlSession中,执行查询。
SqlSessionFactoryBuilder:
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; } }
SqlSessionFactory及实现类:
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); } }
SqlSession及实现类:
public interface SqlSession { //查询所有 public <E> List<E> selectList(String statementid,Object... params) throws Exception; //根据条件查询单个 public <T> T selectOne(String statementid,Object... params) throws Exception; }
import java.lang.reflect.*;
import java.util.List;
public class DefaultSqlSession implements SqlSession {
private Configuration configuration;
public DefaultSqlSession(Configuration configuration) {
this.configuration = configuration;
}
@Override
public <E> List<E> selectList(String statementid, Object... params) throws Exception {
//将要去完成对simpleExecutor里的query方法的调用
SimpleExecutor simpleExecutor = new SimpleExecutor();
MappedStatement mappedStatement = configuration.getMappedStatementMap().get(statementid);
List<Object> list = simpleExecutor.query(configuration, mappedStatement, params);
return (List<E>) list;
}
@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("查询结果为空或者返回结果过多");
}
}
}
如上在sqlSessiion中,通过传入的statementid,可以获取到Configuration中具体的mappedStatement,也就是拿到了具体的sql语句,通过参数等可以开始查询了。 在这里,再把查询的过程抽取到一个执行器SimpleExecutor中去具体执行:
Executor及实现类:
public interface Executor { public <E> List<E> query(Configuration configuration,MappedStatement mappedStatement,Object... params) throws Exception; }
import com.lagou.utils.GenericTokenParser; import com.lagou.utils.ParameterMapping; import com.lagou.utils.ParameterMappingTokenHandler;public class simpleExecutor implements Executor { @Override //user 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; } private Class<?> getClassType(String paramterType) throws ClassNotFoundException { if(paramterType!=null){ Class<?> aClass = Class.forName(paramterType); return aClass; } return null; } /** * 完成对#{}的解析工作: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; } }
如上,在执行器中,通过configuration得到数据库链接信息和mappedStatement中的sql,就可以通过jdbc执行了。
要注意的是,mappedStatement取出的sql的参数,是#{}这种样式:
select * from user where id = #{id} and username = #{username}
jdbc需要的是?的样式:
select * from user where id = ? and username = ?
这里就是通过getBoundSql这个方法,把sql每个 #{} 替换成 ? ,并把#中的参数名称 按顺序存放在一个list中。 并把解析后结果存放到BoundSql中保存返回,然后在executor中,遍历list中每个参数名,通过反射技术,在传递的参数类型(User对象)中获取到具体的值,给preparedStatement中每个?赋值。
BoundSql:存放解析后的sql和参数名列表
public class BoundSql { //解析过后的sql private String sqlText; //解析sql后,将每个#中的参数名存放下来 private List<ParameterMapping> parameterMappingList = new ArrayList<>(); public BoundSql(String sqlText, List<ParameterMapping> parameterMappingList) { this.sqlText = sqlText; this.parameterMappingList = parameterMappingList; } public String getSqlText() { return sqlText; } public void setSqlText(String sqlText) { this.sqlText = sqlText; } public List<ParameterMapping> getParameterMappingList() { return parameterMappingList; } public void setParameterMappingList(List<ParameterMapping> parameterMappingList) { this.parameterMappingList = parameterMappingList; } }
对于查询后的结果ResultSet,也是根据mappedStatement中配置的返回类型创建返回对象,通过反射、内省技术,动态将值设置到返回对象中。
另外,了解一下解析器:
ParameterMapping
public class ParameterMapping { private String content; public ParameterMapping(String content) { this.content = content; } public String getContent() { return content; } public void setContent(String content) { this.content = content; } }
ParameterMappingTokenHandler
public class ParameterMappingTokenHandler implements TokenHandler { private List<ParameterMapping> parameterMappings = new ArrayList<ParameterMapping>(); // content是参数名称 #{id} #{username} public String handleToken(String content) { parameterMappings.add(buildParameterMapping(content)); return "?"; } private ParameterMapping buildParameterMapping(String content) { ParameterMapping parameterMapping = new ParameterMapping(content); return parameterMapping; } public List<ParameterMapping> getParameterMappings() { return parameterMappings; } public void setParameterMappings(List<ParameterMapping> parameterMappings) { this.parameterMappings = parameterMappings; } }
TokenHandler
public interface TokenHandler { String handleToken(String content); }
GenericTokenParser
public class GenericTokenParser { private final String openToken; //开始标记 private final String closeToken; //结束标记 private final TokenHandler handler; //标记处理器 public GenericTokenParser(String openToken, String closeToken, TokenHandler handler) { this.openToken = openToken; this.closeToken = closeToken; this.handler = handler; } /** * 解析${}和#{} * @param text * @return * 该方法主要实现了配置文件、脚本等片段中占位符的解析、处理工作,并返回最终需要的数据。 * 其中,解析工作由该方法完成,处理工作是由处理器handler的handleToken()方法来实现 */ public String parse(String text) { // 验证参数问题,如果是null,就返回空字符串。 if (text == null || text.isEmpty()) { return ""; } // 下面继续验证是否包含开始标签,如果不包含,默认不是占位符,直接原样返回即可,否则继续执行。 int start = text.indexOf(openToken, 0); if (start == -1) { return text; } // 把text转成字符数组src,并且定义默认偏移量offset=0、存储最终需要返回字符串的变量builder, // text变量中占位符对应的变量名expression。判断start是否大于-1(即text中是否存在openToken),如果存在就执行下面代码 char[] src = text.toCharArray(); int offset = 0; final StringBuilder builder = new StringBuilder(); StringBuilder expression = null; while (start > -1) { // 判断如果开始标记前如果有转义字符,就不作为openToken进行处理,否则继续处理 if (start > 0 && src[start - 1] == '\\') { builder.append(src, offset, start - offset - 1).append(openToken); offset = start + openToken.length(); } else { //重置expression变量,避免空指针或者老数据干扰。 if (expression == null) { expression = new StringBuilder(); } else { expression.setLength(0); } builder.append(src, offset, start - offset); offset = start + openToken.length(); int end = text.indexOf(closeToken, offset); while (end > -1) {////存在结束标记时 if (end > offset && src[end - 1] == '\\') {//如果结束标记前面有转义字符时 // this close token is escaped. remove the backslash and continue. expression.append(src, offset, end - offset - 1).append(closeToken); offset = end + closeToken.length(); end = text.indexOf(closeToken, offset); } else {//不存在转义字符,即需要作为参数进行处理 expression.append(src, offset, end - offset); offset = end + closeToken.length(); break; } } if (end == -1) { // close token was not found. builder.append(src, start, src.length - start); offset = src.length; } else { //首先根据参数的key(即expression)进行参数处理,返回?作为占位符 builder.append(handler.handleToken(expression.toString())); offset = end + closeToken.length(); } } start = text.indexOf(openToken, offset); } if (offset < src.length) { builder.append(src, offset, src.length - offset); } return builder.toString(); } }
有了上面的流程后,在业务项目A中,引入持久层框架B的依赖,便可以实现调用了
@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("张三"); 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); } }
三:优化
如上,业务加载自己的配置文件后,使用框架的sqlSession执行操作。但是有几个问题:
a、sqlSession使用后没有关闭数据库连接
解决方式:
提供关闭连接的方法:
SqlSession接口:
public void close() throws SQLException;
DefaultSqlSession类:
public void close () throws SQLException {simpleExcutor.close();}
Executor接口:
void close() throws SQLException;
SimpleExecutor类真正关闭连接:
@Overridepublic void close() throws SQLException {connection.close();}
这样业务就可以调用关闭连接的方法了。
b、调用sqlSession的查询逻辑,应该封装到持久层。
解决方式:
创建dao层,封装xml加载和sql调用的逻辑:
IUserDao
public interface IUserDao { //查询所有用户 public List<User> findAll() throws Exception; //根据条件进行用户查询 public User findByCondition(User user) throws Exception; }
UserDaoImpl
public class UserDaoImpl implements IUserDao { //查询所有用户 public List<User> findAll() throws Exception { InputStream resourceAsSteam = Resources.getResourceAsSteam("sqlMapConfig.xml"); SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsSteam); SqlSession sqlSession = sqlSessionFactory.openSession(); //调用 List<User> users = sqlSession.selectList("user.selectList"); return users; }public User findByCondition(User user) 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); return user2; } }
如上,有了持久层供上层调用。但是,每个方法中都是重复的读取xml,重复的创建selSession,调用sqlSession的方法,另外传入的statementid是硬编码。
解决方式:
删除实现类,在SqlSession中使用动态代理创建IUserDao的代理对象。 在代理对象的invoke方法中,动态获取IUserDao的全限定名和方法名作为statementid(这就要求mapper.xml中的namespace也为dao的全限定名,而标签中的id也要和dao中的方法名一致)。
SqlSession:
//为Dao接口生成代理实现类 public <T> T getMapper(Class<?> mapperClass);
DefaultSqlSession:
@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; }
调用:
@Test public void test() 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); } }
如上,调用userDao代理对象的方法时,会调用invoke对象,从而自动调用sqlSession的查询方法。