本文共 8861 字,大约阅读时间需要 29 分钟。
本节利用Mysql数据库(通过以下步骤)说明如何使用 MyBatis 开发一个简单的 Java 项目: 1. 新建表 students,插入样本数据 2. 新建一个 Java 项目,将 MyBatis依赖添加到 pom.xml中 3. 新建MyBatisSqlSessionFactory 类构建 SqlSessionFactory 4. 新建映射器 StudentMapper 接口和 StudentService 类 5. 新建一个 JUnit 测试类来测试 StudentService 新建表 STUDENTS,插入样本数据 使用图形界面或sql语句创建表并添加数据,我创建的表如下:新建一个 Java 项目 如果你没有使用类似于 Maven 和 Gradle 之类的依赖管理构建工具,你需要手动下载这些依赖的 JAR 包,手动添加到 classpath 中。 你可以从上 下载 MyBatis 的发布包 mybatis-3.4.5.zip。 它包含了 mybatis-3.4.5.jar 文件和可选的依赖包如 slf4j/log4j 日志 jar 包. 我们将使用 slf4j 日志记录框架和log4j 一起记录日志。 你可以从http://junit.org 上下载JUnit JAR文件, 从 上 下载 MySQL 数据库驱动,现在我的pom.xml文件如下:org.mybatis mybatis x.x.x
现在创建一个JavaBean——Student.java4.0.0 MyBatisDemo MyBatisDemo 1.0-SNAPSHOT UTF-8 1.8 4.11 1.7.21 1.2.17 3.4.5 6.0.6 3.3 org.mybatis mybatis ${mybatis.version} mysql mysql-connector-java ${mysql.version} runtime org.slf4j slf4j-api ${slf4j.version} org.slf4j slf4j-log4j12 ${slf4j.version} runtime log4j log4j ${log4j.version} runtime junit junit ${junit.version} test
public class Student { private Integer studId; private String name; private String email; private Date dob; // setters and getters }接下来创建 MyBatis 的主要配置文件 mybatis-config.xml,其中包括数据库连接信息,类型别名等等;然后再创建一个包含了映射的 SQL 语句的 xml 文件。 mybatis-config.xml如下:
创建 SQL 映射器 XML 配置文件,假定为 StudentMapper.xml。 并且将它放在 com.neucloud.mappers 包中 ,内容如下:
创建一个 StudentMapper 接口 其定义的方法名和在 Mapper XML 配置文件定义的 SQL 映射语句名称相同INSERT INTO STUDENTS(STUD_ID,NAME,EMAIL,DOB) VALUES(#{studId},#{name},#{email},#{dob}) UPDATE STUDENTS SET NAME=#{name}, EMAIL=#{email}, DOB=#{dob} WHERE STUD_ID=#{studId}
public interface StudentMapper{ List新建MyBatisSqlSessionFactory 类构建 SqlSessionFactory MyBatis 最关键的组成部分是 SqlSessionFactory,我们可以从中获取 SqlSession,并执行映射的 SQL 语句。SqlSessionFactory 对象可以通过基于 XML 的配置信息或者 Java API 创建findAllStudents(); Student findStudentById(Integer id); void insertStudent(Student student); void updateStudent(Student student);}
public class MyBatisSqlSessionFactory { private static SqlSessionFactory sqlSessionFactory; private static final Properties properties = new Properties(); static { try { InputStream is = DataSourceFactory.class.getResourceAsStream("/mysql.properties"); properties.load(is); } catch (IOException e) { e.printStackTrace(); } } private static SqlSessionFactory getSqlSessionFactory() { if (sqlSessionFactory == null) { InputStream inputStream = null; try { inputStream = Resources.getResourceAsStream("mybatis-config.xml"); sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream); } catch (IOException e) { throw new RuntimeException(e.getCause()); } finally { if (inputStream != null) { try { inputStream.close(); } catch (IOException e) { } } } } return sqlSessionFactory; } public static SqlSession getSqlSession() { return getSqlSessionFactory().openSession(); }}再创建一个 StudentService.java 类 它实现对表 STUDENTS 的数据库操作
public class StudentService { private Logger logger = LoggerFactory.getLogger(getClass()); public List现在写一个类测试一下吧findAllStudents() { SqlSession sqlSession = MyBatisSqlSessionFactory.getSqlSession(); try { StudentMapper studentMapper = sqlSession.getMapper(StudentMapper.class); return studentMapper.findAllStudents(); } finally { sqlSession.close(); } } public Student findStudentById(Integer studId) { logger.debug("Select Student By ID :{}", studId); SqlSession sqlSession = MyBatisSqlSessionFactory.getSqlSession(); try { StudentMapper studentMapper = sqlSession.getMapper(StudentMapper.class);// return studentMapper.findStudentById(studId); //也可以不通过 Mapper 接口执行映射的 SQL 语句 return sqlSession.selectOne("com.neucloud.mappers.StudentMapper.findStudentById", studId); } finally { sqlSession.close(); } } public void createStudent(Student student) { SqlSession sqlSession = MyBatisSqlSessionFactory.getSqlSession(); try { StudentMapper studentMapper = sqlSession.getMapper(StudentMapper.class); studentMapper.insertStudent(student); sqlSession.commit(); } finally { sqlSession.close(); } } public void updateStudent(Student student) { SqlSession sqlSession = MyBatisSqlSessionFactory.getSqlSession(); try { StudentMapper studentMapper = sqlSession.getMapper(StudentMapper.class); studentMapper.updateStudent(student); sqlSession.commit(); } finally { sqlSession.close(); } }}
public class Test { public static void main(String[] args) { StudentService studentService=new StudentService(); Student student=studentService.findStudentById(1); System.out.println(student.getEmail()); }}就是这样,我们的程序完成了,而如果我们使用jdbc这样才操作方式,上述代码会有很多重复的代码:创建一个连接,创建一个 Statement 对象,设置输入参数,关闭资源(如connection,statement,resultSet) 。 MyBatis 抽象了上述的这些相同的任务,如准备需要被执行的 SQL statement 对象并且将 Java 对象作为输入数据传递给 statement 对象的任务,进而开发人员可以专注于真正重要的方面。 另外,MyBatis 还提供了其他的一些特性来简化持久化逻辑的实现: ● 它支持复杂的 SQL 结果集数据映射到嵌套对象图结构 ● 它支持一对一和一对多的结果集和 Java 对象的映射 ● 它支持根据输入的数据构建动态的 SQL 语句 MyBatis的工作原理 首先,我们配置了 MyBatis 最主要的配置文件mybatis-config.xml,里面包含了 JDBC 连接参数;配置了映射器Mapper XML 配置文件文件,里面包含了 SQL 语句的映射。 我们使用 mybatis-config.xml 内的信息创建了 SqlSessionFactory 对象。每个数据库环境应该只有一个SqlSessionFactory 对象实例,所以我们使用了单例模式只创建一个 SqlSessionFactory 实例。 我们创建了一个映射器 Mapper 接口-StudentMapper,其定义的方法签名和在 StudentMapper.xml 中定义的完全一样(即映射器 Mapper 接口中的方法名跟 StudentMapper.xml 中的 id 的值相同) 。注意 StudentMapper.xml 中namespace 的值被设置成 com.neucloud.mappers.StudentMapper,是 StudentMapper 接口的完全限定名。这使我们可以使用接口来调用映射的 SQL 语句。
在 StudentService.java 中,我们在每一个方法中创建了一个新的 SqlSession,并在方法功能完成后关闭SqlSession。每一个线程应该有它自己的 SqlSession 实例。SqlSession 对象实例不是线程安全的,并且不被共享。所以 SqlSession 的作用域最好就是其所在方法的作用域。从 Web 应用程序角度上看,SqlSession 应该存在于 request 级别作用域上。
参考: